GetVolumeResult

data class GetVolumeResult(val autoEnableIo: Boolean? = null, val availabilityZone: String? = null, val encrypted: Boolean? = null, val iops: Int? = null, val kmsKeyId: String? = null, val multiAttachEnabled: Boolean? = null, val outpostArn: String? = null, val size: Int? = null, val snapshotId: String? = null, val tags: List<Tag>? = null, val throughput: Int? = null, val volumeId: String? = null, val volumeType: String? = null)

Constructors

Link copied to clipboard
constructor(autoEnableIo: Boolean? = null, availabilityZone: String? = null, encrypted: Boolean? = null, iops: Int? = null, kmsKeyId: String? = null, multiAttachEnabled: Boolean? = null, outpostArn: String? = null, size: Int? = null, snapshotId: String? = null, tags: List<Tag>? = null, throughput: Int? = null, volumeId: String? = null, volumeType: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val autoEnableIo: Boolean? = null

Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.

Link copied to clipboard

The ID of the Availability Zone in which to create the volume. For example, `us-east-1a`.

Link copied to clipboard
val encrypted: Boolean? = null

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 EBS User Guide. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

Link copied to clipboard
val iops: Int? = null

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:

Link copied to clipboard
val kmsKeyId: String? = null

The identifier of the kms-key-long to use for Amazon EBS encryption. If `KmsKeyId` is specified, the encrypted state must be `true`. If you omit this property and your account is enabled for encryption by default, or Encrypted is set to `true`, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. Alternatively, if you want to specify a different key, you can specify one of the following:

Link copied to clipboard

Indicates whether Amazon EBS Multi-Attach is enabled. CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.

Link copied to clipboard
val outpostArn: String? = null

The Amazon Resource Name (ARN) of the Outpost.

Link copied to clipboard
val size: Int? = null

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:

Link copied to clipboard
val snapshotId: String? = null

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

Link copied to clipboard
val tags: List<Tag>? = null

The tags to apply to the volume during creation.

Link copied to clipboard
val throughput: Int? = null

The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is valid only for `gp3` volumes. The default value is 125. Valid Range: Minimum value of 125. Maximum value of 1000.

Link copied to clipboard
val volumeId: String? = null

The ID of the volume.

Link copied to clipboard
val volumeType: String? = null

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