String region
The AWS Region of the EC2 AMI.
String image
The AMI ID of the EC2 AMI.
String name
The name of the EC2 AMI.
String description
The description of the EC2 AMI.
ImageState state
String name
The name of the distribution configuration.
String description
The description of the distribution configuration.
Map<K,V> amiTags
The tags to apply to AMIs distributed to this Region.
LaunchPermissionConfiguration launchPermission
Launch permissions can be used to configure which AWS 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.
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 componentArn
The Amazon Resource Name (ARN) of the component.
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.
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.
String name
The name of the component.
String version
The semantic version of the component.
String description
The description of the component.
String platform
The platform 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 owner
The owner of the component.
String dateCreated
The date that the component was created.
String name
The name of the component.
String semanticVersion
The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.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.
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 S3 URL and the requester must have permission to access the S3 bucket. If
you use 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 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 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.
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/2019.x.x. The ARN
ends with /20xx.x.x, which communicates to EC2 Image Builder that you want to use the latest AMI
created in 20xx (year). 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 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 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 EC2 AMI.
List<E> securityGroupIds
The security group IDs to associate with the instance used to customize your EC2 AMI.
String subnetId
The subnet ID in which to place the instance used to customize your 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> 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 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, AMI tags).
List<E> licenseConfigurationArns
The License Manager Configuration to associate with the AMI in the specified Region.
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 distributions of the distribution configuration.
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.
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 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.
String name
The name of the image.
String version
The semantic version of the image.
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.
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 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 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 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 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 the image semantic version.
String name
The name of the image semantic version.
String version
The semantic version of the image semantic version.
String platform
The platform of the image semantic version.
String osVersion
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
String owner
The owner of the image semantic version.
String dateCreated
The date at which this image semantic version was created.
String name
The name of the component.
String semanticVersion
The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.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 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 S3 URL and the requester must have permission to access the S3 bucket. If
you use 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 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> 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> tags
The tags 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 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
The filters.
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.
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> 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
The filters.
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 imagePipelineArn
The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
List<E> filters
The filters.
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.
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
The filters.
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
The filters.
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> imageVersionList
The list of image semantic 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 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 expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition
.
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, EC2 Image Builder will build a new image only
when there are known changes pending. When it is set to EXPRESSION_MATCH_ONLY, it will build a new
image every time the CRON expression matches the current time.
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 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 EC2 AMI.
List<E> securityGroupIds
The security group IDs to associate with the instance used to customize your EC2 AMI.
String subnetId
The subnet ID to place the instance used to customize your 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.
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 © 2020. All rights reserved.