getInstance

Google Cloud v9.15.0, Mar 12 26

Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const myInstance = gcp.redis.getInstance({
    name: "my-redis-instance",
});
export const instanceMemorySizeGb = myInstance.then(myInstance => myInstance.memorySizeGb);
export const instanceConnectMode = myInstance.then(myInstance => myInstance.connectMode);
export const instanceAuthorizedNetwork = myInstance.then(myInstance => myInstance.authorizedNetwork);

import pulumi
import pulumi_gcp as gcp

my_instance = gcp.redis.get_instance(name="my-redis-instance")
pulumi.export("instanceMemorySizeGb", my_instance.memory_size_gb)
pulumi.export("instanceConnectMode", my_instance.connect_mode)
pulumi.export("instanceAuthorizedNetwork", my_instance.authorized_network)

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/redis"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myInstance, err := redis.LookupInstance(ctx, &redis.LookupInstanceArgs{
			Name: "my-redis-instance",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("instanceMemorySizeGb", myInstance.MemorySizeGb)
		ctx.Export("instanceConnectMode", myInstance.ConnectMode)
		ctx.Export("instanceAuthorizedNetwork", myInstance.AuthorizedNetwork)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var myInstance = Gcp.Redis.GetInstance.Invoke(new()
    {
        Name = "my-redis-instance",
    });

    return new Dictionary<string, object?>
    {
        ["instanceMemorySizeGb"] = myInstance.Apply(getInstanceResult => getInstanceResult.MemorySizeGb),
        ["instanceConnectMode"] = myInstance.Apply(getInstanceResult => getInstanceResult.ConnectMode),
        ["instanceAuthorizedNetwork"] = myInstance.Apply(getInstanceResult => getInstanceResult.AuthorizedNetwork),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.redis.RedisFunctions;
import com.pulumi.gcp.redis.inputs.GetInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var myInstance = RedisFunctions.getInstance(GetInstanceArgs.builder()
            .name("my-redis-instance")
            .build());

        ctx.export("instanceMemorySizeGb", myInstance.memorySizeGb());
        ctx.export("instanceConnectMode", myInstance.connectMode());
        ctx.export("instanceAuthorizedNetwork", myInstance.authorizedNetwork());
    }
}

variables:
  myInstance:
    fn::invoke:
      function: gcp:redis:getInstance
      arguments:
        name: my-redis-instance
outputs:
  instanceMemorySizeGb: ${myInstance.memorySizeGb}
  instanceConnectMode: ${myInstance.connectMode}
  instanceAuthorizedNetwork: ${myInstance.authorizedNetwork}

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(name: Optional[str] = None,
                 project: Optional[str] = None,
                 region: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(name: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 region: 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)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: gcp:redis/getInstance:getInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of a Redis instance.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region in which the resource belongs. If it is not provided, the provider region is used.

Name string: The name of a Redis instance.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region in which the resource belongs. If it is not provided, the provider region is used.

name String: The name of a Redis instance.
project String: The project in which the resource belongs. If it is not provided, the provider project is used.
region String: The region in which the resource belongs. If it is not provided, the provider region is used.

name string: The name of a Redis instance.
project string: The project in which the resource belongs. If it is not provided, the provider project is used.
region string: The region in which the resource belongs. If it is not provided, the provider region is used.

name str: The name of a Redis instance.
project str: The project in which the resource belongs. If it is not provided, the provider project is used.
region str: The region in which the resource belongs. If it is not provided, the provider region is used.

name String: The name of a Redis instance.
project String: The project in which the resource belongs. If it is not provided, the provider project is used.
region String: The region in which the resource belongs. If it is not provided, the provider region is used.

getInstance Result

The following output properties are available:

AlternativeLocationId string
AuthEnabled bool
AuthString string
AuthorizedNetwork string
ConnectMode string
CreateTime string
CurrentLocationId string
CustomerManagedKey string
DeletionProtection bool
DisplayName string
EffectiveLabels Dictionary<string, string>
EffectiveReservedIpRange string
Host string
Id string: The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, string>
LocationId string
MaintenancePolicies List<GetInstanceMaintenancePolicy>
MaintenanceSchedules List<GetInstanceMaintenanceSchedule>
MaintenanceVersion string
MemorySizeGb int
Name string
Nodes List<GetInstanceNode>
PersistenceConfigs List<GetInstancePersistenceConfig>
PersistenceIamIdentity string
Port int
PulumiLabels Dictionary<string, string>
ReadEndpoint string
ReadEndpointPort int
ReadReplicasMode string
RedisConfigs Dictionary<string, string>
RedisVersion string
ReplicaCount int
ReservedIpRange string
SecondaryIpRange string
ServerCaCerts List<GetInstanceServerCaCert>
Tier string
TransitEncryptionMode string
Project string
Region string

AlternativeLocationId string
AuthEnabled bool
AuthString string
AuthorizedNetwork string
ConnectMode string
CreateTime string
CurrentLocationId string
CustomerManagedKey string
DeletionProtection bool
DisplayName string
EffectiveLabels map[string]string
EffectiveReservedIpRange string
Host string
Id string: The provider-assigned unique ID for this managed resource.
Labels map[string]string
LocationId string
MaintenancePolicies []GetInstanceMaintenancePolicy
MaintenanceSchedules []GetInstanceMaintenanceSchedule
MaintenanceVersion string
MemorySizeGb int
Name string
Nodes []GetInstanceNode
PersistenceConfigs []GetInstancePersistenceConfig
PersistenceIamIdentity string
Port int
PulumiLabels map[string]string
ReadEndpoint string
ReadEndpointPort int
ReadReplicasMode string
RedisConfigs map[string]string
RedisVersion string
ReplicaCount int
ReservedIpRange string
SecondaryIpRange string
ServerCaCerts []GetInstanceServerCaCert
Tier string
TransitEncryptionMode string
Project string
Region string

alternativeLocationId String
authEnabled Boolean
authString String
authorizedNetwork String
connectMode String
createTime String
currentLocationId String
customerManagedKey String
deletionProtection Boolean
displayName String
effectiveLabels Map<String,String>
effectiveReservedIpRange String
host String
id String: The provider-assigned unique ID for this managed resource.
labels Map<String,String>
locationId String
maintenancePolicies List<GetInstanceMaintenancePolicy>
maintenanceSchedules List<GetInstanceMaintenanceSchedule>
maintenanceVersion String
memorySizeGb Integer
name String
nodes List<GetInstanceNode>
persistenceConfigs List<GetInstancePersistenceConfig>
persistenceIamIdentity String
port Integer
pulumiLabels Map<String,String>
readEndpoint String
readEndpointPort Integer
readReplicasMode String
redisConfigs Map<String,String>
redisVersion String
replicaCount Integer
reservedIpRange String
secondaryIpRange String
serverCaCerts List<GetInstanceServerCaCert>
tier String
transitEncryptionMode String
project String
region String

alternativeLocationId string
authEnabled boolean
authString string
authorizedNetwork string
connectMode string
createTime string
currentLocationId string
customerManagedKey string
deletionProtection boolean
displayName string
effectiveLabels {[key: string]: string}
effectiveReservedIpRange string
host string
id string: The provider-assigned unique ID for this managed resource.
labels {[key: string]: string}
locationId string
maintenancePolicies GetInstanceMaintenancePolicy[]
maintenanceSchedules GetInstanceMaintenanceSchedule[]
maintenanceVersion string
memorySizeGb number
name string
nodes GetInstanceNode[]
persistenceConfigs GetInstancePersistenceConfig[]
persistenceIamIdentity string
port number
pulumiLabels {[key: string]: string}
readEndpoint string
readEndpointPort number
readReplicasMode string
redisConfigs {[key: string]: string}
redisVersion string
replicaCount number
reservedIpRange string
secondaryIpRange string
serverCaCerts GetInstanceServerCaCert[]
tier string
transitEncryptionMode string
project string
region string

alternative_location_id str
auth_enabled bool
auth_string str
authorized_network str
connect_mode str
create_time str
current_location_id str
customer_managed_key str
deletion_protection bool
display_name str
effective_labels Mapping[str, str]
effective_reserved_ip_range str
host str
id str: The provider-assigned unique ID for this managed resource.
labels Mapping[str, str]
location_id str
maintenance_policies Sequence[GetInstanceMaintenancePolicy]
maintenance_schedules Sequence[GetInstanceMaintenanceSchedule]
maintenance_version str
memory_size_gb int
name str
nodes Sequence[GetInstanceNode]
persistence_configs Sequence[GetInstancePersistenceConfig]
persistence_iam_identity str
port int
pulumi_labels Mapping[str, str]
read_endpoint str
read_endpoint_port int
read_replicas_mode str
redis_configs Mapping[str, str]
redis_version str
replica_count int
reserved_ip_range str
secondary_ip_range str
server_ca_certs Sequence[GetInstanceServerCaCert]
tier str
transit_encryption_mode str
project str
region str

alternativeLocationId String
authEnabled Boolean
authString String
authorizedNetwork String
connectMode String
createTime String
currentLocationId String
customerManagedKey String
deletionProtection Boolean
displayName String
effectiveLabels Map<String>
effectiveReservedIpRange String
host String
id String: The provider-assigned unique ID for this managed resource.
labels Map<String>
locationId String
maintenancePolicies List<Property Map>
maintenanceSchedules List<Property Map>
maintenanceVersion String
memorySizeGb Number
name String
nodes List<Property Map>
persistenceConfigs List<Property Map>
persistenceIamIdentity String
port Number
pulumiLabels Map<String>
readEndpoint String
readEndpointPort Number
readReplicasMode String
redisConfigs Map<String>
redisVersion String
replicaCount Number
reservedIpRange String
secondaryIpRange String
serverCaCerts List<Property Map>
tier String
transitEncryptionMode String
project String
region String

Supporting Types

GetInstanceMaintenancePolicy

CreateTime string: Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
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: Output only. The time when the policy was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
WeeklyMaintenanceWindows List<GetInstanceMaintenancePolicyWeeklyMaintenanceWindow>: 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: Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
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: Output only. The time when the policy was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
WeeklyMaintenanceWindows []GetInstanceMaintenancePolicyWeeklyMaintenanceWindow: 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: Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
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: Output only. The time when the policy was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
weeklyMaintenanceWindows List<GetInstanceMaintenancePolicyWeeklyMaintenanceWindow>: 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: Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
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: Output only. The time when the policy was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
weeklyMaintenanceWindows GetInstanceMaintenancePolicyWeeklyMaintenanceWindow[]: 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: Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
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: Output only. The time when the policy was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
weekly_maintenance_windows Sequence[GetInstanceMaintenancePolicyWeeklyMaintenanceWindow]: 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: Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
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: Output only. The time when the policy was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
weeklyMaintenanceWindows 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.

GetInstanceMaintenancePolicyWeeklyMaintenanceWindow

Day string

Required. The day of week that maintenance updates occur.

DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
MONDAY: Monday
TUESDAY: Tuesday
WEDNESDAY: Wednesday
THURSDAY: Thursday
FRIDAY: Friday
SATURDAY: Saturday
SUNDAY: Sunday Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]

Duration string

Output only. Duration of the maintenance window. The current window is fixed at 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

StartTimes List<GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime>

Required. Start time of the window in UTC time.

Day string

Required. The day of week that maintenance updates occur.

DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
MONDAY: Monday
TUESDAY: Tuesday
WEDNESDAY: Wednesday
THURSDAY: Thursday
FRIDAY: Friday
SATURDAY: Saturday
SUNDAY: Sunday Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]

Duration string

Output only. Duration of the maintenance window. The current window is fixed at 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

StartTimes []GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime

Required. Start time of the window in UTC time.

day String

Required. The day of week that maintenance updates occur.

DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
MONDAY: Monday
TUESDAY: Tuesday
WEDNESDAY: Wednesday
THURSDAY: Thursday
FRIDAY: Friday
SATURDAY: Saturday
SUNDAY: Sunday Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]

duration String

Output only. Duration of the maintenance window. The current window is fixed at 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

startTimes List<GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime>

Required. Start time of the window in UTC time.

day string

Required. The day of week that maintenance updates occur.

DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
MONDAY: Monday
TUESDAY: Tuesday
WEDNESDAY: Wednesday
THURSDAY: Thursday
FRIDAY: Friday
SATURDAY: Saturday
SUNDAY: Sunday Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]

duration string

