RootVolumeConfiguration
The configuration for the root volume of a capacity provider instance. Specify the amount of free space to guarantee on the root volume. The device name and delete-on-termination settings are fixed and cannot be changed.
Contents
- 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
- freeSpaceGiB
-
The free space guaranteed on the root volume, in GiB. AgentCore adds the operating system overhead on top of this value. The default is 8 GiB.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 65000.
Required: No
- iops
-
The number of IOPS to provision. For
gp3,io1, andio2volumes, this is the number of IOPS provisioned for the volume. Forgp2volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. 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
- throughput
-
The throughput to provision, in MiB/s. Valid only for
gp3volumes. Valid range: 125–2,000 MiB/s.Type: Integer
Valid Range: Minimum value of 125. Maximum value of 2000.
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 | gp3Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: