@pulumi/awsx
Version:
[](https://github.com/pulumi/pulumi-awsx/actions) [](https://slack.pulumi.com) [![NPM version](https://badge.fur
936 lines • 93.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as enums from "../types/enums";
import * as pulumiAws from "@pulumi/aws";
export declare namespace awsx {
/**
* The set of arguments for constructing a Bucket resource.
*/
interface BucketArgs {
/**
* Sets the accelerate configuration of an existing bucket. Can be `Enabled` or `Suspended`. Cannot be used in `cn-north-1` or `us-gov-west-1`. This provider will only perform drift detection if a configuration value is provided.
* Use the resource `aws.s3.BucketAccelerateConfiguration` instead.
*
* @deprecated acceleration_status is deprecated. Use the aws.s3.BucketAccelerateConfiguration resource instead.
*/
accelerationStatus?: pulumi.Input<string | undefined>;
/**
* The [canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Valid values are `private`, `public-read`, `public-read-write`, `aws-exec-read`, `authenticated-read`, and `log-delivery-write`. Defaults to `private`. Conflicts with `grant`. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketAcl` instead.
*/
acl?: pulumi.Input<string | undefined>;
/**
* Name of the bucket. If omitted, the provider will assign a random, unique name. Must be lowercase and less than or equal to 63 characters in length. A full list of bucket naming rules [may be found here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). The name must not be in the format `[bucketName]--[azid]--x-s3`. Use the `aws.s3.DirectoryBucket` resource to manage S3 Express buckets.
*/
bucket?: pulumi.Input<string | undefined>;
/**
* Namespace for the bucket. Determines bucket naming scope. Valid values: `account-regional`, `global`. Defaults to `global` (AWS).
*/
bucketNamespace?: pulumi.Input<string | undefined>;
/**
* Creates a unique bucket name beginning with the specified prefix. Conflicts with `bucket`. Must be lowercase and less than or equal to 37 characters in length. A full list of bucket naming rules [may be found here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).
*/
bucketPrefix?: pulumi.Input<string | undefined>;
/**
* Rule of [Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html). See CORS rule below for details. This provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketCorsConfiguration` instead.
*
* @deprecated cors_rule is deprecated. Use the aws.s3.BucketCorsConfiguration resource instead.
*/
corsRules?: pulumi.Input<pulumi.Input<pulumiAws.types.input.s3.BucketCorsRule>[] | undefined>;
/**
* Boolean that indicates all objects (including any [locked objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html)) should be deleted from the bucket *when the bucket is destroyed* so that the bucket can be destroyed without error. These objects are *not* recoverable. This only deletes objects when the bucket is destroyed, *not* when setting this parameter to `true`. Once this parameter is set to `true`, there must be a successful `pulumi up` run before a destroy is required to update this value in the resource state. Without a successful `pulumi up` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the bucket or destroying the bucket, this flag will not work. Additionally when importing a bucket, a successful `pulumi up` is required to set this value in state before it will take effect on a destroy operation.
*/
forceDestroy?: pulumi.Input<boolean | undefined>;
/**
* An [ACL policy grant](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#sample-acl). See Grant below for details. Conflicts with `acl`. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketAcl` instead.
*
* @deprecated grant is deprecated. Use the aws.s3.BucketAcl resource instead.
*/
grants?: pulumi.Input<pulumi.Input<pulumiAws.types.input.s3.BucketGrant>[] | undefined>;
/**
* Configuration of [object lifecycle management](http://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html). See Lifecycle Rule below for details. The provider will only perform drift detection if a configuration value is provided.
* Use the resource `aws.s3.BucketLifecycleConfiguration` instead.
*
* @deprecated lifecycle_rule is deprecated. Use the aws.s3.BucketLifecycleConfiguration resource instead.
*/
lifecycleRules?: pulumi.Input<pulumi.Input<pulumiAws.types.input.s3.BucketLifecycleRule>[] | undefined>;
/**
* Configuration of [S3 bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/UG/ManagingBucketLogging.html) parameters. See Logging below for details. The provider will only perform drift detection if a configuration value is provided.
* Use the resource `aws.s3.BucketLogging` instead.
*
* @deprecated logging is deprecated. Use the aws.s3.BucketLogging resource instead.
*/
logging?: pulumi.Input<pulumiAws.types.input.s3.BucketLogging | undefined>;
/**
* Configuration of [S3 object locking](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). See Object Lock Configuration below for details.
* The provider wil only perform drift detection if a configuration value is provided.
* Use the `objectLockEnabled` parameter and the resource `aws.s3.BucketObjectLockConfiguration` instead.
*
* @deprecated object_lock_configuration is deprecated. Use the top-level parameter objectLockEnabled and the aws.s3.BucketObjectLockConfiguration resource instead.
*/
objectLockConfiguration?: pulumi.Input<pulumiAws.types.input.s3.BucketObjectLockConfiguration | undefined>;
/**
* Indicates whether this bucket has an Object Lock configuration enabled. Valid values are `true` or `false`. This argument is not supported in all regions or partitions.
*/
objectLockEnabled?: pulumi.Input<boolean | undefined>;
/**
* Valid [bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html) JSON document. Note that if the policy document is not specific enough (but still valid), this provider may view the policy as constantly changing. In this case, please make sure you use the verbose/specific version of the policy. For more information about building AWS IAM policy documents with this provider, see the AWS IAM Policy Document Guide.
* The provider will only perform drift detection if a configuration value is provided.
* Use the resource `aws.s3.BucketPolicy` instead.
*/
policy?: pulumi.Input<string | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string | undefined>;
/**
* Configuration of [replication configuration](http://docs.aws.amazon.com/AmazonS3/latest/dev/crr.html). See Replication Configuration below for details. The provider will only perform drift detection if a configuration value is provided.
* Use the resource `aws.s3.BucketReplicationConfig` instead.
*
* @deprecated replication_configuration is deprecated. Use the aws.s3.BucketReplicationConfig resource instead.
*/
replicationConfiguration?: pulumi.Input<pulumiAws.types.input.s3.BucketReplicationConfiguration | undefined>;
/**
* Specifies who should bear the cost of Amazon S3 data transfer.
* Can be either `BucketOwner` or `Requester`. By default, the owner of the S3 bucket would incur the costs of any data transfer.
* See [Requester Pays Buckets](http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) developer guide for more information.
* The provider will only perform drift detection if a configuration value is provided.
* Use the resource `aws.s3.BucketRequestPaymentConfiguration` instead.
*
* @deprecated request_payer is deprecated. Use the aws.s3.BucketRequestPaymentConfiguration resource instead.
*/
requestPayer?: pulumi.Input<string | undefined>;
/**
* Configuration of [server-side encryption configuration](http://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html). See Server Side Encryption Configuration below for details.
* The provider will only perform drift detection if a configuration value is provided.
* Use the resource `aws.s3.BucketServerSideEncryptionConfiguration` instead.
*
* @deprecated server_side_encryption_configuration is deprecated. Use the aws.s3.BucketServerSideEncryptionConfiguration resource instead.
*/
serverSideEncryptionConfiguration?: pulumi.Input<pulumiAws.types.input.s3.BucketServerSideEncryptionConfiguration | undefined>;
/**
* Map of tags to assign to the bucket. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* The following arguments are deprecated, and will be removed in a future major version:
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Configuration of the [S3 bucket versioning state](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html). See Versioning below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketVersioning` instead.
*
* @deprecated versioning is deprecated. Use the aws.s3.BucketVersioning resource instead.
*/
versioning?: pulumi.Input<pulumiAws.types.input.s3.BucketVersioning | undefined>;
/**
* Configuration of the [S3 bucket website](https://docs.aws.amazon.com/AmazonS3/latest/userguide/WebsiteHosting.html). See Website below for details. The provider will only perform drift detection if a configuration value is provided.
* Use the resource `aws.s3.BucketWebsiteConfiguration` instead.
*
* @deprecated website is deprecated. Use the aws.s3.BucketWebsiteConfiguration resource instead.
*/
website?: pulumi.Input<pulumiAws.types.input.s3.BucketWebsite | undefined>;
}
/**
* Log group with default setup unless explicitly skipped.
*/
interface DefaultLogGroupArgs {
/**
* Arguments to use instead of the default values during creation.
*/
args?: inputs.awsx.LogGroupArgs;
/**
* Identity of an existing log group to use. Cannot be used in combination with `args` or `opts`.
*/
existing?: inputs.awsx.ExistingLogGroupArgs;
/**
* Skip creation of the log group.
*/
skip?: boolean;
}
/**
* Role and policy attachments with default setup unless explicitly skipped or an existing role ARN provided.
*/
interface DefaultRoleWithPolicyArgs {
/**
* Args to use when creating the role and policies. Can't be specified if `roleArn` is used.
*/
args?: inputs.awsx.RoleWithPolicyArgs;
/**
* ARN of existing role to use instead of creating a new role. Cannot be used in combination with `args` or `opts`.
*/
roleArn?: pulumi.Input<string | undefined>;
/**
* Skips creation of the role if set to `true`.
*/
skip?: boolean;
}
/**
* Security Group with default setup unless explicitly skipped or an existing security group id provided.
*/
interface DefaultSecurityGroupArgs {
/**
* Args to use when creating the security group. Can't be specified if `securityGroupId` is used.
*/
args?: inputs.awsx.SecurityGroupArgs;
/**
* Id of existing security group to use instead of creating a new security group. Cannot be used in combination with `args` or `opts`.
*/
securityGroupId?: pulumi.Input<string | undefined>;
/**
* Skips creation of the security group if set to `true`.
*/
skip?: boolean;
}
/**
* defaultSecurityGroupArgsProvideDefaults sets the appropriate defaults for DefaultSecurityGroupArgs
*/
function defaultSecurityGroupArgsProvideDefaults(val: DefaultSecurityGroupArgs): DefaultSecurityGroupArgs;
/**
* Reference to an existing bucket.
*/
interface ExistingBucketArgs {
/**
* Arn of the bucket. Only one of [arn] or [name] can be specified.
*/
arn?: pulumi.Input<string | undefined>;
/**
* Name of the bucket. Only one of [arn] or [name] can be specified.
*/
name?: pulumi.Input<string | undefined>;
}
/**
* Reference to an existing log group.
*/
interface ExistingLogGroupArgs {
/**
* Arn of the log group. Only one of [arn] or [name] can be specified.
*/
arn?: pulumi.Input<string | undefined>;
/**
* Name of the log group. Only one of [arn] or [name] can be specified.
*/
name?: pulumi.Input<string | undefined>;
/**
* Region of the log group. If not specified, the provider region will be used.
*/
region?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a LogGroup resource.
*/
interface LogGroupArgs {
/**
* Boolean to indicate whether deletion protection is enabled. Defaults to `false`. Once set, switching to `false` requires explicitly specifying `false` rather than removing this argument.
*/
deletionProtectionEnabled?: pulumi.Input<boolean | undefined>;
/**
* The ARN of the KMS Key to use when encrypting log data. Please note, after the AWS KMS CMK is disassociated from the log group,
* AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires
* permissions for the CMK whenever the encrypted data is requested.
*/
kmsKeyId?: pulumi.Input<string | undefined>;
/**
* Specified the log class of the log group. Possible values are: `STANDARD`, `INFREQUENT_ACCESS`, or `DELIVERY`.
*/
logGroupClass?: pulumi.Input<string | undefined>;
/**
* The name of the log group. If omitted, this provider will assign a random, unique name.
*/
name?: pulumi.Input<string | undefined>;
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`.
*/
namePrefix?: pulumi.Input<string | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string | undefined>;
/**
* Specifies the number of days
* you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, 3653, and 0.
* If you select 0, the events in the log group are always retained and never expire. If `logGroupClass` is set to `DELIVERY`, this argument is ignored and `retentionInDays` is forcibly set to 2.
*/
retentionInDays?: pulumi.Input<number | undefined>;
/**
* Set to true if you do not wish the log group (and any logs it may contain) to be deleted at destroy time, and instead just remove the log group from the state.
*/
skipDestroy?: pulumi.Input<boolean | undefined>;
/**
* A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
}
/**
* Log group which is only created if enabled.
*/
interface OptionalLogGroupArgs {
/**
* Arguments to use instead of the default values during creation.
*/
args?: inputs.awsx.LogGroupArgs;
/**
* Enable creation of the log group.
*/
enable?: boolean;
/**
* Identity of an existing log group to use. Cannot be used in combination with `args` or `opts`.
*/
existing?: inputs.awsx.ExistingLogGroupArgs;
}
/**
* Bucket with default setup.
*/
interface RequiredBucketArgs {
/**
* Arguments to use instead of the default values during creation.
*/
args?: inputs.awsx.BucketArgs;
/**
* Identity of an existing bucket to use. Cannot be used in combination with `args`.
*/
existing?: inputs.awsx.ExistingBucketArgs;
}
/**
* The set of arguments for constructing a Role resource and Policy attachments.
*/
interface RoleWithPolicyArgs {
/**
* Description of the role.
*/
description?: pulumi.Input<string | undefined>;
/**
* Whether to force detaching any policies the role has before destroying it. Defaults to `false`.
*/
forceDetachPolicies?: pulumi.Input<boolean | undefined>;
/**
* Configuration block defining an exclusive set of IAM inline policies associated with the IAM role. See below. If no blocks are configured, Pulumi will not manage any inline policies in this resource. Configuring one empty block (i.e., `inlinePolicy {}`) will cause Pulumi to remove _all_ inline policies added out of band on `apply`.
*/
inlinePolicies?: pulumi.Input<pulumi.Input<pulumiAws.types.input.iam.RoleInlinePolicy>[] | undefined>;
/**
* Set of exclusive IAM managed policy ARNs to attach to the IAM role. If this attribute is not configured, Pulumi will ignore policy attachments to this resource. When configured, Pulumi will align the role's managed policy attachments with this set by attaching or detaching managed policies. Configuring an empty set (i.e., `managedPolicyArns = []`) will cause Pulumi to remove _all_ managed policy attachments.
*/
managedPolicyArns?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.
*/
maxSessionDuration?: pulumi.Input<number | undefined>;
/**
* Friendly name of the role. If omitted, the provider will assign a random, unique name. See [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) for more information.
*/
name?: pulumi.Input<string | undefined>;
/**
* Creates a unique friendly name beginning with the specified prefix. Conflicts with `name`.
*/
namePrefix?: pulumi.Input<string | undefined>;
/**
* Path to the role. See [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) for more information.
*/
path?: pulumi.Input<string | undefined>;
/**
* ARN of the policy that is used to set the permissions boundary for the role.
*/
permissionsBoundary?: pulumi.Input<string | undefined>;
/**
* ARNs of the policies to attach to the created role.
*/
policyArns?: string[];
/**
* Key-value mapping of tags for the IAM role. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
}
/**
* The set of arguments for constructing a Security Group resource.
*/
interface SecurityGroupArgs {
/**
* Security group description. Defaults to `Managed by Pulumi`. Cannot be `""`. **NOTE**: This field maps to the AWS `GroupDescription` attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, use `tags`.
*/
description?: pulumi.Input<string | undefined>;
/**
* Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
*/
egress?: pulumi.Input<pulumi.Input<pulumiAws.types.input.ec2.SecurityGroupEgress>[] | undefined>;
/**
* Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
*/
ingress?: pulumi.Input<pulumi.Input<pulumiAws.types.input.ec2.SecurityGroupIngress>[] | undefined>;
/**
* Name of the security group. If omitted, the provider will assign a random, unique name.
*/
name?: pulumi.Input<string | undefined>;
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`.
*/
namePrefix?: pulumi.Input<string | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string | undefined>;
/**
* Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default `false`.
*/
revokeRulesOnDelete?: pulumi.Input<boolean | undefined>;
/**
* Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* VPC ID. Defaults to the region's default VPC.
*/
vpcId?: pulumi.Input<string | undefined>;
}
/**
* securityGroupArgsProvideDefaults sets the appropriate defaults for SecurityGroupArgs
*/
function securityGroupArgsProvideDefaults(val: SecurityGroupArgs): SecurityGroupArgs;
}
export declare namespace cloudtrail {
}
export declare namespace ec2 {
/**
* Configuration for NAT Gateways.
*/
interface NatGatewayConfigurationArgs {
/**
* A list of EIP allocation IDs to assign to the NAT Gateways. Optional. If specified, the number of supplied values must match the chosen strategy (either one, or the number of availability zones).
*/
elasticIpAllocationIds?: pulumi.Input<string>[];
/**
* The strategy for deploying NAT Gateways.
*/
strategy: enums.ec2.NatGatewayStrategy;
}
/**
* Configuration for a VPC subnet.
*/
interface SubnetSpecArgs {
/**
* Indicates whether a network interface created in this subnet receives an IPv6 address.
*/
assignIpv6AddressOnCreation?: boolean;
/**
* An optional list of CIDR blocks to assign to the subnet spec for each AZ. If specified, the count must match the number of AZs being used for the VPC, and must also be specified for all other subnet specs.
*/
cidrBlocks?: string[];
/**
* The netmask for the subnet's CIDR block. This is optional, the default value is inferred from the `cidrMask`, `cidrBlocks` or based on an even distribution of available space from the VPC's CIDR block after being divided evenly by availability zone.
*/
cidrMask?: number;
/**
* The subnet's name. Will be templated upon creation.
*/
name?: string;
/**
* Optional size of the subnet's CIDR block - the number of hosts. This value must be a power of 2 (e.g. 256, 512, 1024, etc.). This is optional, the default value is inferred from the `cidrMask`, `cidrBlocks` or based on an even distribution of available space from the VPC's CIDR block after being divided evenly by availability zone.
*/
size?: number;
/**
* A map of tags to assign to the resource.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The type of subnet.
*/
type: enums.ec2.SubnetType;
}
/**
* Provides a VPC Endpoint resource.
*
* > **NOTE on VPC Endpoints and VPC Endpoint Associations:** The provider provides both standalone VPC Endpoint Associations for
* Route Tables - (an association between a VPC endpoint and a single `routeTableId`),
* Security Groups - (an association between a VPC endpoint and a single `securityGroupId`),
* and Subnets - (an association between a VPC endpoint and a single `subnetId`) and
* a VPC Endpoint resource with `routeTableIds` and `subnetIds` attributes.
* Do not use the same resource ID in both a VPC Endpoint resource and a VPC Endpoint Association resource.
* Doing so will cause a conflict of associations and will overwrite the association.
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const s3 = new aws.ec2.VpcEndpoint("s3", {
* vpcId: main.id,
* serviceName: "com.amazonaws.us-west-2.s3",
* });
* ```
*
* ### Basic w/ Tags
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const s3 = new aws.ec2.VpcEndpoint("s3", {
* vpcId: main.id,
* serviceName: "com.amazonaws.us-west-2.s3",
* tags: {
* Environment: "test",
* },
* });
* ```
*
* ### Cross-region enabled AWS services
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const s3 = new aws.ec2.VpcEndpoint("s3", {
* region: "us-west-2",
* vpcId: main.id,
* serviceName: "com.amazonaws.us-east-2.s3",
* serviceRegion: "us-east-2",
* tags: {
* Environment: "test",
* },
* });
* ```
*
* ### Interface Endpoint Type
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const ec2 = new aws.ec2.VpcEndpoint("ec2", {
* vpcId: main.id,
* serviceName: "com.amazonaws.us-west-2.ec2",
* vpcEndpointType: "Interface",
* securityGroupIds: [sg1.id],
* privateDnsEnabled: true,
* });
* ```
*
* ### Interface Endpoint Type with User-Defined IP Address
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const ec2 = new aws.ec2.VpcEndpoint("ec2", {
* vpcId: example.id,
* serviceName: "com.amazonaws.us-west-2.ec2",
* vpcEndpointType: "Interface",
* subnetConfigurations: [
* {
* ipv4: "10.0.1.10",
* subnetId: example1.id,
* },
* {
* ipv4: "10.0.2.10",
* subnetId: example2.id,
* },
* ],
* subnetIds: [
* example1.id,
* example2.id,
* ],
* });
* ```
*
* ### Gateway Load Balancer Endpoint Type
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const current = aws.getCallerIdentity({});
* const example = new aws.ec2.VpcEndpointService("example", {
* acceptanceRequired: false,
* allowedPrincipals: [current.then(current => current.arn)],
* gatewayLoadBalancerArns: [exampleAwsLb.arn],
* });
* const exampleVpcEndpoint = new aws.ec2.VpcEndpoint("example", {
* serviceName: example.serviceName,
* subnetIds: [exampleAwsSubnet.id],
* vpcEndpointType: example.serviceType,
* vpcId: exampleAwsVpc.id,
* });
* ```
*
* ### VPC Lattice Resource Configuration Endpoint Type
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.ec2.VpcEndpoint("example", {
* resourceConfigurationArn: exampleAwsVpclatticeResourceConfiguration.arn,
* subnetIds: [exampleAwsSubnet.id],
* vpcEndpointType: "Resource",
* vpcId: exampleAwsVpc.id,
* });
* ```
*
* ### VPC Lattice Service Network Endpoint Type
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.ec2.VpcEndpoint("example", {
* serviceNetworkArn: exampleAwsVpclatticeServiceNetwork.arn,
* subnetIds: [exampleAwsSubnet.id],
* vpcEndpointType: "ServiceNetwork",
* vpcId: exampleAwsVpc.id,
* });
* ```
*
* ### Non-AWS Service
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const ptfeService = new aws.ec2.VpcEndpoint("ptfe_service", {
* vpcId: vpcId,
* serviceName: ptfeServiceConfig,
* vpcEndpointType: "Interface",
* securityGroupIds: [ptfeServiceAwsSecurityGroup.id],
* subnetIds: [subnetIds],
* privateDnsEnabled: false,
* });
* const internal = aws.route53.getZone({
* name: "vpc.internal.",
* privateZone: true,
* vpcId: vpcId,
* });
* const ptfeServiceRecord = new aws.route53.Record("ptfe_service", {
* zoneId: internal.then(internal => internal.zoneId),
* name: internal.then(internal => `ptfe.${internal.name}`),
* type: aws.route53.RecordType.CNAME,
* ttl: 300,
* records: [ptfeService.dnsEntries[0].dns_name],
* });
* ```
*
* > **NOTE The `dnsEntry` output is a list of maps:** This provider interpolation support for lists of maps requires the `lookup` and `[]` until full support of lists of maps is available
*
* ## Import
*
* ### Identity Schema
*
* #### Required
*
* * `id` - (String) ID of the VPC endpoint.
*
* #### Optional
*
* * `accountId` (String) AWS Account where this resource is managed.
* * `region` (String) Region where this resource is managed.
*
* Using `pulumi import`, import VPC Endpoints using the VPC endpoint `id`. For example:
*
* ```sh
* $ pulumi import aws:ec2/vpcEndpoint:VpcEndpoint example vpce-3ecf2a57
* ```
*/
interface VpcEndpointSpecArgs {
/**
* Accept the VPC endpoint (the VPC endpoint and service need to be in the same AWS account).
*/
autoAccept?: boolean;
/**
* The DNS options for the endpoint. See dnsOptions below.
*/
dnsOptions?: pulumi.Input<pulumiAws.types.input.ec2.VpcEndpointDnsOptions | undefined>;
/**
* The IP address type for the endpoint. Valid values are `ipv4`, `dualstack`, and `ipv6`.
*/
ipAddressType?: pulumi.Input<string | undefined>;
/**
* A policy to attach to the endpoint that controls access to the service. This is a JSON formatted string. Defaults to full access. All `Gateway` and some `Interface` endpoints support policies - see the [relevant AWS documentation](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints-access.html) for more details.
*/
policy?: pulumi.Input<string | undefined>;
/**
* Whether or not to associate a private hosted zone with the specified VPC. Applicable for endpoints of type Interface. Defaults to `false`.
*/
privateDnsEnabled?: boolean;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string | undefined>;
/**
* The ARN of a Resource Configuration to connect this VPC Endpoint to. Exactly one of `resourceConfigurationArn`, `serviceName` or `serviceNetworkArn` is required.
*/
resourceConfigurationArn?: pulumi.Input<string | undefined>;
/**
* One or more route table IDs. Applicable for endpoints of type `Gateway`.
*/
routeTableIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The ID of one or more security groups to associate with the network interface. Applicable for endpoints of type `Interface`.
* If no security groups are specified, the VPC's [default security group](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#DefaultSecurityGroup) is associated with the endpoint.
*/
securityGroupIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The service name. For AWS services the service name is usually in the form `com.amazonaws.<region>.<service>` (the SageMaker Notebook service is an exception to this rule, the service name is in the form `aws.sagemaker.<region>.notebook`).
*/
serviceName: string;
/**
* The ARN of a Service Network to connect this VPC Endpoint to. Exactly one of `resourceConfigurationArn`, `serviceName` or `serviceNetworkArn` is required.
*/
serviceNetworkArn?: pulumi.Input<string | undefined>;
/**
* The AWS region of the VPC Endpoint Service. If specified, the VPC endpoint will connect to the service in the provided region. Applicable for endpoints of type `Interface`.
*/
serviceRegion?: pulumi.Input<string | undefined>;
/**
* Subnet configuration for the endpoint, used to select specific IPv4 and/or IPv6 addresses to the endpoint. See subnetConfiguration below.
*/
subnetConfigurations?: pulumi.Input<pulumi.Input<pulumiAws.types.input.ec2.VpcEndpointSubnetConfiguration>[] | undefined>;
/**
* The ID of one or more subnets in which to create a network interface for the endpoint. Applicable for endpoints of type `GatewayLoadBalancer` and `Interface`. Interface type endpoints cannot function without being assigned to a subnet.
*/
subnetIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The VPC endpoint type, `Gateway`, `GatewayLoadBalancer`,`Interface`, `Resource` or `ServiceNetwork`. Defaults to `Gateway`.
*/
vpcEndpointType?: pulumi.Input<string | undefined>;
}
}
export declare namespace ecr {
/**
* Simplified lifecycle policy model consisting of one or more rules that determine which images in a repository should be expired. See https://docs.aws.amazon.com/AmazonECR/latest/userguide/lifecycle_policy_examples.html for more details.
*/
interface LifecyclePolicyArgs {
/**
* Specifies the rules to determine how images should be retired from this repository. Rules are ordered from lowest priority to highest. If there is a rule with a `selection` value of `any`, then it will have the highest priority.
*/
rules?: pulumi.Input<pulumi.Input<inputs.ecr.LifecyclePolicyRuleArgs>[] | undefined>;
/**
* Skips creation of the policy if set to `true`.
*/
skip?: boolean;
}
/**
* A lifecycle policy rule that determine which images in a repository should be expired.
*/
interface LifecyclePolicyRuleArgs {
/**
* Describes the purpose of a rule within a lifecycle policy.
*/
description?: pulumi.Input<string | undefined>;
/**
* The maximum age limit (in days) for your images. Either [maximumNumberOfImages] or [maximumAgeLimit] must be provided.
*/
maximumAgeLimit?: pulumi.Input<number | undefined>;
/**
* The maximum number of images that you want to retain in your repository. Either [maximumNumberOfImages] or [maximumAgeLimit] must be provided.
*/
maximumNumberOfImages?: pulumi.Input<number | undefined>;
/**
* A list of image tag prefixes on which to take action with your lifecycle policy. Only used if you specified "tagStatus": "tagged". For example, if your images are tagged as prod, prod1, prod2, and so on, you would use the tag prefix prod to specify all of them. If you specify multiple tags, only the images with all specified tags are selected.
*/
tagPrefixList?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Determines whether the lifecycle policy rule that you are adding specifies a tag for an image. Acceptable options are tagged, untagged, or any. If you specify any, then all images have the rule evaluated against them. If you specify tagged, then you must also specify a tagPrefixList value. If you specify untagged, then you must omit tagPrefixList.
*/
tagStatus: pulumi.Input<enums.ecr.LifecycleTagStatus>;
}
}
export declare namespace ecs {
/**
* Create a TaskDefinition resource with the given unique name, arguments, and options.
* Creates required log-group and task & execution roles.
* Presents required Service load balancers if target group included in port mappings.
*/
interface EC2ServiceTaskDefinitionArgs {
/**
* Single container to make a TaskDefinition from. Useful for simple cases where there aren't
* multiple containers, especially when creating a TaskDefinition to call [run] on.
*
* Either [container] or [containers] must be provided.
*/
container?: inputs.ecs.TaskDefinitionContainerDefinitionArgs;
/**
* All the containers to make a TaskDefinition from. Useful when creating a Service that will
* contain many containers within.
*
* Either [container] or [containers] must be provided.
*/
containers?: {
[key: string]: inputs.ecs.TaskDefinitionContainerDefinitionArgs;
};
/**
* The number of cpu units used by the task. If not provided, a default will be computed based on the cumulative needs specified by [containerDefinitions]
*/
cpu?: pulumi.Input<string | undefined>;
/**
* Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is `false`.
*/
enableFaultInjection?: pulumi.Input<boolean | undefined>;
/**
* The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See Ephemeral Storage.
*/
ephemeralStorage?: pulumi.Input<pulumiAws.types.input.ecs.TaskDefinitionEphemeralStorage | undefined>;
/**
* The execution role that the Amazon ECS container agent and the Docker daemon can assume.
* Will be created automatically if not defined.
*/
executionRole?: inputs.awsx.DefaultRoleWithPolicyArgs;
/**
* An optional unique name for your task definition. If not specified, then a default will be created.
*/
family?: pulumi.Input<string | undefined>;
/**
* IPC resource namespace to be used for the containers in the task. Valid values: `host`, `task`, `none`.
*/
ipcMode?: pulumi.Input<string | undefined>;
/**
* A set of volume blocks that containers in your task may use.
*/
logGroup?: inputs.awsx.DefaultLogGroupArgs;
/**
* The amount (in MiB) of memory used by the task. If not provided, a default will be computed
* based on the cumulative needs specified by [containerDefinitions]
*/
memory?: pulumi.Input<string | undefined>;
/**
* Docker networking mode to use for the containers in the task. Valid values: `awsvpc`, `bridge`, `host`, and `none`.
*/
networkMode?: pulumi.Input<string | undefined>;
/**
* Process namespace to use for the containers in the task. Valid values: host` , `task`.
*/
pidMode?: pulumi.Input<string | undefined>;
/**
* Configuration block for rules that are taken into consideration during task placement. Maximum number of `placementConstraints` is `10`. Detailed below.
*/
placementConstraints?: pulumi.Input<pulumi.Input<pulumiAws.types.input.ecs.TaskDefinitionPlacementConstraint>[] | undefined>;
/**
* Configuration block for the App Mesh proxy. Detailed below.
*/
proxyConfiguration?: pulumi.Input<pulumiAws.types.input.ecs.TaskDefinitionProxyConfiguration | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string | undefined>;
/**
* Configuration block for runtimePlatform that containers in your task may use.
*/
runtimePlatform?: pulumi.Input<pulumiAws.types.input.ecs.TaskDefinitionRuntimePlatform | undefined>;
/**
* Whether to retain the old revision when the resource is destroyed or replacement is necessary. Default is `false`.
*/
skipDestroy?: pulumi.Input<boolean | undefined>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* IAM role that allows your Amazon ECS container task to make calls to other AWS services.
* Will be created automatically if not defined.
*/
taskRole?: inputs.awsx.DefaultRoleWithPolicyArgs;
/**
* Whether should track latest `ACTIVE` task definition on AWS or the one created with the resource stored in state. Default is `false`. Useful in the event the task definition is modified outside of this resource.
*/
trackLatest?: pulumi.Input<boolean | undefined>;
/**
* Repeatable configuration block for volumes that containers in your task may use. Detailed below.
*
* > **NOTE:** Proper escaping is required for JSON field values containing quotes (`"`) such as `environment` values. If directly setting the JSON, they should be escaped as `\"` in the JSON, e.g., `"value": "I \"love\" escaped quotes"`. If using a variable value, they should be escaped as `\\\"` in the variable, e.g., `value = "I \\\"love\\\" escaped quotes"` in the variable and `"value": "${var.myvariable}"` in the JSON.
*
* > **Note:** Fault injection only works with tasks using the `awsvpc` or `host` network modes. Fault injection isn't available on Windows.
*/
volumes?: pulumi.Input<pulumi.Input<pulumiAws.types.input.ecs.TaskDefinitionVolume>[] | undefined>;
}
/**
* Create a TaskDefinition resource with the given unique name, arguments, and options.
* Creates required log-group and task & execution roles.
* Presents required Service load balancers if target group included in port mappings.
*/
interface FargateServiceTaskDefinitionArgs {
/**
* Single container to make a TaskDefinition from. Useful for simple cases where there aren't
* multiple containers, especially when creating a TaskDefinition to call [run] on.
*
* Either [container] or [containers] must be provided.
*/
container?: inputs.ecs.TaskDefinitionContainerDefinitionArgs;
/**
* All the containers to make a TaskDefinition from. Useful when creating a Service that will
* contain many containers within.
*
* Either [container] or [containers] must be provided.
*/
containers?: {
[key: string]: inputs.ecs.TaskDefinitionContainerDefinitionArgs;
};
/**
* The number of cpu units used by the task. If not provided, a default will be computed based on the cumulative needs specified by [containerDefinitions]
*/
cpu?: pulumi.Input<string | undefined>;
/**
* Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is `false`.
*/
enableFaultInjection?: pulumi.Input<boolean | undefined>;
/**
* The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See Ephemeral Storage.
*/
ephemeralStorage?: pulumi.Input<pulumiAws.types.input.ecs.TaskDefinitionEphemeralStorage | undefined>;
/**
* The execution role that the Amazon ECS container agent and the Docker daemon can assume.
* Will be created automatically if not defined.
*/
executionRole?: inputs.awsx.DefaultRoleWithPolicyArgs;
/**
* An optional unique name for your task definition. If not specified, then a default will be created.
*/
family?: pulumi.Input<string | undefined>;
/**
* IPC resource namespace to be used for the containers in the task. Valid values: `host`, `task`, `none`.
*/
ipcMode?: pulumi.Input<string | undefined>;
/**
* A set of volume blocks that containers in your task may use.
*/
logGroup?: inputs.awsx.DefaultLogGroupArgs;
/**
* The amount (in MiB) of memory used by the task. If not provided, a default will be computed
* based on the cumulative needs specified by [containerDefinitions]
*/
memory?: pulumi.Input<string | undefined>;
/**
* Process namespace to use for the containers in the task. Valid values: host` , `task`.
*/
pidMode?: pulumi.Input<string | undefined>;
/**
* Configuration block for rules that are taken into consideration during task placement. Maximum number of `placementConstraints` is `10`. Detailed below.
*/
placementConstraints?: pulumi.Input<pulumi.Input<pulumiAws.types.input.ecs.TaskDefinitionPlacementConstraint>[] | undefined>;
/**
* Configuration block for the App Mesh proxy. Detailed below.
*/
proxyConfiguration?: pulumi.Input<pulumiAws.types.input.ecs.TaskDefinitionProxyConfiguration | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string | undefined>;
/**
* Configuration block for runtimePlatform that containers in your task may use.
*/
runtimePlatform?: pulumi.Input<pulumiAws.types.input.ecs.TaskDefinitionRuntimePlatform | undefined>;
/**
* Whether to retain the old revision when the resource is destroyed