Class CfnModuleVersion

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:56.240Z") @Stability(Stable) public class CfnModuleVersion extends CfnResource implements IInspectable
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.*;
 CfnModuleVersion cfnModuleVersion = CfnModuleVersion.Builder.create(this, "MyCfnModuleVersion")
         .moduleName("moduleName")
         .modulePackage("modulePackage")
         .build();
 

See Also:
  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnModuleVersionProps 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

      @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 extension.
    • getAttrDescription

      @Stability(Stable) @NotNull public String getAttrDescription()
      The description of the extension.
    • 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 extension version is set as the default version.

      This applies only to private extensions you have registered in your account, and extensions published by AWS . For public third-party extensions, whether they are activated in your account, CloudFormation returns null .

    • getAttrSchema

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

      For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide .

    • getAttrTimeCreated

      @Stability(Stable) @NotNull public String getAttrTimeCreated()
      When the specified private extension version was registered or activated in your account.
    • 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 extension is visible and usable in CloudFormation operations.

      Valid values include:

      • PRIVATE : The extension is only visible and usable within the account in which it is registered. AWS CloudFormation marks any extensions you register as PRIVATE .
      • PUBLIC : The extension is publicly visible and usable within any AWS 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.
    • 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.