Output only. Duration of the maintenance window. The current window is fixed at 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

startTimes GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime[]

Required. Start time of the window in UTC time.

day str

Required. The day of week that maintenance updates occur.

DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
MONDAY: Monday
TUESDAY: Tuesday
WEDNESDAY: Wednesday
THURSDAY: Thursday
FRIDAY: Friday
SATURDAY: Saturday
SUNDAY: Sunday Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]

duration str

Output only. Duration of the maintenance window. The current window is fixed at 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

start_times Sequence[GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime]

Required. Start time of the window in UTC time.

day String

Required. The day of week that maintenance updates occur.

DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
MONDAY: Monday
TUESDAY: Tuesday
WEDNESDAY: Wednesday
THURSDAY: Thursday
FRIDAY: Friday
SATURDAY: Saturday
SUNDAY: Sunday Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]

duration String

Output only. Duration of the maintenance window. The current window is fixed at 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

startTimes List<Property Map>

Required. Start time of the window in UTC time.

GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime

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.

GetInstanceMaintenanceSchedule

EndTime string: Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
ScheduleDeadlineTime string: Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
StartTime string: Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

EndTime string: Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
ScheduleDeadlineTime string: Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
StartTime string: Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

endTime String: Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
scheduleDeadlineTime String: Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
startTime String: Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

endTime string: Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
scheduleDeadlineTime string: Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
startTime string: Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

end_time str: Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
schedule_deadline_time str: Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
start_time str: Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

endTime String: Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
scheduleDeadlineTime String: Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
startTime String: Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

GetInstanceNode

Id string: Node identifying string. e.g. 'node-0', 'node-1'
Zone string: Location of the node.

Id string: Node identifying string. e.g. 'node-0', 'node-1'
Zone string: Location of the node.

id String: Node identifying string. e.g. 'node-0', 'node-1'
zone String: Location of the node.

id string: Node identifying string. e.g. 'node-0', 'node-1'
zone string: Location of the node.

id str: Node identifying string. e.g. 'node-0', 'node-1'
zone str: Location of the node.

id String: Node identifying string. e.g. 'node-0', 'node-1'
zone String: Location of the node.

GetInstancePersistenceConfig

PersistenceMode string

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

DISABLED: Persistence is disabled for the instance, and any existing snapshots are deleted.
RDB: RDB based Persistence is enabled. Possible values: ["DISABLED", "RDB"]

RdbNextSnapshotTime string

Output only. The next time that a snapshot attempt is scheduled to occur. 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".

RdbSnapshotPeriod string

Optional. Available snapshot periods for scheduling.

ONE_HOUR: Snapshot every 1 hour.
SIX_HOURS: Snapshot every 6 hours.
TWELVE_HOURS: Snapshot every 12 hours.
TWENTY_FOUR_HOURS: Snapshot every 24 hours. Possible values: ["ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS"]

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

PersistenceMode string

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

DISABLED: Persistence is disabled for the instance, and any existing snapshots are deleted.
RDB: RDB based Persistence is enabled. Possible values: ["DISABLED", "RDB"]

RdbNextSnapshotTime string

RdbSnapshotPeriod string

Optional. Available snapshot periods for scheduling.

ONE_HOUR: Snapshot every 1 hour.
SIX_HOURS: Snapshot every 6 hours.
TWELVE_HOURS: Snapshot every 12 hours.
TWENTY_FOUR_HOURS: Snapshot every 24 hours. Possible values: ["ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS"]

RdbSnapshotStartTime string

persistenceMode String

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

DISABLED: Persistence is disabled for the instance, and any existing snapshots are deleted.
RDB: RDB based Persistence is enabled. Possible values: ["DISABLED", "RDB"]

rdbNextSnapshotTime String

rdbSnapshotPeriod String

Optional. Available snapshot periods for scheduling.

