Package software.amazon.awscdk.services.cloudformation

Class CfnModuleDefaultVersion

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cloudformation.CfnModuleDefaultVersion
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.517Z") @Stability(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 AWS CloudFormation User Guide . For information on developing modules, see Developing modules in the AWS 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnModuleDefaultVersion

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

    • CfnModuleDefaultVersion

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

    • CfnModuleDefaultVersion

      @Stability(Stable) public CfnModuleDefaultVersion(@NotNull 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(Stable) public CfnModuleDefaultVersion(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getArn

      @Stability(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(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(Stable) @Nullable public String getModuleName()
      The name of the module.

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

    • setModuleName

      @Stability(Stable) public void setModuleName(@Nullable String value)
      The name of the module.

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

    • getVersionId

      @Stability(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(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 .