EphemeralEBSVolumeConfiguration

The shared Amazon EBS performance and encryption properties for a volume. These properties are common across the different volume configurations for a capacity provider.

ebsCardIndex

The index of the Amazon EBS card. Applies to instances with multiple Amazon EBS cards.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

encrypted

Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value.

Type: Boolean

Required: No

iops

The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000.

Type: Integer

Valid Range: Minimum value of 100. Maximum value of 256000.

Required: No

kmsKeyId

The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed AWS KMS key to use for Amazon EBS encryption.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: No

snapshotId

The ID of the snapshot.

Type: String

Length Constraints: Minimum length of 13. Maximum length of 64.

Pattern: snap-[a-f0-9]{8,17}

Required: No

throughput

The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s.

Type: Integer

Valid Range: Minimum value of 125. Maximum value of 2000.

Required: No

volumeInitializationRate

The rate at which the volume is initialized after creation, in MiB/s. Supported only for volumes created from snapshots. Valid range: 100–300 MiB/s.

Type: Integer

Valid Range: Minimum value of 100. Maximum value of 300.

Required: No

volumeSize

The size of the volume, in GiB. You must specify either a snapshot ID or a volume size. Supported sizes: gp2, 1–16,384; gp3, 1–65,536; io1, 4–16,384; io2, 4–65,536.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65536.

Required: No

volumeType

The Amazon EBS volume type. If you do not specify a type, the default is gp3.

Type: String

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

Required: No

EphemeralEBSVolumeConfiguration

Contents

See Also