EbsVolume
A resource of the AWS provider, version 0.3.0, in its Storage group. Import it with:
import EbsVolume from "aws/storage"Example
resource EbsVolume example {
availabilityZone = "example-value"
size = 3.14
volumeType = "gp3"
iops = 3.14
throughput = 3.14
encrypted = false
kmsKeyId = "example-value"
snapshotId = "example-value"
multiAttachEnabled = false
tags = "..."
}Properties
Set by your code in the resource block. A required one must be set; any other you leave out takes the value under Default, if it has one.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
availabilityZone | string | — | No | The Availability Zone in which to create the volume |
size | number | — | No | The size of the volume in GiBs |
volumeType | string | "gp3" | No | The volume type Allowed: "gp2", "gp3", "io1", "io2", "st1", "sc1", "standard" |
iops | number | — | No | The number of I/O operations per second (IOPS) |
throughput | number | — | No | The throughput in MiB/s. Only valid for gp3 volumes |
encrypted | boolean | false | No | Whether the volume should be encrypted |
kmsKeyId | string | — | No | The ARN of the KMS key to use for encryption |
snapshotId | string | — | No | The snapshot ID to create the volume from |
multiAttachEnabled | boolean | false | No | Enable Multi-Attach for io1/io2 volumes |
tags | object | — | No | Tags to apply to the volume |
Set by AWS after the resource is created: your code can read them but not set them. An importable one identifies an existing resource.
| Name | Type | Importable | Description |
|---|---|---|---|
volumeId | string | No | The volume ID assigned by AWS |
arn | string | Yes | The Amazon Resource Name (ARN) of the volume |
state | string | No | The current state of the volume |
createTime | string | No | The time the volume was created |
attachments | string | No | Information about the volume attachments |