@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:34.865Z") 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.core.*; CfnModuleVersion cfnModuleVersion = CfnModuleVersion.Builder.create(this, "MyCfnModuleVersion") .moduleName("moduleName") .modulePackage("modulePackage") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnModuleVersion.Builder
A fluent builder for
CfnModuleVersion . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnModuleVersion(Construct scope,
java.lang.String id,
CfnModuleVersionProps props)
Create a new `AWS::CloudFormation::ModuleVersion`.
|
protected |
CfnModuleVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnModuleVersion(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the module.
|
java.lang.String |
getAttrDescription()
The description of the module.
|
java.lang.String |
getAttrDocumentationUrl()
The URL of a page providing detailed documentation for this module.
|
IResolvable |
getAttrIsDefaultVersion()
Whether the specified module version is set as the default version.
|
java.lang.String |
getAttrSchema()
The schema that defines the module.
|
java.lang.String |
getAttrTimeCreated()
When the specified module version was registered.
|
java.lang.String |
getAttrVersionId()
The ID of this version of the module.
|
java.lang.String |
getAttrVisibility()
The scope at which the module is visible and usable in CloudFormation operations.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getModuleName()
The name of the module being registered.
|
java.lang.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.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setModuleName(java.lang.String value)
The name of the module being registered.
|
void |
setModulePackage(java.lang.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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnModuleVersion(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnModuleVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnModuleVersion(Construct scope, java.lang.String id, CfnModuleVersionProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrDescription()
public java.lang.String getAttrDocumentationUrl()
public IResolvable getAttrIsDefaultVersion()
public java.lang.String getAttrSchema()
public java.lang.String getAttrTimeCreated()
public java.lang.String getAttrVersionId()
public java.lang.String getAttrVisibility()
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.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getModuleName()
public void setModuleName(java.lang.String value)
public java.lang.String getModulePackage()
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 .
public void setModulePackage(java.lang.String value)
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 .