VolumeState class

Input properties used for looking up and filtering Volume resources.

Constructors

VolumeState({Input<String?>? activeDirectory, Input<VolumeBackupConfig?>? backupConfig, Input<List<VolumeBlockDevice>?>? blockDevices, Input<VolumeCacheParameters?>? cacheParameters, Input<String?>? capacityGib, Input<String?>? coldTierSizeGib, Input<String?>? createTime, Input<String?>? deletionPolicy, Input<String?>? description, Input<Map<String, String>?>? effectiveLabels, Input<String?>? encryptionType, Input<VolumeExportPolicy?>? exportPolicy, Input<bool?>? hasReplication, Input<String?>? hotTierSizeUsedGib, Input<VolumeHybridReplicationParameters?>? hybridReplicationParameters, Input<bool?>? kerberosEnabled, Input<String?>? kmsConfig, Input<Map<String, String>?>? labels, Input<bool?>? largeCapacity, Input<VolumeLargeCapacityConfig?>? largeCapacityConfig, Input<bool?>? ldapEnabled, Input<String?>? location, Input<List<VolumeMountOption>?>? mountOptions, Input<bool?>? multipleEndpoints, Input<String?>? name, Input<String?>? network, Input<String?>? project, Input<List<String>?>? protocols, Input<String?>? psaRange, Input<Map<String, String>?>? pulumiLabels, Input<String?>? replicaZone, Input<VolumeRestoreParameters?>? restoreParameters, Input<List<String>?>? restrictedActions, Input<String?>? securityStyle, Input<String?>? serviceLevel, Input<String?>? shareName, Input<List<String>?>? smbSettings, Input<bool?>? snapshotDirectory, Input<VolumeSnapshotPolicy?>? snapshotPolicy, Input<String?>? state, Input<String?>? stateDetails, Input<String?>? storagePool, Input<double?>? throughputMibps, Input<VolumeTieringPolicy?>? tieringPolicy, Input<String?>? unixPermissions, Input<String?>? usedGib, Input<String?>? zone})
Creates a new VolumeState. activeDirectory Reports the resource name of the Active Directory policy being used. Inherited from storage pool. backupConfig Backup configuration for the volume. blockDevices Block device represents the device(s) which are stored in the block volume. cacheParameters Cache parameters for the volume. capacityGib Capacity of the volume (in GiB). coldTierSizeGib Output only. Size of the volume cold tier data in GiB. createTime Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z". deletionPolicy Policy to determine if the volume should be deleted forcefully. description An optional description of this resource. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. encryptionType Reports the data-at-rest encryption type of the volume. Inherited from storage pool. exportPolicy Export policy of the volume for NFSV3 and/or NFSV4.1 access. hasReplication Indicates whether the volume is part of a volume replication relationship. hotTierSizeUsedGib Total hot tier data rounded down to the nearest GiB used by the volume. This field is only used for flex Service Level hybridReplicationParameters Volume migration and kerberosEnabled Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p). kmsConfig Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool. labels Labels as key value pairs. Example: { "owner": "Bob", "department": "finance", "purpose": "testing" }. largeCapacity Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. largeCapacityConfig Configuration for a Large Capacity Volume. A Large Capacity Volume ldapEnabled Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool. location Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name. mountOptions Reports mount instructions for this volume. multipleEndpoints Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. name The name of the volume. Needs to be unique per location. network VPC network name with format: projects/{{project}}/global/networks/{{network}}. Inherited from storage pool. project The ID of the project in which the resource belongs. protocols The protocol of the volume. Allowed combinations are ['NFSV3'], ['NFSV4'], ['SMB'], ['NFSV3', 'NFSV4'], ['SMB', 'NFSV3'] and ['SMB', 'NFSV4']. psaRange Name of the Private Service Access allocated range. Inherited from storage pool. pulumiLabels The combination of labels configured directly on the resource replicaZone Specifies the replica zone for regional volume. restoreParameters Used to create this volume from a snapshot (= cloning) or an backup. restrictedActions List of actions that are restricted on this volume. securityStyle Security Style of the Volume. Use UNIX to use UNIX or NFSV4 ACLs for file permissions. serviceLevel Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTREME, STANDARD, FLEX. shareName Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location. smbSettings Settings for volumes with SMB access. snapshotDirectory If enabled, a NFS volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots. Will enable "Previous Versions" support for SMB. snapshotPolicy Snapshot policy defines the schedule for automatic snapshot creation. state State of the volume. stateDetails State details of the volume. storagePool Name of the storage pool to create the volume in. Pool needs enough spare capacity to accommodate the volume. throughputMibps Optional. Custom Performance Total Throughput of the pool (in MiB/s). tieringPolicy Tiering policy for the volume. unixPermissions Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only. usedGib Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage. zone Specifies the active zone for regional volume.
const
VolumeState.fromMap(Map<String, dynamic> map)
factory

Properties

activeDirectory → Input<String?>?
Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
final
backupConfig → Input<VolumeBackupConfig?>?
Backup configuration for the volume. Structure is documented below.
final
blockDevices → Input<List<VolumeBlockDevice>?>?
Block device represents the device(s) which are stored in the block volume. Currently, only one block device is permitted per Volume. Structure is documented below.
final
cacheParameters → Input<VolumeCacheParameters?>?
Cache parameters for the volume. Structure is documented below.
final
capacityGib → Input<String?>?
Capacity of the volume (in GiB).
final
coldTierSizeGib → Input<String?>?
Output only. Size of the volume cold tier data in GiB.
final
createTime → Input<String?>?
Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
final
deletionPolicy → Input<String?>?
Policy to determine if the volume should be deleted forcefully. Volumes may have nested snapshot resources. Deleting such a volume will fail. Setting this parameter to FORCE will delete volumes including nested snapshots.
final
description → Input<String?>?
An optional description of this resource.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
encryptionType → Input<String?>?
Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
final
exportPolicy → Input<VolumeExportPolicy?>?
Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
hasReplication → Input<bool?>?
Indicates whether the volume is part of a volume replication relationship.
final
hotTierSizeUsedGib → Input<String?>?
Total hot tier data rounded down to the nearest GiB used by the volume. This field is only used for flex Service Level
final
hybridReplicationParameters → Input<VolumeHybridReplicationParameters?>?
Volume migration and external replication are two types of Hybrid Replication. This parameter block specifies the parameters for a hybrid replication. Structure is documented below.
final
kerberosEnabled → Input<bool?>?
Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
final
kmsConfig → Input<String?>?
Reports the CMEK policy resurce name being used for volume encryption. Inherited from storage pool.
final
labels → Input<Map<String, String>?>?
Labels as key value pairs. Example: { "owner": "Bob", "department": "finance", "purpose": "testing" }.
final
largeCapacity → Input<bool?>?
Optional. Flag indicating if the volume will be a large capacity volume or a regular volume.
final
largeCapacityConfig → Input<VolumeLargeCapacityConfig?>?
Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 12 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. Structure is documented below.
final
ldapEnabled → Input<bool?>?
Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
final
location → Input<String?>?
Name of the pool location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
final
mountOptions → Input<List<VolumeMountOption>?>?
Reports mount instructions for this volume. Structure is documented below.
final
multipleEndpoints → Input<bool?>?
Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with largeCapacity will be allowed to have multiple endpoints.
final
name → Input<String?>?
The name of the volume. Needs to be unique per location.
final
network → Input<String?>?
VPC network name with format: projects/{{project}}/global/networks/{{network}}. Inherited from storage pool.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
protocols → Input<List<String>?>?
The protocol of the volume. Allowed combinations are ['NFSV3'], ['NFSV4'], ['SMB'], ['NFSV3', 'NFSV4'], ['SMB', 'NFSV3'] and ['SMB', 'NFSV4']. Each value may be one of: NFSV3, NFSV4, SMB, ISCSI.
final
psaRange → Input<String?>?
Name of the Private Service Access allocated range. Inherited from storage pool.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
replicaZone → Input<String?>?
Specifies the replica zone for regional volume.
final
restoreParameters → Input<VolumeRestoreParameters?>?
Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
final
restrictedActions → Input<List<String>?>?
List of actions that are restricted on this volume. Each value may be one of: DELETE.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityStyle → Input<String?>?
Security Style of the Volume. Use UNIX to use UNIX or NFSV4 ACLs for file permissions. Use NTFS to use NTFS ACLs for file permissions. Can only be set for volumes which use SMB together with NFS as protocol. Possible values are: NTFS, UNIX.
final
serviceLevel → Input<String?>?
Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTREME, STANDARD, FLEX.
final
shareName → Input<String?>?
Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.
final
smbSettings → Input<List<String>?>?
Settings for volumes with SMB access. Each value may be one of: ENCRYPT_DATA, BROWSABLE, CHANGE_NOTIFY, NON_BROWSABLE, OPLOCKS, SHOW_SNAPSHOT, SHOW_PREVIOUS_VERSIONS, ACCESS_BASED_ENUMERATION, CONTINUOUSLY_AVAILABLE.
final
snapshotDirectory → Input<bool?>?
If enabled, a NFS volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots. Will enable "Previous Versions" support for SMB.
final
snapshotPolicy → Input<VolumeSnapshotPolicy?>?
Snapshot policy defines the schedule for automatic snapshot creation. To disable automatic snapshot creation you have to remove the whole snapshotPolicy block. Structure is documented below.
final
state → Input<String?>?
State of the volume.
final
stateDetails → Input<String?>?
State details of the volume.
final
storagePool → Input<String?>?
Name of the storage pool to create the volume in. Pool needs enough spare capacity to accommodate the volume.
final
throughputMibps → Input<double?>?
Optional. Custom Performance Total Throughput of the pool (in MiB/s).
final
tieringPolicy → Input<VolumeTieringPolicy?>?
Tiering policy for the volume. Structure is documented below.
final
unixPermissions → Input<String?>?
Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.
final
usedGib → Input<String?>?
Used capacity of the volume (in GiB). This is computed periodically and it does not represent the realtime usage.
final
zone → Input<String?>?
Specifies the active zone for regional volume.
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