Table of Contents

Class CfnModuleVersion

Namespace
Amazon.CDK
Assembly
Amazon.CDK.dll

A CloudFormation AWS::CloudFormation::ModuleVersion.

public class CfnModuleVersion : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Inheritance
CfnModuleVersion
Implements
IConstruct
Inherited Members

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             var cfnModuleVersion = new CfnModuleVersion(this, "MyCfnModuleVersion", new CfnModuleVersionProps {
                 ModuleName = "moduleName",
                 ModulePackage = "modulePackage"
             });

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html

ExampleMetadata: fixture=_generated

Constructors

CfnModuleVersion(Construct, string, ICfnModuleVersionProps)

Create a new AWS::CloudFormation::ModuleVersion.

public CfnModuleVersion(Construct scope, string id, ICfnModuleVersionProps props)

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnModuleVersionProps
  • resource properties.

Properties

AttrArn

The Amazon Resource Name (ARN) of the module.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrDescription

The description of the module.

public virtual string AttrDescription { get; }

Property Value

string

Remarks

CloudformationAttribute: Description

AttrDocumentationUrl

The URL of a page providing detailed documentation for this module.

public virtual string AttrDocumentationUrl { get; }

Property Value

string

Remarks

CloudformationAttribute: DocumentationUrl

AttrIsDefaultVersion

Whether the specified module version is set as the default version.

public virtual IResolvable AttrIsDefaultVersion { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: IsDefaultVersion

AttrSchema

The schema that defines the module.

public virtual string AttrSchema { get; }

Property Value

string

Remarks

CloudformationAttribute: Schema

AttrTimeCreated

When the specified module version was registered.

public virtual string AttrTimeCreated { get; }

Property Value

string

Remarks

CloudformationAttribute: TimeCreated

AttrVersionId

The ID of this version of the module.

public virtual string AttrVersionId { get; }

Property Value

string

Remarks

CloudformationAttribute: VersionId

AttrVisibility

The scope at which the module is visible and usable in CloudFormation operations.

public virtual string AttrVisibility { get; }

Property Value

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

    string

    CfnProperties 

    protected override IDictionary<string, object> CfnProperties { get; }

    Property Value

    IDictionary<string, object>

    ModuleName

    The name of the module being registered.

    public virtual string ModuleName { get; set; }

    Property Value

    string

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulename

    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

    string

    Remarks

    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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> permissions for the package. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a> in the <em>AWS Identity and Access Management User Guide</em> .

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulepackage

    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 IDictionary<string, object>

    Returns

    IDictionary<string, object>