Class: Aws::Imagebuilder::Types::DistributeImageRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2874

class DistributeImageRequest < Struct.new(
  :source_image,
  :distribution_configuration_arn,
  :execution_role,
  :tags,
  :client_token,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#distribution_configuration_arn ⇒ String

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:

  • (String) 


2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2874

class DistributeImageRequest < Struct.new(
  :source_image,
  :distribution_configuration_arn,
  :execution_role,
  :tags,
  :client_token,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role ⇒ String

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

Returns:

  • (String) 


2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2874

class DistributeImageRequest < Struct.new(
  :source_image,
  :distribution_configuration_arn,
  :execution_role,
  :tags,
  :client_token,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#logging_configuration ⇒ Types::ImageLoggingConfiguration

The logging configuration for the distribution.

Returns:



2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2874

class DistributeImageRequest < Struct.new(
  :source_image,
  :distribution_configuration_arn,
  :execution_role,
  :tags,
  :client_token,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#source_image ⇒ String

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.

Returns:

  • (String) 


2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2874

class DistributeImageRequest < Struct.new(
  :source_image,
  :distribution_configuration_arn,
  :execution_role,
  :tags,
  :client_token,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) 


2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2874

class DistributeImageRequest < Struct.new(
  :source_image,
  :distribution_configuration_arn,
  :execution_role,
  :tags,
  :client_token,
  :logging_configuration)
  SENSITIVE = []
  include Aws::Structure
end