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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-06T23:25:11.094Z")
@Stability(Stable)
public class CfnDistributionConfiguration
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Define and configure the output AMIs of the pipeline.static final class
A fluent builder forCfnDistributionConfiguration
.static interface
Container distribution settings for encryption, licensing, and sharing in a specific Region.static interface
The distribution configuration distribution defines the settings for a specific Region in the Distribution Configuration.static interface
Define and configure faster launching for output Windows AMIs.static interface
Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.static interface
Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.static interface
Describes the configuration for a launch permission.static interface
Identifies an Amazon EC2 launch template to use for a specific account.static interface
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnDistributionConfiguration
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDistributionConfiguration
(software.amazon.jsii.JsiiObjectRef objRef) CfnDistributionConfiguration
(software.constructs.Construct scope, String id, CfnDistributionConfigurationProps props) -
Method Summary
Modifier and TypeMethodDescriptionReturns the Amazon Resource Name (ARN) of this distribution configuration.Returns the name of the distribution configuration.The description of this distribution configuration.The distributions of this distribution configuration formatted as an array of Distribution objects.getName()
The name of this distribution configuration.getTags()
Tag Manager which manages the tags for this resource.The tags of this distribution configuration.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) The description of this distribution configuration.void
setDistributions
(List<Object> value) The distributions of this distribution configuration formatted as an array of Distribution objects.void
setDistributions
(IResolvable value) The distributions of this distribution configuration formatted as an array of Distribution objects.void
The name of this distribution configuration.void
setTagsRaw
(Map<String, String> value) The tags of this distribution configuration.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDistributionConfiguration
protected CfnDistributionConfiguration(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDistributionConfiguration
protected CfnDistributionConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDistributionConfiguration
@Stability(Stable) public CfnDistributionConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDistributionConfigurationProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
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
Returns the name of the distribution configuration. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getDistributions
The distributions of this distribution configuration formatted as an array of Distribution objects. -
setDistributions
The distributions of this distribution configuration formatted as an array of Distribution objects. -
setDistributions
The distributions of this distribution configuration formatted as an array of Distribution objects. -
getName
The name of this distribution configuration. -
setName
The name of this distribution configuration. -
getDescription
The description of this distribution configuration. -
setDescription
The description of this distribution configuration. -
getTagsRaw
The tags of this distribution configuration. -
setTagsRaw
The tags of this distribution configuration.
-