Interface ICfnVolumeProps
Properties for defining a CfnVolume
.
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public interface ICfnVolumeProps
Syntax (vb)
Public Interface ICfnVolumeProps
Remarks
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 cfnVolumeProps = 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
Properties
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. |
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:. |
Properties
AutoEnableIo
Indicates whether the volume is auto-enabled for I/O operations.
virtual object AutoEnableIo { get; }
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.
string AvailabilityZone { get; }
Property Value
System.String
Remarks
For example, us-east-1a
.
Encrypted
Indicates whether the volume should be encrypted.
virtual object Encrypted { get; }
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).
virtual Nullable<double> Iops { get; }
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.
virtual string KmsKeyId { get; }
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.
virtual object MultiAttachEnabled { get; }
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.
virtual string OutpostArn { get; }
Property Value
System.String
Remarks
Size
The size of the volume, in GiBs.
virtual Nullable<double> Size { get; }
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.
virtual string SnapshotId { get; }
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.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
Throughput
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
virtual Nullable<double> Throughput { get; }
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:.
virtual string VolumeType { get; }
Property Value
System.String
Remarks
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide .
Default: gp2