Resource: awsImagebuilderInfrastructureConfiguration
Manages an Image Builder Infrastructure Configuration.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.imagebuilderInfrastructureConfiguration.ImagebuilderInfrastructureConfiguration(
this,
"example",
{
description: "example description",
instanceProfileName: "${aws_iam_instance_profile.example.name}",
instanceTypes: ["t2.nano", "t3.micro"],
keyPair: "${aws_key_pair.example.key_name}",
logging: {
s3Logs: {
s3BucketName: "${aws_s3_bucket.example.bucket}",
s3KeyPrefix: "logs",
},
},
name: "example",
securityGroupIds: ["${aws_security_group.example.id}"],
snsTopicArn: "${aws_sns_topic.example.arn}",
subnetId: "${aws_subnet.main.id}",
tags: {
foo: "bar",
},
terminateInstanceOnFailure: true,
}
);
Argument Reference
The following arguments are required:
instanceProfileName
- (Required) Name of IAM Instance Profile.name
- (Required) Name for the configuration.
The following arguments are optional:
description
- (Optional) Description for the configuration.instanceMetadataOptions
- (Optional) Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.instanceTypes
- (Optional) Set of EC2 Instance Types.keyPair
- (Optional) Name of EC2 Key Pair.logging
- (Optional) Configuration block with logging settings. Detailed below.resourceTags
- (Optional) Key-value map of resource tags to assign to infrastructure created by the configuration.securityGroupIds
- (Optional) Set of EC2 Security Group identifiers.snsTopicArn
- (Optional) Amazon Resource Name (ARN) of SNS Topic.subnetId
- (Optional) EC2 Subnet identifier. Also requiressecurityGroupIds
argument.tags
- (Optional) Key-value map of resource tags to assign to the configuration. If configured with a providerdefaultTags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.terminateInstanceOnFailure
- (Optional) Enable if the instance should be terminated when the pipeline fails. Defaults tofalse
.
instanceMetadataOptions
The following arguments are optional:
httpPutResponseHopLimit
- The number of hops that an instance can traverse to reach its destonation.httpTokens
- Whether a signed token is required for instance metadata retrieval requests. Valid values:required
,optional
.
logging
The following arguments are required:
s3Logs
- (Required) Configuration block with S3 logging settings. Detailed below.
s3Logs
The following arguments are required:
s3BucketName
- (Required) Name of the S3 Bucket.
The following arguments are optional:
s3KeyPrefix
- (Optional) Prefix to use for S3 logs. Defaults to/
.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
id
- Amazon Resource Name (ARN) of the configuration.arn
- Amazon Resource Name (ARN) of the configuration.dateCreated
- Date when the configuration was created.dateUpdated
- Date when the configuration was updated.tagsAll
- A map of tags assigned to the resource, including those inherited from the providerdefaultTags
configuration block.
Import
awsImagebuilderInfrastructureConfiguration
can be imported using the Amazon Resource Name (ARN), e.g.,