pulumi-google-native-kotlin/com.pulumi.googlenative.redis.v1beta1.kotlin.outputs/GetInstanceResult

GetInstanceResult

data class GetInstanceResult(val alternativeLocationId: String, val authEnabled: Boolean, val authorizedNetwork: String, val availableMaintenanceVersions: List<String>, val connectMode: String, val createTime: String, val currentLocationId: String, val customerManagedKey: String, val displayName: String, val host: String, val labels: Map<String, String>, val location: String, val maintenancePolicy: MaintenancePolicyResponse, val maintenanceSchedule: MaintenanceScheduleResponse, val maintenanceVersion: String, val memorySizeGb: Int, val name: String, val nodes: List<NodeInfoResponse>, val persistenceConfig: PersistenceConfigResponse, val persistenceIamIdentity: String, val port: Int, val readEndpoint: String, val readEndpointPort: Int, val readReplicasMode: String, val redisConfigs: Map<String, String>, val redisVersion: String, val replicaCount: Int, val reservedIpRange: String, val secondaryIpRange: String, val serverCaCerts: List<TlsCertificateResponse>, val state: String, val statusMessage: String, val suspensionReasons: List<String>, val tier: String, val transitEncryptionMode: String)

Constructors

GetInstanceResult

fun GetInstanceResult(alternativeLocationId: String, authEnabled: Boolean, authorizedNetwork: String, availableMaintenanceVersions: List<String>, connectMode: String, createTime: String, currentLocationId: String, customerManagedKey: String, displayName: String, host: String, labels: Map<String, String>, location: String, maintenancePolicy: MaintenancePolicyResponse, maintenanceSchedule: MaintenanceScheduleResponse, maintenanceVersion: String, memorySizeGb: Int, name: String, nodes: List<NodeInfoResponse>, persistenceConfig: PersistenceConfigResponse, persistenceIamIdentity: String, port: Int, readEndpoint: String, readEndpointPort: Int, readReplicasMode: String, redisConfigs: Map<String, String>, redisVersion: String, replicaCount: Int, reservedIpRange: String, secondaryIpRange: String, serverCaCerts: List<TlsCertificateResponse>, state: String, statusMessage: String, suspensionReasons: List<String>, tier: String, transitEncryptionMode: String)

Types

Companion

object Companion

Properties

alternativeLocationId

val alternativeLocationId: String

Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in location_id. Additional nodes beyond the first 2 will be placed in zones selected by the service.

authEnabled

val authEnabled: Boolean

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.

authorizedNetwork

val authorizedNetwork: String

Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.

availableMaintenanceVersions

val availableMaintenanceVersions: List<String>

Optional. The available maintenance versions that an instance could update to.

connectMode

val connectMode: String

Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.

createTime

val createTime: String

The time the instance was created.

currentLocationId

val currentLocationId: String

The current zone where the Redis primary node is located. In basic tier, this will always be the same as location_id. In standard tier, this can be the zone of any node in the instance.

customerManagedKey

val customerManagedKey: String

Optional. The KMS key reference that the customer provides when trying to create the instance.

displayName

val displayName: String

An arbitrary and optional user-provided name for the instance.

host

val host: String

Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

labels

val labels: Map<String, String>

Resource labels to represent user provided metadata

location

val location: String

Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.

maintenancePolicy

val maintenancePolicy: MaintenancePolicyResponse

Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.

maintenanceSchedule

val maintenanceSchedule: MaintenanceScheduleResponse

Date and time of upcoming maintenance events which have been scheduled.

maintenanceVersion

val maintenanceVersion: String

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".

memorySizeGb

val memorySizeGb: Int

Redis memory size in GiB.

name

val name: String

Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.

nodes

val nodes: List<NodeInfoResponse>

Info per node.

persistenceConfig

val persistenceConfig: PersistenceConfigResponse

Optional. Persistence configuration parameters

persistenceIamIdentity

val persistenceIamIdentity: String

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.

port

val port: Int

The port number of the exposed Redis endpoint.

readEndpoint

val readEndpoint: String

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'.

readEndpointPort

val readEndpointPort: Int

The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.

readReplicasMode

val readReplicasMode: String

Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.

redisConfigs

val redisConfigs: Map<String, String>

Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries

redisVersion

val redisVersion: String

Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * REDIS_3_2 for Redis 3.2 compatibility * REDIS_4_0 for Redis 4.0 compatibility (default) * REDIS_5_0 for Redis 5.0 compatibility * REDIS_6_X for Redis 6.x compatibility

replicaCount

val replicaCount: 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.

reservedIpRange

val reservedIpRange: String

Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.

secondaryIpRange

val secondaryIpRange: 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".

serverCaCerts

val serverCaCerts: List<TlsCertificateResponse>

List of server CA certificates for the instance.

state

val state: String

The current state of this instance.

statusMessage

val statusMessage: String

Additional information about the current status of this instance, if available.

suspensionReasons

val suspensionReasons: List<String>

Optional. reasons that causes instance in "SUSPENDED" state.