Package software.amazon.awscdk.services.imagebuilder

Interface CfnDistributionConfiguration.AmiDistributionConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistributionConfiguration.AmiDistributionConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDistributionConfiguration

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

Define and configure the output AMIs of the pipeline.

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.*;
 AmiDistributionConfigurationProperty amiDistributionConfigurationProperty = AmiDistributionConfigurationProperty.builder()
         .amiTags(Map.of(
                 "amiTagsKey", "amiTags"))
         .description("description")
         .kmsKeyId("kmsKeyId")
         .launchPermissionConfiguration(LaunchPermissionConfigurationProperty.builder()
                 .organizationalUnitArns(List.of("organizationalUnitArns"))
                 .organizationArns(List.of("organizationArns"))
                 .userGroups(List.of("userGroups"))
                 .userIds(List.of("userIds"))
                 .build())
         .name("name")
         .targetAccountIds(List.of("targetAccountIds"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDistributionConfiguration.AmiDistributionConfigurationProperty.Builder	builder()
default Object	getAmiTags()	The tags to apply to AMIs distributed to this Region.
default String	getDescription()	The description of the AMI distribution configuration.
default String	getKmsKeyId()	The KMS key identifier used to encrypt the distributed image.
default Object	getLaunchPermissionConfiguration()	Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.
default String	getName()	The name of the output AMI.
default List<String>	getTargetAccountIds()	The ID of an account to which you want to distribute an image.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAmiTags

@Stability(Stable)
@Nullable
default Object getAmiTags()

The tags to apply to AMIs distributed to this Region.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the AMI distribution configuration.

Minimum and maximum length are in characters.

See Also:

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The KMS key identifier used to encrypt the distributed image.

See Also:

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

getLaunchPermissionConfiguration

@Stability(Stable)
@Nullable
default Object getLaunchPermissionConfiguration()

Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the output AMI.

See Also:

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

getTargetAccountIds

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

The ID of an account to which you want to distribute an image.

See Also:

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

builder

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

Returns:

a CfnDistributionConfiguration.AmiDistributionConfigurationProperty.Builder of CfnDistributionConfiguration.AmiDistributionConfigurationProperty