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-]+)?):(?: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.
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 instances that are launched from your image will run.
Type: Placement object
Required: No
- resourceTags
-
The tags attached to the resource created by Image Builder.
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-Z+-=._:/]+$
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) for the SNS topic to which we send image build event notifications.
Note
EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
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-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Required: No
- terminateInstanceOnFailure
-
The terminate instance on failure configuration of the infrastructure configuration.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: