@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-27T16:27:55.493Z") public class CfnDistributionConfiguration extends CfnResource implements IInspectable
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) .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();
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.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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnDistributionConfiguration(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
Returns the Amazon Resource Name (ARN) of this distribution configuration.
|
java.lang.String |
getAttrName()
Returns the name of the distribution configuration.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
The description of this distribution configuration.
|
java.lang.Object |
getDistributions()
The distributions of this distribution configuration formatted as an array of Distribution objects.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDescription(java.lang.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(java.util.List<java.lang.Object> value)
The distributions of this distribution configuration formatted as an array of Distribution objects.
|
void |
setName(java.lang.String value)
The name of this distribution configuration.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDistributionConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDistributionConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDistributionConfiguration(Construct scope, java.lang.String id, CfnDistributionConfigurationProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
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+)?)?$
.
public java.lang.String getAttrName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.Object getDistributions()
public void setDistributions(IResolvable value)
public void setDistributions(java.util.List<java.lang.Object> value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)