Skip to content

Distributes an existing AMI to target Regions and accounts without running the full image build process

Description

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.

Usage

imagebuilder_distribute_image(sourceImage, distributionConfigurationArn,
  executionRole, tags, clientToken, loggingConfiguration)

Arguments

  • sourceImage

    [required] The source image to distribute. You can specify the source in any of the following formats:

    • An AMI ID.
    • An Amazon Web Services Systems Manager Parameter Store reference, prefixed by ssm:, followed by the parameter name or ARN.
    • An Image Builder image Amazon Resource Name (ARN). An image version ARN resolves to the latest available build version.

    Whichever format you use, the source must resolve to an AMI in the current Amazon Web Services Region.

  • distributionConfigurationArn

    [required] The Amazon Resource Name (ARN) of the distribution configuration. The configuration defines target Regions, accounts, and AMI settings. The distribution configuration must be in the same Region as this operation.

  • executionRole

    [required] The name or Amazon Resource Name (ARN) of the IAM role that Image Builder assumes to distribute the image.

  • tags

    The tags to apply to the new Image Builder image resource that this operation creates. To tag the output AMIs, use amiTags in the distribution configuration.

  • clientToken

    [required] A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

  • loggingConfiguration

    The logging configuration for the distribution.

Value

A list with the following syntax:

list(
  clientToken = "string",
  imageBuildVersionArn = "string"
)

Request syntax

svc$distribute_image(
  sourceImage = "string",
  distributionConfigurationArn = "string",
  executionRole = "string",
  tags = list(
    "string"
  ),
  clientToken = "string",
  loggingConfiguration = list(
    logGroupName = "string"
  )
)