gcp.redis.getInstance
Get info about a Google Cloud Redis instance.
Example Usage
using System.Collections.Generic;
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 main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/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
})
}
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()));
}
}
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)
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);
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: gcp:redis/getInstance:getInstance
arguments:
# arguments dictionary
The following arguments are supported:
getInstance Result
The following output properties are available:
- Alternative
Location stringId - Auth
Enabled bool - Auth
String string - string
- Connect
Mode string - Create
Time string - Current
Location stringId - Customer
Managed stringKey - Display
Name string - Host string
- Id string
The provider-assigned unique ID for this managed resource.
- Labels Dictionary<string, string>
- Location
Id string - Maintenance
Policies List<GetInstance Maintenance Policy> - Maintenance
Schedules List<GetInstance Maintenance Schedule> - Memory
Size intGb - Name string
- Nodes
List<Get
Instance Node> - Persistence
Configs List<GetInstance Persistence Config> - Persistence
Iam stringIdentity - Port int
- Read
Endpoint string - Read
Endpoint intPort - Read
Replicas stringMode - Redis
Configs Dictionary<string, string> - Redis
Version string - Replica
Count int - Reserved
Ip stringRange - Secondary
Ip stringRange - Server
Ca List<GetCerts Instance Server Ca Cert> - Tier string
- Transit
Encryption stringMode - Project string
- Region string
- Alternative
Location stringId - Auth
Enabled bool - Auth
String string - string
- Connect
Mode string - Create
Time string - Current
Location stringId - Customer
Managed stringKey - Display
Name string - Host string
- Id string
The provider-assigned unique ID for this managed resource.
- Labels map[string]string
- Location
Id string - Maintenance
Policies []GetInstance Maintenance Policy - Maintenance
Schedules []GetInstance Maintenance Schedule - Memory
Size intGb - Name string
- Nodes
[]Get
Instance Node - Persistence
Configs []GetInstance Persistence Config - Persistence
Iam stringIdentity - Port int
- Read
Endpoint string - Read
Endpoint intPort - Read
Replicas stringMode - Redis
Configs map[string]string - Redis
Version string - Replica
Count int - Reserved
Ip stringRange - Secondary
Ip stringRange - Server
Ca []GetCerts Instance Server Ca Cert - Tier string
- Transit
Encryption stringMode - Project string
- Region string
- alternative
Location StringId - auth
Enabled Boolean - auth
String String - String
- connect
Mode String - create
Time String - current
Location StringId - customer
Managed StringKey - display
Name String - host String
- id String
The provider-assigned unique ID for this managed resource.
- labels Map<String,String>
- location
Id String - maintenance
Policies List<GetInstance Maintenance Policy> - maintenance
Schedules List<GetInstance Maintenance Schedule> - memory
Size IntegerGb - name String
- nodes
List<Get
Instance Node> - persistence
Configs List<GetInstance Persistence Config> - persistence
Iam StringIdentity - port Integer
- read
Endpoint String - read
Endpoint IntegerPort - read
Replicas StringMode - redis
Configs Map<String,String> - redis
Version String - replica
Count Integer - reserved
Ip StringRange - secondary
Ip StringRange - server
Ca List<GetCerts Instance Server Ca Cert> - tier String
- transit
Encryption StringMode - project String
- region String
- alternative
Location stringId - auth
Enabled boolean - auth
String string - string
- connect
Mode string - create
Time string - current
Location stringId - customer
Managed stringKey - display
Name string - host string
- id string
The provider-assigned unique ID for this managed resource.
- labels {[key: string]: string}
- location
Id string - maintenance
Policies GetInstance Maintenance Policy[] - maintenance
Schedules GetInstance Maintenance Schedule[] - memory
Size numberGb - name string
- nodes
Get
Instance Node[] - persistence
Configs GetInstance Persistence Config[] - persistence
Iam stringIdentity - port number
- read
Endpoint string - read
Endpoint numberPort - read
Replicas stringMode - redis
Configs {[key: string]: string} - redis
Version string - replica
Count number - reserved
Ip stringRange - secondary
Ip stringRange - server
Ca GetCerts Instance Server Ca Cert[] - tier string
- transit
Encryption stringMode - project string
- region string
- alternative_
location_ strid - auth_
enabled bool - auth_
string str - str
- connect_
mode str - create_
time str - current_
location_ strid - customer_
managed_ strkey - display_
name str - host str
- id str
The provider-assigned unique ID for this managed resource.
- labels Mapping[str, str]
- location_
id str - maintenance_
policies Sequence[GetInstance Maintenance Policy] - maintenance_
schedules Sequence[GetInstance Maintenance Schedule] - memory_
size_ intgb - name str
- nodes
Sequence[Get
Instance Node] - persistence_
configs Sequence[GetInstance Persistence Config] - persistence_
iam_ stridentity - port int
- read_
endpoint str - read_
endpoint_ intport - read_
replicas_ strmode - redis_
configs Mapping[str, str] - redis_
version str - replica_
count int - reserved_
ip_ strrange - secondary_
ip_ strrange - server_
ca_ Sequence[Getcerts Instance Server Ca Cert] - tier str
- transit_
encryption_ strmode - project str
- region str
- alternative
Location StringId - auth
Enabled Boolean - auth
String String - String
- connect
Mode String - create
Time String - current
Location StringId - customer
Managed StringKey - display
Name String - host String
- id String
The provider-assigned unique ID for this managed resource.
- labels Map<String>
- location
Id String - maintenance
Policies List<Property Map> - maintenance
Schedules List<Property Map> - memory
Size NumberGb - name String
- nodes List<Property Map>
- persistence
Configs List<Property Map> - persistence
Iam StringIdentity - port Number
- read
Endpoint String - read
Endpoint NumberPort - read
Replicas StringMode - redis
Configs Map<String> - redis
Version String - replica
Count Number - reserved
Ip StringRange - secondary
Ip StringRange - server
Ca List<Property Map>Certs - tier String
- transit
Encryption StringMode - project String
- region String
Supporting Types
GetInstanceMaintenancePolicy
- create
Time String - description String
- update
Time String - weekly
Maintenance List<Property Map>Windows
GetInstanceMaintenancePolicyWeeklyMaintenanceWindow
- day String
- duration String
- start
Times List<Property Map>
GetInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime
GetInstanceMaintenanceSchedule
- End
Time string - Schedule
Deadline stringTime - Start
Time string
- End
Time string - Schedule
Deadline stringTime - Start
Time string
- end
Time String - schedule
Deadline StringTime - start
Time String
- end
Time string - schedule
Deadline stringTime - start
Time string
- end_
time str - schedule_
deadline_ strtime - start_
time str
- end
Time String - schedule
Deadline StringTime - start
Time String
GetInstanceNode
GetInstancePersistenceConfig
- Persistence
Mode string - Rdb
Next stringSnapshot Time - Rdb
Snapshot stringPeriod - Rdb
Snapshot stringStart Time
- Persistence
Mode string - Rdb
Next stringSnapshot Time - Rdb
Snapshot stringPeriod - Rdb
Snapshot stringStart Time
- persistence
Mode String - rdb
Next StringSnapshot Time - rdb
Snapshot StringPeriod - rdb
Snapshot StringStart Time
- persistence
Mode string - rdb
Next stringSnapshot Time - rdb
Snapshot stringPeriod - rdb
Snapshot stringStart Time
- persistence
Mode String - rdb
Next StringSnapshot Time - rdb
Snapshot StringPeriod - rdb
Snapshot StringStart Time
GetInstanceServerCaCert
- Cert string
- Create
Time string - Expire
Time string - Serial
Number string - Sha1Fingerprint string
- Cert string
- Create
Time string - Expire
Time string - Serial
Number string - Sha1Fingerprint string
- cert String
- create
Time String - expire
Time String - serial
Number String - sha1Fingerprint String
- cert string
- create
Time string - expire
Time string - serial
Number string - sha1Fingerprint string
- cert str
- create_
time str - expire_
time str - serial_
number str - sha1_
fingerprint str
- cert String
- create
Time String - expire
Time String - serial
Number String - sha1Fingerprint String
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.