ReadonlyavailabilityOptional ReadonlyencryptionReadonlyenvThe 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.
ReadonlynodeThe tree node.
Protected ReadonlyphysicalReturns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationReadonlystackThe stack in which this resource is defined.
ReadonlyvolumeStatic ReadonlyPROPERTY_Uniquely identifies this class.
A reference to a Volume resource.
InternalCalled when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
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).
ProtectedgenerateProtectedgetReturns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName in arnComponents.
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes
it's the CFN resource's ref.
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
ProtectedgetReturns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
The CFN attribute which resolves to the resource's name.
Commonly this is the resource's ref.
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 IVolume.grantAttachVolumeToSelf to grant an instance permission to attach this
volume to itself.
the principal being granted permission.
Optionalinstances: IInstanceRef[]the instances to which permission is being granted to attach this volume to. If not specified, then permission is granted to attach to all instances in this account.
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.
the principal being granted permission.
The list of constructs that will have the generated resource tag applied to them.
OptionaltagKeySuffix: stringA suffix to use on the generated Tag key in place of the generated hash value. Defaults to a hash calculated from this volume and list of constructs. (DEPRECATED)
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 IVolume.grantDetachVolumeFromSelf to grant an instance permission to detach this
volume from itself.
the principal being granted permission.
Optionalinstances: IInstanceRef[]the instances to which permission is being granted to detach this volume from. If not specified, then permission is granted to detach from all instances in this account.
Grants permission to detach the Volume by a ResourceTag condition.
This is implemented via the same mechanism as IVolume.grantAttachVolumeByResourceTag,
and is subject to the same conditions.
the principal being granted permission.
The list of constructs that will have the generated resource tag applied to them.
OptionaltagKeySuffix: stringA suffix to use on the generated Tag key in place of the generated hash value. Defaults to a hash calculated from this volume and list of constructs. (DEPRECATED)
Returns a string representation of this construct.
ProtectedvalidateStaticfromImport an existing EBS Volume into the Stack.
the scope of the import.
the ID of the imported Volume in the construct tree.
the attributes of the imported Volume
StaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturns true if the construct was created by CDK, and false otherwise
StaticisCheck whether the given construct is a Resource
A construct for creating a compliant EBS volume resource. Specifically, the construct ensures that the EBS volume is encrypted.