Class CfnModuleVersion

A CloudFormation AWS::CloudFormation::ModuleVersion.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnModuleVersion
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFormation
Assembly: Amazon.CDK.AWS.CloudFormation.dll
Syntax (csharp)
public class CfnModuleVersion : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnModuleVersion
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
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

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;

CfnModuleVersion cfnModuleVersion = new CfnModuleVersion(this, "MyCfnModuleVersion", new CfnModuleVersionProps {
    ModuleName = "moduleName",
    ModulePackage = "modulePackage"
});

Synopsis

Constructors

CfnModuleVersion(Construct, String, ICfnModuleVersionProps)

Create a new AWS::CloudFormation::ModuleVersion.
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

Properties

AttrArn

The Amazon Resource Name (ARN) of the module.
AttrDescription

The description of the module.
AttrDocumentationUrl

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

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

The schema that defines the module.
AttrTimeCreated

When the specified module version was registered.
AttrVersionId

The ID of this version of the module.
AttrVisibility

The scope at which the module 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(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 System.String
  • scoped id of the resource.
props ICfnModuleVersionProps
  • resource properties.

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

Properties

AttrArn

The Amazon Resource Name (ARN) of the module.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrDescription

The description of the module.

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

System.String

Remarks

CloudformationAttribute: Schema

AttrTimeCreated

When the specified module version was registered.

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

    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

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

    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 System.Collections.Generic.IDictionary<System.String, System.Object>
    Returns

    System.Collections.Generic.IDictionary<System.String, System.Object>

    Overrides

    Implements

    Constructs.IConstruct