Interface DistributeImageRequest.Builder

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

  • Method Details

    • sourceImage

      DistributeImageRequest.Builder sourceImage(String sourceImage)

      The source image to distribute. Specify an AMI identifier, SSM parameter path, or Image Builder image Amazon Resource Name (ARN). When you specify an Image Builder image Amazon Resource Name (ARN), the image must be in the AVAILABLE state.

      Parameters:
      sourceImage - The source image to distribute. Specify an AMI identifier, SSM parameter path, or Image Builder image Amazon Resource Name (ARN). When you specify an Image Builder image Amazon Resource Name (ARN), the image must be in the AVAILABLE state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • distributionConfigurationArn

      DistributeImageRequest.Builder distributionConfigurationArn(String distributionConfigurationArn)

      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.

      Parameters:
      distributionConfigurationArn - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRole

      DistributeImageRequest.Builder executionRole(String executionRole)

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

      Parameters:
      executionRole - The name or Amazon Resource Name (ARN) of the IAM role that Image Builder assumes to distribute the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DistributeImageRequest.Builder tags(Map<String,String> tags)

      The tags to apply to the distributed image.

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

    • clientToken

      DistributeImageRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      DistributeImageRequest.Builder loggingConfiguration(ImageLoggingConfiguration loggingConfiguration)

      The logging configuration for the distribution.

      Parameters:
      loggingConfiguration - The logging configuration for the distribution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      default DistributeImageRequest.Builder loggingConfiguration(Consumer<ImageLoggingConfiguration.Builder> loggingConfiguration)

      The logging configuration for the distribution.

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

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

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

    • overrideConfiguration

      DistributeImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DistributeImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.