Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints .
You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes with the Encrypted
parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide .
You can tag your volumes during creation. For more information, see Tagging Your Amazon EC2 Resources .
For more information, see Creating an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide .
- createVolume :: Text -> CreateVolume
- data CreateVolume
- cvvSize :: Lens' CreateVolume (Maybe Int)
- cvvIOPS :: Lens' CreateVolume (Maybe Int)
- cvvEncrypted :: Lens' CreateVolume (Maybe Bool)
- cvvTagSpecifications :: Lens' CreateVolume [TagSpecification]
- cvvKMSKeyId :: Lens' CreateVolume (Maybe Text)
- cvvVolumeType :: Lens' CreateVolume (Maybe VolumeType)
- cvvDryRun :: Lens' CreateVolume (Maybe Bool)
- cvvSnapshotId :: Lens' CreateVolume (Maybe Text)
- cvvAvailabilityZone :: Lens' CreateVolume Text
- volume :: Text -> UTCTime -> Bool -> Int -> Text -> VolumeState -> Text -> VolumeType -> Volume
- data Volume
- vAttachments :: Lens' Volume [VolumeAttachment]
- vIOPS :: Lens' Volume (Maybe Int)
- vKMSKeyId :: Lens' Volume (Maybe Text)
- vTags :: Lens' Volume [Tag]
- vAvailabilityZone :: Lens' Volume Text
- vCreateTime :: Lens' Volume UTCTime
- vEncrypted :: Lens' Volume Bool
- vSize :: Lens' Volume Int
- vSnapshotId :: Lens' Volume Text
- vState :: Lens' Volume VolumeState
- vVolumeId :: Lens' Volume Text
- vVolumeType :: Lens' Volume VolumeType
Creating a Request
Creates a value of CreateVolume
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cvvSize
- The size of the volume, in GiBs. Constraints: 1-16384 forgp2
, 4-16384 forio1
, 500-16384 forst1
, 500-16384 forsc1
, and 1-1024 forstandard
. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.cvvIOPS
- The number of IO operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPSGiB. Range is 100 to 32000 IOPS for volumes in most regions. For exceptions, see Amazon EBS Volume Types . This parameter is valid only for Provisioned IOPS SSD (io1) volumes.cvvEncrypted
- Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide .cvvTagSpecifications
- The tags to apply to the volume during creation.cvvKMSKeyId
- An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If aKmsKeyId
is specified, theEncrypted
flag must also be set. The CMK identifier may be provided in any of the following formats: * Key ID * Key alias * ARN using key ID. The ID ARN contains thearn:aws:kms
namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, thekey
namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1 :012345678910 :key/abcd1234-a123-456a-a12b-a123b4cd56ef . * ARN using key alias. The alias ARN contains thearn:aws:kms
namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, thealias
namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1 :012345678910 :alias/ExampleAlias . AWS parsesKmsKeyId
asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.cvvVolumeType
- The volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes. Defaults: If no volume type is specified, the default isstandard
in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other regions, EBS defaults togp2
.cvvDryRun
- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.cvvSnapshotId
- The snapshot from which to create the volume.cvvAvailabilityZone
- The Availability Zone in which to create the volume. UseDescribeAvailabilityZones
to list the Availability Zones that are currently available to you.
data CreateVolume Source #
Contains the parameters for CreateVolume.
See: createVolume
smart constructor.
Request Lenses
cvvSize :: Lens' CreateVolume (Maybe Int) Source #
The size of the volume, in GiBs. Constraints: 1-16384 for gp2
, 4-16384 for io1
, 500-16384 for st1
, 500-16384 for sc1
, and 1-1024 for standard
. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
cvvIOPS :: Lens' CreateVolume (Maybe Int) Source #
The number of IO operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPSGiB. Range is 100 to 32000 IOPS for volumes in most regions. For exceptions, see Amazon EBS Volume Types . This parameter is valid only for Provisioned IOPS SSD (io1) volumes.
cvvEncrypted :: Lens' CreateVolume (Maybe Bool) Source #
Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide .
cvvTagSpecifications :: Lens' CreateVolume [TagSpecification] Source #
The tags to apply to the volume during creation.
cvvKMSKeyId :: Lens' CreateVolume (Maybe Text) Source #
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId
is specified, the Encrypted
flag must also be set. The CMK identifier may be provided in any of the following formats: * Key ID * Key alias * ARN using key ID. The ID ARN contains the arn:aws:kms
namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key
namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1 :012345678910 :key/abcd1234-a123-456a-a12b-a123b4cd56ef . * ARN using key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias
namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1 :012345678910 :alias/ExampleAlias . AWS parses KmsKeyId
asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.
cvvVolumeType :: Lens' CreateVolume (Maybe VolumeType) Source #
The volume type. This can be gp2
for General Purpose SSD, io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for Cold HDD, or standard
for Magnetic volumes. Defaults: If no volume type is specified, the default is standard
in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other regions, EBS defaults to gp2
.
cvvDryRun :: Lens' CreateVolume (Maybe Bool) Source #
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
cvvSnapshotId :: Lens' CreateVolume (Maybe Text) Source #
The snapshot from which to create the volume.
cvvAvailabilityZone :: Lens' CreateVolume Text Source #
The Availability Zone in which to create the volume. Use DescribeAvailabilityZones
to list the Availability Zones that are currently available to you.
Destructuring the Response
:: Text | |
-> UTCTime | |
-> Bool | |
-> Int | |
-> Text | |
-> VolumeState | |
-> Text | |
-> VolumeType | |
-> Volume |
Creates a value of Volume
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vAttachments
- Information about the volume attachments.vIOPS
- The number of IO operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates IO credits for bursting. For more information on General Purpose SSD baseline performance, IO credits, and bursting, see <http:docs.aws.amazon.comAWSEC2latestUserGuideEBSVolumeTypes.html Amazon EBS Volume Types> in the Amazon Elastic Compute Cloud User Guide/ . Constraint: Range is 100-32000 IOPS for io1 volumes and 100-10000 IOPS forgp2
volumes. Condition: This parameter is required for requests to createio1
volumes; it is not used in requests to creategp2
,st1
,sc1
, orstandard
volumes.vKMSKeyId
- The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.vTags
- Any tags assigned to the volume.vAvailabilityZone
- The Availability Zone for the volume.vCreateTime
- The time stamp when volume creation was initiated.vEncrypted
- Indicates whether the volume will be encrypted.vSize
- The size of the volume, in GiBs.vSnapshotId
- The snapshot from which the volume was created, if applicable.vState
- The volume state.vVolumeId
- The ID of the volume.vVolumeType
- The volume type. This can begp2
for General Purpose SSD,io1
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic volumes.
Describes a volume.
See: volume
smart constructor.
Response Lenses
vAttachments :: Lens' Volume [VolumeAttachment] Source #
Information about the volume attachments.
vIOPS :: Lens' Volume (Maybe Int) Source #
The number of IO operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates IO credits for bursting. For more information on General Purpose SSD baseline performance, IO credits, and bursting, see <http:docs.aws.amazon.comAWSEC2latestUserGuideEBSVolumeTypes.html Amazon EBS Volume Types> in the Amazon Elastic Compute Cloud User Guide/ . Constraint: Range is 100-32000 IOPS for io1 volumes and 100-10000 IOPS for gp2
volumes. Condition: This parameter is required for requests to create io1
volumes; it is not used in requests to create gp2
, st1
, sc1
, or standard
volumes.
vKMSKeyId :: Lens' Volume (Maybe Text) Source #
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
vSnapshotId :: Lens' Volume Text Source #
The snapshot from which the volume was created, if applicable.
vVolumeType :: Lens' Volume VolumeType Source #
The volume type. This can be gp2
for General Purpose SSD, io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for Cold HDD, or standard
for Magnetic volumes.