software.amazon.awscdk.services.ec2

Class Volume

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ec2.Volume

All Implemented Interfaces:

IResource, IVolume, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:17.127Z")
 @Stability(value=Experimental)
public class Volume
extends Resource
implements IVolume

(experimental) Creates a new EBS Volume in AWS EC2.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Volume.Builder (experimental) A fluent builder for Volume.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IVolume

IVolume.Jsii$Default, IVolume.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Volume(software.constructs.Construct scope, String id, VolumeProps props)
protected	Volume(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Volume(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IVolume	fromVolumeAttributes(software.constructs.Construct scope, String id, VolumeAttributes attrs) (experimental) Import an existing EBS Volume into the Stack.
String	getAvailabilityZone() (experimental) The availability zone that the EBS Volume is contained within (ex: us-west-2a).
IKey	getEncryptionKey() (experimental) The customer-managed encryption key that is used to encrypt the Volume.
String	getVolumeId() (experimental) The EBS Volume's ID.
Grant	grantAttachVolume(IGrantable grantee) (experimental) Grants permission to attach this Volume to an instance.
Grant	grantAttachVolume(IGrantable grantee, List<IInstance> instances) (experimental) Grants permission to attach this Volume to an instance.
Grant	grantAttachVolumeByResourceTag(IGrantable grantee, List<software.constructs.Construct> constructs) (experimental) Grants permission to attach the Volume by a ResourceTag condition.
Grant	grantAttachVolumeByResourceTag(IGrantable grantee, List<software.constructs.Construct> constructs, String tagKeySuffix) (experimental) Grants permission to attach the Volume by a ResourceTag condition.
Grant	grantDetachVolume(IGrantable grantee) (experimental) Grants permission to detach this Volume from an instance CAUTION: Granting an instance permission to detach from itself using this method will lead to an unresolvable circular reference between the instance role and the instance.
Grant	grantDetachVolume(IGrantable grantee, List<IInstance> instances) (experimental) Grants permission to detach this Volume from an instance CAUTION: Granting an instance permission to detach from itself using this method will lead to an unresolvable circular reference between the instance role and the instance.
Grant	grantDetachVolumeByResourceTag(IGrantable grantee, List<software.constructs.Construct> constructs) (experimental) Grants permission to detach the Volume by a ResourceTag condition.
Grant	grantDetachVolumeByResourceTag(IGrantable grantee, List<software.constructs.Construct> constructs, String tagKeySuffix) (experimental) Grants permission to detach the Volume by a ResourceTag condition.
protected void	validateProps(VolumeProps props)

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Volume

protected Volume(software.amazon.jsii.JsiiObjectRef objRef)

Volume

protected Volume(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Volume

@Stability(value=Experimental)
public Volume(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             VolumeProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromVolumeAttributes

@Stability(value=Experimental)
 @NotNull
public static IVolume fromVolumeAttributes(@NotNull
                                                                                    software.constructs.Construct scope,
                                                                                    @NotNull
                                                                                    String id,
                                                                                    @NotNull
                                                                                    VolumeAttributes attrs)

(experimental) Import an existing EBS Volume into the Stack.

Parameters:

scope - the scope of the import. This parameter is required.

id - the ID of the imported Volume in the construct tree. This parameter is required.

attrs - the attributes of the imported Volume. This parameter is required.

grantAttachVolume

@Stability(value=Experimental)
 @NotNull
public Grant grantAttachVolume(@NotNull
                                                                        IGrantable grantee,
                                                                        @Nullable
                                                                        List<IInstance> instances)

(experimental) Grants permission to attach this Volume to an instance.

CAUTION: Granting an instance permission to attach to itself using this method will lead to an unresolvable circular reference between the instance role and the instance. Use {@link IVolume.grantAttachVolumeToSelf} to grant an instance permission to attach this volume to itself.

Specified by:

grantAttachVolume in interface IVolume

Parameters:

grantee - This parameter is required.

instances -

grantAttachVolume

@Stability(value=Experimental)
 @NotNull
public Grant grantAttachVolume(@NotNull
                                                                        IGrantable grantee)

(experimental) Grants permission to attach this Volume to an instance.

CAUTION: Granting an instance permission to attach to itself using this method will lead to an unresolvable circular reference between the instance role and the instance. Use {@link IVolume.grantAttachVolumeToSelf} to grant an instance permission to attach this volume to itself.

Specified by:

grantAttachVolume in interface IVolume

Parameters:

grantee - This parameter is required.

grantAttachVolumeByResourceTag

@Stability(value=Experimental)
 @NotNull
public Grant grantAttachVolumeByResourceTag(@NotNull
                                                                                     IGrantable grantee,
                                                                                     @NotNull
                                                                                     List<software.constructs.Construct> constructs,
                                                                                     @Nullable
                                                                                     String tagKeySuffix)

(experimental) Grants permission to attach the Volume by a ResourceTag condition.

If you are looking to grant an Instance, AutoScalingGroup, EC2-Fleet, SpotFleet, ECS host, etc the ability to attach this volume to itself then this is the method you want to use.

This is implemented by adding a Tag with key VolumeGrantAttach-<suffix> to the given constructs and this Volume, and then conditioning the Grant such that the grantee is only given the ability to AttachVolume if both the Volume and the destination Instance have that tag applied to them.

Specified by:

grantAttachVolumeByResourceTag in interface IVolume

Parameters:

grantee - This parameter is required.

constructs - This parameter is required.

tagKeySuffix -

grantAttachVolumeByResourceTag

@Stability(value=Experimental)
 @NotNull
public Grant grantAttachVolumeByResourceTag(@NotNull
                                                                                     IGrantable grantee,
                                                                                     @NotNull
                                                                                     List<software.constructs.Construct> constructs)

(experimental) Grants permission to attach the Volume by a ResourceTag condition.

If you are looking to grant an Instance, AutoScalingGroup, EC2-Fleet, SpotFleet, ECS host, etc the ability to attach this volume to itself then this is the method you want to use.

This is implemented by adding a Tag with key VolumeGrantAttach-<suffix> to the given constructs and this Volume, and then conditioning the Grant such that the grantee is only given the ability to AttachVolume if both the Volume and the destination Instance have that tag applied to them.

Specified by:

grantAttachVolumeByResourceTag in interface IVolume

Parameters:

grantee - This parameter is required.

constructs - This parameter is required.

grantDetachVolume

@Stability(value=Experimental)
 @NotNull
public Grant grantDetachVolume(@NotNull
                                                                        IGrantable grantee,
                                                                        @Nullable
                                                                        List<IInstance> instances)

(experimental) Grants permission to detach this Volume from an instance CAUTION: Granting an instance permission to detach from itself using this method will lead to an unresolvable circular reference between the instance role and the instance.

Use {@link IVolume.grantDetachVolumeFromSelf} to grant an instance permission to detach this volume from itself.

Specified by:

grantDetachVolume in interface IVolume

Parameters:

grantee - This parameter is required.

instances -

grantDetachVolume

@Stability(value=Experimental)
 @NotNull
public Grant grantDetachVolume(@NotNull
                                                                        IGrantable grantee)

(experimental) Grants permission to detach this Volume from an instance CAUTION: Granting an instance permission to detach from itself using this method will lead to an unresolvable circular reference between the instance role and the instance.

Use {@link IVolume.grantDetachVolumeFromSelf} to grant an instance permission to detach this volume from itself.

Specified by:

grantDetachVolume in interface IVolume

Parameters:

grantee - This parameter is required.

grantDetachVolumeByResourceTag

@Stability(value=Experimental)
 @NotNull
public Grant grantDetachVolumeByResourceTag(@NotNull
                                                                                     IGrantable grantee,
                                                                                     @NotNull
                                                                                     List<software.constructs.Construct> constructs,
                                                                                     @Nullable
                                                                                     String tagKeySuffix)

(experimental) Grants permission to detach the Volume by a ResourceTag condition.

This is implemented via the same mechanism as {@link IVolume.grantAttachVolumeByResourceTag}, and is subject to the same conditions.

Specified by:

grantDetachVolumeByResourceTag in interface IVolume

Parameters:

grantee - This parameter is required.

constructs - This parameter is required.

tagKeySuffix -

grantDetachVolumeByResourceTag

@Stability(value=Experimental)
 @NotNull
public Grant grantDetachVolumeByResourceTag(@NotNull
                                                                                     IGrantable grantee,
                                                                                     @NotNull
                                                                                     List<software.constructs.Construct> constructs)

(experimental) Grants permission to detach the Volume by a ResourceTag condition.

This is implemented via the same mechanism as {@link IVolume.grantAttachVolumeByResourceTag}, and is subject to the same conditions.

Specified by:

grantDetachVolumeByResourceTag in interface IVolume

Parameters:

grantee - This parameter is required.

constructs - This parameter is required.

validateProps

@Stability(value=Experimental)
protected void validateProps(@NotNull
                                                            VolumeProps props)

Parameters:

props - This parameter is required.

getAvailabilityZone

@Stability(value=Experimental)
 @NotNull
public String getAvailabilityZone()

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

Specified by:

getAvailabilityZone in interface IVolume

getVolumeId

@Stability(value=Experimental)
 @NotNull
public String getVolumeId()

(experimental) The EBS Volume's ID.

Specified by:

getVolumeId in interface IVolume

getEncryptionKey

@Stability(value=Experimental)
 @Nullable
public IKey getEncryptionKey()

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

Specified by:

getEncryptionKey in interface IVolume