2021/04/02 - EC2 Image Builder - 6 updated api methods
Changes This release adds support for Block Device Mappings for container image builds, and adds distribution configuration support for EC2 launch templates in AMI builds.
{'instanceConfiguration': {'blockDeviceMappings': [{'deviceName': 'string',
'ebs': {'deleteOnTermination': 'boolean',
'encrypted': 'boolean',
'iops': 'integer',
'kmsKeyId': 'string',
'snapshotId': 'string',
'volumeSize': 'integer',
'volumeType': 'standard '
'| '
'io1 '
'| '
'io2 '
'| '
'gp2 '
'| '
'gp3 '
'| '
'sc1 '
'| '
'st1'},
'noDevice': 'string',
'virtualName': 'string'}],
'image': 'string'}}
Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
See also: AWS API Documentation
Request Syntax
client.create_container_recipe(
containerType='DOCKER',
name='string',
description='string',
semanticVersion='string',
components=[
{
'componentArn': 'string'
},
],
instanceConfiguration={
'image': 'string',
'blockDeviceMappings': [
{
'deviceName': 'string',
'ebs': {
'encrypted': True|False,
'deleteOnTermination': True|False,
'iops': 123,
'kmsKeyId': 'string',
'snapshotId': 'string',
'volumeSize': 123,
'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1'
},
'virtualName': 'string',
'noDevice': 'string'
},
]
},
dockerfileTemplateData='string',
dockerfileTemplateUri='string',
platformOverride='Windows'|'Linux',
imageOsVersionOverride='string',
parentImage='string',
tags={
'string': 'string'
},
workingDirectory='string',
targetRepository={
'service': 'ECR',
'repositoryName': 'string'
},
kmsKeyId='string',
clientToken='string'
)
string
[REQUIRED]
The type of container to create.
string
[REQUIRED]
The name of the container recipe.
string
The description of the container recipe.
string
[REQUIRED]
The semantic version of the container recipe (<major>.<minor>.<patch>).
list
[REQUIRED]
Components for build and test that are included in the container recipe.
(dict) --
Configuration details of the component.
componentArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the component.
dict
A group of options that can be used to configure an instance for building and testing container images.
image (string) --
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.
blockDeviceMappings (list) --
Defines the block devices to attach for building an instance from this Image Builder AMI.
(dict) --
Defines block device mappings for the instance used to configure your image.
deviceName (string) --
The device to which these mappings apply.
ebs (dict) --
Use to manage Amazon EBS-specific configuration for this mapping.
encrypted (boolean) --
Use to configure device encryption.
deleteOnTermination (boolean) --
Use to configure delete on termination of the associated device.
iops (integer) --
Use to configure device IOPS.
kmsKeyId (string) --
Use to configure the KMS key to use when encrypting the device.
snapshotId (string) --
The snapshot that defines the device contents.
volumeSize (integer) --
Use to override the device's volume size.
volumeType (string) --
Use to override the device's volume type.
virtualName (string) --
Use to manage instance ephemeral devices.
noDevice (string) --
Use to remove a mapping from the parent image.
string
The Dockerfile template used to build your image as an inline data blob.
string
The S3 URI for the Dockerfile that will be used to build your container image.
string
Specifies the operating system platform when you use a custom source image.
string
Specifies the operating system version for the source image.
string
[REQUIRED]
The source image for the container recipe.
dict
Tags that are attached to the container recipe.
(string) --
(string) --
string
The working directory for use during build and test workflows.
dict
[REQUIRED]
The destination repository for the container image.
service (string) -- [REQUIRED]
Specifies the service in which this image was registered.
repositoryName (string) -- [REQUIRED]
The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
string
Identifies which KMS key is used to encrypt the container image.
string
[REQUIRED]
The client token used to make this request idempotent.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'containerRecipeArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
clientToken (string) --
The client token used to make this request idempotent.
containerRecipeArn (string) --
Returns the Amazon Resource Name (ARN) of the container recipe that the request created.
{'distributions': {'launchTemplateConfigurations': [{'accountId': 'string',
'launchTemplateId': 'string',
'setDefaultVersion': 'boolean'}]}}
Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
See also: AWS API Documentation
Request Syntax
client.create_distribution_configuration(
name='string',
description='string',
distributions=[
{
'region': 'string',
'amiDistributionConfiguration': {
'name': 'string',
'description': 'string',
'targetAccountIds': [
'string',
],
'amiTags': {
'string': 'string'
},
'kmsKeyId': 'string',
'launchPermission': {
'userIds': [
'string',
],
'userGroups': [
'string',
]
}
},
'containerDistributionConfiguration': {
'description': 'string',
'containerTags': [
'string',
],
'targetRepository': {
'service': 'ECR',
'repositoryName': 'string'
}
},
'licenseConfigurationArns': [
'string',
],
'launchTemplateConfigurations': [
{
'launchTemplateId': 'string',
'accountId': 'string',
'setDefaultVersion': True|False
},
]
},
],
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the distribution configuration.
string
The description of the distribution configuration.
list
[REQUIRED]
The distributions of the distribution configuration.
(dict) --
Defines the settings for a specific Region.
region (string) -- [REQUIRED]
The target Region.
amiDistributionConfiguration (dict) --
The specific AMI settings; for example, launch permissions or AMI tags.
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration. Minimum and maximum length are in characters.
targetAccountIds (list) --
The ID of an account to which you want to distribute an image.
(string) --
amiTags (dict) --
The tags to apply to AMIs distributed to this Region.
(string) --
(string) --
kmsKeyId (string) --
The KMS key identifier used to encrypt the distributed image.
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
The AWS account ID.
(string) --
userGroups (list) --
The name of the group.
(string) --
containerDistributionConfiguration (dict) --
Container distribution settings for encryption, licensing, and sharing in a specific Region.
description (string) --
The description of the container distribution configuration.
containerTags (list) --
Tags that are attached to the container distribution configuration.
(string) --
targetRepository (dict) -- [REQUIRED]
The destination repository for the container distribution configuration.
service (string) -- [REQUIRED]
Specifies the service in which this image was registered.
repositoryName (string) -- [REQUIRED]
The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
licenseConfigurationArns (list) --
The License Manager Configuration to associate with the AMI in the specified Region.
(string) --
launchTemplateConfigurations (list) --
A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
(dict) --
Identifies an EC2 launch template to use for a specific account.
launchTemplateId (string) -- [REQUIRED]
Identifies the EC2 launch template to use.
accountId (string) --
The account ID that this configuration applies to.
setDefaultVersion (boolean) --
Set the specified EC2 launch template as the default launch template for the specified account.
dict
The tags of the distribution configuration.
(string) --
(string) --
string
[REQUIRED]
The idempotency token of the distribution configuration.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'distributionConfigurationArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
clientToken (string) --
The idempotency token used to make this request idempotent.
distributionConfigurationArn (string) --
The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.
{'containerRecipe': {'instanceConfiguration': {'blockDeviceMappings': [{'deviceName': 'string',
'ebs': {'deleteOnTermination': 'boolean',
'encrypted': 'boolean',
'iops': 'integer',
'kmsKeyId': 'string',
'snapshotId': 'string',
'volumeSize': 'integer',
'volumeType': 'standard '
'| '
'io1 '
'| '
'io2 '
'| '
'gp2 '
'| '
'gp3 '
'| '
'sc1 '
'| '
'st1'},
'noDevice': 'string',
'virtualName': 'string'}],
'image': 'string'}}}
Retrieves a container recipe.
See also: AWS API Documentation
Request Syntax
client.get_container_recipe(
containerRecipeArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the container recipe to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'containerRecipe': {
'arn': 'string',
'containerType': 'DOCKER',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux',
'owner': 'string',
'version': 'string',
'components': [
{
'componentArn': 'string'
},
],
'instanceConfiguration': {
'image': 'string',
'blockDeviceMappings': [
{
'deviceName': 'string',
'ebs': {
'encrypted': True|False,
'deleteOnTermination': True|False,
'iops': 123,
'kmsKeyId': 'string',
'snapshotId': 'string',
'volumeSize': 123,
'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1'
},
'virtualName': 'string',
'noDevice': 'string'
},
]
},
'dockerfileTemplateData': 'string',
'kmsKeyId': 'string',
'encrypted': True|False,
'parentImage': 'string',
'dateCreated': 'string',
'tags': {
'string': 'string'
},
'workingDirectory': 'string',
'targetRepository': {
'service': 'ECR',
'repositoryName': 'string'
}
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
containerRecipe (dict) --
The container recipe object that is returned.
arn (string) --
The Amazon Resource Name (ARN) of the container recipe.
containerType (string) --
Specifies the type of container, such as Docker.
name (string) --
The name of the container recipe.
description (string) --
The description of the container recipe.
platform (string) --
The system platform for the container, such as Windows or Linux.
owner (string) --
The owner of the container recipe.
version (string) --
The semantic version of the container recipe (<major>.<minor>.<patch>).
components (list) --
Components for build and test that are included in the container recipe.
(dict) --
Configuration details of the component.
componentArn (string) --
The Amazon Resource Name (ARN) of the component.
instanceConfiguration (dict) --
A group of options that can be used to configure an instance for building and testing container images.
image (string) --
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.
blockDeviceMappings (list) --
Defines the block devices to attach for building an instance from this Image Builder AMI.
(dict) --
Defines block device mappings for the instance used to configure your image.
deviceName (string) --
The device to which these mappings apply.
ebs (dict) --
Use to manage Amazon EBS-specific configuration for this mapping.
encrypted (boolean) --
Use to configure device encryption.
deleteOnTermination (boolean) --
Use to configure delete on termination of the associated device.
iops (integer) --
Use to configure device IOPS.
kmsKeyId (string) --
Use to configure the KMS key to use when encrypting the device.
snapshotId (string) --
The snapshot that defines the device contents.
volumeSize (integer) --
Use to override the device's volume size.
volumeType (string) --
Use to override the device's volume type.
virtualName (string) --
Use to manage instance ephemeral devices.
noDevice (string) --
Use to remove a mapping from the parent image.
dockerfileTemplateData (string) --
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.
kmsKeyId (string) --
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
encrypted (boolean) --
A flag that indicates if the target container is encrypted.
parentImage (string) --
The source image for the container recipe.
dateCreated (string) --
The date when this container recipe was created.
tags (dict) --
Tags that are attached to the container recipe.
(string) --
(string) --
workingDirectory (string) --
The working directory for use during build and test workflows.
targetRepository (dict) --
The destination repository for the container image.
service (string) --
Specifies the service in which this image was registered.
repositoryName (string) --
The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
{'distributionConfiguration': {'distributions': {'launchTemplateConfigurations': [{'accountId': 'string',
'launchTemplateId': 'string',
'setDefaultVersion': 'boolean'}]}}}
Gets a distribution configuration.
See also: AWS API Documentation
Request Syntax
client.get_distribution_configuration(
distributionConfigurationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'distributionConfiguration': {
'arn': 'string',
'name': 'string',
'description': 'string',
'distributions': [
{
'region': 'string',
'amiDistributionConfiguration': {
'name': 'string',
'description': 'string',
'targetAccountIds': [
'string',
],
'amiTags': {
'string': 'string'
},
'kmsKeyId': 'string',
'launchPermission': {
'userIds': [
'string',
],
'userGroups': [
'string',
]
}
},
'containerDistributionConfiguration': {
'description': 'string',
'containerTags': [
'string',
],
'targetRepository': {
'service': 'ECR',
'repositoryName': 'string'
}
},
'licenseConfigurationArns': [
'string',
],
'launchTemplateConfigurations': [
{
'launchTemplateId': 'string',
'accountId': 'string',
'setDefaultVersion': True|False
},
]
},
],
'timeoutMinutes': 123,
'dateCreated': 'string',
'dateUpdated': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
distributionConfiguration (dict) --
The distribution configuration object.
arn (string) --
The Amazon Resource Name (ARN) of the distribution configuration.
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration.
distributions (list) --
The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.
(dict) --
Defines the settings for a specific Region.
region (string) --
The target Region.
amiDistributionConfiguration (dict) --
The specific AMI settings; for example, launch permissions or AMI tags.
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration. Minimum and maximum length are in characters.
targetAccountIds (list) --
The ID of an account to which you want to distribute an image.
(string) --
amiTags (dict) --
The tags to apply to AMIs distributed to this Region.
(string) --
(string) --
kmsKeyId (string) --
The KMS key identifier used to encrypt the distributed image.
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
The AWS account ID.
(string) --
userGroups (list) --
The name of the group.
(string) --
containerDistributionConfiguration (dict) --
Container distribution settings for encryption, licensing, and sharing in a specific Region.
description (string) --
The description of the container distribution configuration.
containerTags (list) --
Tags that are attached to the container distribution configuration.
(string) --
targetRepository (dict) --
The destination repository for the container distribution configuration.
service (string) --
Specifies the service in which this image was registered.
repositoryName (string) --
The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
licenseConfigurationArns (list) --
The License Manager Configuration to associate with the AMI in the specified Region.
(string) --
launchTemplateConfigurations (list) --
A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
(dict) --
Identifies an EC2 launch template to use for a specific account.
launchTemplateId (string) --
Identifies the EC2 launch template to use.
accountId (string) --
The account ID that this configuration applies to.
setDefaultVersion (boolean) --
Set the specified EC2 launch template as the default launch template for the specified account.
timeoutMinutes (integer) --
The maximum duration in minutes for this distribution configuration.
dateCreated (string) --
The date on which this distribution configuration was created.
dateUpdated (string) --
The date on which this distribution configuration was last updated.
tags (dict) --
The tags of the distribution configuration.
(string) --
(string) --
{'image': {'containerRecipe': {'instanceConfiguration': {'blockDeviceMappings': [{'deviceName': 'string',
'ebs': {'deleteOnTermination': 'boolean',
'encrypted': 'boolean',
'iops': 'integer',
'kmsKeyId': 'string',
'snapshotId': 'string',
'volumeSize': 'integer',
'volumeType': 'standard '
'| '
'io1 '
'| '
'io2 '
'| '
'gp2 '
'| '
'gp3 '
'| '
'sc1 '
'| '
'st1'},
'noDevice': 'string',
'virtualName': 'string'}],
'image': 'string'}},
'distributionConfiguration': {'distributions': {'launchTemplateConfigurations': [{'accountId': 'string',
'launchTemplateId': 'string',
'setDefaultVersion': 'boolean'}]}}}}
Gets an image.
See also: AWS API Documentation
Request Syntax
client.get_image(
imageBuildVersionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image that you want to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'image': {
'arn': 'string',
'type': 'AMI'|'DOCKER',
'name': 'string',
'version': 'string',
'platform': 'Windows'|'Linux',
'enhancedImageMetadataEnabled': True|False,
'osVersion': 'string',
'state': {
'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED',
'reason': 'string'
},
'imageRecipe': {
'arn': 'string',
'type': 'AMI'|'DOCKER',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux',
'owner': 'string',
'version': 'string',
'components': [
{
'componentArn': 'string'
},
],
'parentImage': 'string',
'blockDeviceMappings': [
{
'deviceName': 'string',
'ebs': {
'encrypted': True|False,
'deleteOnTermination': True|False,
'iops': 123,
'kmsKeyId': 'string',
'snapshotId': 'string',
'volumeSize': 123,
'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1'
},
'virtualName': 'string',
'noDevice': 'string'
},
],
'dateCreated': 'string',
'tags': {
'string': 'string'
},
'workingDirectory': 'string'
},
'containerRecipe': {
'arn': 'string',
'containerType': 'DOCKER',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux',
'owner': 'string',
'version': 'string',
'components': [
{
'componentArn': 'string'
},
],
'instanceConfiguration': {
'image': 'string',
'blockDeviceMappings': [
{
'deviceName': 'string',
'ebs': {
'encrypted': True|False,
'deleteOnTermination': True|False,
'iops': 123,
'kmsKeyId': 'string',
'snapshotId': 'string',
'volumeSize': 123,
'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1'
},
'virtualName': 'string',
'noDevice': 'string'
},
]
},
'dockerfileTemplateData': 'string',
'kmsKeyId': 'string',
'encrypted': True|False,
'parentImage': 'string',
'dateCreated': 'string',
'tags': {
'string': 'string'
},
'workingDirectory': 'string',
'targetRepository': {
'service': 'ECR',
'repositoryName': 'string'
}
},
'sourcePipelineName': 'string',
'sourcePipelineArn': 'string',
'infrastructureConfiguration': {
'arn': 'string',
'name': 'string',
'description': 'string',
'instanceTypes': [
'string',
],
'instanceProfileName': 'string',
'securityGroupIds': [
'string',
],
'subnetId': 'string',
'logging': {
's3Logs': {
's3BucketName': 'string',
's3KeyPrefix': 'string'
}
},
'keyPair': 'string',
'terminateInstanceOnFailure': True|False,
'snsTopicArn': 'string',
'dateCreated': 'string',
'dateUpdated': 'string',
'resourceTags': {
'string': 'string'
},
'tags': {
'string': 'string'
}
},
'distributionConfiguration': {
'arn': 'string',
'name': 'string',
'description': 'string',
'distributions': [
{
'region': 'string',
'amiDistributionConfiguration': {
'name': 'string',
'description': 'string',
'targetAccountIds': [
'string',
],
'amiTags': {
'string': 'string'
},
'kmsKeyId': 'string',
'launchPermission': {
'userIds': [
'string',
],
'userGroups': [
'string',
]
}
},
'containerDistributionConfiguration': {
'description': 'string',
'containerTags': [
'string',
],
'targetRepository': {
'service': 'ECR',
'repositoryName': 'string'
}
},
'licenseConfigurationArns': [
'string',
],
'launchTemplateConfigurations': [
{
'launchTemplateId': 'string',
'accountId': 'string',
'setDefaultVersion': True|False
},
]
},
],
'timeoutMinutes': 123,
'dateCreated': 'string',
'dateUpdated': 'string',
'tags': {
'string': 'string'
}
},
'imageTestsConfiguration': {
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
'dateCreated': 'string',
'outputResources': {
'amis': [
{
'region': 'string',
'image': 'string',
'name': 'string',
'description': 'string',
'state': {
'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED',
'reason': 'string'
},
'accountId': 'string'
},
],
'containers': [
{
'region': 'string',
'imageUris': [
'string',
]
},
]
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
image (dict) --
The image object.
arn (string) --
The Amazon Resource Name (ARN) of the image.
type (string) --
Specifies whether this is an AMI or container image.
name (string) --
The name of the image.
version (string) --
The semantic version of the image.
platform (string) --
The platform of the image.
enhancedImageMetadataEnabled (boolean) --
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.
osVersion (string) --
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
state (dict) --
The state of the image.
status (string) --
The status of the image.
reason (string) --
The reason for the image's status.
imageRecipe (dict) --
The image recipe used when creating the image.
arn (string) --
The Amazon Resource Name (ARN) of the image recipe.
type (string) --
Specifies which type of image is created by the recipe - an AMI or a container image.
name (string) --
The name of the image recipe.
description (string) --
The description of the image recipe.
platform (string) --
The platform of the image recipe.
owner (string) --
The owner of the image recipe.
version (string) --
The version of the image recipe.
components (list) --
The components of the image recipe.
(dict) --
Configuration details of the component.
componentArn (string) --
The Amazon Resource Name (ARN) of the component.
parentImage (string) --
The parent image of the image recipe.
blockDeviceMappings (list) --
The block device mappings to apply when creating images from this recipe.
(dict) --
Defines block device mappings for the instance used to configure your image.
deviceName (string) --
The device to which these mappings apply.
ebs (dict) --
Use to manage Amazon EBS-specific configuration for this mapping.
encrypted (boolean) --
Use to configure device encryption.
deleteOnTermination (boolean) --
Use to configure delete on termination of the associated device.
iops (integer) --
Use to configure device IOPS.
kmsKeyId (string) --
Use to configure the KMS key to use when encrypting the device.
snapshotId (string) --
The snapshot that defines the device contents.
volumeSize (integer) --
Use to override the device's volume size.
volumeType (string) --
Use to override the device's volume type.
virtualName (string) --
Use to manage instance ephemeral devices.
noDevice (string) --
Use to remove a mapping from the parent image.
dateCreated (string) --
The date on which this image recipe was created.
tags (dict) --
The tags of the image recipe.
(string) --
(string) --
workingDirectory (string) --
The working directory to be used during build and test workflows.
containerRecipe (dict) --
The container recipe used to create the container image type.
arn (string) --
The Amazon Resource Name (ARN) of the container recipe.
containerType (string) --
Specifies the type of container, such as Docker.
name (string) --
The name of the container recipe.
description (string) --
The description of the container recipe.
platform (string) --
The system platform for the container, such as Windows or Linux.
owner (string) --
The owner of the container recipe.
version (string) --
The semantic version of the container recipe (<major>.<minor>.<patch>).
components (list) --
Components for build and test that are included in the container recipe.
(dict) --
Configuration details of the component.
componentArn (string) --
The Amazon Resource Name (ARN) of the component.
instanceConfiguration (dict) --
A group of options that can be used to configure an instance for building and testing container images.
image (string) --
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.
blockDeviceMappings (list) --
Defines the block devices to attach for building an instance from this Image Builder AMI.
(dict) --
Defines block device mappings for the instance used to configure your image.
deviceName (string) --
The device to which these mappings apply.
ebs (dict) --
Use to manage Amazon EBS-specific configuration for this mapping.
encrypted (boolean) --
Use to configure device encryption.
deleteOnTermination (boolean) --
Use to configure delete on termination of the associated device.
iops (integer) --
Use to configure device IOPS.
kmsKeyId (string) --
Use to configure the KMS key to use when encrypting the device.
snapshotId (string) --
The snapshot that defines the device contents.
volumeSize (integer) --
Use to override the device's volume size.
volumeType (string) --
Use to override the device's volume type.
virtualName (string) --
Use to manage instance ephemeral devices.
noDevice (string) --
Use to remove a mapping from the parent image.
dockerfileTemplateData (string) --
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.
kmsKeyId (string) --
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
encrypted (boolean) --
A flag that indicates if the target container is encrypted.
parentImage (string) --
The source image for the container recipe.
dateCreated (string) --
The date when this container recipe was created.
tags (dict) --
Tags that are attached to the container recipe.
(string) --
(string) --
workingDirectory (string) --
The working directory for use during build and test workflows.
targetRepository (dict) --
The destination repository for the container image.
service (string) --
Specifies the service in which this image was registered.
repositoryName (string) --
The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
sourcePipelineName (string) --
The name of the image pipeline that created this image.
sourcePipelineArn (string) --
The Amazon Resource Name (ARN) of the image pipeline that created this image.
infrastructureConfiguration (dict) --
The infrastructure used when creating this image.
arn (string) --
The Amazon Resource Name (ARN) of the infrastructure configuration.
name (string) --
The name of the infrastructure configuration.
description (string) --
The description of the infrastructure configuration.
instanceTypes (list) --
The instance types of the infrastructure configuration.
(string) --
instanceProfileName (string) --
The instance profile of the infrastructure configuration.
securityGroupIds (list) --
The security group IDs of the infrastructure configuration.
(string) --
subnetId (string) --
The subnet ID of the infrastructure configuration.
logging (dict) --
The logging configuration of the infrastructure configuration.
s3Logs (dict) --
The Amazon S3 logging configuration.
s3BucketName (string) --
The Amazon S3 bucket in which to store the logs.
s3KeyPrefix (string) --
The Amazon S3 path in which to store the logs.
keyPair (string) --
The EC2 key pair of the infrastructure configuration.
terminateInstanceOnFailure (boolean) --
The terminate instance on failure configuration of the infrastructure configuration.
snsTopicArn (string) --
The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.
dateCreated (string) --
The date on which the infrastructure configuration was created.
dateUpdated (string) --
The date on which the infrastructure configuration was last updated.
resourceTags (dict) --
The tags attached to the resource created by Image Builder.
(string) --
(string) --
tags (dict) --
The tags of the infrastructure configuration.
(string) --
(string) --
distributionConfiguration (dict) --
The distribution configuration used when creating this image.
arn (string) --
The Amazon Resource Name (ARN) of the distribution configuration.
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration.
distributions (list) --
The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.
(dict) --
Defines the settings for a specific Region.
region (string) --
The target Region.
amiDistributionConfiguration (dict) --
The specific AMI settings; for example, launch permissions or AMI tags.
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration. Minimum and maximum length are in characters.
targetAccountIds (list) --
The ID of an account to which you want to distribute an image.
(string) --
amiTags (dict) --
The tags to apply to AMIs distributed to this Region.
(string) --
(string) --
kmsKeyId (string) --
The KMS key identifier used to encrypt the distributed image.
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
The AWS account ID.
(string) --
userGroups (list) --
The name of the group.
(string) --
containerDistributionConfiguration (dict) --
Container distribution settings for encryption, licensing, and sharing in a specific Region.
description (string) --
The description of the container distribution configuration.
containerTags (list) --
Tags that are attached to the container distribution configuration.
(string) --
targetRepository (dict) --
The destination repository for the container distribution configuration.
service (string) --
Specifies the service in which this image was registered.
repositoryName (string) --
The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
licenseConfigurationArns (list) --
The License Manager Configuration to associate with the AMI in the specified Region.
(string) --
launchTemplateConfigurations (list) --
A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
(dict) --
Identifies an EC2 launch template to use for a specific account.
launchTemplateId (string) --
Identifies the EC2 launch template to use.
accountId (string) --
The account ID that this configuration applies to.
setDefaultVersion (boolean) --
Set the specified EC2 launch template as the default launch template for the specified account.
timeoutMinutes (integer) --
The maximum duration in minutes for this distribution configuration.
dateCreated (string) --
The date on which this distribution configuration was created.
dateUpdated (string) --
The date on which this distribution configuration was last updated.
tags (dict) --
The tags of the distribution configuration.
(string) --
(string) --
imageTestsConfiguration (dict) --
The image tests configuration used when creating this image.
imageTestsEnabled (boolean) --
Defines if tests should be executed when building this image.
timeoutMinutes (integer) --
The maximum time in minutes that tests are permitted to run.
dateCreated (string) --
The date on which this image was created.
outputResources (dict) --
The output resources produced when creating this image.
amis (list) --
The EC2 AMIs created by this image.
(dict) --
Details of an EC2 AMI.
region (string) --
The AWS Region of the EC2 AMI.
image (string) --
The AMI ID of the EC2 AMI.
name (string) --
The name of the EC2 AMI.
description (string) --
The description of the EC2 AMI. Minimum and maximum length are in characters.
state (dict) --
Image state shows the image status and the reason for that status.
status (string) --
The status of the image.
reason (string) --
The reason for the image's status.
accountId (string) --
The account ID of the owner of the AMI.
containers (list) --
Container images that the pipeline has generated and stored in the output repository.
(dict) --
A container encapsulates the runtime environment for an application.
region (string) --
Containers and container images are Region-specific. This is the Region context for the container.
imageUris (list) --
A list of URIs for containers created in the context Region.
(string) --
tags (dict) --
The tags of the image.
(string) --
(string) --
{'distributions': {'launchTemplateConfigurations': [{'accountId': 'string',
'launchTemplateId': 'string',
'setDefaultVersion': 'boolean'}]}}
Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
See also: AWS API Documentation
Request Syntax
client.update_distribution_configuration(
distributionConfigurationArn='string',
description='string',
distributions=[
{
'region': 'string',
'amiDistributionConfiguration': {
'name': 'string',
'description': 'string',
'targetAccountIds': [
'string',
],
'amiTags': {
'string': 'string'
},
'kmsKeyId': 'string',
'launchPermission': {
'userIds': [
'string',
],
'userGroups': [
'string',
]
}
},
'containerDistributionConfiguration': {
'description': 'string',
'containerTags': [
'string',
],
'targetRepository': {
'service': 'ECR',
'repositoryName': 'string'
}
},
'licenseConfigurationArns': [
'string',
],
'launchTemplateConfigurations': [
{
'launchTemplateId': 'string',
'accountId': 'string',
'setDefaultVersion': True|False
},
]
},
],
clientToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the distribution configuration that you want to update.
string
The description of the distribution configuration.
list
[REQUIRED]
The distributions of the distribution configuration.
(dict) --
Defines the settings for a specific Region.
region (string) -- [REQUIRED]
The target Region.
amiDistributionConfiguration (dict) --
The specific AMI settings; for example, launch permissions or AMI tags.
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration. Minimum and maximum length are in characters.
targetAccountIds (list) --
The ID of an account to which you want to distribute an image.
(string) --
amiTags (dict) --
The tags to apply to AMIs distributed to this Region.
(string) --
(string) --
kmsKeyId (string) --
The KMS key identifier used to encrypt the distributed image.
launchPermission (dict) --
Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
userIds (list) --
The AWS account ID.
(string) --
userGroups (list) --
The name of the group.
(string) --
containerDistributionConfiguration (dict) --
Container distribution settings for encryption, licensing, and sharing in a specific Region.
description (string) --
The description of the container distribution configuration.
containerTags (list) --
Tags that are attached to the container distribution configuration.
(string) --
targetRepository (dict) -- [REQUIRED]
The destination repository for the container distribution configuration.
service (string) -- [REQUIRED]
Specifies the service in which this image was registered.
repositoryName (string) -- [REQUIRED]
The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
licenseConfigurationArns (list) --
The License Manager Configuration to associate with the AMI in the specified Region.
(string) --
launchTemplateConfigurations (list) --
A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
(dict) --
Identifies an EC2 launch template to use for a specific account.
launchTemplateId (string) -- [REQUIRED]
Identifies the EC2 launch template to use.
accountId (string) --
The account ID that this configuration applies to.
setDefaultVersion (boolean) --
Set the specified EC2 launch template as the default launch template for the specified account.
string
[REQUIRED]
The idempotency token of the distribution configuration.
This field is autopopulated if not provided.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'distributionConfigurationArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
clientToken (string) --
The idempotency token used to make this request idempotent.
distributionConfigurationArn (string) --
The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.