Class CfnModuleVersion

The AWS::CloudFormation::ModuleVersion resource registers the specified version of the module with the CloudFormation registry.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnModuleVersion

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

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.

For more information, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide .

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .

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

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(Construct, string, ICfnModuleVersionProps)

The AWS::CloudFormation::ModuleVersion resource registers the specified version of the module with the CloudFormation registry.

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 private module version was registered or activated in your account.
AttrVersionId	The ID of this version of the module.
AttrVisibility	The visibility level that determines who can see and use this module in CloudFormation operations:.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::CloudFormation::ModuleVersion resource registers the specified version of the module with the CloudFormation registry.
ModuleName	The name of the module being registered.
ModulePackage	A URL to the S3 bucket for 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>)	The AWS::CloudFormation::ModuleVersion resource registers the specified version of the module with the CloudFormation registry.

Constructors

CfnModuleVersion(Construct, string, ICfnModuleVersionProps)

The AWS::CloudFormation::ModuleVersion resource registers the specified version of the module with the CloudFormation registry.

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

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnModuleVersionProps

Resource properties.

Remarks

Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.

For more information, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide .

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .

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

CloudformationResource: AWS::CloudFormation::ModuleVersion

ExampleMetadata: fixture=_generated

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

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

public virtual string AttrSchema { get; }

Property Value

string

Remarks

CloudformationAttribute: Schema

AttrTimeCreated

When the specified private module version was registered or activated in your account.

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 visibility level that determines who can see and use this module in CloudFormation operations:.

public virtual string AttrVisibility { get; }

Property Value

string

Remarks

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

Remarks

Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.

For more information, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide .

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .

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

CloudformationResource: AWS::CloudFormation::ModuleVersion

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::CloudFormation::ModuleVersion resource registers the specified version of the module with the CloudFormation registry.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.

For more information, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide .

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .

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

CloudformationResource: AWS::CloudFormation::ModuleVersion

ExampleMetadata: fixture=_generated

ModuleName

The name of the module being registered.

public virtual string ModuleName { get; set; }

Property Value

string

Remarks

Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.

For more information, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide .

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .

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

CloudformationResource: AWS::CloudFormation::ModuleVersion

ExampleMetadata: fixture=_generated

ModulePackage

A URL to the S3 bucket for 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

Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.

For more information, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide .

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .

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

CloudformationResource: AWS::CloudFormation::ModuleVersion

ExampleMetadata: fixture=_generated

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.

Remarks

Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.

For more information, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide .

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .

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

CloudformationResource: AWS::CloudFormation::ModuleVersion

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::CloudFormation::ModuleVersion resource registers the specified version of the module with the CloudFormation registry.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.

For more information, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide .

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .

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

CloudformationResource: AWS::CloudFormation::ModuleVersion

ExampleMetadata: fixture=_generated

Implements

IInspectable