Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. redis
  5. getInstance
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.redis.getInstance

Explore with Pulumi AI

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

Get info about a Google Cloud Redis instance.

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);
Copy
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)
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/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
	})
}
Copy
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),
    };
});
Copy
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.applyValue(getInstanceResult -> getInstanceResult.memorySizeGb()));
        ctx.export("instanceConnectMode", myInstance.applyValue(getInstanceResult -> getInstanceResult.connectMode()));
        ctx.export("instanceAuthorizedNetwork", myInstance.applyValue(getInstanceResult -> getInstanceResult.authorizedNetwork()));
    }
}
Copy
variables:
  myInstance:
    fn::invoke:
      function: gcp:redis:getInstance
      arguments:
        name: my-redis-instance
outputs:
  instanceMemorySizeGb: ${myInstance.memorySizeGb}
  instanceConnectMode: ${myInstance.connectMode}
  instanceAuthorizedNetwork: ${myInstance.authorizedNetwork}
Copy

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>
Copy
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]
Copy
func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gcp:redis/getInstance:getInstance
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
DisplayName string
EffectiveLabels Dictionary<string, 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
DisplayName string
EffectiveLabels map[string]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
displayName String
effectiveLabels Map<String,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
displayName string
effectiveLabels {[key: string]: 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
display_name str
effective_labels Mapping[str, 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
displayName String
effectiveLabels Map<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 This property is required. 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 This property is required. string
Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
UpdateTime This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
UpdateTime This property is required. 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 This property is required. []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 This property is required. 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 This property is required. String
Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
updateTime This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
updateTime This property is required. 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 This property is required. 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 This property is required. 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 This property is required. str
Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
update_time This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
updateTime This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. List<GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime>
Required. Start time of the window in UTC time.
Day This property is required. 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 This property is required. 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 This property is required. []GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime
Required. Start time of the window in UTC time.
day This property is required. 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 This property is required. 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 This property is required. List<GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime>
Required. Start time of the window in UTC time.
day This property is required. 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 This property is required. 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 This property is required. GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime[]
Required. Start time of the window in UTC time.
day This property is required. 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 This property is required. 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 This property is required. Sequence[GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime]
Required. Start time of the window in UTC time.
day This property is required. 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 This property is required. 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 This property is required. List<Property Map>
Required. Start time of the window in UTC time.

GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime

Hours This property is required. 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 This property is required. int
Minutes of hour of day. Must be from 0 to 59.
Nanos This property is required. int
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
Seconds This property is required. 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 This property is required. 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 This property is required. int
Minutes of hour of day. Must be from 0 to 59.
Nanos This property is required. int
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
Seconds This property is required. 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 This property is required. 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 This property is required. Integer
Minutes of hour of day. Must be from 0 to 59.
nanos This property is required. Integer
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
seconds This property is required. 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 This property is required. 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 This property is required. number
Minutes of hour of day. Must be from 0 to 59.
nanos This property is required. number
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
seconds This property is required. 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 This property is required. 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 This property is required. int
Minutes of hour of day. Must be from 0 to 59.
nanos This property is required. int
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
seconds This property is required. 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 This property is required. 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 This property is required. Number
Minutes of hour of day. Must be from 0 to 59.
nanos This property is required. Number
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
seconds This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Node identifying string. e.g. 'node-0', 'node-1'
Zone This property is required. string
Location of the node.
Id This property is required. string
Node identifying string. e.g. 'node-0', 'node-1'
Zone This property is required. string
Location of the node.
id This property is required. String
Node identifying string. e.g. 'node-0', 'node-1'
zone This property is required. String
Location of the node.
id This property is required. string
Node identifying string. e.g. 'node-0', 'node-1'
zone This property is required. string
Location of the node.
id This property is required. str
Node identifying string. e.g. 'node-0', 'node-1'
zone This property is required. str
Location of the node.
id This property is required. String
Node identifying string. e.g. 'node-0', 'node-1'
zone This property is required. String
Location of the node.

GetInstancePersistenceConfig

PersistenceMode This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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".
persistence_mode This property is required. 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 This property is required. str
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".
rdb_snapshot_period This property is required. 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 This property is required. 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. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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".

GetInstanceServerCaCert

Cert This property is required. string
The certificate data in PEM format.
CreateTime This property is required. string
The time when the certificate was created.
ExpireTime This property is required. string
The time when the certificate expires.
SerialNumber This property is required. string
Serial number, as extracted from the certificate.
Sha1Fingerprint This property is required. string
Sha1 Fingerprint of the certificate.
Cert This property is required. string
The certificate data in PEM format.
CreateTime This property is required. string
The time when the certificate was created.
ExpireTime This property is required. string
The time when the certificate expires.
SerialNumber This property is required. string
Serial number, as extracted from the certificate.
Sha1Fingerprint This property is required. string
Sha1 Fingerprint of the certificate.
cert This property is required. String
The certificate data in PEM format.
createTime This property is required. String
The time when the certificate was created.
expireTime This property is required. String
The time when the certificate expires.
serialNumber This property is required. String
Serial number, as extracted from the certificate.
sha1Fingerprint This property is required. String
Sha1 Fingerprint of the certificate.
cert This property is required. string
The certificate data in PEM format.
createTime This property is required. string
The time when the certificate was created.
expireTime This property is required. string
The time when the certificate expires.
serialNumber This property is required. string
Serial number, as extracted from the certificate.
sha1Fingerprint This property is required. string
Sha1 Fingerprint of the certificate.
cert This property is required. str
The certificate data in PEM format.
create_time This property is required. str
The time when the certificate was created.
expire_time This property is required. str
The time when the certificate expires.
serial_number This property is required. str
Serial number, as extracted from the certificate.
sha1_fingerprint This property is required. str
Sha1 Fingerprint of the certificate.
cert This property is required. String
The certificate data in PEM format.
createTime This property is required. String
The time when the certificate was created.
expireTime This property is required. String
The time when the certificate expires.
serialNumber This property is required. String
Serial number, as extracted from the certificate.
sha1Fingerprint This property is required. 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.
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp