software.amazon.awscdk.services.ec2

Class IVolume.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.IVolume.Jsii$Proxy

All Implemented Interfaces:

IResource, IResource.Jsii$Default, IVolume, IVolume.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default

Enclosing interface:

IVolume

@Internal
public static final class IVolume.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IVolume.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
String	getAvailabilityZone() The availability zone that the EBS Volume is contained within (ex: us-west-2a).
IKey	getEncryptionKey() The customer-managed encryption key that is used to encrypt the Volume.
ResourceEnvironment	getEnv() The environment this resource belongs to.
software.constructs.Node	getNode() The tree node.
Stack	getStack() The stack in which this resource is defined.
String	getVolumeId() The EBS Volume's ID.
Grant	grantAttachVolume(IGrantable grantee) Grants permission to attach this Volume to an instance.
Grant	grantAttachVolume(IGrantable grantee, List<IInstance> instances) Grants permission to attach this Volume to an instance.
Grant	grantAttachVolumeByResourceTag(IGrantable grantee, List<software.constructs.Construct> constructs) Grants permission to attach the Volume by a ResourceTag condition.
Grant	grantAttachVolumeByResourceTag(IGrantable grantee, List<software.constructs.Construct> constructs, String tagKeySuffix) Grants permission to attach the Volume by a ResourceTag condition.
Grant	grantDetachVolume(IGrantable grantee) 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) 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) Grants permission to detach the Volume by a ResourceTag condition.
Grant	grantDetachVolumeByResourceTag(IGrantable grantee, List<software.constructs.Construct> constructs, String tagKeySuffix) Grants permission to detach the Volume by a ResourceTag condition.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
public final software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IVolume.Jsii$Default

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
public final ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IVolume.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IVolume.Jsii$Default

getAvailabilityZone

@Stability(value=Stable)
 @NotNull
public final String getAvailabilityZone()

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

Specified by:

getAvailabilityZone in interface IVolume

Specified by:

getAvailabilityZone in interface IVolume.Jsii$Default

getVolumeId

@Stability(value=Stable)
 @NotNull
public final String getVolumeId()

The EBS Volume's ID.

Specified by:

getVolumeId in interface IVolume

Specified by:

getVolumeId in interface IVolume.Jsii$Default

getEncryptionKey

@Stability(value=Stable)
 @Nullable
public final IKey getEncryptionKey()

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

Specified by:

getEncryptionKey in interface IVolume

Specified by:

getEncryptionKey in interface IVolume.Jsii$Default

applyRemovalPolicy

@Stability(value=Stable)
public final void applyRemovalPolicy(@NotNull
                                                              RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IVolume.Jsii$Default

Parameters:

policy - This parameter is required.

grantAttachVolume

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

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

Specified by:

grantAttachVolume in interface IVolume.Jsii$Default

Parameters:

grantee - the principal being granted permission. This parameter is required.

instances - the instances to which permission is being granted to attach this volume to.

grantAttachVolume

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

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 - the principal being granted permission. This parameter is required.

grantAttachVolumeByResourceTag

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

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

Specified by:

grantAttachVolumeByResourceTag in interface IVolume.Jsii$Default

Parameters:

grantee - the principal being granted permission. This parameter is required.

constructs - The list of constructs that will have the generated resource tag applied to them. This parameter is required.

tagKeySuffix - A suffix to use on the generated Tag key in place of the generated hash value.

grantAttachVolumeByResourceTag

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

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 - the principal being granted permission. This parameter is required.

constructs - The list of constructs that will have the generated resource tag applied to them. This parameter is required.

grantDetachVolume

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

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

Specified by:

grantDetachVolume in interface IVolume.Jsii$Default

Parameters:

grantee - the principal being granted permission. This parameter is required.

instances - the instances to which permission is being granted to detach this volume from.

grantDetachVolume

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

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 - the principal being granted permission. This parameter is required.

grantDetachVolumeByResourceTag

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

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

Specified by:

grantDetachVolumeByResourceTag in interface IVolume.Jsii$Default

Parameters:

grantee - the principal being granted permission. This parameter is required.

constructs - The list of constructs that will have the generated resource tag applied to them. This parameter is required.

tagKeySuffix - A suffix to use on the generated Tag key in place of the generated hash value.

grantDetachVolumeByResourceTag

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

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 - the principal being granted permission. This parameter is required.

constructs - The list of constructs that will have the generated resource tag applied to them. This parameter is required.