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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/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: "KmsKeyId",
  outpost_arn: "String",
  size: 1,
  snapshot_id: "SnapshotId",
  volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
  dry_run: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  multi_attach_enabled: false,
  throughput: 1,
  client_token: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

The Availability Zone in which to create the volume.

Returns:

  • (String)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

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)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#encryptedBoolean

Indicates whether the volume should be encrypted. 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.

Returns:

  • (Boolean)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#iopsInteger

The number of I/O operations per second (IOPS). 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:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

  • io2: 100-64,000 IOPS

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.

Returns:

  • (Integer)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the KMS key using any of the following:

  • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Returns:

  • (String)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#multi_attach_enabledBoolean

Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (Boolean)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arnString

The Amazon Resource Name (ARN) of the Outpost.

Returns:

  • (String)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#sizeInteger

The size of the volume, in GiBs. 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:

  • gp2 and gp3: 1-16,384

  • io1 and io2: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

Returns:

  • (Integer)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_idString

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Returns:

  • (String)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the volume during creation.

Returns:



11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#throughputInteger

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

This parameter is valid only for gp3 volumes.

Valid Range: Minimum value of 125. Maximum value of 1000.

Returns:

  • (Integer)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#volume_typeString

The volume type. This parameter can be one of the following values:

  • General Purpose SSD: gp2 | gp3

  • Provisioned IOPS SSD: io1 | io2

  • Throughput Optimized HDD: st1

  • Cold HDD: sc1

  • Magnetic: standard

For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: gp2

Returns:

  • (String)


11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11391

class CreateVolumeRequest < Struct.new(
  :availability_zone,
  :encrypted,
  :iops,
  :kms_key_id,
  :outpost_arn,
  :size,
  :snapshot_id,
  :volume_type,
  :dry_run,
  :tag_specifications,
  :multi_attach_enabled,
  :throughput,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end