software.amazon.awscdk.services.imagebuilder

Class CfnDistributionConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.imagebuilder.CfnDistributionConfiguration

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.813Z")
 @Stability(value=Stable)
public class CfnDistributionConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ImageBuilder::DistributionConfiguration`.

A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions . It also allows you to export the AMI to Amazon S3 .

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;
 CfnDistributionConfiguration cfnDistributionConfiguration = CfnDistributionConfiguration.Builder.create(this, "MyCfnDistributionConfiguration")
         .distributions(List.of(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()))
         .name("name")
         // the properties below are optional
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnDistributionConfiguration.AmiDistributionConfigurationProperty Define and configure the output AMIs of the pipeline.
static class	CfnDistributionConfiguration.Builder A fluent builder for CfnDistributionConfiguration.
static interface	CfnDistributionConfiguration.ContainerDistributionConfigurationProperty Container distribution settings for encryption, licensing, and sharing in a specific Region.
static interface	CfnDistributionConfiguration.DistributionProperty The distribution configuration distribution defines the settings for a specific Region in the Distribution Configuration.
static interface	CfnDistributionConfiguration.FastLaunchConfigurationProperty Example:
static interface	CfnDistributionConfiguration.FastLaunchLaunchTemplateSpecificationProperty Example:
static interface	CfnDistributionConfiguration.FastLaunchSnapshotConfigurationProperty Example:
static interface	CfnDistributionConfiguration.LaunchPermissionConfigurationProperty Describes the configuration for a launch permission.
static interface	CfnDistributionConfiguration.LaunchTemplateConfigurationProperty Identifies an Amazon EC2 launch template to use for a specific account.
static interface	CfnDistributionConfiguration.TargetContainerRepositoryProperty The container repository where the output container image is stored.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDistributionConfiguration(software.constructs.Construct scope, String id, CfnDistributionConfigurationProps props) Create a new `AWS::ImageBuilder::DistributionConfiguration`.
protected	CfnDistributionConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDistributionConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() Returns the Amazon Resource Name (ARN) of this distribution configuration.
String	getAttrName() Returns the name of the distribution configuration.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of this distribution configuration.
Object	getDistributions() The distributions of this distribution configuration formatted as an array of Distribution objects.
String	getName() The name of this distribution configuration.
TagManager	getTags() The tags of this distribution configuration.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of this distribution configuration.
void	setDistributions(IResolvable value) The distributions of this distribution configuration formatted as an array of Distribution objects.
void	setDistributions(List<Object> value) The distributions of this distribution configuration formatted as an array of Distribution objects.
void	setName(String value) The name of this distribution configuration.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDistributionConfiguration

protected CfnDistributionConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

CfnDistributionConfiguration

protected CfnDistributionConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDistributionConfiguration

@Stability(value=Stable)
public CfnDistributionConfiguration(@NotNull
                                                             software.constructs.Construct scope,
                                                             @NotNull
                                                             String id,
                                                             @NotNull
                                                             CfnDistributionConfigurationProps props)

Create a new `AWS::ImageBuilder::DistributionConfiguration`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

Returns the Amazon Resource Name (ARN) of this distribution configuration.

The following pattern is applied: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\d+)\.(?:x|\d+)\.(?:x|\d+))(?:/\d+)?)?$ .

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

Returns the name of the distribution configuration.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags of this distribution configuration.

getDistributions

@Stability(value=Stable)
 @NotNull
public Object getDistributions()

The distributions of this distribution configuration formatted as an array of Distribution objects.

setDistributions

@Stability(value=Stable)
public void setDistributions(@NotNull
                                                      IResolvable value)

The distributions of this distribution configuration formatted as an array of Distribution objects.

setDistributions

@Stability(value=Stable)
public void setDistributions(@NotNull
                                                      List<Object> value)

The distributions of this distribution configuration formatted as an array of Distribution objects.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of this distribution configuration.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of this distribution configuration.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of this distribution configuration.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of this distribution configuration.