Network.AWS.EC2.CreateVolume

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.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

Creating a Request

createVolume

Arguments

:: Text

creAvailabilityZone

-> CreateVolume

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:

• creSize
• creIOPS
• creEncrypted
• creKMSKeyId
• creVolumeType
• creDryRun
• creSnapshotId
• creAvailabilityZone

data CreateVolume

Contains the parameters for CreateVolume.

See: createVolume smart constructor.

Instances

Eq CreateVolume

Methods

(==) :: CreateVolume -> CreateVolume -> Bool

(/=) :: CreateVolume -> CreateVolume -> Bool

Data CreateVolume

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateVolume -> c CreateVolume

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateVolume

toConstr :: CreateVolume -> Constr

dataTypeOf :: CreateVolume -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateVolume)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateVolume)

gmapT :: (forall b. Data b => b -> b) -> CreateVolume -> CreateVolume

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateVolume -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateVolume -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateVolume -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateVolume -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateVolume -> m CreateVolume

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateVolume -> m CreateVolume

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateVolume -> m CreateVolume

Read CreateVolume

Methods

readsPrec :: Int -> ReadS CreateVolume

readList :: ReadS [CreateVolume]

readPrec :: ReadPrec CreateVolume

readListPrec :: ReadPrec [CreateVolume]

Show CreateVolume

Methods

showsPrec :: Int -> CreateVolume -> ShowS

show :: CreateVolume -> String

showList :: [CreateVolume] -> ShowS

Generic CreateVolume

Associated Types

type Rep CreateVolume :: * -> *

Methods

from :: CreateVolume -> Rep CreateVolume x

to :: Rep CreateVolume x -> CreateVolume

Hashable CreateVolume

Methods

hashWithSalt :: Int -> CreateVolume -> Int

hash :: CreateVolume -> Int

NFData CreateVolume

Methods

rnf :: CreateVolume -> ()

AWSRequest CreateVolume

Associated Types

type Rs CreateVolume :: *

Methods

request :: CreateVolume -> Request CreateVolume

response :: MonadResource m => Logger -> Service -> Proxy * CreateVolume -> ClientResponse -> m (Response CreateVolume)

ToPath CreateVolume

Methods

toPath :: CreateVolume -> ByteString

ToHeaders CreateVolume

Methods

toHeaders :: CreateVolume -> [Header]

ToQuery CreateVolume

Methods

toQuery :: CreateVolume -> QueryString

type Rep CreateVolume

type Rep CreateVolume = D1 (MetaData "CreateVolume" "Network.AWS.EC2.CreateVolume" "amazonka-ec2-1.4.2-6EJAAVBh1q13dHrwE82a1F" False) (C1 (MetaCons "CreateVolume'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_creSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_creIOPS") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "_creEncrypted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_creKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_creVolumeType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumeType))) (S1 (MetaSel (Just Symbol "_creDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_creSnapshotId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_creAvailabilityZone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CreateVolume

type Rs CreateVolume = Volume

Request Lenses

creSize :: Lens' CreateVolume (Maybe Int)

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.

creIOPS :: Lens' CreateVolume (Maybe Int)

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

creEncrypted :: Lens' CreateVolume (Maybe Bool)

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.

creKMSKeyId :: Lens' CreateVolume (Maybe Text)

The full ARN of 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. The 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. If a KmsKeyId is specified, the Encrypted flag must also be set.

creVolumeType :: Lens' CreateVolume (Maybe VolumeType)

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.

Default: standard

creDryRun :: Lens' CreateVolume (Maybe Bool)

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.

creSnapshotId :: Lens' CreateVolume (Maybe Text)

The snapshot from which to create the volume.

creAvailabilityZone :: Lens' CreateVolume Text

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

volume

Arguments

:: Text

vAvailabilityZone

-> UTCTime

vCreateTime

-> Bool

vEncrypted

-> Int

vSize

-> Text

vSnapshotId

-> VolumeState

vState

-> Text

vVolumeId

-> VolumeType

vVolumeType

-> 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
• vIOPS
• vKMSKeyId
• vTags
• vAvailabilityZone
• vCreateTime
• vEncrypted
• vSize
• vSnapshotId
• vState
• vVolumeId
• vVolumeType

data Volume

Describes a volume.

See: volume smart constructor.

Instances

Eq Volume

Methods

(==) :: Volume -> Volume -> Bool

(/=) :: Volume -> Volume -> Bool

Data Volume

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Volume -> c Volume

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Volume

toConstr :: Volume -> Constr

dataTypeOf :: Volume -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Volume)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Volume)

gmapT :: (forall b. Data b => b -> b) -> Volume -> Volume

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Volume -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Volume -> r

gmapQ :: (forall d. Data d => d -> u) -> Volume -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Volume -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Volume -> m Volume

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Volume -> m Volume

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Volume -> m Volume

Read Volume

Methods

readsPrec :: Int -> ReadS Volume

readList :: ReadS [Volume]

readPrec :: ReadPrec Volume

readListPrec :: ReadPrec [Volume]

Show Volume

Methods

showsPrec :: Int -> Volume -> ShowS

show :: Volume -> String

showList :: [Volume] -> ShowS

Generic Volume

Associated Types

type Rep Volume :: * -> *

Methods

from :: Volume -> Rep Volume x

to :: Rep Volume x -> Volume

Hashable Volume

Methods

hashWithSalt :: Int -> Volume -> Int

hash :: Volume -> Int

NFData Volume

Methods

rnf :: Volume -> ()

FromXML Volume

Methods

parseXML :: [Node] -> Either String Volume

type Rep Volume

type Rep Volume = D1 (MetaData "Volume" "Network.AWS.EC2.Types.Product" "amazonka-ec2-1.4.2-6EJAAVBh1q13dHrwE82a1F" False) (C1 (MetaCons "Volume'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_vAttachments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [VolumeAttachment]))) ((:*:) (S1 (MetaSel (Just Symbol "_vIOPS") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_vKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_vTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) ((:*:) (S1 (MetaSel (Just Symbol "_vAvailabilityZone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_vCreateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ISO8601))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_vEncrypted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) ((:*:) (S1 (MetaSel (Just Symbol "_vSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_vSnapshotId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_vState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 VolumeState)) ((:*:) (S1 (MetaSel (Just Symbol "_vVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_vVolumeType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 VolumeType)))))))

Response Lenses

vAttachments :: Lens' Volume [VolumeAttachment]

Information about the volume attachments.

vIOPS :: Lens' Volume (Maybe Int)

The number of I/O 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 I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 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)

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 :: Lens' Volume [Tag]

Any tags assigned to the volume.

vAvailabilityZone :: Lens' Volume Text

The Availability Zone for the volume.

vCreateTime :: Lens' Volume UTCTime

The time stamp when volume creation was initiated.

vEncrypted :: Lens' Volume Bool

Indicates whether the volume will be encrypted.

vSize :: Lens' Volume Int

The size of the volume, in GiBs.

vSnapshotId :: Lens' Volume Text

The snapshot from which the volume was created, if applicable.

vState :: Lens' Volume VolumeState

The volume state.

vVolumeId :: Lens' Volume Text

The ID of the volume.

vVolumeType :: Lens' Volume VolumeType

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.