Updates a distribution configuration¶

Description¶

Updates a distribution configuration. Distribution configurations define and configure the outputs for your images, including the target Regions, accounts, and settings for each Region.

This operation doesn't support selective updates. The request replaces the stored configuration, so include every setting that you want to keep.

Usage¶

imagebuilder_update_distribution_configuration(
  distributionConfigurationArn, description, distributions, clientToken)

Arguments¶

distributionConfigurationArn

[required] The Amazon Resource Name (ARN) of the distribution configuration that you want to update.
description

The description of the distribution configuration.
distributions

[required] The distribution settings for the configuration. Each entry defines how output images are distributed in one target Amazon Web Services Region. A Region can appear at most once in the list. This list replaces the configuration's existing distributions entirely.
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.

Value¶

A list with the following syntax:

list(
  requestId = "string",
  clientToken = "string",
  distributionConfigurationArn = "string"
)

Request syntax¶

svc$update_distribution_configuration(
  distributionConfigurationArn = "string",
  description = "string",
  distributions = list(
    list(
      region = "string",
      amiDistributionConfiguration = list(
        name = "string",
        description = "string",
        targetAccountIds = list(
          "string"
        ),
        amiTags = list(
          "string"
        ),
        kmsKeyId = "string",
        launchPermission = list(
          userIds = list(
            "string"
          ),
          userGroups = list(
            "string"
          ),
          organizationArns = list(
            "string"
          ),
          organizationalUnitArns = list(
            "string"
          )
        )
      ),
      containerDistributionConfiguration = list(
        description = "string",
        containerTags = list(
          "string"
        ),
        targetRepository = list(
          service = "ECR",
          repositoryName = "string"
        )
      ),
      licenseConfigurationArns = list(
        "string"
      ),
      launchTemplateConfigurations = list(
        list(
          launchTemplateId = "string",
          accountId = "string",
          setDefaultVersion = TRUE|FALSE
        )
      ),
      s3ExportConfiguration = list(
        roleName = "string",
        diskImageFormat = "VMDK"|"RAW"|"VHD",
        s3Bucket = "string",
        s3Prefix = "string"
      ),
      fastLaunchConfigurations = list(
        list(
          enabled = TRUE|FALSE,
          snapshotConfiguration = list(
            targetResourceCount = 123
          ),
          maxParallelLaunches = 123,
          launchTemplate = list(
            launchTemplateId = "string",
            launchTemplateName = "string",
            launchTemplateVersion = "string"
          ),
          accountId = "string"
        )
      ),
      ssmParameterConfigurations = list(
        list(
          amiAccountId = "string",
          parameterName = "string",
          dataType = "text"|"aws:ec2:image"
        )
      )
    )
  ),
  clientToken = "string"
)