Package software.amazon.awscdk.core

Class CfnModuleVersion

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.core.CfnModuleVersion
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:29:54.868Z") @Stability(Stable) public class CfnModuleVersion extends CfnResource implements IInspectable
A CloudFormation AWS::CloudFormation::ModuleVersion.

Registers the specified version of the module with the CloudFormation service. Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.

To specify a module version as the default version, use the [AWS::CloudFormation::ModuleDefaultVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.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.core.*;
 CfnModuleVersion cfnModuleVersion = CfnModuleVersion.Builder.create(this, "MyCfnModuleVersion")
         .moduleName("moduleName")
         .modulePackage("modulePackage")
         .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

    • CfnModuleVersion

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

    • CfnModuleVersion

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

    • CfnModuleVersion

      @Stability(Stable) public CfnModuleVersion(@NotNull Construct scope, @NotNull String id, @NotNull CfnModuleVersionProps props)
      Create a new AWS::CloudFormation::ModuleVersion.

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

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the module.

    • getAttrDescription

      @Stability(Stable) @NotNull public String getAttrDescription()
      The description of the module.

    • getAttrDocumentationUrl

      @Stability(Stable) @NotNull public String getAttrDocumentationUrl()
      The URL of a page providing detailed documentation for this module.

    • getAttrIsDefaultVersion

      @Stability(Stable) @NotNull public IResolvable getAttrIsDefaultVersion()
      Whether the specified module version is set as the default version.

    • getAttrSchema

      @Stability(Stable) @NotNull public String getAttrSchema()
      The schema that defines the module.

    • getAttrTimeCreated

      @Stability(Stable) @NotNull public String getAttrTimeCreated()
      When the specified module version was registered.

    • getAttrVersionId

      @Stability(Stable) @NotNull public String getAttrVersionId()
      The ID of this version of the module.

    • getAttrVisibility

      @Stability(Stable) @NotNull public String getAttrVisibility()
      The scope at which the module is visible and usable in CloudFormation operations.

      Valid values include:

      • PRIVATE : The module is only visible and usable within the account in which it's registered.
      • PUBLIC : The module is publicly visible and usable within any Amazon account.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getModuleName

      @Stability(Stable) @NotNull public String getModuleName()
      The name of the module being registered.

    • setModuleName

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

    • getModulePackage

      @Stability(Stable) @NotNull public String getModulePackage()
      A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register.

      The user registering the module version must be able to access the module package in the S3 bucket. That's, the user needs to have GetObject permissions for the package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .

    • setModulePackage

      @Stability(Stable) public void setModulePackage(@NotNull String value)
      A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register.

      The user registering the module version must be able to access the module package in the S3 bucket. That's, the user needs to have GetObject permissions for the package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .