Google Native

Pulumi Official
Package maintained by Pulumi
v0.23.0 published on Thursday, Aug 11, 2022 by Pulumi

getInstance

Gets the details of a specific Redis instance.

Using getInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
def get_instance(instance_id: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

> Note: This function is named LookupInstance in the Go SDK.

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:redis/v1beta1:getInstance
  Arguments:
    # Arguments dictionary

The following arguments are supported:

InstanceId string
Location string
Project string
InstanceId string
Location string
Project string
instanceId String
location String
project String
instanceId string
location string
project string
instanceId String
location String
project String

getInstance Result

The following output properties are available:

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

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 List<string>

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

ConnectMode string

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

CreateTime string

The time the instance was created.

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 string

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

DisplayName string

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

Host string

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

Labels Dictionary<string, string>

Resource labels to represent user provided metadata

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 Pulumi.GoogleNative.Redis.V1Beta1.Outputs.MaintenancePolicyResponse

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

MaintenanceSchedule Pulumi.GoogleNative.Redis.V1Beta1.Outputs.MaintenanceScheduleResponse

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

MaintenanceVersion string

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

MemorySizeGb int

Redis memory size in GiB.

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 List<Pulumi.GoogleNative.Redis.V1Beta1.Outputs.NodeInfoResponse>

Info per node.

PersistenceConfig Pulumi.GoogleNative.Redis.V1Beta1.Outputs.PersistenceConfigResponse

Optional. Persistence configuration parameters

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 int

The port number of the exposed Redis endpoint.

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 int

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

ReadReplicasMode string

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

RedisConfigs Dictionary<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 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 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 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 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 List<Pulumi.GoogleNative.Redis.V1Beta1.Outputs.TlsCertificateResponse>

List of server CA certificates for the instance.

State string

The current state of this instance.

StatusMessage string

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

SuspensionReasons List<string>

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

Tier string

The service tier of the instance.

TransitEncryptionMode string

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

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

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 []string

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

ConnectMode string

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

CreateTime string

The time the instance was created.

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 string

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

DisplayName string

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

Host string

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

Labels map[string]string

Resource labels to represent user provided metadata

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 MaintenancePolicyResponse

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

MaintenanceSchedule MaintenanceScheduleResponse

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

MaintenanceVersion string

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

MemorySizeGb int

Redis memory size in GiB.

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 []NodeInfoResponse

Info per node.

PersistenceConfig PersistenceConfigResponse

Optional. Persistence configuration parameters

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 int

The port number of the exposed Redis endpoint.

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 int

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

ReadReplicasMode string

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

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 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 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 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 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 []TlsCertificateResponse

List of server CA certificates for the instance.

State string

The current state of this instance.

StatusMessage string

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

SuspensionReasons []string

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

Tier string

The service tier of the instance.

TransitEncryptionMode string

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

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 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 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 List<String>

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

connectMode String

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

createTime String

The time the instance was created.

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 String

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

displayName String

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

host String

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

labels Map<String,String>

Resource labels to represent user provided metadata

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 MaintenancePolicyResponse

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

maintenanceSchedule MaintenanceScheduleResponse

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

maintenanceVersion String

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

memorySizeGb Integer

Redis memory size in GiB.

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 List<NodeInfoResponse>

Info per node.

persistenceConfig PersistenceConfigResponse

Optional. Persistence configuration parameters

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 Integer

The port number of the exposed Redis endpoint.

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 Integer

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

readReplicasMode String

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

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 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 Integer

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 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 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 List<TlsCertificateResponse>

List of server CA certificates for the instance.

state String

The current state of this instance.

statusMessage String

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

suspensionReasons List<String>

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

tier String

The service tier of the instance.

transitEncryptionMode String

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

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 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 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 string[]

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

connectMode string

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

createTime string

The time the instance was created.

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 string

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

displayName string

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

host string

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

labels {[key: string]: string}

Resource labels to represent user provided metadata

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 MaintenancePolicyResponse

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

maintenanceSchedule MaintenanceScheduleResponse

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

maintenanceVersion string

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

memorySizeGb number

Redis memory size in GiB.

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 NodeInfoResponse[]

Info per node.

persistenceConfig PersistenceConfigResponse

Optional. Persistence configuration parameters

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 number

The port number of the exposed Redis endpoint.

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 number

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

readReplicasMode string

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

redisConfigs {[key: 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 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 number

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 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 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 TlsCertificateResponse[]

List of server CA certificates for the instance.

state string

The current state of this instance.

statusMessage string

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

suspensionReasons string[]

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

tier string

The service tier of the instance.

transitEncryptionMode string

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

alternative_location_id str

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.

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

authorized_network str

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.

available_maintenance_versions Sequence[str]

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

connect_mode str

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

create_time str

The time the instance was created.

current_location_id str

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.

customer_managed_key str

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

display_name str

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

host str

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

labels Mapping[str, str]

Resource labels to represent user provided metadata

location str

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.

maintenance_policy MaintenancePolicyResponse

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

maintenance_schedule MaintenanceScheduleResponse

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

maintenance_version str

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

memory_size_gb int

Redis memory size in GiB.

name str

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 Sequence[NodeInfoResponse]

Info per node.

persistence_config PersistenceConfigResponse

Optional. Persistence configuration parameters

persistence_iam_identity str

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 int

The port number of the exposed Redis endpoint.

read_endpoint str

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

read_endpoint_port int

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

read_replicas_mode str

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

redis_configs Mapping[str, str]

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

redis_version str

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

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

reserved_ip_range str

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.

secondary_ip_range str

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

server_ca_certs Sequence[TlsCertificateResponse]

List of server CA certificates for the instance.

state str

The current state of this instance.

status_message str

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

suspension_reasons Sequence[str]

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

tier str

The service tier of the instance.

transit_encryption_mode str

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

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 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 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 List<String>

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

connectMode String

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

createTime String

The time the instance was created.

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 String

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

displayName String

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

host String

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

labels Map<String>

Resource labels to represent user provided metadata

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 Property Map

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

maintenanceSchedule Property Map

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

maintenanceVersion String

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

memorySizeGb Number

Redis memory size in GiB.

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 List<Property Map>

Info per node.

persistenceConfig Property Map

Optional. Persistence configuration parameters

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 Number

The port number of the exposed Redis endpoint.

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 Number

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

readReplicasMode String

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

redisConfigs Map<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 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 Number

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 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 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 List<Property Map>

List of server CA certificates for the instance.

state String

The current state of this instance.

statusMessage String

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

suspensionReasons List<String>

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

tier String

The service tier of the instance.

transitEncryptionMode String

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

Supporting Types

MaintenancePolicyResponse

CreateTime string

The time when the policy was created.

Description string

Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.

UpdateTime string

The time when the policy was last updated.

WeeklyMaintenanceWindow List<Pulumi.GoogleNative.Redis.V1Beta1.Inputs.WeeklyMaintenanceWindowResponse>

Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one.

CreateTime string

The time when the policy was created.

Description string

Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.

UpdateTime string

The time when the policy was last updated.

WeeklyMaintenanceWindow []WeeklyMaintenanceWindowResponse

Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one.

createTime String

The time when the policy was created.

description String

Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.

updateTime String

The time when the policy was last updated.

weeklyMaintenanceWindow List<WeeklyMaintenanceWindowResponse>

Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one.

createTime string

The time when the policy was created.

description string

Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.

updateTime string

The time when the policy was last updated.

weeklyMaintenanceWindow WeeklyMaintenanceWindowResponse[]

Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one.

create_time str

The time when the policy was created.

description str

Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.

update_time str

The time when the policy was last updated.

weekly_maintenance_window Sequence[WeeklyMaintenanceWindowResponse]

Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one.

createTime String

The time when the policy was created.

description String

Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.

updateTime String

The time when the policy was last updated.

weeklyMaintenanceWindow List<Property Map>

Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one.

MaintenanceScheduleResponse

CanReschedule bool

If the scheduled maintenance can be rescheduled, default is true.

EndTime string

The end time of any upcoming scheduled maintenance for this instance.

ScheduleDeadlineTime string

The deadline that the maintenance schedule start time can not go beyond, including reschedule.

StartTime string

The start time of any upcoming scheduled maintenance for this instance.

CanReschedule bool

If the scheduled maintenance can be rescheduled, default is true.

EndTime string

The end time of any upcoming scheduled maintenance for this instance.

ScheduleDeadlineTime string

The deadline that the maintenance schedule start time can not go beyond, including reschedule.

StartTime string

The start time of any upcoming scheduled maintenance for this instance.

canReschedule Boolean

If the scheduled maintenance can be rescheduled, default is true.

endTime String

The end time of any upcoming scheduled maintenance for this instance.

scheduleDeadlineTime String

The deadline that the maintenance schedule start time can not go beyond, including reschedule.

startTime String

The start time of any upcoming scheduled maintenance for this instance.

canReschedule boolean

If the scheduled maintenance can be rescheduled, default is true.

endTime string

The end time of any upcoming scheduled maintenance for this instance.

scheduleDeadlineTime string

The deadline that the maintenance schedule start time can not go beyond, including reschedule.

startTime string

The start time of any upcoming scheduled maintenance for this instance.

can_reschedule bool

If the scheduled maintenance can be rescheduled, default is true.

end_time str

The end time of any upcoming scheduled maintenance for this instance.

schedule_deadline_time str

The deadline that the maintenance schedule start time can not go beyond, including reschedule.

start_time str

The start time of any upcoming scheduled maintenance for this instance.

canReschedule Boolean

If the scheduled maintenance can be rescheduled, default is true.

endTime String

The end time of any upcoming scheduled maintenance for this instance.

scheduleDeadlineTime String

The deadline that the maintenance schedule start time can not go beyond, including reschedule.

startTime String

The start time of any upcoming scheduled maintenance for this instance.

NodeInfoResponse

Zone string

Location of the node.

Zone string

Location of the node.

zone String

Location of the node.

zone string

Location of the node.

zone str

Location of the node.

zone String

Location of the node.

PersistenceConfigResponse

PersistenceMode string

Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.

RdbNextSnapshotTime string

The next time that a snapshot attempt is scheduled to occur.

RdbSnapshotPeriod string

Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default.

RdbSnapshotStartTime string

Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.

PersistenceMode string

Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.

RdbNextSnapshotTime string

The next time that a snapshot attempt is scheduled to occur.

RdbSnapshotPeriod string

Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default.

RdbSnapshotStartTime string

Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.

persistenceMode String

Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.

rdbNextSnapshotTime String

The next time that a snapshot attempt is scheduled to occur.

rdbSnapshotPeriod String

Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default.

rdbSnapshotStartTime String

Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.

persistenceMode string

Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.

rdbNextSnapshotTime string

The next time that a snapshot attempt is scheduled to occur.

rdbSnapshotPeriod string

Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default.

rdbSnapshotStartTime string

Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.

persistence_mode str

Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.

rdb_next_snapshot_time str

The next time that a snapshot attempt is scheduled to occur.

rdb_snapshot_period str

Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default.

rdb_snapshot_start_time str

Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.

persistenceMode String

Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.

rdbNextSnapshotTime String

The next time that a snapshot attempt is scheduled to occur.

rdbSnapshotPeriod String

Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default.

rdbSnapshotStartTime String

Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.

TimeOfDayResponse

Hours int

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

Minutes int

Minutes of hour of day. Must be from 0 to 59.

Nanos int

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Seconds int

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

Hours int

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

Minutes int

Minutes of hour of day. Must be from 0 to 59.

Nanos int

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Seconds int

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

hours Integer

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

minutes Integer

Minutes of hour of day. Must be from 0 to 59.

nanos Integer

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

seconds Integer

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

hours number

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

minutes number

Minutes of hour of day. Must be from 0 to 59.

nanos number

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

seconds number

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

hours int

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

minutes int

Minutes of hour of day. Must be from 0 to 59.

nanos int

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

seconds int

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

hours Number

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

minutes Number

Minutes of hour of day. Must be from 0 to 59.

nanos Number

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

seconds Number

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

TlsCertificateResponse

Cert string

PEM representation.

CreateTime string

The time when the certificate was created in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

ExpireTime string

The time when the certificate expires in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

SerialNumber string

Serial number, as extracted from the certificate.

Sha1Fingerprint string

Sha1 Fingerprint of the certificate.

Cert string

PEM representation.

CreateTime string

The time when the certificate was created in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

ExpireTime string

The time when the certificate expires in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

SerialNumber string

Serial number, as extracted from the certificate.

Sha1Fingerprint string

Sha1 Fingerprint of the certificate.

cert String

PEM representation.

createTime String

The time when the certificate was created in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

expireTime String

The time when the certificate expires in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

serialNumber String

Serial number, as extracted from the certificate.

sha1Fingerprint String

Sha1 Fingerprint of the certificate.

cert string

PEM representation.

createTime string

The time when the certificate was created in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

expireTime string

The time when the certificate expires in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

serialNumber string

Serial number, as extracted from the certificate.

sha1Fingerprint string

Sha1 Fingerprint of the certificate.

cert str

PEM representation.

create_time str

The time when the certificate was created in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

expire_time str

The time when the certificate expires in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

serial_number str

Serial number, as extracted from the certificate.

sha1_fingerprint str

Sha1 Fingerprint of the certificate.

cert String

PEM representation.

createTime String

The time when the certificate was created in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

expireTime String

The time when the certificate expires in RFC 3339 format, for example 2020-05-18T00:00:00.094Z.

serialNumber String

Serial number, as extracted from the certificate.

sha1Fingerprint String

Sha1 Fingerprint of the certificate.

WeeklyMaintenanceWindowResponse

Day string

The day of week that maintenance updates occur.

Duration string

Duration of the maintenance window. The current window is fixed at 1 hour.

StartTime Pulumi.GoogleNative.Redis.V1Beta1.Inputs.TimeOfDayResponse

Start time of the window in UTC time.

Day string

The day of week that maintenance updates occur.

Duration string

Duration of the maintenance window. The current window is fixed at 1 hour.

StartTime TimeOfDayResponse

Start time of the window in UTC time.

day String

The day of week that maintenance updates occur.

duration String

Duration of the maintenance window. The current window is fixed at 1 hour.

startTime TimeOfDayResponse

Start time of the window in UTC time.

day string

The day of week that maintenance updates occur.

duration string

Duration of the maintenance window. The current window is fixed at 1 hour.

startTime TimeOfDayResponse

Start time of the window in UTC time.

day str

The day of week that maintenance updates occur.

duration str

Duration of the maintenance window. The current window is fixed at 1 hour.

start_time TimeOfDayResponse

Start time of the window in UTC time.

day String

The day of week that maintenance updates occur.

duration String

Duration of the maintenance window. The current window is fixed at 1 hour.

startTime Property Map

Start time of the window in UTC time.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0