software.amazon.awscdk.services.ec2

Interface VolumeAttributes

All Known Implementing Classes:

VolumeAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:59.606Z")
public interface VolumeAttributes

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.kms.*;
 Key key;
 VolumeAttributes volumeAttributes = VolumeAttributes.builder()
         .availabilityZone("availabilityZone")
         .volumeId("volumeId")
         // the properties below are optional
         .encryptionKey(key)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VolumeAttributes.Builder A builder for VolumeAttributes
static class	VolumeAttributes.Jsii$Proxy An implementation for VolumeAttributes

Method Summary

Modifier and Type	Method and Description
static VolumeAttributes.Builder	builder()
java.lang.String	getAvailabilityZone() The availability zone that the EBS Volume is contained within (ex: us-west-2a).
default IKey	getEncryptionKey() The customer-managed encryption key that is used to encrypt the Volume.
java.lang.String	getVolumeId() The EBS Volume's ID.

Method Detail

getAvailabilityZone

java.lang.String getAvailabilityZone()

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

getVolumeId

java.lang.String getVolumeId()

The EBS Volume's ID.

getEncryptionKey

default IKey getEncryptionKey()

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

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

builder

static VolumeAttributes.Builder builder()

Returns:

a VolumeAttributes.Builder of VolumeAttributes