InfrastructureConfiguration
Details of the infrastructure configuration.
Contents
- arn
-
The Amazon Resource Name (ARN) of the infrastructure configuration.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$Required: No
- dateCreated
-
The date on which the infrastructure configuration was created.
Type: String
Required: No
- dateUpdated
-
The date on which the infrastructure configuration was last updated.
Type: String
Required: No
- description
-
The description of the infrastructure configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- instanceMetadataOptions
-
The instance metadata option settings for the infrastructure configuration.
Type: InstanceMetadataOptions object
Required: No
- instanceProfileName
-
The instance profile of the infrastructure configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[\w+=,.@-]+$Required: No
- instanceTypes
-
The instance types of the infrastructure configuration.
Type: Array of strings
Required: No
- keyPair
-
The Amazon EC2 key pair of the infrastructure configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- logging
-
The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.
Type: Logging object
Required: No
- name
-
The name of the infrastructure configuration.
Type: String
Pattern:
^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$Required: No
- placement
-
The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.
Type: Placement object
Required: No
- resourceTags
-
The metadata tags assigned to the Amazon EC2 build and test instances that Image Builder launches during image creation.
Type: String to string map
Map Entries: Maximum number of 30 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z0-9\s_.:/=+\-@]*$Value Length Constraints: Maximum length of 256.
Required: No
- securityGroupIds
-
The security group IDs of the infrastructure configuration.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- snsTopicArn
-
The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO topics.
Note
EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- subnetId
-
The subnet ID of the infrastructure configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
-
The tags of the infrastructure configuration.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z0-9\s_.:/=+\-@]*$Value Length Constraints: Maximum length of 256.
Required: No
- terminateInstanceOnFailure
-
Indicates whether Image Builder terminates the build and test instances when the image build fails. When
false, Image Builder retains the instance so that you can debug it.Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
