Class Volume

Manages a single EBS volume.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Ebs.Volume("example", new Aws.Ebs.VolumeArgs
    {
        AvailabilityZone = "us-west-2a",
        Size = 40,
        Tags = 
        {
            { "Name", "HelloWorld" },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Volume

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Ebs

Assembly: Pulumi.Aws.dll

Syntax

public class Volume : CustomResource

Constructors

Volume(String, VolumeArgs, CustomResourceOptions)

Create a Volume resource with the given unique name, arguments, and options.

Declaration

public Volume(string name, VolumeArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
VolumeArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

The volume ARN (e.g. arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

AvailabilityZone

The AZ where the EBS volume will exist.

Declaration

public Output<string> AvailabilityZone { get; }

Property Value

Type	Description
Output<System.String>

Encrypted

If true, the disk will be encrypted.

Declaration

public Output<bool> Encrypted { get; }

Property Value

Type	Description
Output<System.Boolean>

Iops

The amount of IOPS to provision for the disk.

Declaration

public Output<int> Iops { get; }

Property Value

Type	Description
Output<System.Int32>

KmsKeyId

The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.

Declaration

public Output<string> KmsKeyId { get; }

Property Value

Type	Description
Output<System.String>

MultiAttachEnabled

Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported exclusively on io1 volumes.

Declaration

public Output<bool?> MultiAttachEnabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

OutpostArn

The Amazon Resource Name (ARN) of the Outpost.

Declaration

public Output<string> OutpostArn { get; }

Property Value

Type	Description
Output<System.String>

Size

The size of the drive in GiBs.

Declaration

public Output<int> Size { get; }

Property Value

Type	Description
Output<System.Int32>

SnapshotId

A snapshot to base the EBS volume off of.

Declaration

public Output<string> SnapshotId { get; }

Property Value

Type	Description
Output<System.String>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Type

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

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, VolumeState, CustomResourceOptions)

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

Declaration

public static Volume Get(string name, Input<string> id, VolumeState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
VolumeState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Volume