Class CfnModuleDefaultVersion
Specifies the default version of a module.
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnModuleDefaultVersion : CfnResource, IInspectable, IModuleDefaultVersionRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnModuleDefaultVersion Inherits CfnResource Implements IInspectable, IModuleDefaultVersionRef, IConstruct, IDependable, IEnvironmentAware
Remarks
The default version of the module will be used in CloudFormation operations for this 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 CloudFormation 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 |
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 | Specifies the default version of a module. |
| ModuleDefaultVersionRef | A reference to a ModuleDefaultVersion resource. |
| 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. |
| IsCfnModuleDefaultVersion(object) | Checks whether the given object is a CfnModuleDefaultVersion. |
| RenderProperties(IDictionary<string, object>) | Specifies the default version of a module. |
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
Construct identifier for this resource (unique in its scope).
- props ICfnModuleDefaultVersionProps
Resource properties.
Remarks
The default version of the module will be used in CloudFormation operations for this 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 CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::ModuleDefaultVersion
ExampleMetadata: fixture=_generated
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
The default version of the module will be used in CloudFormation operations for this 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 CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::ModuleDefaultVersion
ExampleMetadata: fixture=_generated
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
The default version of the module will be used in CloudFormation operations for this 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 CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::ModuleDefaultVersion
ExampleMetadata: fixture=_generated
CfnProperties
Specifies the default version of a module.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
The default version of the module will be used in CloudFormation operations for this 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 CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::ModuleDefaultVersion
ExampleMetadata: fixture=_generated
ModuleDefaultVersionRef
A reference to a ModuleDefaultVersion resource.
public virtual IModuleDefaultVersionReference ModuleDefaultVersionRef { get; }
Property Value
IModuleDefaultVersionReference
Remarks
The default version of the module will be used in CloudFormation operations for this 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 CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::ModuleDefaultVersion
ExampleMetadata: fixture=_generated
ModuleName
The name of the module.
public virtual string? ModuleName { get; set; }
Property Value
Remarks
The default version of the module will be used in CloudFormation operations for this 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 CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::ModuleDefaultVersion
ExampleMetadata: fixture=_generated
VersionId
The ID for the specific version of the module.
public virtual string? VersionId { get; set; }
Property Value
Remarks
The default version of the module will be used in CloudFormation operations for this 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 CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::ModuleDefaultVersion
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
The default version of the module will be used in CloudFormation operations for this 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 CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::ModuleDefaultVersion
ExampleMetadata: fixture=_generated
IsCfnModuleDefaultVersion(object)
Checks whether the given object is a CfnModuleDefaultVersion.
public static bool IsCfnModuleDefaultVersion(object x)
Parameters
- x object
Returns
Remarks
The default version of the module will be used in CloudFormation operations for this 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 CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::ModuleDefaultVersion
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Specifies the default version of a module.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
The default version of the module will be used in CloudFormation operations for this 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 CloudFormation User Guide .
CloudformationResource: AWS::CloudFormation::ModuleDefaultVersion
ExampleMetadata: fixture=_generated