AWSEC2EbsBlockDevice

Objective-C

@interface AWSEC2EbsBlockDevice

Swift

class AWSEC2EbsBlockDevice

Describes a block device for an EBS volume.

  • Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.

    Declaration

    Objective-C

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

    Swift

    var deleteOnTermination: NSNumber? { get set }

  • Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the Amazon EBS User Guide.

    In no case can you remove encryption from an encrypted volume.

    Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

    This parameter is not returned by DescribeImageAttribute.

    For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.

    • If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).

    • If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.

    • If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.

    • If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.

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

    Declaration

    Objective-C

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

    Swift

    var iops: NSNumber? { get set }

  • Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

    This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

    Declaration

    Objective-C

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

    Swift

    var kmsKeyId: String? { get set }

  • The ARN of the Outpost on which the snapshot is stored.

    This parameter is not supported when using CreateImage.

    Declaration

    Objective-C

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

    Swift

    var outpostArn: String? { get set }

  • The ID of the snapshot.

    Declaration

    Objective-C

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

    Swift

    var snapshotId: String? { get set }

  • The throughput that the volume supports, in 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 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 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

    Declaration

    Objective-C

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

    Swift

    var volumeSize: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2VolumeType volumeType;

    Swift

    var volumeType: AWSEC2VolumeType { get set }