AWS Cloud Control v1.27.0, Apr 14 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.ec2.getVolume

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

When you use AWS CloudFormation to update an Amazon EBS volume that modifies Iops , Size , or VolumeType , there is a cooldown period before another operation can occur. This can cause your stack to report being in UPDATE_IN_PROGRESS or UPDATE_ROLLBACK_IN_PROGRESS for long periods of time.

Amazon EBS does not support sizing down an Amazon EBS volume. AWS CloudFormation does not attempt to modify an Amazon EBS volume to a smaller size on rollback.

Some common scenarios when you might encounter a cooldown period for Amazon EBS include:

You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.
You successfully update an Amazon EBS volume and the update succeeds but another change in your update-stack call fails. The rollback will be subject to a cooldown period.

For more information, see Requirements for EBS volume modifications .

DeletionPolicy attribute

To control how AWS CloudFormation handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to retain the volume, to delete the volume, or to create a snapshot of the volume. For more information, see DeletionPolicy attribute .

If you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot.

Using getVolume

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
function getVolumeOutput(args: GetVolumeOutputArgs, opts?: InvokeOptions): Output<GetVolumeResult>

def get_volume(volume_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(volume_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]

func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput

> Note: This function is named LookupVolume in the Go SDK.

public static class GetVolume 
{
    public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:ec2:getVolume
  arguments:
    # arguments dictionary

The following arguments are supported:

VolumeId string: The ID of the volume.

VolumeId string: The ID of the volume.

volumeId String: The ID of the volume.

volumeId string: The ID of the volume.

volume_id str: The ID of the volume.

volumeId String: The ID of the volume.

getVolume Result

The following output properties are available:

AutoEnableIo bool

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.

AvailabilityZone string

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

Encrypted bool

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.

Iops int

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:

gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.

KmsKeyId string

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:

Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. Specify the alias for the key, prefixed with alias/. For example, for a key with the alias my_cmk, use alias/my_cmk. Or to specify the aws-managed-key, use alias/aws/ebs.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

MultiAttachEnabled bool

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.

OutpostArn string

The Amazon Resource Name (ARN) of the Outpost.

Size int

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:

gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB

SnapshotId string

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

Tags List<Pulumi.AwsNative.Outputs.Tag>

The tags to apply to the volume during creation.

Throughput int

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.

VolumeId string

The ID of the volume.

VolumeType string

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

General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard

For more information, see Amazon EBS volume types. Default: gp2

AutoEnableIo bool

AvailabilityZone string

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

Encrypted bool

Iops int

gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS

KmsKeyId string

Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. Specify the alias for the key, prefixed with alias/. For example, for a key with the alias my_cmk, use alias/my_cmk. Or to specify the aws-managed-key, use alias/aws/ebs.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

MultiAttachEnabled bool

OutpostArn string

The Amazon Resource Name (ARN) of the Outpost.

Size int

gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB

SnapshotId string

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

Tags Tag

The tags to apply to the volume during creation.

Throughput int

VolumeId string

The ID of the volume.

VolumeType string

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

General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard

For more information, see Amazon EBS volume types. Default: gp2

autoEnableIo Boolean

availabilityZone String

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

encrypted Boolean

iops Integer

gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS

kmsKeyId String

Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. Specify the alias for the key, prefixed with alias/. For example, for a key with the alias my_cmk, use alias/my_cmk. Or to specify the aws-managed-key, use alias/aws/ebs.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

multiAttachEnabled Boolean

outpostArn String

The Amazon Resource Name (ARN) of the Outpost.

size Integer

gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB

snapshotId String

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

tags List<Tag>

The tags to apply to the volume during creation.

throughput Integer

volumeId String

The ID of the volume.

volumeType String

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

General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard

For more information, see Amazon EBS volume types. Default: gp2

autoEnableIo boolean

availabilityZone string

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

encrypted boolean

iops number

gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS

kmsKeyId string

Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. Specify the alias for the key, prefixed with alias/. For example, for a key with the alias my_cmk, use alias/my_cmk. Or to specify the aws-managed-key, use alias/aws/ebs.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

multiAttachEnabled boolean

outpostArn string

The Amazon Resource Name (ARN) of the Outpost.

size number

gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB

snapshotId string

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

tags Tag[]

The tags to apply to the volume during creation.

throughput number

volumeId string

The ID of the volume.

volumeType string

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

General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard

For more information, see Amazon EBS volume types. Default: gp2

auto_enable_io bool

availability_zone str

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

encrypted bool

iops int

gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS

kms_key_id str

Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. Specify the alias for the key, prefixed with alias/. For example, for a key with the alias my_cmk, use alias/my_cmk. Or to specify the aws-managed-key, use alias/aws/ebs.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

multi_attach_enabled bool

outpost_arn str

The Amazon Resource Name (ARN) of the Outpost.

size int

gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB

snapshot_id str

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

tags Sequence[root_Tag]

The tags to apply to the volume during creation.

throughput int

volume_id str

The ID of the volume.

volume_type str

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

General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard

For more information, see Amazon EBS volume types. Default: gp2

autoEnableIo Boolean

availabilityZone String

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

encrypted Boolean

iops Number

gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS

kmsKeyId String

Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. Specify the alias for the key, prefixed with alias/. For example, for a key with the alias my_cmk, use alias/my_cmk. Or to specify the aws-managed-key, use alias/aws/ebs.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

multiAttachEnabled Boolean

outpostArn String