Class CfnVolume
A CloudFormation AWS::OpsWorks::Volume
.
Inherited Members
Namespace: Amazon.CDK.AWS.OpsWorks
Assembly: Amazon.CDK.AWS.OpsWorks.dll
Syntax (csharp)
public class CfnVolume : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnVolume
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Describes an instance's Amazon EBS volume.
CloudformationResource: AWS::OpsWorks::Volume
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.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.OpsWorks;
var cfnVolume = new CfnVolume(this, "MyCfnVolume", new CfnVolumeProps {
Ec2VolumeId = "ec2VolumeId",
StackId = "stackId",
// the properties below are optional
MountPoint = "mountPoint",
Name = "name"
});
Synopsis
Constructors
CfnVolume(Construct, String, ICfnVolumeProps) | Create a new |
CfnVolume(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnVolume(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Ec2VolumeId | The Amazon EC2 volume ID. |
MountPoint | The volume mount point. |
Name | The volume name. |
StackId | The stack ID. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnVolume(Construct, String, ICfnVolumeProps)
Create a new AWS::OpsWorks::Volume
.
public CfnVolume(Construct scope, string id, ICfnVolumeProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnVolumeProps
- resource properties.
CfnVolume(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnVolume(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnVolume(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnVolume(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
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
Ec2VolumeId
The Amazon EC2 volume ID.
public virtual string Ec2VolumeId { get; set; }
Property Value
System.String
Remarks
MountPoint
The volume mount point.
public virtual string MountPoint { get; set; }
Property Value
System.String
Remarks
For example, "/mnt/disk1".
Name
The volume name.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Volume names are a maximum of 128 characters.
StackId
The stack ID.
public virtual string StackId { get; set; }
Property Value
System.String
Remarks
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>