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< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>int?> ? throughput, Input<String?> ? type, Input<int?> ? volumeInitializationRate}) -
Creates a new VolumeState.
arnVolume ARN (e.g., arn:aws:ec2:us-east-1:123456789012:volume/vol-59fcb34e).availabilityZoneAvailability zone where the EBS volume will exist.createTimeTimestamp when volume creation was initiated.encryptedIf true, the disk will be encrypted.finalSnapshotIf true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to falseiopsAmount of IOPS to provision for the disk. Only valid fortypeofio1,io2orgp3.kmsKeyIdARN for the KMS encryption key. When specifyingkmsKeyId,encryptedneeds to be set to true. Note: The provider must be running with credentials which have theGenerateDataKeyWithoutPlaintextpermission 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.multiAttachEnabledSpecifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported onio1andio2volumes.outpostArnARN of the Outpost.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.sizeSize of the drive in GiBs.snapshotIdA snapshot to base the EBS volume off of.tagsA map of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.throughputThroughput that the volume supports, in MiB/s. Only valid fortypeofgp3.typeType of EBS volume. Can bestandard,gp2,gp3,io1,io2,sc1orst1(Default:gp2).volumeInitializationRateEBS 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 ifsnapshotIdis 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
typeofio1,io2orgp3.final -
kmsKeyId
→ Input<
String?> ? -
ARN for the KMS encryption key. When specifying
kmsKeyId,encryptedneeds to be set to true. Note: The provider must be running with credentials which have theGenerateDataKeyWithoutPlaintextpermission 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
io1andio2volumes.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
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
throughput
→ Input<
int?> ? -
Throughput that the volume supports, in MiB/s. Only valid for
typeofgp3.final -
type
→ Input<
String?> ? -
Type of EBS volume. Can be
standard,gp2,gp3,io1,io2,sc1orst1(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
snapshotIdis 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