Class CfnModuleVersion
Registers the specified version of the module with the CloudFormation service.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFormation
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnModuleVersion : CfnResource, IInspectable
Syntax (vb)
Public Class CfnModuleVersion
Inherits CfnResource
Implements IInspectable
Remarks
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
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 .
CloudformationResource: AWS::CloudFormation::ModuleVersion
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFormation;
var cfnModuleVersion = new CfnModuleVersion(this, "MyCfnModuleVersion", new CfnModuleVersionProps {
ModuleName = "moduleName",
ModulePackage = "modulePackage"
});
Synopsis
Constructors
CfnModuleVersion(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnModuleVersion(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnModuleVersion(Construct, String, ICfnModuleVersionProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the extension. |
AttrDescription | The description of the extension. |
AttrDocumentationUrl | The URL of a page providing detailed documentation for this module. |
AttrIsDefaultVersion | Whether the specified extension version is set as the default version. |
AttrSchema | The schema that defines the extension. |
AttrTimeCreated | When the specified private extension version was registered or activated in your account. |
AttrVersionId | The ID of this version of the module. |
AttrVisibility | The scope at which the extension is visible and usable in CloudFormation operations. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ModuleName | The name of the module being registered. |
ModulePackage | A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnModuleVersion(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnModuleVersion(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnModuleVersion(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnModuleVersion(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnModuleVersion(Construct, String, ICfnModuleVersionProps)
public CfnModuleVersion(Construct scope, string id, ICfnModuleVersionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnModuleVersionProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the extension.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrDescription
The description of the extension.
public virtual string AttrDescription { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Description
AttrDocumentationUrl
The URL of a page providing detailed documentation for this module.
public virtual string AttrDocumentationUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DocumentationUrl
AttrIsDefaultVersion
Whether the specified extension version is set as the default version.
public virtual IResolvable AttrIsDefaultVersion { get; }
Property Value
Remarks
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
.
CloudformationAttribute: IsDefaultVersion
AttrSchema
The schema that defines the extension.
public virtual string AttrSchema { get; }
Property Value
System.String
Remarks
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide .
CloudformationAttribute: Schema
AttrTimeCreated
When the specified private extension version was registered or activated in your account.
public virtual string AttrTimeCreated { get; }
Property Value
System.String
Remarks
CloudformationAttribute: TimeCreated
AttrVersionId
The ID of this version of the module.
public virtual string AttrVersionId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: VersionId
AttrVisibility
The scope at which the extension is visible and usable in CloudFormation operations.
public virtual string AttrVisibility { get; }
Property Value
System.String
Remarks
Valid values include:
CloudformationAttribute: Visibility
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ModuleName
The name of the module being registered.
public virtual string ModuleName { get; set; }
Property Value
System.String
ModulePackage
A URL to the S3 bucket containing the package that contains the template fragment and schema files for the module version to register.
public virtual string ModulePackage { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>