Class CfnModuleDefaultVersion
A CloudFormation AWS::CloudFormation::ModuleDefaultVersion
.
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public class CfnModuleDefaultVersion : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnModuleDefaultVersion
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies the default version of a module. The default version of the module will be used in CloudFormation operations for this account and Region.
To register a module version, use the AWS::CloudFormation::ModuleVersion
resource.
For more information using modules, see Using modules to encapsulate and reuse resource configurations and Registering extensions in the AWS CloudFormation User Guide . For information on developing modules, see Developing modules in the AWS CloudFormation CLI User Guide .
CloudformationResource: AWS::CloudFormation::ModuleDefaultVersion
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;
var cfnModuleDefaultVersion = new CfnModuleDefaultVersion(this, "MyCfnModuleDefaultVersion", new CfnModuleDefaultVersionProps {
Arn = "arn",
ModuleName = "moduleName",
VersionId = "versionId"
});
Synopsis
Constructors
CfnModuleDefaultVersion(Construct, String, ICfnModuleDefaultVersionProps) | Create a new |
CfnModuleDefaultVersion(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnModuleDefaultVersion(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
Arn | The Amazon Resource Name (ARN) of the module version to set as the default version. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ModuleName | The name of the module. |
VersionId | The ID for the specific version of the module. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnModuleDefaultVersion(Construct, String, ICfnModuleDefaultVersionProps)
Create a new AWS::CloudFormation::ModuleDefaultVersion
.
public CfnModuleDefaultVersion(Construct scope, string id, ICfnModuleDefaultVersionProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnModuleDefaultVersionProps
- resource properties.
CfnModuleDefaultVersion(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnModuleDefaultVersion(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnModuleDefaultVersion(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnModuleDefaultVersion(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
Arn
The Amazon Resource Name (ARN) of the module version to set as the default version.
public virtual string Arn { get; set; }
Property Value
System.String
Remarks
Conditional: You must specify either Arn
, or ModuleName
and VersionId
.
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.
public virtual string ModuleName { get; set; }
Property Value
System.String
Remarks
Conditional: You must specify either Arn
, or ModuleName
and VersionId
.
VersionId
The ID for the specific version of the module.
public virtual string VersionId { get; set; }
Property Value
System.String
Remarks
Conditional: You must specify either Arn
, or ModuleName
and VersionId
.
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>