EC2 / Client / create_volume

create_volume#

EC2.Client.create_volume(**kwargs)#

Creates an EBS volume that can be attached to an instance in the same Availability Zone.

You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes. Encrypted volumes must 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 EBS User Guide.

You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.

For more information, see Create an Amazon EBS volume in the Amazon EBS User Guide.

Request Syntax

response = client.create_volume(
    AvailabilityZone='string',
    Encrypted=True|False,
    Iops=123,
    KmsKeyId='string',
    OutpostArn='string',
    Size=123,
    SnapshotId='string',
    VolumeType='standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
    DryRun=True|False,
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'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'|'ipam'|'ipam-pool'|'ipam-scope'|'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'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'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'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    MultiAttachEnabled=True|False,
    Throughput=123,
    ClientToken='string'
)

Parameters:

AvailabilityZone (string) –
[REQUIRED]

The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
Encrypted (boolean) –
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 EBS User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
Iops (integer) –
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 - 256,000 IOPS
For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve 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 (string) –
The identifier of the 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.
OutpostArn (string) –
The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can’t use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.
Size (integer) –
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 GiB
- io1: 4 - 16,384 GiB
- io2: 4 - 65,536 GiB
- st1 and sc1: 125 - 16,384 GiB
- standard: 1 - 1024 GiB
SnapshotId (string) – The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
VolumeType (string) –
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
Warning
Throughput Optimized HDD ( st1) and Cold HDD ( sc1) volumes can’t be used as boot volumes.

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

Default: gp2
DryRun (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.
TagSpecifications (list) –
The tags to apply to the volume during creation.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
  - ResourceType (string) –
    
    The type of resource to tag on creation.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
MultiAttachEnabled (boolean) – 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 EBS User Guide.
Throughput (integer) –
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.
ClientToken (string) –
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'Attachments': [
        {
            'AttachTime': datetime(2015, 1, 1),
            'Device': 'string',
            'InstanceId': 'string',
            'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
            'VolumeId': 'string',
            'DeleteOnTermination': True|False,
            'AssociatedResource': 'string',
            'InstanceOwningService': 'string'
        },
    ],
    'AvailabilityZone': 'string',
    'CreateTime': datetime(2015, 1, 1),
    'Encrypted': True|False,
    'KmsKeyId': 'string',
    'OutpostArn': 'string',
    'Size': 123,
    'SnapshotId': 'string',
    'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
    'VolumeId': 'string',
    'Iops': 123,
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
    'FastRestored': True|False,
    'MultiAttachEnabled': True|False,
    'Throughput': 123,
    'SseType': 'sse-ebs'|'sse-kms'|'none'
}

Response Structure

(dict) –

Describes a volume.
- Attachments (list) –
  
  Note
  This parameter is not returned by CreateVolume.
  
  Information about the volume attachments.
  - (dict) –
    
    Describes volume attachment details.
    - AttachTime (datetime) –
      
      The time stamp when the attachment initiated.
    - Device (string) –
      
      The device name.
      
      If the volume is attached to a Fargate task, this parameter returns null.
    - InstanceId (string) –
      
      The ID of the instance.
      
      If the volume is attached to a Fargate task, this parameter returns null.
    - State (string) –
      
      The attachment state of the volume.
    - VolumeId (string) –
      
      The ID of the volume.
    - DeleteOnTermination (boolean) –
      
      Indicates whether the EBS volume is deleted on instance termination.
    - AssociatedResource (string) –
      
      The ARN of the Amazon ECS or Fargate task to which the volume is attached.
    - InstanceOwningService (string) –
      
      The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.
      
      This parameter is returned only for volumes that are attached to Fargate tasks.
- AvailabilityZone (string) –
  
  The Availability Zone for the volume.
- CreateTime (datetime) –
  
  The time stamp when volume creation was initiated.
- Encrypted (boolean) –
  
  Indicates whether the volume is encrypted.
- KmsKeyId (string) –
  
  The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.
- OutpostArn (string) –
  
  The Amazon Resource Name (ARN) of the Outpost.
- Size (integer) –
  
  The size of the volume, in GiBs.
- SnapshotId (string) –
  
  The snapshot from which the volume was created, if applicable.
- State (string) –
  
  The volume state.
- VolumeId (string) –
  
  The ID of the volume.
- Iops (integer) –
  
  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.
- Tags (list) –
  
  Any tags assigned to the volume.
  - (dict) –
    
    Describes a tag.
    - Key (string) –
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) –
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- VolumeType (string) –
  
  The volume type.
- FastRestored (boolean) –
  
  Note
  This parameter is not returned by CreateVolume.
  
  Indicates whether the volume was created using fast snapshot restore.
- MultiAttachEnabled (boolean) –
  
  Indicates whether Amazon EBS Multi-Attach is enabled.
- Throughput (integer) –
  
  The throughput that the volume supports, in MiB/s.
- SseType (string) –
  
  Note
  This parameter is not returned by CreateVolume.
  
  Reserved for future use.

Examples

This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone us-east-1a.

response = client.create_volume(
    AvailabilityZone='us-east-1a',
    Size=80,
    VolumeType='gp2',
)

print(response)

Expected Output:

{
    'AvailabilityZone': 'us-east-1a',
    'CreateTime': datetime(2016, 8, 29, 18, 52, 32, 0, 242, 0),
    'Encrypted': False,
    'Iops': 240,
    'Size': 80,
    'SnapshotId': '',
    'State': 'creating',
    'VolumeId': 'vol-6b60b7c7',
    'VolumeType': 'gp2',
    'ResponseMetadata': {
        '...': '...',
    },
}

This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone us-east-1a.

response = client.create_volume(
    AvailabilityZone='us-east-1a',
    Iops=1000,
    SnapshotId='snap-066877671789bd71b',
    VolumeType='io1',
)

print(response)

Expected Output:

{
    'Attachments': [
    ],
    'AvailabilityZone': 'us-east-1a',
    'CreateTime': datetime(2016, 8, 29, 18, 52, 32, 0, 242, 0),
    'Iops': 1000,
    'Size': 500,
    'SnapshotId': 'snap-066877671789bd71b',
    'State': 'creating',
    'Tags': [
    ],
    'VolumeId': 'vol-1234567890abcdef0',
    'VolumeType': 'io1',
    'ResponseMetadata': {
        '...': '...',
    },
}