Package software.amazon.awscdk.services.imagebuilder

Interface CfnDistributionConfiguration.LaunchPermissionConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistributionConfiguration.LaunchPermissionConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDistributionConfiguration

@Stability(Stable)
public static interface CfnDistributionConfiguration.LaunchPermissionConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.*;
 LaunchPermissionConfigurationProperty launchPermissionConfigurationProperty = LaunchPermissionConfigurationProperty.builder()
         .organizationalUnitArns(List.of("organizationalUnitArns"))
         .organizationArns(List.of("organizationArns"))
         .userGroups(List.of("userGroups"))
         .userIds(List.of("userIds"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDistributionConfiguration.LaunchPermissionConfigurationProperty.Builder	A builder for CfnDistributionConfiguration.LaunchPermissionConfigurationProperty
static final class	CfnDistributionConfiguration.LaunchPermissionConfigurationProperty.Jsii$Proxy	An implementation for CfnDistributionConfiguration.LaunchPermissionConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDistributionConfiguration.LaunchPermissionConfigurationProperty.Builder	builder()
default List<String>	getOrganizationalUnitArns()	The ARN for an AWS Organizations organizational unit (OU) that you want to share your AMI with.
default List<String>	getOrganizationArns()	The ARN for an AWS Organization that you want to share your AMI with.
default List<String>	getUserGroups()	The name of the group.
default List<String>	getUserIds()	The AWS account ID.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOrganizationalUnitArns

@Stability(Stable)
@Nullable
default List<String> getOrganizationalUnitArns()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-organizationalunitarns

getOrganizationArns

@Stability(Stable)
@Nullable
default List<String> getOrganizationArns()

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

For more information, see What is AWS Organizations ? .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-organizationarns

getUserGroups

@Stability(Stable)
@Nullable
default List<String> getUserGroups()

The name of the group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-usergroups

getUserIds

@Stability(Stable)
@Nullable
default List<String> getUserIds()

The AWS account ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-userids

builder

@Stability(Stable)
static CfnDistributionConfiguration.LaunchPermissionConfigurationProperty.Builder builder()

Returns:

a CfnDistributionConfiguration.LaunchPermissionConfigurationProperty.Builder of CfnDistributionConfiguration.LaunchPermissionConfigurationProperty