ec2_create_volume {aws.ecx}R Documentation

Create Volume

Description

Create Volume

Usage

ec2_create_volume(
  AvailabilityZone,
  Encrypted = NULL,
  Iops = NULL,
  KmsKeyId = NULL,
  OutpostArn = NULL,
  Size = NULL,
  SnapshotId = NULL,
  VolumeType = NULL,
  DryRun = NULL,
  TagSpecification = NULL,
  MultiAttachEnabled = NULL,
  Throughput = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

AvailabilityZone

Character. The Availability Zone in which to create the volume.

Encrypted

Logical. Indicates whether the volume should be encrypted.[optional]

Iops

Integer. The number of I/O operations per second (IOPS).[optional]

KmsKeyId

Character. The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for...[optional]

OutpostArn

Character. The Amazon Resource Name (ARN) of the Outpost.[optional]

Size

Integer. The size of the volume, in GiBs.[optional]

SnapshotId

Character. The snapshot from which to create the volume.[optional]

VolumeType

Character. The volume type.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

TagSpecification

List. The tags to apply to the volume during creation.[optional]

MultiAttachEnabled

Logical. Indicates whether to enable Amazon EBS Multi-Attach.[optional]

Throughput

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

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

AvailabilityZone

The Availability Zone in which to create the volume.

Encrypted

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.

Iops

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:

For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee 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

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

You can specify the CMK using any of the following:

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

OutpostArn

The Amazon Resource Name (ARN) of the Outpost.

Size

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:

SnapshotId

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

VolumeType

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

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

Default: gp2

DryRun

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.

TagSpecification

The tags to apply to the volume during creation.

MultiAttachEnabled

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.

Throughput

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.

[Package aws.ecx version 1.0.5 Index]