ClusterState class

Input properties used for looking up and filtering Cluster resources.

Constructors

ClusterState({Input<String?>? aclPolicy, Input<String?>? authorizationMode, Input<ClusterAutomatedBackupConfig?>? automatedBackupConfig, Input<List<String>?>? availableMaintenanceVersions, Input<String?>? backupCollection, Input<String?>? createTime, Input<ClusterCrossClusterReplicationConfig?>? crossClusterReplicationConfig, Input<String?>? deletionPolicy, Input<bool?>? deletionProtectionEnabled, Input<List<ClusterDiscoveryEndpoint>?>? discoveryEndpoints, Input<Map<String, String>?>? effectiveLabels, Input<String?>? effectiveMaintenanceVersion, Input<ClusterGcsSource?>? gcsSource, Input<bool?>? isAclPolicyInSync, Input<String?>? kmsKey, Input<Map<String, String>?>? labels, Input<ClusterMaintenancePolicy?>? maintenancePolicy, Input<List<ClusterMaintenanceSchedule>?>? maintenanceSchedules, Input<String?>? maintenanceVersion, Input<ClusterManagedBackupSource?>? managedBackupSource, Input<List<ClusterManagedServerCa>?>? managedServerCas, Input<String?>? name, Input<String?>? nodeType, Input<ClusterPersistenceConfig?>? persistenceConfig, Input<double?>? preciseSizeGb, Input<String?>? project, Input<List<ClusterPscConfig>?>? pscConfigs, Input<List<ClusterPscConnection>?>? pscConnections, Input<List<ClusterPscServiceAttachment>?>? pscServiceAttachments, Input<Map<String, String>?>? pulumiLabels, Input<Map<String, String>?>? redisConfigs, Input<String?>? region, Input<int?>? replicaCount, Input<String?>? serverCaMode, Input<String?>? serverCaPool, Input<int?>? shardCount, Input<int?>? sizeGb, Input<String?>? state, Input<List<ClusterStateInfo>?>? stateInfos, Input<String?>? transitEncryptionMode, Input<String?>? uid, Input<ClusterZoneDistributionConfig?>? zoneDistributionConfig})
Creates a new ClusterState. aclPolicy Optional. The name of the ACL policy to attach to the cluster. authorizationMode Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. automatedBackupConfig The automated backup config for a instance. availableMaintenanceVersions This field is used to determine the available maintenance versions for the self service update. backupCollection The backup collection full resource name. createTime The timestamp associated with the cluster creation request. A timestamp in crossClusterReplicationConfig Cross cluster replication config deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. deletionProtectionEnabled Optional. Indicates if the cluster is deletion protected or not. discoveryEndpoints Output only. Endpoints created on each given network, effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. effectiveMaintenanceVersion This field represents the actual maintenance version of the cluster. gcsSource Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. isAclPolicyInSync Optional. Whether the ACL policy is in sync with the cluster. kmsKey The KMS key used to encrypt the at-rest data of the cluster. labels Resource labels to represent user provided metadata. maintenancePolicy Maintenance policy for a cluster maintenanceSchedules Upcoming maintenance schedule. maintenanceVersion This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the availableMaintenanceVersions field. managedBackupSource Backups that generated and managed by memorystore. managedServerCas Cluster's Certificate Authority. This field will only be populated if Redis Cluster's transitEncryptionMode is TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION name Unique name of the resource in this scope including project and location using the form: nodeType The nodeType for the Redis cluster. persistenceConfig Persistence config (RDB, AOF) for the cluster. preciseSizeGb Output only. Redis memory precise size in GB for the entire cluster. project The ID of the project in which the resource belongs. pscConfigs Required. Each PscConfig configures the consumer network where two pscConnections Output only. PSC connections for discovery of the cluster topology and accessing the cluster. pscServiceAttachments Service attachment details to configure Psc connections. pulumiLabels The combination of labels configured directly on the resource redisConfigs Configure Redis Cluster behavior using a subset of native Redis configuration parameters. region The name of the region of the Redis cluster. replicaCount Optional. The number of replica nodes per shard. serverCaMode The serverCaMode for the TLS enabled Redis cluster. serverCaPool The resource name of the server CA pool for an instance with SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA shardCount Required. Number of shards for the Redis cluster. sizeGb Output only. Redis memory size in GB for the entire cluster. state The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED stateInfos Output only. Additional information about the current state of the cluster. transitEncryptionMode Optional. The in-transit encryption for the Redis cluster. uid System assigned, unique identifier for the cluster. zoneDistributionConfig Immutable. Zone distribution config for Memorystore Redis cluster.
const
ClusterState.fromMap(Map<String, dynamic> map)
factory

Properties

