Class: Aws::EC2::Types::CreateVolumeRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateVolumeRequest data as a hash:

{
  availability_zone: "String", # required
  encrypted: false,
  iops: 1,
  kms_key_id: "String",
  size: 1,
  snapshot_id: "String",
  volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
  dry_run: false,
  tag_specifications: [
    {
      resource_type: "customer-gateway", # accepts customer-gateway, dhcp-options, image, instance, internet-gateway, network-acl, network-interface, reserved-instances, route-table, snapshot, spot-instances-request, subnet, security-group, volume, vpc, vpn-connection, vpn-gateway
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Contains the parameters for CreateVolume.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone ⇒ String

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

Returns:

  • (String) 


3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
 
# File 'lib/aws-sdk-ec2/types.rb', line 3970

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications)
  include Aws::Structure
end

#dry_run ⇒ Boolean

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`.

Returns:

  • (Boolean) 


3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
 
# File 'lib/aws-sdk-ec2/types.rb', line 3970

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications)
  include Aws::Structure
end

#encrypted ⇒ Boolean

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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html

Returns:

  • (Boolean) 


3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
 
# File 'lib/aws-sdk-ec2/types.rb', line 3970

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications)
  include Aws::Structure
end

#iops ⇒ Integer

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 50 IOPS/GiB.

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

Returns:

  • (Integer) 


3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
 
# File 'lib/aws-sdk-ec2/types.rb', line 3970

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications)
  include Aws::Structure
end

#kms_key_id ⇒ String

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.

Returns:

  • (String) 


3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
 
# File 'lib/aws-sdk-ec2/types.rb', line 3970

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications)
  include Aws::Structure
end

#size ⇒ Integer

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.

Returns:

  • (Integer) 


3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
 
# File 'lib/aws-sdk-ec2/types.rb', line 3970

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications)
  include Aws::Structure
end

#snapshot_id ⇒ String

The snapshot from which to create the volume.

Returns:

  • (String) 


3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
 
# File 'lib/aws-sdk-ec2/types.rb', line 3970

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications)
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the volume during creation.

Returns:



3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
 
# File 'lib/aws-sdk-ec2/types.rb', line 3970

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications)
  include Aws::Structure
end

#volume_type ⇒ String

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`

Returns:

  • (String) 


3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
 
# File 'lib/aws-sdk-ec2/types.rb', line 3970

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications)
  include Aws::Structure
end