AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CreateVolumeInput

import "github.com/aws/aws-sdk-go/service/ec2"

type CreateVolumeInput struct { AvailabilityZone *string `type:"string" required:"true"` DryRun *bool `locationName:"dryRun" type:"boolean"` Encrypted *bool `locationName:"encrypted" type:"boolean"` Iops *int64 `type:"integer"` KmsKeyId *string `type:"string"` Size *int64 `type:"integer"` SnapshotId *string `type:"string"` TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" type:"list"` VolumeType *string `type:"string" enum:"VolumeType"` }

Contains the parameters for CreateVolume.

AvailabilityZone

Type: *string

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

AvailabilityZone is a required field

DryRun

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

Encrypted

Type: *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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the Amazon Elastic Compute Cloud User Guide.

Iops

Type: *int64

The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the Amazon Elastic Compute Cloud User Guide.

This parameter is valid only for Provisioned IOPS SSD (io1) volumes.

KmsKeyId

Type: *string

An identifier for 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. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias

  • ARN using key ID. The ID 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.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.

Size

Type: *int64

The size of the volume, in GiBs.

Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 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.

At least one of Size or SnapshotId are required.

SnapshotId

Type: *string

The snapshot from which to create the volume.

At least one of Size or SnapshotId are required.

TagSpecifications

The tags to apply to a resource when the resource is being created.

VolumeType

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.

Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.

Method

GoString

func (s CreateVolumeInput) GoString() string

GoString returns the string representation

SetAvailabilityZone

func (s *CreateVolumeInput) SetAvailabilityZone(v string) *CreateVolumeInput

SetAvailabilityZone sets the AvailabilityZone field's value.

SetDryRun

func (s *CreateVolumeInput) SetDryRun(v bool) *CreateVolumeInput

SetDryRun sets the DryRun field's value.

SetEncrypted

func (s *CreateVolumeInput) SetEncrypted(v bool) *CreateVolumeInput

SetEncrypted sets the Encrypted field's value.

SetIops

func (s *CreateVolumeInput) SetIops(v int64) *CreateVolumeInput

SetIops sets the Iops field's value.

SetKmsKeyId

func (s *CreateVolumeInput) SetKmsKeyId(v string) *CreateVolumeInput

SetKmsKeyId sets the KmsKeyId field's value.

SetSize

func (s *CreateVolumeInput) SetSize(v int64) *CreateVolumeInput

SetSize sets the Size field's value.

SetSnapshotId

func (s *CreateVolumeInput) SetSnapshotId(v string) *CreateVolumeInput

SetSnapshotId sets the SnapshotId field's value.

SetTagSpecifications

func (s *CreateVolumeInput) SetTagSpecifications(v []*TagSpecification) *CreateVolumeInput

SetTagSpecifications sets the TagSpecifications field's value.

SetVolumeType

func (s *CreateVolumeInput) SetVolumeType(v string) *CreateVolumeInput

SetVolumeType sets the VolumeType field's value.

String

func (s CreateVolumeInput) String() string

String returns the string representation

Validate

func (s *CreateVolumeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: