class CfnVolume (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.CfnVolume |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnVolume |
![]() | software.amazon.awscdk.services.ec2.CfnVolume |
![]() | aws_cdk.aws_ec2.CfnVolume |
![]() | aws-cdk-lib » aws_ec2 » CfnVolume |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Specifies an Amazon Elastic Block Store (Amazon EBS) volume.
When you use AWS CloudFormation to update an Amazon EBS volume that modifies Iops
, Size
, or VolumeType
, there is a cooldown period before another operation can occur. This can cause your stack to report being in UPDATE_IN_PROGRESS
or UPDATE_ROLLBACK_IN_PROGRESS
for long periods of time.
Amazon EBS does not support sizing down an Amazon EBS volume. AWS CloudFormation does not attempt to modify an Amazon EBS volume to a smaller size on rollback.
Some common scenarios when you might encounter a cooldown period for Amazon EBS include:
- You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.
- You successfully update an Amazon EBS volume and the update succeeds but another change in your
update-stack
call fails. The rollback will be subject to a cooldown period.
For more information, see Requirements for EBS volume modifications .
DeletionPolicy attribute
To control how AWS CloudFormation handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to retain the volume, to delete the volume, or to create a snapshot of the volume. For more information, see DeletionPolicy attribute .
If you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnVolume = new ec2.CfnVolume(this, 'MyCfnVolume', {
availabilityZone: 'availabilityZone',
// the properties below are optional
autoEnableIo: false,
encrypted: false,
iops: 123,
kmsKeyId: 'kmsKeyId',
multiAttachEnabled: false,
outpostArn: 'outpostArn',
size: 123,
snapshotId: 'snapshotId',
tags: [{
key: 'key',
value: 'value',
}],
throughput: 123,
volumeType: 'volumeType',
});
Initializer
new CfnVolume(scope: Construct, id: string, props: CfnVolumeProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Volume Props
Construct Props
Name | Type | Description |
---|---|---|
availability | string | The ID of the Availability Zone in which to create the volume. |
auto | boolean | IResolvable | Indicates whether the volume is auto-enabled for I/O operations. |
encrypted? | boolean | IResolvable | Indicates whether the volume should be encrypted. |
iops? | number | The number of I/O operations per second (IOPS). |
kms | string | The identifier of the AWS KMS key to use for Amazon EBS encryption. |
multi | boolean | IResolvable | Indicates whether Amazon EBS Multi-Attach is enabled. |
outpost | string | The Amazon Resource Name (ARN) of the Outpost. |
size? | number | The size of the volume, in GiBs. |
snapshot | string | The snapshot from which to create the volume. |
tags? | Cfn [] | The tags to apply to the volume during creation. |
throughput? | number | The throughput to provision for a volume, with a maximum of 1,000 MiB/s. |
volume | string | The volume type. This parameter can be one of the following values:. |
availabilityZone
Type:
string
The ID of the Availability Zone in which to create the volume.
For example, us-east-1a
.
autoEnableIo?
Type:
boolean |
IResolvable
(optional)
Indicates whether the volume is auto-enabled for I/O operations.
By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
encrypted?
Type:
boolean |
IResolvable
(optional)
Indicates whether the volume should be encrypted.
The effect of setting the encryption state to true
depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon EBS User Guide .
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
iops?
Type:
number
(optional)
The number of I/O operations per second (IOPS).
For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3
: 3,000 - 16,000 IOPSio1
: 100 - 64,000 IOPSio2
: 100 - 256,000 IOPS
For io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System . On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1
and io2
volumes. The default for gp3
volumes is 3,000 IOPS. This parameter is not supported for gp2
, st1
, sc1
, or standard
volumes.
kmsKeyId?
Type:
string
(optional)
The identifier of the AWS KMS key to use for Amazon EBS encryption.
If KmsKeyId
is specified, the encrypted state must be true
.
If you omit this property and your account is enabled for encryption by default, or Encrypted is set to true
, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the AWS managed key .
Alternatively, if you want to specify a different key, you can specify one of the following:
- Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
- Key alias. Specify the alias for the key, prefixed with
alias/
. For example, for a key with the aliasmy_cmk
, usealias/my_cmk
. Or to specify the AWS managed key , usealias/aws/ebs
. - Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
- Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
multiAttachEnabled?
Type:
boolean |
IResolvable
(optional)
Indicates whether Amazon EBS Multi-Attach is enabled.
AWS CloudFormation does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
outpostArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the Outpost.
size?
Type:
number
(optional)
The size of the volume, in GiBs.
You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2
andgp3
: 1 - 16,384 GiBio1
: 4 - 16,384 GiBio2
: 4 - 65,536 GiBst1
andsc1
: 125 - 16,384 GiBstandard
: 1 - 1024 GiB
snapshotId?
Type:
string
(optional)
The snapshot from which to create the volume.
You must specify either a snapshot ID or a volume size.
tags?
Type:
Cfn
[]
(optional)
The tags to apply to the volume during creation.
throughput?
Type:
number
(optional)
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3
volumes. The default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
volumeType?
Type:
string
(optional)
The volume type. This parameter can be one of the following values:.
- General Purpose SSD:
gp2
|gp3
- Provisioned IOPS SSD:
io1
|io2
- Throughput Optimized HDD:
st1
- Cold HDD:
sc1
- Magnetic:
standard
For more information, see Amazon EBS volume types .
Default: gp2
Properties
Name | Type | Description |
---|---|---|
attr | string | The ID of the volume. |
availability | string | The ID of the Availability Zone in which to create the volume. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
auto | boolean | IResolvable | Indicates whether the volume is auto-enabled for I/O operations. |
encrypted? | boolean | IResolvable | Indicates whether the volume should be encrypted. |
iops? | number | The number of I/O operations per second (IOPS). |
kms | string | The identifier of the AWS KMS key to use for Amazon EBS encryption. |
multi | boolean | IResolvable | Indicates whether Amazon EBS Multi-Attach is enabled. |
outpost | string | The Amazon Resource Name (ARN) of the Outpost. |
size? | number | The size of the volume, in GiBs. |
snapshot | string | The snapshot from which to create the volume. |
tags | Cfn [] | The tags to apply to the volume during creation. |
throughput? | number | The throughput to provision for a volume, with a maximum of 1,000 MiB/s. |
volume | string | The volume type. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrVolumeId
Type:
string
The ID of the volume.
availabilityZone
Type:
string
The ID of the Availability Zone in which to create the volume.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
autoEnableIo?
Type:
boolean |
IResolvable
(optional)
Indicates whether the volume is auto-enabled for I/O operations.
encrypted?
Type:
boolean |
IResolvable
(optional)
Indicates whether the volume should be encrypted.
iops?
Type:
number
(optional)
The number of I/O operations per second (IOPS).
kmsKeyId?
Type:
string
(optional)
The identifier of the AWS KMS key to use for Amazon EBS encryption.
multiAttachEnabled?
Type:
boolean |
IResolvable
(optional)
Indicates whether Amazon EBS Multi-Attach is enabled.
outpostArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the Outpost.
size?
Type:
number
(optional)
The size of the volume, in GiBs.
snapshotId?
Type:
string
(optional)
The snapshot from which to create the volume.
tagsRaw?
Type:
Cfn
[]
(optional)
The tags to apply to the volume during creation.
throughput?
Type:
number
(optional)
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
volumeType?
Type:
string
(optional)
The volume type.
This parameter can be one of the following values:.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
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
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }