Skip to content

Creates a new distribution configuration

Description

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

Usage

imagebuilder_create_distribution_configuration(name, description,
  distributions, tags, clientToken, dryRun)

Arguments

  • name

    [required] The name of the distribution configuration. Distribution configuration names must be unique to your account in each Amazon Web Services Region. Image Builder generates the distribution configuration ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.

  • 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.

  • tags

    The tags of 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.

  • dryRun

    Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

Value

A list with the following syntax:

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

Request syntax

svc$create_distribution_configuration(
  name = "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"
        )
      )
    )
  ),
  tags = list(
    "string"
  ),
  clientToken = "string",
  dryRun = TRUE|FALSE
)