ONE_HOUR: Snapshot every 1 hour.
SIX_HOURS: Snapshot every 6 hours.
TWELVE_HOURS: Snapshot every 12 hours.
TWENTY_FOUR_HOURS: Snapshot every 24 hours. Possible values: ["ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS"]

rdbSnapshotStartTime String

persistenceMode string

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

DISABLED: Persistence is disabled for the instance, and any existing snapshots are deleted.
RDB: RDB based Persistence is enabled. Possible values: ["DISABLED", "RDB"]

rdbNextSnapshotTime string

rdbSnapshotPeriod string

Optional. Available snapshot periods for scheduling.

ONE_HOUR: Snapshot every 1 hour.
SIX_HOURS: Snapshot every 6 hours.
TWELVE_HOURS: Snapshot every 12 hours.
TWENTY_FOUR_HOURS: Snapshot every 24 hours. Possible values: ["ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS"]

rdbSnapshotStartTime string

persistence_mode str

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

DISABLED: Persistence is disabled for the instance, and any existing snapshots are deleted.
RDB: RDB based Persistence is enabled. Possible values: ["DISABLED", "RDB"]

rdb_next_snapshot_time str

rdb_snapshot_period str

Optional. Available snapshot periods for scheduling.

ONE_HOUR: Snapshot every 1 hour.
SIX_HOURS: Snapshot every 6 hours.
TWELVE_HOURS: Snapshot every 12 hours.
TWENTY_FOUR_HOURS: Snapshot every 24 hours. Possible values: ["ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS"]

rdb_snapshot_start_time str

persistenceMode String

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

DISABLED: Persistence is disabled for the instance, and any existing snapshots are deleted.
RDB: RDB based Persistence is enabled. Possible values: ["DISABLED", "RDB"]

rdbNextSnapshotTime String

rdbSnapshotPeriod String

Optional. Available snapshot periods for scheduling.

ONE_HOUR: Snapshot every 1 hour.
SIX_HOURS: Snapshot every 6 hours.
TWELVE_HOURS: Snapshot every 12 hours.
TWENTY_FOUR_HOURS: Snapshot every 24 hours. Possible values: ["ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS"]

rdbSnapshotStartTime String

GetInstanceServerCaCert

Cert string: The certificate data in PEM format.
CreateTime string: The time when the certificate was created.
ExpireTime string: The time when the certificate expires.
SerialNumber string: Serial number, as extracted from the certificate.
Sha1Fingerprint string: Sha1 Fingerprint of the certificate.

Cert string: The certificate data in PEM format.
CreateTime string: The time when the certificate was created.
ExpireTime string: The time when the certificate expires.
SerialNumber string: Serial number, as extracted from the certificate.
Sha1Fingerprint string: Sha1 Fingerprint of the certificate.

cert String: The certificate data in PEM format.
createTime String: The time when the certificate was created.
expireTime String: The time when the certificate expires.
serialNumber String: Serial number, as extracted from the certificate.
sha1Fingerprint String: Sha1 Fingerprint of the certificate.

cert string: The certificate data in PEM format.
createTime string: The time when the certificate was created.
expireTime string: The time when the certificate expires.
serialNumber string: Serial number, as extracted from the certificate.
sha1Fingerprint string: Sha1 Fingerprint of the certificate.

cert str: The certificate data in PEM format.
create_time str: The time when the certificate was created.
expire_time str: The time when the certificate expires.
serial_number str: Serial number, as extracted from the certificate.
sha1_fingerprint str: Sha1 Fingerprint of the certificate.

cert String: The certificate data in PEM format.
createTime String: The time when the certificate was created.
expireTime String: The time when the certificate expires.
serialNumber String: Serial number, as extracted from the certificate.
sha1Fingerprint String: Sha1 Fingerprint of the certificate.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

gcp.redis.getInstance

On this page

On this page

Example Usage

Using getInstance

getInstance Result

Supporting Types

GetInstanceMaintenancePolicy

GetInstanceMaintenancePolicyWeeklyMaintenanceWindow

GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime

GetInstanceMaintenanceSchedule

GetInstanceNode

GetInstancePersistenceConfig

GetInstanceServerCaCert

Package Details

On this page

On this page