Package software.amazon.awscdk.services.imagebuilder

Interface CfnDistributionConfiguration.DistributionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistributionConfiguration.DistributionProperty.Jsii$Proxy

Enclosing class:

CfnDistributionConfiguration

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

The distribution configuration distribution defines the settings for a specific Region in the Distribution Configuration.

You must specify whether the distribution is for an AMI or a container image. To do so, include exactly one of the following data types for your distribution:

• amiDistributionConfiguration
• containerDistributionConfiguration

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.*;
 Object amiDistributionConfiguration;
 Object containerDistributionConfiguration;
 DistributionProperty distributionProperty = DistributionProperty.builder()
         .region("region")
         // the properties below are optional
         .amiDistributionConfiguration(amiDistributionConfiguration)
         .containerDistributionConfiguration(containerDistributionConfiguration)
         .fastLaunchConfigurations(List.of(FastLaunchConfigurationProperty.builder()
                 .accountId("accountId")
                 .enabled(false)
                 .launchTemplate(FastLaunchLaunchTemplateSpecificationProperty.builder()
                         .launchTemplateId("launchTemplateId")
                         .launchTemplateName("launchTemplateName")
                         .launchTemplateVersion("launchTemplateVersion")
                         .build())
                 .maxParallelLaunches(123)
                 .snapshotConfiguration(FastLaunchSnapshotConfigurationProperty.builder()
                         .targetResourceCount(123)
                         .build())
                 .build()))
         .launchTemplateConfigurations(List.of(LaunchTemplateConfigurationProperty.builder()
                 .accountId("accountId")
                 .launchTemplateId("launchTemplateId")
                 .setDefaultVersion(false)
                 .build()))
         .licenseConfigurationArns(List.of("licenseConfigurationArns"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDistributionConfiguration.DistributionProperty.Builder	builder()
default Object	getAmiDistributionConfiguration()	The specific AMI settings, such as launch permissions and AMI tags.
default Object	getContainerDistributionConfiguration()	Container distribution settings for encryption, licensing, and sharing in a specific Region.
default Object	getFastLaunchConfigurations()	The Windows faster-launching configurations to use for AMI distribution.
default Object	getLaunchTemplateConfigurations()	A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
default List<String>	getLicenseConfigurationArns()	The License Manager Configuration to associate with the AMI in the specified Region.
String	getRegion()	The target Region for the Distribution Configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRegion

@Stability(Stable)
@NotNull
String getRegion()

The target Region for the Distribution Configuration.

For example, eu-west-1 .

See Also:

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

getAmiDistributionConfiguration

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

The specific AMI settings, such as launch permissions and AMI tags.

For details, see example schema below.

See Also:

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

getContainerDistributionConfiguration

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

Container distribution settings for encryption, licensing, and sharing in a specific Region.

For details, see example schema below.

See Also:

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

getFastLaunchConfigurations

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

The Windows faster-launching configurations to use for AMI distribution.

See Also:

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

getLaunchTemplateConfigurations

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

A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

See Also:

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

getLicenseConfigurationArns

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

The License Manager Configuration to associate with the AMI in the specified Region.

For more information, see the LicenseConfiguration API .

See Also:

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

builder

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

Returns:

a CfnDistributionConfiguration.DistributionProperty.Builder of CfnDistributionConfiguration.DistributionProperty