aclPolicy → Input<String?>?
Optional. The name of the ACL policy to attach to the cluster.
final
authorizationMode → Input<String?>?
Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. Default value is AUTH_MODE_DISABLED. Possible values are: AUTH_MODE_UNSPECIFIED, AUTH_MODE_IAM_AUTH, AUTH_MODE_DISABLED.
final
automatedBackupConfig → Input<ClusterAutomatedBackupConfig?>?
The automated backup config for a instance. Structure is documented below.
final
availableMaintenanceVersions → Input<List<String>?>?
This field is used to determine the available maintenance versions for the self service update.
final
backupCollection → Input<String?>?
The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
final
createTime → Input<String?>?
The timestamp associated with the cluster creation request. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
final
crossClusterReplicationConfig → Input<ClusterCrossClusterReplicationConfig?>?
Cross cluster replication config Structure is documented below.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
deletionProtectionEnabled → Input<bool?>?
Optional. Indicates if the cluster is deletion protected or not. If the value if set to true, any delete cluster operation will fail. Default value is true.
final
discoveryEndpoints → Input<List<ClusterDiscoveryEndpoint>?>?
Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one endpoint is supported. Structure is documented below.
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
effectiveMaintenanceVersion → Input<String?>?
This field represents the actual maintenance version of the cluster.
final
gcsSource → Input<ClusterGcsSource?>?
Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
isAclPolicyInSync → Input<bool?>?
Optional. Whether the ACL policy is in sync with the cluster.
final
kmsKey → Input<String?>?
The KMS key used to encrypt the at-rest data of the cluster.
final
labels → Input<Map<String, String>?>?
Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
final
maintenancePolicy → Input<ClusterMaintenancePolicy?>?
Maintenance policy for a cluster Structure is documented below.
final
maintenanceSchedules → Input<List<ClusterMaintenanceSchedule>?>?
Upcoming maintenance schedule. Structure is documented below.
final
maintenanceVersion → Input<String?>?
This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the availableMaintenanceVersions field. Note: This field can only be specified when updating an existing cluster to a newer version. Downgrades are currently not supported!
final
managedBackupSource → Input<ClusterManagedBackupSource?>?
Backups that generated and managed by memorystore. Structure is documented below.
final
managedServerCas → Input<List<ClusterManagedServerCa>?>?
Cluster's Certificate Authority. This field will only be populated if Redis Cluster's transitEncryptionMode is TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION Structure is documented below.
final
name → Input<String?>?
Unique name of the resource in this scope including project and location using the form: projects/{projectId}/locations/{locationId}/clusters/{clusterId}
final
nodeType → Input<String?>?
The nodeType for the Redis cluster. If not provided, REDIS_HIGHMEM_MEDIUM will be used as default Possible values are: REDIS_SHARED_CORE_NANO, REDIS_HIGHMEM_MEDIUM, REDIS_HIGHCPU_MEDIUM, REDIS_STANDARD_LARGE, REDIS_HIGHMEM_XLARGE, REDIS_HIGHMEM_2XLARGE, REDIS_STANDARD_SMALL.
final
persistenceConfig → Input<ClusterPersistenceConfig?>?
Persistence config (RDB, AOF) for the cluster. Structure is documented below.
final
preciseSizeGb → Input<double?>?
Output only. Redis memory precise size in GB for the entire cluster.
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
pscConfigs → Input<List<ClusterPscConfig>?>?
Required. Each PscConfig configures the consumer network where two network addresses will be designated to the cluster for client access. Currently, only one PscConfig is supported. Structure is documented below.
final
pscConnections → Input<List<ClusterPscConnection>?>?
Output only. PSC connections for discovery of the cluster topology and accessing the cluster. Structure is documented below.
final
pscServiceAttachments → Input<List<ClusterPscServiceAttachment>?>?
Service attachment details to configure Psc connections. Structure is documented below.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
redisConfigs → Input<Map<String, String>?>?
Configure Redis Cluster behavior using a subset of native Redis configuration parameters. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/cluster/supported-instance-configurations
final
region → Input<String?>?
The name of the region of the Redis cluster.
final
replicaCount → Input<int?>?
Optional. The number of replica nodes per shard.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverCaMode → Input<String?>?
The serverCaMode for the TLS enabled Redis cluster. If not provided, SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA will be used as default Possible values are: SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA, SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA, SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA, SERVER_CA_MODE_UNSPECIFIED.
final
serverCaPool → Input<String?>?
The resource name of the server CA pool for an instance with SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA as the server_ca_mode. Format: projects/{project}/locations/{region}/caPools/{caPoolId}
final
shardCount → Input<int?>?
Required. Number of shards for the Redis cluster.
final
sizeGb → Input<int?>?
Output only. Redis memory size in GB for the entire cluster.
final
state → Input<String?>?
The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED
final
stateInfos → Input<List<ClusterStateInfo>?>?
Output only. Additional information about the current state of the cluster. Structure is documented below.
final
transitEncryptionMode → Input<String?>?
Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. Default value is TRANSIT_ENCRYPTION_MODE_DISABLED. Possible values are: TRANSIT_ENCRYPTION_MODE_UNSPECIFIED, TRANSIT_ENCRYPTION_MODE_DISABLED, TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION.
final
uid → Input<String?>?
System assigned, unique identifier for the cluster.
final
zoneDistributionConfig → Input<ClusterZoneDistributionConfig?>?
Immutable. Zone distribution config for Memorystore Redis cluster. Structure is documented below.
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