AWSEC2CreateVolumeRequest

Objective-C

@interface AWSEC2CreateVolumeRequest

Swift

class AWSEC2CreateVolumeRequest
  • The Availability Zone in which to create the volume.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable availabilityZone;

    Swift

    var availabilityZone: String? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable dryRun;

    Swift

    var dryRun: NSNumber? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable encrypted;

    Swift

    var encrypted: NSNumber? { get set }
  • 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

    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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable iops;

    Swift

    var iops: NSNumber? { get set }
  • 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:

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

    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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable kmsKeyId;

    Swift

    var kmsKeyId: String? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable multiAttachEnabled;

    Swift

    var multiAttachEnabled: NSNumber? { get set }
  • The Amazon Resource Name (ARN) of the Outpost.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable outpostArn;

    Swift

    var outpostArn: String? { get set }
  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable size;

    Swift

    var size: NSNumber? { get set }
  • The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable snapshotId;

    Swift

    var snapshotId: String? { get set }
  • The tags to apply to the volume during creation.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2TagSpecification *> *_Nullable tagSpecifications;

    Swift

    var tagSpecifications: [AWSEC2TagSpecification]? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable throughput;

    Swift

    var throughput: NSNumber? { get set }
  • 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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2VolumeType volumeType;

    Swift

    var volumeType: AWSEC2VolumeType { get set }