distribution_configurations

Creates, updates, deletes, gets or lists a distribution_configurations resource.

Overview

Name	distribution_configurations
Type	Resource
Id	aws.imagebuilder.distribution_configurations

Fields

The following fields are returned by SELECT queries:

get_distribution_configuration

Name	Datatype	Description
distribution_configuration	object	The distribution configuration object.
request_id	string	The request ID that uniquely identifies this request.

list_distribution_configurations

Name	Datatype	Description
name	string	The name of the distribution configuration. (pattern: <code>^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$</code>)
arn	string	The Amazon Resource Name (ARN) of the distribution configuration. (pattern: <code>^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+).(?:x|[0-9]+).(?:x|[0-9]+))(?:/[0-9]+)?)?$</code>)
date_created	string	The date on which the distribution configuration was created.
date_updated	string	The date on which the distribution configuration was updated.
description	string	The description of the distribution configuration.
regions	array	A list of Regions where the container image is distributed to.
tags	object	The tags associated with the distribution configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_distribution_configuration	select	distributionConfigurationArn, region		Gets a distribution configuration.
list_distribution_configurations	select	region		Returns a list of distribution configurations.
create_distribution_configuration	insert	region, name, distributions, clientToken		Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
update_distribution_configuration	update	region, distributionConfigurationArn, distributions, clientToken		Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
delete_distribution_configuration	delete	distributionConfigurationArn, region		Deletes a distribution configuration.
distribute_image	exec	region, sourceImage, distributionConfigurationArn, executionRole, clientToken		Distributes an existing AMI to target Regions and accounts without running the full image build process. This operation only runs the distribution phase on an image that has already been built.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
distributionConfigurationArn	string	The Amazon Resource Name (ARN) of the distribution configuration to delete.
region	string	AWS region (default: us-east-1)

SELECT examples

get_distribution_configuration

Gets a distribution configuration.

SELECT
distribution_configuration,
request_id
FROM aws.imagebuilder.distribution_configurations
WHERE distributionConfigurationArn = '{{ distributionConfigurationArn }}' -- required
AND region = '{{ region }}' -- required
;

list_distribution_configurations

Returns a list of distribution configurations.

SELECT
name,
arn,
date_created,
date_updated,
description,
regions,
tags
FROM aws.imagebuilder.distribution_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_distribution_configuration

Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

INSERT INTO aws.imagebuilder.distribution_configurations (
name,
description,
distributions,
tags,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ distributions }}' /* required */,
'{{ tags }}',
'{{ clientToken }}' /* required */,
'{{ region }}'
RETURNING
client_token,
distribution_configuration_arn,
request_id
;

Manifest

# Description fields are for documentation purposes
- name: distribution_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the distribution_configurations resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: distributions
    value:
      - region: "{{ region }}"
        amiDistributionConfiguration:
          name: "{{ name }}"
          description: "{{ description }}"
          targetAccountIds:
            - "{{ targetAccountIds }}"
          amiTags: "{{ amiTags }}"
          kmsKeyId: "{{ kmsKeyId }}"
          launchPermission:
            userIds:
              - "{{ userIds }}"
            userGroups:
              - "{{ userGroups }}"
            organizationArns:
              - "{{ organizationArns }}"
            organizationalUnitArns:
              - "{{ organizationalUnitArns }}"
        containerDistributionConfiguration:
          description: "{{ description }}"
          containerTags:
            - "{{ containerTags }}"
          targetRepository:
            service: "{{ service }}"
            repositoryName: "{{ repositoryName }}"
        licenseConfigurationArns: "{{ licenseConfigurationArns }}"
        launchTemplateConfigurations: "{{ launchTemplateConfigurations }}"
        s3ExportConfiguration:
          roleName: "{{ roleName }}"
          diskImageFormat: "{{ diskImageFormat }}"
          s3Bucket: "{{ s3Bucket }}"
          s3Prefix: "{{ s3Prefix }}"
        fastLaunchConfigurations: "{{ fastLaunchConfigurations }}"
        ssmParameterConfigurations: "{{ ssmParameterConfigurations }}"
  - name: tags
    value: "{{ tags }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_distribution_configuration

Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

UPDATE aws.imagebuilder.distribution_configurations
SET 
distributionConfigurationArn = '{{ distributionConfigurationArn }}',
description = '{{ description }}',
distributions = '{{ distributions }}',
clientToken = '{{ clientToken }}'
WHERE 
region = '{{ region }}' --required
AND distributionConfigurationArn = '{{ distributionConfigurationArn }}' --required
AND distributions = '{{ distributions }}' --required
AND clientToken = '{{ clientToken }}' --required
RETURNING
client_token,
distribution_configuration_arn,
request_id;

DELETE examples

delete_distribution_configuration

Deletes a distribution configuration.

DELETE FROM aws.imagebuilder.distribution_configurations
WHERE distributionConfigurationArn = '{{ distributionConfigurationArn }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

distribute_image

Distributes an existing AMI to target Regions and accounts without running the full image build process. This operation only runs the distribution phase on an image that has already been built.

EXEC aws.imagebuilder.distribution_configurations.distribute_image 
@region='{{ region }}' --required 
@@json=
'{
"sourceImage": "{{ sourceImage }}", 
"distributionConfigurationArn": "{{ distributionConfigurationArn }}", 
"executionRole": "{{ executionRole }}", 
"tags": "{{ tags }}", 
"clientToken": "{{ clientToken }}", 
"loggingConfiguration": "{{ loggingConfiguration }}"
}'
;