Class CfnVolume
A CloudFormation AWS::EC2::Volume
.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnVolume : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnVolume
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies an Amazon Elastic Block Store (Amazon EBS) volume. You can attach the volume to an instance in the same Availability Zone using AWS::EC2::VolumeAttachment .
When you use AWS CloudFormation to update an Amazon EBS volume that modifies Iops
, Size
, or VolumeType
, there is a cooldown period before another operation can occur. This can cause your stack to report being in UPDATE_IN_PROGRESS
or UPDATE_ROLLBACK_IN_PROGRESS
for long periods of time.
Amazon EBS does not support sizing down an Amazon EBS volume. AWS CloudFormation does not attempt to modify an Amazon EBS volume to a smaller size on rollback.
Some common scenarios when you might encounter a cooldown period for Amazon EBS include:
For more information on the cooldown period, see Requirements when modifying volumes .
DeletionPolicy attribute
To control how AWS CloudFormation handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to retain the volume, to delete the volume, or to create a snapshot of the volume. For more information, see DeletionPolicy attribute .
If you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot.
CloudformationResource: AWS::EC2::Volume
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-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.EC2;
var cfnVolume = new CfnVolume(this, "MyCfnVolume", new CfnVolumeProps {
AvailabilityZone = "availabilityZone",
// the properties below are optional
AutoEnableIo = false,
Encrypted = false,
Iops = 123,
KmsKeyId = "kmsKeyId",
MultiAttachEnabled = false,
OutpostArn = "outpostArn",
Size = 123,
SnapshotId = "snapshotId",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Throughput = 123,
VolumeType = "volumeType"
});
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
AttrVolumeId | The ID of the volume. |
AutoEnableIo | Indicates whether the volume is auto-enabled for I/O operations. |
AvailabilityZone | The ID of the Availability Zone in which to create the volume. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Encrypted | Indicates whether the volume should be encrypted. |
Iops | The number of I/O operations per second (IOPS). |
KmsKeyId | The identifier of the AWS KMS key to use for Amazon EBS encryption. |
MultiAttachEnabled | Indicates whether Amazon EBS Multi-Attach is enabled. |
OutpostArn | The Amazon Resource Name (ARN) of the Outpost. |
Size | The size of the volume, in GiBs. |
SnapshotId | The snapshot from which to create the volume. |
Tags | The tags to apply to the volume during creation. |
Throughput | The throughput to provision for a volume, with a maximum of 1,000 MiB/s. |
VolumeType | The volume type. This parameter can be one of the following values:. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnVolume(Construct, String, ICfnVolumeProps)
Create a new AWS::EC2::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
AttrVolumeId
The ID of the volume.
public virtual string AttrVolumeId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: VolumeId
AutoEnableIo
Indicates whether the volume is auto-enabled for I/O operations.
public virtual object AutoEnableIo { get; set; }
Property Value
System.Object
Remarks
By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
AvailabilityZone
The ID of the Availability Zone in which to create the volume.
public virtual string AvailabilityZone { get; set; }
Property Value
System.String
Remarks
For example, us-east-1a
.
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
Encrypted
Indicates whether the volume should be encrypted.
public virtual object Encrypted { get; set; }
Property Value
System.Object
Remarks
The effect of setting the encryption state to true
depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide .
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
Iops
The number of I/O operations per second (IOPS).
public virtual Nullable<double> Iops { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
io1
and io2
volumes support up to 64,000 IOPS only on Instances built on the Nitro System . Other instance families support performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS. This parameter is not supported for gp2
, st1
, sc1
, or standard
volumes.
KmsKeyId
The identifier of the AWS KMS key to use for Amazon EBS encryption.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Remarks
If KmsKeyId
is specified, the encrypted state must be true
.
If you omit this property and your account is enabled for encryption by default, or Encrypted is set to true
, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the AWS managed key .
Alternatively, if you want to specify a different key, you can specify one of the following:
MultiAttachEnabled
Indicates whether Amazon EBS Multi-Attach is enabled.
public virtual object MultiAttachEnabled { get; set; }
Property Value
System.Object
Remarks
AWS CloudFormation does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
OutpostArn
The Amazon Resource Name (ARN) of the Outpost.
public virtual string OutpostArn { get; set; }
Property Value
System.String
Remarks
Size
The size of the volume, in GiBs.
public virtual Nullable<double> Size { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
SnapshotId
The snapshot from which to create the volume.
public virtual string SnapshotId { get; set; }
Property Value
System.String
Remarks
You must specify either a snapshot ID or a volume size.
Tags
The tags to apply to the volume during creation.
public virtual TagManager Tags { get; }
Property Value
Remarks
Throughput
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
public virtual Nullable<double> Throughput { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This parameter is valid only for gp3
volumes. The default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
VolumeType
The volume type. This parameter can be one of the following values:.
public virtual string VolumeType { get; set; }
Property Value
System.String
Remarks
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide .
Default: gp2
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>