Class: AWSCDK::ImageBuilder::CfnDistributionConfiguration::LaunchPermissionConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
image_builder/cfn_distribution_configuration.rb

Overview

Describes the configuration for a launch permission.

The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all . See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(organizational_unit_arns: nil, organization_arns: nil, user_groups: nil, user_ids: nil) ⇒ LaunchPermissionConfigurationProperty

Returns a new instance of LaunchPermissionConfigurationProperty.

Parameters:

  • organizational_unit_arns (Array<String>, nil) (defaults to: nil) —

    The ARN for an AWS Organizations organizational unit (OU) that you want to share your AMI with.

  • organization_arns (Array<String>, nil) (defaults to: nil) —

    The ARN for an AWS Organization that you want to share your AMI with.

  • user_groups (Array<String>, nil) (defaults to: nil) —

    The name of the group.

  • user_ids (Array<String>, nil) (defaults to: nil) —

    The AWS account ID.



981
982
983
984
985
986
987
988
989
990
 
# File 'image_builder/cfn_distribution_configuration.rb', line 981

def initialize(organizational_unit_arns: nil, organization_arns: nil, user_groups: nil, user_ids: nil)
  @organizational_unit_arns = organizational_unit_arns
  Jsii::Type.check_type(@organizational_unit_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "organizationalUnitArns") unless @organizational_unit_arns.nil?
  @organization_arns = organization_arns
  Jsii::Type.check_type(@organization_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "organizationArns") unless @organization_arns.nil?
  @user_groups = user_groups
  Jsii::Type.check_type(@user_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "userGroups") unless @user_groups.nil?
  @user_ids = user_ids
  Jsii::Type.check_type(@user_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "userIds") unless @user_ids.nil?
end

Instance Attribute Details

#organization_arns ⇒ Array<String>? (readonly)

The ARN for an AWS Organization that you want to share your AMI with.

For more information, see What is AWS Organizations ? .

Returns:

  • (Array<String>, nil)

See Also:



1005
1006
1007
 
# File 'image_builder/cfn_distribution_configuration.rb', line 1005

def organization_arns
  @organization_arns
end

#organizational_unit_arns ⇒ Array<String>? (readonly)

The ARN for an AWS Organizations organizational unit (OU) that you want to share your AMI with.

For more information about key concepts for AWS Organizations , see AWS Organizations terminology and concepts .

Returns:

  • (Array<String>, nil)

See Also:



998
999
1000
 
# File 'image_builder/cfn_distribution_configuration.rb', line 998

def organizational_unit_arns
  @organizational_unit_arns
end

#user_groups ⇒ Array<String>? (readonly)

The name of the group.

Returns:

  • (Array<String>, nil)

See Also:



1010
1011
1012
 
# File 'image_builder/cfn_distribution_configuration.rb', line 1010

def user_groups
  @user_groups
end

#user_ids ⇒ Array<String>? (readonly)

The AWS account ID.

Returns:

  • (Array<String>, nil)

See Also:



1015
1016
1017
 
# File 'image_builder/cfn_distribution_configuration.rb', line 1015

def user_ids
  @user_ids
end

Class Method Details

.jsii_properties ⇒ Object 



1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'image_builder/cfn_distribution_configuration.rb', line 1017

def self.jsii_properties
  {
    :organizational_unit_arns => "organizationalUnitArns",
    :organization_arns => "organizationArns",
    :user_groups => "userGroups",
    :user_ids => "userIds",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'image_builder/cfn_distribution_configuration.rb', line 1026

def to_jsii
  result = {}
  result.merge!({
    "organizationalUnitArns" => @organizational_unit_arns,
    "organizationArns" => @organization_arns,
    "userGroups" => @user_groups,
    "userIds" => @user_ids,
  })
  result.compact
end