VolumeState class

Input properties used for looking up and filtering Volume resources.

Constructors

VolumeState({Input<String?>? arn, Input<String?>? availabilityZone, Input<String?>? createTime, Input<bool?>? encrypted, Input<bool?>? finalSnapshot, Input<int?>? iops, Input<String?>? kmsKeyId, Input<bool?>? multiAttachEnabled, Input<String?>? outpostArn, Input<String?>? region, Input<int?>? size, Input<String?>? snapshotId, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<int?>? throughput, Input<String?>? type, Input<int?>? volumeInitializationRate})
Creates a new VolumeState. arn Volume ARN (e.g., arn:aws:ec2:us-east-1:123456789012:volume/vol-59fcb34e). availabilityZone Availability zone where the EBS volume will exist. createTime Timestamp when volume creation was initiated. encrypted If true, the disk will be encrypted. finalSnapshot If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false iops Amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3. kmsKeyId ARN for the KMS encryption key. When specifying kmsKeyId, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted. multiAttachEnabled Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes. outpostArn ARN of the Outpost. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. size Size of the drive in GiBs. snapshotId A snapshot to base the EBS volume off of. tags A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. throughput Throughput that the volume supports, in MiB/s. Only valid for type of gp3. type Type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2). volumeInitializationRate EBS provisioned rate for volume initialization, in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This argument can only be set if snapshotId is specified.
const
VolumeState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
Volume ARN (e.g., arn:aws:ec2:us-east-1:123456789012:volume/vol-59fcb34e).
final
availabilityZone → Input<String?>?
Availability zone where the EBS volume will exist.
final
createTime → Input<String?>?
Timestamp when volume creation was initiated.
final
encrypted → Input<bool?>?
If true, the disk will be encrypted.
final
finalSnapshot → Input<bool?>?
If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false
final
hashCode → int
The hash code for this object.
no setterinherited
iops → Input<int?>?
Amount of IOPS to provision for the disk. Only valid for type of io1, io2 or gp3.
final
kmsKeyId → Input<String?>?
ARN for the KMS encryption key. When specifying kmsKeyId, encrypted needs to be set to true. Note: The provider must be running with credentials which have the GenerateDataKeyWithoutPlaintext permission on the specified KMS key as required by the EBS KMS CMK volume provisioning process to prevent a volume from being created and almost immediately deleted.
final
multiAttachEnabled → Input<bool?>?
Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported on io1 and io2 volumes.
final
outpostArn → Input<String?>?
ARN of the Outpost.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
size → Input<int?>?
Size of the drive in GiBs.
final
snapshotId → Input<String?>?
A snapshot to base the EBS volume off of.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
throughput → Input<int?>?
Throughput that the volume supports, in MiB/s. Only valid for type of gp3.
final
type → Input<String?>?
Type of EBS volume. Can be standard, gp2, gp3, io1, io2, sc1 or st1 (Default: gp2).
final
volumeInitializationRate → Input<int?>?
EBS provisioned rate for volume initialization, in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This argument can only be set if snapshotId is specified.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited