SystemsManagerAgent systemsManagerAgent
Contains settings for the SSM agent on your build instance.
String userDataOverride
Use this property to provide commands or a command script to run when you launch your build instance.
The userDataOverride property replaces any commands that Image Builder might have added to ensure that SSM is installed on your Linux build instance. If you override the user data, make sure that you add commands to install SSM, if it is not pre-installed on your source image.
String region
The Amazon Web Services Region of the Amazon EC2 AMI.
String image
The AMI ID of the Amazon EC2 AMI.
String name
The name of the Amazon EC2 AMI.
String description
The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.
ImageState state
String accountId
The account ID of the owner of the AMI.
String name
The name of the distribution configuration.
String description
The description of the distribution configuration. Minimum and maximum length are in characters.
List<E> targetAccountIds
The ID of an account to which you want to distribute an image.
Map<K,V> amiTags
The tags to apply to AMIs distributed to this Region.
String kmsKeyId
The KMS key identifier used to encrypt the distributed image.
LaunchPermissionConfiguration launchPermission
Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
String arn
The Amazon Resource Name (ARN) of the component.
String name
The name of the component.
String version
The version of the component.
String description
The description of the component.
String changeDescription
The change description of the component.
String type
The type of the component denotes whether the component is used to build the image or only to test it.
String platform
The platform of the component.
List<E> supportedOsVersions
The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
List<E> parameters
Contains parameter details for each of the parameters that are defined for the component.
String owner
The owner of the component.
String data
The data of the component.
String kmsKeyId
The KMS key identifier used to encrypt the component.
Boolean encrypted
The encryption status of the component.
String dateCreated
The date that the component was created.
Map<K,V> tags
The tags associated with the component.
String name
The name of this input parameter.
String type
The type of input this parameter provides. The currently supported value is "string".
List<E> defaultValue
The default value of this parameter if no input is provided.
String description
Describes this parameter.
String arn
The Amazon Resource Name (ARN) of the component.
String name
The name of the component.
String version
The version of the component.
String platform
The platform of the component.
List<E> supportedOsVersions
The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
String type
The type of the component denotes whether the component is used to build the image or only to test it.
String owner
The owner of the component.
String description
The description of the component.
String changeDescription
The change description of the component.
String dateCreated
The date that the component was created.
Map<K,V> tags
The tags associated with the component.
String arn
The Amazon Resource Name (ARN) of the component.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
String name
The name of the component.
String version
The semantic version of the component.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number, and that is not open for updates.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: When you retrieve or reference a resource with a semantic version, you can use wildcards (x) to filter your results. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. For example, specifying "1.2.x", or "1.x.x" works to filter list results, but neither "1.x.2", nor "x.2.x" will work. You do not have to specify the build - Image Builder automatically uses a wildcard for that, if applicable.
String description
The description of the component.
String platform
The platform of the component.
List<E> supportedOsVersions
he operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
String type
The type of the component denotes whether the component is used to build the image or only to test it.
String owner
The owner of the component.
String dateCreated
The date that the component was created.
String description
The description of the container distribution configuration.
List<E> containerTags
Tags that are attached to the container distribution configuration.
TargetContainerRepository targetRepository
The destination repository for the container distribution configuration.
String arn
The Amazon Resource Name (ARN) of the container recipe.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
String containerType
Specifies the type of container, such as Docker.
String name
The name of the container recipe.
String description
The description of the container recipe.
String platform
The system platform for the container, such as Windows or Linux.
String owner
The owner of the container recipe.
String version
The semantic version of the container recipe.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number, and that is not open for updates.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: When you retrieve or reference a resource with a semantic version, you can use wildcards (x) to filter your results. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. For example, specifying "1.2.x", or "1.x.x" works to filter list results, but neither "1.x.2", nor "x.2.x" will work. You do not have to specify the build - Image Builder automatically uses a wildcard for that, if applicable.
List<E> components
Components for build and test that are included in the container recipe.
InstanceConfiguration instanceConfiguration
A group of options that can be used to configure an instance for building and testing container images.
String dockerfileTemplateData
Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
String kmsKeyId
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
Boolean encrypted
A flag that indicates if the target container is encrypted.
String parentImage
The source image for the container recipe.
String dateCreated
The date when this container recipe was created.
Map<K,V> tags
Tags that are attached to the container recipe.
String workingDirectory
The working directory for use during build and test workflows.
TargetContainerRepository targetRepository
The destination repository for the container image.
String arn
The Amazon Resource Name (ARN) of the container recipe.
String containerType
Specifies the type of container, such as "Docker".
String name
The name of the container recipe.
String platform
The system platform for the container, such as Windows or Linux.
String owner
The owner of the container recipe.
String parentImage
The source image for the container recipe.
String dateCreated
The date when this container recipe was created.
Map<K,V> tags
Tags that are attached to the container recipe.
String name
The name of the component.
String semanticVersion
The semantic version of the component. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number, and that is not open for updates.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
String description
The description of the component. Describes the contents of the component.
String changeDescription
The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.
String platform
The platform of the component.
List<E> supportedOsVersions
The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
String data
The data of the component. Used to specify the data inline. Either data or uri can be
used to specify the data within the component.
String uri
The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3
bucket. If you use Amazon S3, you can specify component content up to your service quota. Either
data or uri can be used to specify the data within the component.
String kmsKeyId
The ID of the KMS key that should be used to encrypt this component.
Map<K,V> tags
The tags of the component.
String clientToken
The idempotency token of the component.
String requestId
The request ID that uniquely identifies this request.
String clientToken
The idempotency token used to make this request idempotent.
String componentBuildVersionArn
The Amazon Resource Name (ARN) of the component that was created by this request.
String containerType
The type of container to create.
String name
The name of the container recipe.
String description
The description of the container recipe.
String semanticVersion
The semantic version of the container recipe. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number, and that is not open for updates.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
List<E> components
Components for build and test that are included in the container recipe.
InstanceConfiguration instanceConfiguration
A group of options that can be used to configure an instance for building and testing container images.
String dockerfileTemplateData
The Dockerfile template used to build your image as an inline data blob.
String dockerfileTemplateUri
The Amazon S3 URI for the Dockerfile that will be used to build your container image.
String platformOverride
Specifies the operating system platform when you use a custom source image.
String imageOsVersionOverride
Specifies the operating system version for the source image.
String parentImage
The source image for the container recipe.
Map<K,V> tags
Tags that are attached to the container recipe.
String workingDirectory
The working directory for use during build and test workflows.
TargetContainerRepository targetRepository
The destination repository for the container image.
String kmsKeyId
Identifies which KMS key is used to encrypt the container image.
String clientToken
The client token used to make this request idempotent.
String requestId
The request ID that uniquely identifies this request.
String clientToken
The client token used to make this request idempotent.
String containerRecipeArn
Returns the Amazon Resource Name (ARN) of the container recipe that the request created.
String name
The name of the distribution configuration.
String description
The description of the distribution configuration.
List<E> distributions
The distributions of the distribution configuration.
Map<K,V> tags
The tags of the distribution configuration.
String clientToken
The idempotency token of the distribution configuration.
String requestId
The request ID that uniquely identifies this request.
String clientToken
The idempotency token used to make this request idempotent.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.
String name
The name of the image pipeline.
String description
The description of the image pipeline.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.
ImageTestsConfiguration imageTestsConfiguration
The image test configuration of the image pipeline.
Boolean enhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
Schedule schedule
The schedule of the image pipeline.
String status
The status of the image pipeline.
Map<K,V> tags
The tags of the image pipeline.
String clientToken
The idempotency token used to make this request idempotent.
String name
The name of the image recipe.
String description
The description of the image recipe.
String semanticVersion
The semantic version of the image recipe. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number, and that is not open for updates.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
List<E> components
The components of the image recipe.
String parentImage
The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID.
The format for the ARN follows this example:
arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can
provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter
an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which
you are using Image Builder.
List<E> blockDeviceMappings
The block device mappings of the image recipe.
Map<K,V> tags
The tags of the image recipe.
String workingDirectory
The working directory used during build and test workflows.
AdditionalInstanceConfiguration additionalInstanceConfiguration
Specify additional settings and launch scripts for your build instances.
String clientToken
The idempotency token used to make this request idempotent.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
ImageTestsConfiguration imageTestsConfiguration
The image tests configuration of the image.
Boolean enhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
Map<K,V> tags
The tags of the image.
String clientToken
The idempotency token used to make this request idempotent.
String name
The name of the infrastructure configuration.
String description
The description of the infrastructure configuration.
List<E> instanceTypes
The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
String instanceProfileName
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
List<E> securityGroupIds
The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
String subnetId
The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
Logging logging
The logging configuration of the infrastructure configuration.
String keyPair
The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image.
Boolean terminateInstanceOnFailure
The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
String snsTopicArn
The SNS topic on which to send image build events.
Map<K,V> resourceTags
The tags attached to the resource created by Image Builder.
Map<K,V> tags
The tags of the infrastructure configuration.
String clientToken
The idempotency token used to make this request idempotent.
String requestId
The request ID that uniquely identifies this request.
String clientToken
The idempotency token used to make this request idempotent.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.
String componentBuildVersionArn
The Amazon Resource Name (ARN) of the component build version to delete.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe to delete.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration to delete.
String imagePipelineArn
The Amazon Resource Name (ARN) of the image pipeline to delete.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe to delete.
String imageBuildVersionArn
The Amazon Resource Name (ARN) of the image to delete.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
String region
The target Region.
AmiDistributionConfiguration amiDistributionConfiguration
The specific AMI settings; for example, launch permissions or AMI tags.
ContainerDistributionConfiguration containerDistributionConfiguration
Container distribution settings for encryption, licensing, and sharing in a specific Region.
List<E> licenseConfigurationArns
The License Manager Configuration to associate with the AMI in the specified Region.
List<E> launchTemplateConfigurations
A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
String arn
The Amazon Resource Name (ARN) of the distribution configuration.
String name
The name of the distribution configuration.
String description
The description of the distribution configuration.
List<E> distributions
The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.
Integer timeoutMinutes
The maximum duration in minutes for this distribution configuration.
String dateCreated
The date on which this distribution configuration was created.
String dateUpdated
The date on which this distribution configuration was last updated.
Map<K,V> tags
The tags of the distribution configuration.
String arn
The Amazon Resource Name (ARN) of the distribution configuration.
String name
The name of the distribution configuration.
String description
The description of the distribution configuration.
String dateCreated
The date on which the distribution configuration was created.
String dateUpdated
The date on which the distribution configuration was updated.
Map<K,V> tags
The tags associated with the distribution configuration.
List<E> regions
A list of Regions where the container image is distributed to.
Boolean encrypted
Use to configure device encryption.
Boolean deleteOnTermination
Use to configure delete on termination of the associated device.
Integer iops
Use to configure device IOPS.
String kmsKeyId
Use to configure the KMS key to use when encrypting the device.
String snapshotId
The snapshot that defines the device contents.
Integer volumeSize
Use to override the device's volume size.
String volumeType
Use to override the device's volume type.
String componentArn
The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.
String componentBuildVersionArn
The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires "/\d+$" suffix.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe for the policy being requested.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe to retrieve.
String requestId
The request ID that uniquely identifies this request.
ContainerRecipe containerRecipe
The container recipe object that is returned.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.
String requestId
The request ID that uniquely identifies this request.
DistributionConfiguration distributionConfiguration
The distribution configuration object.
String imagePipelineArn
The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
String requestId
The request ID that uniquely identifies this request.
ImagePipeline imagePipeline
The image pipeline object.
String imageArn
The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.
String requestId
The request ID that uniquely identifies this request.
ImageRecipe imageRecipe
The image recipe object.
String imageBuildVersionArn
The Amazon Resource Name (ARN) of the image that you want to retrieve.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.
String requestId
The request ID that uniquely identifies this request.
InfrastructureConfiguration infrastructureConfiguration
The infrastructure configuration object.
String arn
The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
String type
Specifies whether this is an AMI or container image.
String name
The name of the image.
String version
The semantic version of the image.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number, and that is not open for updates.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: When you retrieve or reference a resource with a semantic version, you can use wildcards (x) to filter your results. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. For example, specifying "1.2.x", or "1.x.x" works to filter list results, but neither "1.x.2", nor "x.2.x" will work. You do not have to specify the build - Image Builder automatically uses a wildcard for that, if applicable.
String platform
The platform of the image.
Boolean enhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
String osVersion
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
ImageState state
The state of the image.
ImageRecipe imageRecipe
The image recipe used when creating the image.
ContainerRecipe containerRecipe
The recipe that is used to create an Image Builder container image.
String sourcePipelineName
The name of the image pipeline that created this image.
String sourcePipelineArn
The Amazon Resource Name (ARN) of the image pipeline that created this image.
InfrastructureConfiguration infrastructureConfiguration
The infrastructure used when creating this image.
DistributionConfiguration distributionConfiguration
The distribution configuration used when creating this image.
ImageTestsConfiguration imageTestsConfiguration
The image tests configuration used when creating this image.
String dateCreated
The date on which this image was created.
OutputResources outputResources
The output resources produced when creating this image.
Map<K,V> tags
The tags of the image.
String arn
The Amazon Resource Name (ARN) of the image pipeline.
String name
The name of the image pipeline.
String description
The description of the image pipeline.
String platform
The platform of the image pipeline.
Boolean enhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
ImageTestsConfiguration imageTestsConfiguration
The image tests configuration of the image pipeline.
Schedule schedule
The schedule of the image pipeline.
String status
The status of the image pipeline.
String dateCreated
The date on which this image pipeline was created.
String dateUpdated
The date on which this image pipeline was last updated.
String dateLastRun
The date on which this image pipeline was last run.
String dateNextRun
The date on which this image pipeline will next be run.
Map<K,V> tags
The tags of this image pipeline.
String arn
The Amazon Resource Name (ARN) of the image recipe.
String type
Specifies which type of image is created by the recipe - an AMI or a container image.
String name
The name of the image recipe.
String description
The description of the image recipe.
String platform
The platform of the image recipe.
String owner
The owner of the image recipe.
String version
The version of the image recipe.
List<E> components
The components of the image recipe.
String parentImage
The parent image of the image recipe.
List<E> blockDeviceMappings
The block device mappings to apply when creating images from this recipe.
String dateCreated
The date on which this image recipe was created.
Map<K,V> tags
The tags of the image recipe.
String workingDirectory
The working directory to be used during build and test workflows.
AdditionalInstanceConfiguration additionalInstanceConfiguration
Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.
String arn
The Amazon Resource Name (ARN) of the image recipe.
String name
The name of the image recipe.
String platform
The platform of the image recipe.
String owner
The owner of the image recipe.
String parentImage
The parent image of the image recipe.
String dateCreated
The date on which this image recipe was created.
Map<K,V> tags
The tags of the image recipe.
String arn
The Amazon Resource Name (ARN) of the image.
String name
The name of the image.
String type
Specifies whether this is an AMI or container image.
String version
The version of the image.
String platform
The platform of the image.
String osVersion
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
ImageState state
The state of the image.
String owner
The owner of the image.
String dateCreated
The date on which this image was created.
OutputResources outputResources
The output resources produced when creating this image.
Map<K,V> tags
The tags of the image.
String arn
The Amazon Resource Name (ARN) of a specific version of an Image Builder image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
String name
The name of this specific version of an Image Builder image.
String type
Specifies whether this image is an AMI or a container image.
String version
Details for a specific version of an Image Builder image. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number, and that is not open for updates.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: When you retrieve or reference a resource with a semantic version, you can use wildcards (x) to filter your results. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. For example, specifying "1.2.x", or "1.x.x" works to filter list results, but neither "1.x.2", nor "x.2.x" will work. You do not have to specify the build - Image Builder automatically uses a wildcard for that, if applicable.
String platform
The platform of the image version, for example "Windows" or "Linux".
String osVersion
The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
String owner
The owner of the image version.
String dateCreated
The date on which this specific version of the Image Builder image was created.
String name
The name of the component.
String semanticVersion
The semantic version of the component. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: When you retrieve or reference a resource with a semantic version, you can use wildcards (x) to filter your results. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. For example, specifying "1.2.x", or "1.x.x" works to filter list results, but neither "1.x.2", nor "x.2.x" will work. You do not have to specify the build - Image Builder automatically uses a wildcard for that, if applicable.
String description
The description of the component. Describes the contents of the component.
String changeDescription
The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.
String type
The type of the component denotes whether the component is used to build the image, or only to test it.
String format
The format of the resource that you want to import as a component.
String platform
The platform of the component.
String data
The data of the component. Used to specify the data inline. Either data or uri can be
used to specify the data within the component.
String uri
The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3
bucket. If you use Amazon S3, you can specify component content up to your service quota. Either
data or uri can be used to specify the data within the component.
String kmsKeyId
The ID of the KMS key that should be used to encrypt this component.
Map<K,V> tags
The tags of the component.
String clientToken
The idempotency token of the component.
String arn
The Amazon Resource Name (ARN) of the infrastructure configuration.
String name
The name of the infrastructure configuration.
String description
The description of the infrastructure configuration.
List<E> instanceTypes
The instance types of the infrastructure configuration.
String instanceProfileName
The instance profile of the infrastructure configuration.
List<E> securityGroupIds
The security group IDs of the infrastructure configuration.
String subnetId
The subnet ID of the infrastructure configuration.
Logging logging
The logging configuration of the infrastructure configuration.
String keyPair
The Amazon EC2 key pair of the infrastructure configuration.
Boolean terminateInstanceOnFailure
The terminate instance on failure configuration of the infrastructure configuration.
String snsTopicArn
The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.
String dateCreated
The date on which the infrastructure configuration was created.
String dateUpdated
The date on which the infrastructure configuration was last updated.
Map<K,V> resourceTags
The tags attached to the resource created by Image Builder.
Map<K,V> tags
The tags of the infrastructure configuration.
String arn
The Amazon Resource Name (ARN) of the infrastructure configuration.
String name
The name of the infrastructure configuration.
String description
The description of the infrastructure configuration.
String dateCreated
The date on which the infrastructure configuration was created.
String dateUpdated
The date on which the infrastructure configuration was last updated.
Map<K,V> resourceTags
The tags attached to the image created by Image Builder.
Map<K,V> tags
The tags of the infrastructure configuration.
List<E> instanceTypes
The instance types of the infrastructure configuration.
String instanceProfileName
The instance profile of the infrastructure configuration.
String deviceName
The device to which these mappings apply.
EbsInstanceBlockDeviceSpecification ebs
Use to manage Amazon EBS-specific configuration for this mapping.
String virtualName
Use to manage instance ephemeral devices.
String noDevice
Use to remove a mapping from the parent image.
String image
The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
List<E> blockDeviceMappings
Defines the block devices to attach for building an instance from this Image Builder AMI.
String launchTemplateId
Identifies the Amazon EC2 launch template to use.
String accountId
The account ID that this configuration applies to.
Boolean setDefaultVersion
Set the specified Amazon EC2 launch template as the default launch template for the specified account.
String componentVersionArn
The component version Amazon Resource Name (ARN) whose versions you want to list.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> componentSummaryList
The list of component summaries for the specified semantic version.
String nextToken
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
String owner
The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers.
List<E> filters
Use the following filters to streamline results:
description
name
platform
supportedOsVersion
type
version
Boolean byName
Returns the list of component build versions for the specified name.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> componentVersionList
The list of component semantic versions.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
String nextToken
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
String owner
Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.
List<E> filters
Use the following filters to streamline results:
containerType
name
parentImage
platform
Integer maxResults
The maximum number of results to return in the list.
String nextToken
Provides a token for pagination, which determines where to begin the next set of results when the current set reaches the maximum for one request.
String requestId
The request ID that uniquely identifies this request.
List<E> containerRecipeSummaryList
The list of container recipes returned for the request.
String nextToken
The next token field is used for paginated responses. When this is not empty, there are additional container recipes that the service has not included in this response. Use this token with the next request to retrieve additional list items.
String requestId
The request ID that uniquely identifies this request.
List<E> distributionConfigurationSummaryList
The list of distributions.
String nextToken
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
String imageVersionArn
The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.
List<E> filters
Use the following filters to streamline results:
name
osVersion
platform
type
version
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> imageSummaryList
The list of image build versions.
String nextToken
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
String imageBuildVersionArn
Filter results for the ListImagePackages request by the Image Build Version ARN
Integer maxResults
The maxiumum number of results to return from the ListImagePackages request.
String nextToken
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> imagePackageList
The list of Image Packages returned in the response.
String nextToken
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
String imagePipelineArn
The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
List<E> filters
Use the following filters to streamline results:
name
version
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> imageSummaryList
The list of images built by this pipeline.
String nextToken
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
List<E> filters
Use the following filters to streamline results:
description
distributionConfigurationArn
imageRecipeArn
infrastructureConfigurationArn
name
status
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> imagePipelineList
The list of image pipelines.
String nextToken
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
String owner
The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.
List<E> filters
Use the following filters to streamline results:
name
parentImage
platform
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
String requestId
The request ID that uniquely identifies this request.
List<E> imageRecipeSummaryList
The list of image pipelines.
String nextToken
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
String owner
The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.
List<E> filters
Use the following filters to streamline results:
name
osVersion
platform
type
version
Boolean byName
Requests a list of images with a specific recipe name.
Integer maxResults
The maximum items to return in a request.
String nextToken
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Boolean includeDeprecated
Includes deprecated images in the response list.
String requestId
The request ID that uniquely identifies this request.
List<E> imageVersionList
The list of image semantic versions.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: When you retrieve or reference a resource with a semantic version, you can use wildcards (x) to filter your results. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. For example, specifying "1.2.x", or "1.x.x" works to filter list results, but neither "1.x.2", nor "x.2.x" will work. You do not have to specify the build - Image Builder automatically uses a wildcard for that, if applicable.
String nextToken
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
String requestId
The request ID that uniquely identifies this request.
List<E> infrastructureConfigurationSummaryList
The list of infrastructure configurations.
String nextToken
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
String resourceArn
The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
S3Logs s3Logs
The Amazon S3 logging configuration.
String scheduleExpression
The cron expression determines how often EC2 Image Builder evaluates your
pipelineExecutionStartCondition.
For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
String timezone
The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
String pipelineExecutionStartCondition
The condition configures when the pipeline should trigger a new image build. When the
pipelineExecutionStartCondition is set to
EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the
source image or components in your image recipe, EC2 Image Builder will build a new image only when there are new
versions of the image or components in your recipe that match the semantic version filter. When it is set to
EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current
time. For semantic version syntax, see CreateComponent
in the EC2 Image Builder API Reference.
Boolean uninstallAfterBuild
Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that you want to update.
String description
The description of the distribution configuration.
List<E> distributions
The distributions of the distribution configuration.
String clientToken
The idempotency token of the distribution configuration.
String requestId
The request ID that uniquely identifies this request.
String clientToken
The idempotency token used to make this request idempotent.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.
String imagePipelineArn
The Amazon Resource Name (ARN) of the image pipeline that you want to update.
String description
The description of the image pipeline.
String imageRecipeArn
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
String containerRecipeArn
The Amazon Resource Name (ARN) of the container pipeline to update.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.
String distributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.
ImageTestsConfiguration imageTestsConfiguration
The image test configuration of the image pipeline.
Boolean enhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
Schedule schedule
The schedule of the image pipeline.
String status
The status of the image pipeline.
String clientToken
The idempotency token used to make this request idempotent.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
String description
The description of the infrastructure configuration.
List<E> instanceTypes
The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
String instanceProfileName
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
List<E> securityGroupIds
The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
String subnetId
The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
Logging logging
The logging configuration of the infrastructure configuration.
String keyPair
The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image.
Boolean terminateInstanceOnFailure
The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
String snsTopicArn
The SNS topic on which to send image build events.
String clientToken
The idempotency token used to make this request idempotent.
Map<K,V> resourceTags
The tags attached to the resource created by Image Builder.
String requestId
The request ID that uniquely identifies this request.
String clientToken
The idempotency token used to make this request idempotent.
String infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.
Copyright © 2021. All rights reserved.