Class CfnModuleDefaultVersion
A CloudFormation AWS::CloudFormation::ModuleDefaultVersion
.
public class CfnModuleDefaultVersion : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
- Inheritance
-
CfnModuleDefaultVersion
- 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 cfnModuleDefaultVersion = new CfnModuleDefaultVersion(this, "MyCfnModuleDefaultVersion", new CfnModuleDefaultVersionProps {
Arn = "arn",
ModuleName = "moduleName",
VersionId = "versionId"
});
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
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
string- scoped id of the resource.
props
ICfnModuleDefaultVersionProps- resource properties.
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
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
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
ModuleName
The name of the module.
public virtual string? ModuleName { get; set; }
Property Value
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
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
IDictionary<string, object>