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

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

Overview

Note:

When making an API call, you may pass AmiDistributionConfiguration data as a hash:

{
  name: "AmiNameString",
  description: "NonEmptyString",
  target_account_ids: ["AccountId"],
  ami_tags: {
    "TagKey" => "TagValue",
  },
  kms_key_id: "NonEmptyString",
  launch_permission: {
    user_ids: ["AccountId"],
    user_groups: ["NonEmptyString"],
    organization_arns: ["OrganizationArn"],
    organizational_unit_arns: ["OrganizationalUnitArn"],
  },
}

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>) 


156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 156

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 of the AMI distribution configuration. Minimum and maximum length are in characters.

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 156

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 KMS key identifier used to encrypt the distributed image.

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 156

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:



156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 156

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.

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 156

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 ID of an account to which you want to distribute an image.

Returns:

  • (Array<String>) 


156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 156

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