Class: Aws::Imagebuilder::Types::AmiDistributionConfiguration

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

Overview

Define and configure the output AMIs of the pipeline.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ami_tags ⇒ Hash<String,String>

The tags to apply to AMIs distributed to this Region.

Returns:

  • (Hash<String,String>) 


190
191
192
193
194
195
196
197
198
199
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 190

class AmiDistributionConfiguration < Struct.new(
  :name,
  :description,
  :target_account_ids,
  :ami_tags,
  :kms_key_id,
  :launch_permission)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

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:

  • (String) 


190
191
192
193
194
195
196
197
198
199
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 190

class AmiDistributionConfiguration < Struct.new(
  :name,
  :description,
  :target_account_ids,
  :ami_tags,
  :kms_key_id,
  :launch_permission)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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:

  • (String) 


190
191
192
193
194
195
196
197
198
199
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 190

class AmiDistributionConfiguration < Struct.new(
  :name,
  :description,
  :target_account_ids,
  :ami_tags,
  :kms_key_id,
  :launch_permission)
  SENSITIVE = []
  include Aws::Structure
end

#launch_permission ⇒ Types::LaunchPermissionConfiguration

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

Returns:



190
191
192
193
194
195
196
197
198
199
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 190

class AmiDistributionConfiguration < Struct.new(
  :name,
  :description,
  :target_account_ids,
  :ami_tags,
  :kms_key_id,
  :launch_permission)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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:

  • (String) 


190
191
192
193
194
195
196
197
198
199
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 190

class AmiDistributionConfiguration < Struct.new(
  :name,
  :description,
  :target_account_ids,
  :ami_tags,
  :kms_key_id,
  :launch_permission)
  SENSITIVE = []
  include Aws::Structure
end

#target_account_ids ⇒ Array<String>

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:

  • (Array<String>) 


190
191
192
193
194
195
196
197
198
199
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 190

class AmiDistributionConfiguration < Struct.new(
  :name,
  :description,
  :target_account_ids,
  :ami_tags,
  :kms_key_id,
  :launch_permission)
  SENSITIVE = []
  include Aws::Structure
end