software.amazon.awscdk.services.cloudformation

Class CfnModuleDefaultVersion

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.cloudformation.CfnModuleDefaultVersion

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:36.999Z")
 @Stability(value=Stable)
public class CfnModuleDefaultVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFormation::ModuleDefaultVersion`.

Specifies the default version of a module. The default version of the module will be used in CloudFormation operations for this account and Region.

To register a module version, use the [AWS::CloudFormation::ModuleVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html) resource.

For more information using modules, see Using modules to encapsulate and reuse resource configurations and Registering extensions in the CloudFormation User Guide . For information on developing modules, see Developing modules in the CloudFormation CLI User Guide .

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.cloudformation.*;
 CfnModuleDefaultVersion cfnModuleDefaultVersion = CfnModuleDefaultVersion.Builder.create(this, "MyCfnModuleDefaultVersion")
         .arn("arn")
         .moduleName("moduleName")
         .versionId("versionId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnModuleDefaultVersion.Builder A fluent builder for CfnModuleDefaultVersion.

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
	CfnModuleDefaultVersion(software.constructs.Construct scope, String id) Create a new `AWS::CloudFormation::ModuleDefaultVersion`.
	CfnModuleDefaultVersion(software.constructs.Construct scope, String id, CfnModuleDefaultVersionProps props) Create a new `AWS::CloudFormation::ModuleDefaultVersion`.
protected	CfnModuleDefaultVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnModuleDefaultVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getArn() The Amazon Resource Name (ARN) of the module version to set as the default version.
protected Map<String,Object>	getCfnProperties()
String	getModuleName() The name of the module.
String	getVersionId() The ID for the specific version of the module.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setArn(String value) The Amazon Resource Name (ARN) of the module version to set as the default version.
void	setModuleName(String value) The name of the module.
void	setVersionId(String value) The ID for the specific version of the module.

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

CfnModuleDefaultVersion

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

CfnModuleDefaultVersion

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

CfnModuleDefaultVersion

@Stability(value=Stable)
public CfnModuleDefaultVersion(@NotNull
                                                        software.constructs.Construct scope,
                                                        @NotNull
                                                        String id,
                                                        @Nullable
                                                        CfnModuleDefaultVersionProps props)

Create a new `AWS::CloudFormation::ModuleDefaultVersion`.

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.

CfnModuleDefaultVersion

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

Create a new `AWS::CloudFormation::ModuleDefaultVersion`.

Parameters:

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

id - - scoped id of the resource. 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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getArn

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

The Amazon Resource Name (ARN) of the module version to set as the default version.

Conditional: You must specify either Arn , or ModuleName and VersionId .

setArn

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

The Amazon Resource Name (ARN) of the module version to set as the default version.

Conditional: You must specify either Arn , or ModuleName and VersionId .

getModuleName

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

The name of the module.

Conditional: You must specify either Arn , or ModuleName and VersionId .

setModuleName

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

The name of the module.

Conditional: You must specify either Arn , or ModuleName and VersionId .

getVersionId

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

The ID for the specific version of the module.

Conditional: You must specify either Arn , or ModuleName and VersionId .

setVersionId

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

The ID for the specific version of the module.

Conditional: You must specify either Arn , or ModuleName and VersionId .