Interface AmiDistributionConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AmiDistributionConfiguration.Builder,AmiDistributionConfiguration>, SdkBuilder<AmiDistributionConfiguration.Builder,AmiDistributionConfiguration>, SdkPojo
Enclosing class:
AmiDistributionConfiguration
@Mutable @NotThreadSafe public static interface AmiDistributionConfiguration.Builder extends SdkPojo, CopyableBuilder<AmiDistributionConfiguration.Builder,AmiDistributionConfiguration>

  • Method Details

    • name

      AmiDistributionConfiguration.Builder name(String name)

      The name of the output AMI. The name must include the {{ imagebuilder:buildDate }} dynamic tag so that each build produces a uniquely named AMI. If you don't specify a name, Image Builder names the output AMI with the image name followed by the build timestamp, for example my-image 2022-10-26T22-30-05.912619Z.

      Parameters:
      name - The name of the output AMI. The name must include the {{ imagebuilder:buildDate }} dynamic tag so that each build produces a uniquely named AMI. If you don't specify a name, Image Builder names the output AMI with the image name followed by the build timestamp, for example my-image 2022-10-26T22-30-05.912619Z.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      AmiDistributionConfiguration.Builder description(String description)

      The description to apply to the distributed AMI. Image Builder sets this as the output AMI's description in each target Region and account. If you don't specify a description, the AMI in the build Region uses the image recipe's description, if the recipe has one. Copies distributed to other Regions and accounts don't receive a default description.

      Parameters:
      description - The description to apply to the distributed AMI. Image Builder sets this as the output AMI's description in each target Region and account. If you don't specify a description, the AMI in the build Region uses the image recipe's description, if the recipe has one. Copies distributed to other Regions and accounts don't receive a default description.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetAccountIds

      AmiDistributionConfiguration.Builder targetAccountIds(Collection<String> targetAccountIds)

      The Amazon Web Services account IDs to distribute the AMI to in this Region. Each listed account receives its own copy of the output AMI. If you don't specify accounts, Image Builder distributes the AMI only to your own account.

      Parameters:
      targetAccountIds - The Amazon Web Services account IDs to distribute the AMI to in this Region. Each listed account receives its own copy of the output AMI. If you don't specify accounts, Image Builder distributes the AMI only to your own account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetAccountIds

      AmiDistributionConfiguration.Builder targetAccountIds(String... targetAccountIds)

      The Amazon Web Services account IDs to distribute the AMI to in this Region. Each listed account receives its own copy of the output AMI. If you don't specify accounts, Image Builder distributes the AMI only to your own account.

      Parameters:
      targetAccountIds - The Amazon Web Services account IDs to distribute the AMI to in this Region. Each listed account receives its own copy of the output AMI. If you don't specify accounts, Image Builder distributes the AMI only to your own account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • amiTags

      AmiDistributionConfiguration.Builder amiTags(Map<String,String> amiTags)

      The tags to apply to AMIs distributed to this Region.

      Parameters:
      amiTags - The tags to apply to AMIs distributed to this Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      AmiDistributionConfiguration.Builder kmsKeyId(String kmsKeyId)

      The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

      Parameters:
      kmsKeyId - The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchPermission

      AmiDistributionConfiguration.Builder launchPermission(LaunchPermissionConfiguration launchPermission)

      Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

      Parameters:
      launchPermission - Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchPermission

      default AmiDistributionConfiguration.Builder launchPermission(Consumer<LaunchPermissionConfiguration.Builder> launchPermission)

      Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

      This is a convenience method that creates an instance of the LaunchPermissionConfiguration.Builder avoiding the need to create one manually via LaunchPermissionConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to launchPermission(LaunchPermissionConfiguration).

      Parameters:
      launchPermission - a consumer that will call methods on LaunchPermissionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: