AWSAutoScalingEbs

Objective-C

@interface AWSAutoScalingEbs

Swift

class AWSAutoScalingEbs

Describes information used to set up an Amazon EBS volume specified in a block device mapping.

  • Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

    Declaration

    Objective-C

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

    Swift

    var deleteOnTermination: NSNumber? { get set }
  • Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

    If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the Amazon Web Services managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.

    Enabling encryption by default results in all EBS volumes being encrypted with the Amazon Web Services managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.

    For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK key policy for use with encrypted volumes in the Amazon EC2 Auto Scaling User Guide.

    Declaration

    Objective-C

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

    Swift

    var encrypted: NSNumber? { get set }
  • The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 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

    For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.

    Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

    Declaration

    Objective-C

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

    Swift

    var iops: NSNumber? { get set }
  • The snapshot ID of the volume to use.

    You must specify either a VolumeSize or a SnapshotId.

    Declaration

    Objective-C

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

    Swift

    var snapshotId: String? { get set }
  • The throughput (MiBps) to provision for a gp3 volume.

    Declaration

    Objective-C

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

    Swift

    var throughput: NSNumber? { get set }
  • The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

    • gp2 and gp3: 1-16,384

    • io1: 4-16,384

    • st1 and sc1: 125-16,384

    • standard: 1-1,024

    You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

    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 EC2 User Guide for Linux Instances.

    Valid Values: standard | io1 | gp2 | st1 | sc1 | gp3

    Declaration

    Objective-C

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

    Swift

    var volumeType: String? { get set }