1. Packages
  2. AWS Classic
  3. API Docs
  4. ebs
  5. Volume

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.37.1 published on Friday, May 24, 2024 by Pulumi

aws.ebs.Volume

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.37.1 published on Friday, May 24, 2024 by Pulumi

    Manages a single EBS volume.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.ebs.Volume("example", {
        availabilityZone: "us-west-2a",
        size: 40,
        tags: {
            Name: "HelloWorld",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.ebs.Volume("example",
        availability_zone="us-west-2a",
        size=40,
        tags={
            "Name": "HelloWorld",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ebs"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ebs.NewVolume(ctx, "example", &ebs.VolumeArgs{
    			AvailabilityZone: pulumi.String("us-west-2a"),
    			Size:             pulumi.Int(40),
    			Tags: pulumi.StringMap{
    				"Name": pulumi.String("HelloWorld"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Ebs.Volume("example", new()
        {
            AvailabilityZone = "us-west-2a",
            Size = 40,
            Tags = 
            {
                { "Name", "HelloWorld" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ebs.Volume;
    import com.pulumi.aws.ebs.VolumeArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Volume("example", VolumeArgs.builder()
                .availabilityZone("us-west-2a")
                .size(40)
                .tags(Map.of("Name", "HelloWorld"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:ebs:Volume
        properties:
          availabilityZone: us-west-2a
          size: 40
          tags:
            Name: HelloWorld
    

    NOTE: At least one of size or snapshot_id is required when specifying an EBS volume

    Create Volume Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);
    @overload
    def Volume(resource_name: str,
               args: VolumeArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Volume(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               availability_zone: Optional[str] = None,
               encrypted: Optional[bool] = None,
               final_snapshot: Optional[bool] = None,
               iops: Optional[int] = None,
               kms_key_id: Optional[str] = None,
               multi_attach_enabled: Optional[bool] = None,
               outpost_arn: Optional[str] = None,
               size: Optional[int] = None,
               snapshot_id: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               throughput: Optional[int] = None,
               type: Optional[str] = None)
    func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
    public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
    public Volume(String name, VolumeArgs args)
    public Volume(String name, VolumeArgs args, CustomResourceOptions options)
    
    type: aws:ebs:Volume
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var volumeResource = new Aws.Ebs.Volume("volumeResource", new()
    {
        AvailabilityZone = "string",
        Encrypted = false,
        FinalSnapshot = false,
        Iops = 0,
        KmsKeyId = "string",
        MultiAttachEnabled = false,
        OutpostArn = "string",
        Size = 0,
        SnapshotId = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Throughput = 0,
        Type = "string",
    });
    
    example, err := ebs.NewVolume(ctx, "volumeResource", &ebs.VolumeArgs{
    	AvailabilityZone:   pulumi.String("string"),
    	Encrypted:          pulumi.Bool(false),
    	FinalSnapshot:      pulumi.Bool(false),
    	Iops:               pulumi.Int(0),
    	KmsKeyId:           pulumi.String("string"),
    	MultiAttachEnabled: pulumi.Bool(false),
    	OutpostArn:         pulumi.String("string"),
    	Size:               pulumi.Int(0),
    	SnapshotId:         pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Throughput: pulumi.Int(0),
    	Type:       pulumi.String("string"),
    })
    
    var volumeResource = new Volume("volumeResource", VolumeArgs.builder()        
        .availabilityZone("string")
        .encrypted(false)
        .finalSnapshot(false)
        .iops(0)
        .kmsKeyId("string")
        .multiAttachEnabled(false)
        .outpostArn("string")
        .size(0)
        .snapshotId("string")
        .tags(Map.of("string", "string"))
        .throughput(0)
        .type("string")
        .build());
    
    volume_resource = aws.ebs.Volume("volumeResource",
        availability_zone="string",
        encrypted=False,
        final_snapshot=False,
        iops=0,
        kms_key_id="string",
        multi_attach_enabled=False,
        outpost_arn="string",
        size=0,
        snapshot_id="string",
        tags={
            "string": "string",
        },
        throughput=0,
        type="string")
    
    const volumeResource = new aws.ebs.Volume("volumeResource", {
        availabilityZone: "string",
        encrypted: false,
        finalSnapshot: false,
        iops: 0,
        kmsKeyId: "string",
        multiAttachEnabled: false,
        outpostArn: "string",
        size: 0,
        snapshotId: "string",
        tags: {
            string: "string",
        },
        throughput: 0,
        type: "string",
    });
    
    type: aws:ebs:Volume
    properties:
        availabilityZone: string
        encrypted: false
        finalSnapshot: false
        iops: 0
        kmsKeyId: string
        multiAttachEnabled: false
        outpostArn: string
        size: 0
        snapshotId: string
        tags:
            string: string
        throughput: 0
        type: string
    

    Volume Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Volume resource accepts the following input properties:

    AvailabilityZone string
    The AZ where the EBS volume will exist.
    Encrypted bool
    If true, the disk will be encrypted.
    FinalSnapshot bool
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    Iops int
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    KmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    MultiAttachEnabled bool
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    OutpostArn string
    The Amazon Resource Name (ARN) of the Outpost.
    Size int
    The size of the drive in GiBs.
    SnapshotId string
    A snapshot to base the EBS volume off of.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Throughput int

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    Type string
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).
    AvailabilityZone string
    The AZ where the EBS volume will exist.
    Encrypted bool
    If true, the disk will be encrypted.
    FinalSnapshot bool
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    Iops int
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    KmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    MultiAttachEnabled bool
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    OutpostArn string
    The Amazon Resource Name (ARN) of the Outpost.
    Size int
    The size of the drive in GiBs.
    SnapshotId string
    A snapshot to base the EBS volume off of.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Throughput int

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    Type string
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).
    availabilityZone String
    The AZ where the EBS volume will exist.
    encrypted Boolean
    If true, the disk will be encrypted.
    finalSnapshot Boolean
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    iops Integer
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    kmsKeyId String
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    multiAttachEnabled Boolean
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    outpostArn String
    The Amazon Resource Name (ARN) of the Outpost.
    size Integer
    The size of the drive in GiBs.
    snapshotId String
    A snapshot to base the EBS volume off of.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    throughput Integer

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    type String
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).
    availabilityZone string
    The AZ where the EBS volume will exist.
    encrypted boolean
    If true, the disk will be encrypted.
    finalSnapshot boolean
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    iops number
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    kmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    multiAttachEnabled boolean
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    outpostArn string
    The Amazon Resource Name (ARN) of the Outpost.
    size number
    The size of the drive in GiBs.
    snapshotId string
    A snapshot to base the EBS volume off of.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    throughput number

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    type string
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).
    availability_zone str
    The AZ where the EBS volume will exist.
    encrypted bool
    If true, the disk will be encrypted.
    final_snapshot bool
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    iops int
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    kms_key_id str
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    multi_attach_enabled bool
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    outpost_arn str
    The Amazon Resource Name (ARN) of the Outpost.
    size int
    The size of the drive in GiBs.
    snapshot_id str
    A snapshot to base the EBS volume off of.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    throughput int

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    type str
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).
    availabilityZone String
    The AZ where the EBS volume will exist.
    encrypted Boolean
    If true, the disk will be encrypted.
    finalSnapshot Boolean
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    iops Number
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    kmsKeyId String
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    multiAttachEnabled Boolean
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    outpostArn String
    The Amazon Resource Name (ARN) of the Outpost.
    size Number
    The size of the drive in GiBs.
    snapshotId String
    A snapshot to base the EBS volume off of.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    throughput Number

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    type String
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:

    Arn string
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Volume Resource

    Get an existing Volume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VolumeState, opts?: CustomResourceOptions): Volume
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            availability_zone: Optional[str] = None,
            encrypted: Optional[bool] = None,
            final_snapshot: Optional[bool] = None,
            iops: Optional[int] = None,
            kms_key_id: Optional[str] = None,
            multi_attach_enabled: Optional[bool] = None,
            outpost_arn: Optional[str] = None,
            size: Optional[int] = None,
            snapshot_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            throughput: Optional[int] = None,
            type: Optional[str] = None) -> Volume
    func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)
    public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)
    public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    AvailabilityZone string
    The AZ where the EBS volume will exist.
    Encrypted bool
    If true, the disk will be encrypted.
    FinalSnapshot bool
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    Iops int
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    KmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    MultiAttachEnabled bool
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    OutpostArn string
    The Amazon Resource Name (ARN) of the Outpost.
    Size int
    The size of the drive in GiBs.
    SnapshotId string
    A snapshot to base the EBS volume off of.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Throughput int

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    Type string
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).
    Arn string
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    AvailabilityZone string
    The AZ where the EBS volume will exist.
    Encrypted bool
    If true, the disk will be encrypted.
    FinalSnapshot bool
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    Iops int
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    KmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    MultiAttachEnabled bool
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    OutpostArn string
    The Amazon Resource Name (ARN) of the Outpost.
    Size int
    The size of the drive in GiBs.
    SnapshotId string
    A snapshot to base the EBS volume off of.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Throughput int

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    Type string
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).
    arn String
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    availabilityZone String
    The AZ where the EBS volume will exist.
    encrypted Boolean
    If true, the disk will be encrypted.
    finalSnapshot Boolean
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    iops Integer
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    kmsKeyId String
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    multiAttachEnabled Boolean
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    outpostArn String
    The Amazon Resource Name (ARN) of the Outpost.
    size Integer
    The size of the drive in GiBs.
    snapshotId String
    A snapshot to base the EBS volume off of.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    throughput Integer

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    type String
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).
    arn string
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    availabilityZone string
    The AZ where the EBS volume will exist.
    encrypted boolean
    If true, the disk will be encrypted.
    finalSnapshot boolean
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    iops number
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    kmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    multiAttachEnabled boolean
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    outpostArn string
    The Amazon Resource Name (ARN) of the Outpost.
    size number
    The size of the drive in GiBs.
    snapshotId string
    A snapshot to base the EBS volume off of.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    throughput number

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    type string
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).
    arn str
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    availability_zone str
    The AZ where the EBS volume will exist.
    encrypted bool
    If true, the disk will be encrypted.
    final_snapshot bool
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    iops int
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    kms_key_id str
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    multi_attach_enabled bool
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    outpost_arn str
    The Amazon Resource Name (ARN) of the Outpost.
    size int
    The size of the drive in GiBs.
    snapshot_id str
    A snapshot to base the EBS volume off of.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    throughput int

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    type str
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).
    arn String
    The volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
    availabilityZone String
    The AZ where the EBS volume will exist.
    encrypted Boolean
    If true, the disk will be encrypted.
    finalSnapshot Boolean
    If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
    iops Number
    The amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
    kmsKeyId String
    The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
    multiAttachEnabled Boolean
    Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
    outpostArn String
    The Amazon Resource Name (ARN) of the Outpost.
    size Number
    The size of the drive in GiBs.
    snapshotId String
    A snapshot to base the EBS volume off of.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    throughput Number

    The throughput that the volume supports, in MiB/s. Only valid for type of gp3.

    NOTE: When changing the size, iops or type of an instance, there are considerations to be aware of.

    type String
    The type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).

    Import

    Using pulumi import, import EBS Volumes using the id. For example:

    $ pulumi import aws:ebs/volume:Volume id vol-049df61146c4d7901
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.37.1 published on Friday, May 24, 2024 by Pulumi