Show / Hide Table of Contents

Class VolumeAttributes

Attributes required to import an existing EBS Volume into the Stack.

Inheritance
object
VolumeAttributes
Implements
IVolumeAttributes
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class VolumeAttributes : IVolumeAttributes
Syntax (vb)
Public Class VolumeAttributes Implements IVolumeAttributes
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.KMS;

            Key key;

            var volumeAttributes = new VolumeAttributes {
                AvailabilityZone = "availabilityZone",
                VolumeId = "volumeId",

                // the properties below are optional
                EncryptionKey = key
            };

Synopsis

Constructors

VolumeAttributes()

Attributes required to import an existing EBS Volume into the Stack.

Properties

AvailabilityZone

The availability zone that the EBS Volume is contained within (ex: us-west-2a).

EncryptionKey

The customer-managed encryption key that is used to encrypt the Volume.

VolumeId

The EBS Volume's ID.

Constructors

VolumeAttributes()

Attributes required to import an existing EBS Volume into the Stack.

public VolumeAttributes()
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.KMS;

            Key key;

            var volumeAttributes = new VolumeAttributes {
                AvailabilityZone = "availabilityZone",
                VolumeId = "volumeId",

                // the properties below are optional
                EncryptionKey = key
            };

Properties

AvailabilityZone

The availability zone that the EBS Volume is contained within (ex: us-west-2a).

public string AvailabilityZone { get; set; }
Property Value

string

Remarks

ExampleMetadata: fixture=_generated

EncryptionKey

The customer-managed encryption key that is used to encrypt the Volume.

public IKey? EncryptionKey { get; set; }
Property Value

IKey

Remarks

Default: None -- The EBS Volume is not using a customer-managed KMS key for encryption.

VolumeId

The EBS Volume's ID.

public string VolumeId { get; set; }
Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Implements

IVolumeAttributes
Back to top Generated by DocFX