Class CfnModuleVersion
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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:
-
Nested Class Summary
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
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnModuleVersion
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnModuleVersion
(software.amazon.jsii.JsiiObjectRef objRef) CfnModuleVersion
(software.constructs.Construct scope, String id, CfnModuleVersionProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the extension.The description of the extension.The URL of a page providing detailed documentation for this module.Whether the specified extension version is set as the default version.The schema that defines the extension.When the specified private extension version was registered or activated in your account.The ID of this version of the module.The scope at which the extension is visible and usable in CloudFormation operations.The name of the module being registered.A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setModuleName
(String value) The name of the module being registered.void
setModulePackage
(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.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
-
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
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
The Amazon Resource Name (ARN) of the extension. -
getAttrDescription
The description of the extension. -
getAttrDocumentationUrl
The URL of a page providing detailed documentation for this module. -
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
The schema that defines the extension.For more information about extension schemas, see Resource type schema in the AWS CloudFormation Command Line Interface (CLI) User Guide .
-
getAttrTimeCreated
When the specified private extension version was registered or activated in your account. -
getAttrVersionId
The ID of this version of the module. -
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. CloudFormation marks any extensions you register asPRIVATE
.PUBLIC
: The extension is publicly visible and usable within any AWS account.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getModuleName
The name of the module being registered. -
setModuleName
The name of the module being registered. -
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
A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register.
-