InstanceState class

Input properties used for looking up and filtering Instance resources.

Constructors

InstanceState({Input<String?>? alternativeLocationId, Input<bool?>? authEnabled, Input<String?>? authString, Input<String?>? authorizedNetwork, Input<String?>? connectMode, Input<String?>? createTime, Input<String?>? currentLocationId, Input<String?>? customerManagedKey, Input<String?>? deletionPolicy, Input<bool?>? deletionProtection, Input<String?>? displayName, Input<Map<String, String>?>? effectiveLabels, Input<String?>? effectiveReservedIpRange, Input<String?>? host, Input<Map<String, String>?>? labels, Input<String?>? locationId, Input<InstanceMaintenancePolicy?>? maintenancePolicy, Input<List<InstanceMaintenanceSchedule>?>? maintenanceSchedules, Input<String?>? maintenanceVersion, Input<int?>? memorySizeGb, Input<String?>? name, Input<List<InstanceNode>?>? nodes, Input<InstancePersistenceConfig?>? persistenceConfig, Input<String?>? persistenceIamIdentity, Input<int?>? port, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<String?>? readEndpoint, Input<int?>? readEndpointPort, Input<String?>? readReplicasMode, Input<Map<String, String>?>? redisConfigs, Input<String?>? redisVersion, Input<String?>? region, Input<int?>? replicaCount, Input<String?>? reservedIpRange, Input<String?>? secondaryIpRange, Input<List<InstanceServerCaCert>?>? serverCaCerts, Input<String?>? tier, Input<String?>? transitEncryptionMode})
Creates a new InstanceState. alternativeLocationId Only applicable to STANDARD_HA tier which protects the instance authEnabled Optional. Indicates whether OSS Redis AUTH is enabled for the authString AUTH String set on the instance. This field will only be populated if authEnabled is true. authorizedNetwork The full name of the Google Compute Engine network to which the connectMode The connection mode of the Redis instance. createTime (Output) currentLocationId The current zone where the Redis endpoint is placed. customerManagedKey Optional. The KMS key reference that you want to use to encrypt the data at rest for this Redis deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. deletionProtection Whether Terraform will be prevented from destroying the instance. displayName An arbitrary and optional user-provided name for the instance. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. effectiveReservedIpRange The CIDR range of internal addresses that are reserved for this host Hostname or IP address of the exposed Redis endpoint used by clients labels Resource labels to represent user provided metadata. locationId The zone where the instance will be provisioned. If not provided, maintenancePolicy Maintenance policy for an instance. maintenanceSchedules Upcoming maintenance schedule. maintenanceVersion The self service update maintenance version. memorySizeGb Redis memory size in GiB. name The ID of the instance or a fully qualified identifier for the instance. nodes Output only. Info per node. persistenceConfig Persistence configuration for an instance. persistenceIamIdentity Output only. Cloud IAM identity used by import / export operations port The port number of the exposed Redis endpoint. project The ID of the project in which the resource belongs. pulumiLabels The combination of labels configured directly on the resource readEndpoint Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. readEndpointPort Output only. The port number of the exposed readonly redis endpoint. Standard tier only. readReplicasMode Optional. Read replica mode. Can only be specified when trying to create the instance. redisConfigs Redis configuration parameters, according to http://redis.io/topics/config. redisVersion The version of Redis software. If not provided, latest supported region The name of the Redis region of the instance. replicaCount Optional. The number of replica nodes. The valid range for the Standard Tier with reservedIpRange The CIDR range of internal addresses that are reserved for this secondaryIpRange Optional. Additional IP range for node placement. Required when enabling read replicas on serverCaCerts List of server CA certificates for the instance. tier The service tier of the instance. Must be one of these values: transitEncryptionMode The TLS mode of the Redis instance, If not provided, TLS is disabled for the instance.
const
InstanceState.fromMap(Map<String, dynamic> map)
factory

Properties

alternativeLocationId → Input<String?>?
Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in locationId.
final
authEnabled → Input<bool?>?
Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.
final
authorizedNetwork → Input<String?>?
The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
final
authString → Input<String?>?
AUTH String set on the instance. This field will only be populated if authEnabled is true.
final
connectMode → Input<String?>?
The connection mode of the Redis instance. Default value is DIRECT_PEERING. Possible values are: DIRECT_PEERING, PRIVATE_SERVICE_ACCESS.
final
createTime → Input<String?>?
(Output) The time when the certificate was created.
final
currentLocationId → Input<String?>?
The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the locationId provided by the user at creation time. For Standard Tier instances, this can be either locationId or alternativeLocationId and can change after a failover event.
final
customerManagedKey → Input<String?>?
Optional. The KMS key reference that you want to use to encrypt the data at rest for this Redis instance. If this is provided, CMEK is enabled.
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
deletionProtection → Input<bool?>?
Whether Terraform will be prevented from destroying the instance. When aterraform destroy or pulumi up would delete the instance, the command will fail if this field is not set to false in Terraform state. When the field is set to true or unset in Terraform state, a pulumi up or terraform destroy that would delete the instance will fail. When the field is set to false, deleting the instance is allowed.
final
displayName → Input<String?>?
An arbitrary and optional user-provided name for the instance.
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
effectiveReservedIpRange → Input<String?>?
The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
final
hashCode → int
The hash code for this object.
no setterinherited
host → Input<String?>?
Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
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
locationId → Input<String?>?
The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If alternativeLocationId is also provided, it must be different from locationId.
final
maintenancePolicy → Input<InstanceMaintenancePolicy?>?
Maintenance policy for an instance. Structure is documented below.
final
maintenanceSchedules → Input<List<InstanceMaintenanceSchedule>?>?
Upcoming maintenance schedule. Structure is documented below.
final
maintenanceVersion → Input<String?>?
The self service update maintenance version.
final
memorySizeGb → Input<int?>?
Redis memory size in GiB.
final
name → Input<String?>?
The ID of the instance or a fully qualified identifier for the instance.
final
nodes → Input<List<InstanceNode>?>?
Output only. Info per node. Structure is documented below.
final
persistenceConfig → Input<InstancePersistenceConfig?>?
Persistence configuration for an instance. Structure is documented below.
final
persistenceIamIdentity → Input<String?>?
Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.
final
port → Input<int?>?
The port number of the exposed Redis endpoint.
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
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
readEndpoint → Input<String?>?
Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.
final
readEndpointPort → Input<int?>?
Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
final
readReplicasMode → Input<String?>?
Optional. Read replica mode. Can only be specified when trying to create the instance. If not set, Memorystore Redis backend will default to READ_REPLICAS_DISABLED.
final
redisConfigs → Input<Map<String, String>?>?
Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs
final
redisVersion → Input<String?>?
The version of Redis software. If not provided, latest supported version will be used. Please check the API documentation linked at the top for the latest valid values.
final
region → Input<String?>?
The name of the Redis region of the instance.
final
replicaCount → Input<int?>?
Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is 1-5 and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.
final
reservedIpRange → Input<String?>?
The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondaryIpRange → Input<String?>?
Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".
final
serverCaCerts → Input<List<InstanceServerCaCert>?>?
List of server CA certificates for the instance. Structure is documented below.
final
tier → Input<String?>?
The service tier of the instance. Must be one of these values:
final
transitEncryptionMode → Input<String?>?
The TLS mode of the Redis instance, If not provided, TLS is disabled for the instance.
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