Instance

A Google Cloud Redis instance.

To get more information about Instance, see:

API documentation
How-to Guides
- Official Documentation

Create a Instance Resource

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);

def Instance(resource_name, opts=None, alternative_location_id=None, authorized_network=None, connect_mode=None, display_name=None, labels=None, location_id=None, memory_size_gb=None, name=None, project=None, redis_configs=None, redis_version=None, region=None, reserved_ip_range=None, tier=None, __props__=None);

func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Instance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Instance resource accepts the following input properties:

MemorySizeGb int: Redis memory size in GiB.
AlternativeLocationId string: Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId].
AuthorizedNetwork string: The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
ConnectMode string: The connection mode of the Redis instance.
DisplayName string: An arbitrary and optional user-provided name for the instance.
Labels Dictionary<string, string>: Resource labels to represent user provided metadata.
LocationId string: The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId].
Name string: The ID of the instance or a fully qualified identifier for the instance.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RedisConfigs Dictionary<string, string>: Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs
RedisVersion string: The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: - REDIS_4_0 for Redis 4.0 compatibility - REDIS_3_2 for Redis 3.2 compatibility
Region string: The name of the Redis region of the instance.
ReservedIpRange string: The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
Tier string: The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances

MemorySizeGb int: Redis memory size in GiB.
AlternativeLocationId string: Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId].
AuthorizedNetwork string: The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
ConnectMode string: The connection mode of the Redis instance.
DisplayName string: An arbitrary and optional user-provided name for the instance.
Labels map[string]string: Resource labels to represent user provided metadata.
LocationId string: The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId].
Name string: The ID of the instance or a fully qualified identifier for the instance.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RedisConfigs map[string]string: Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs
RedisVersion string: The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: - REDIS_4_0 for Redis 4.0 compatibility - REDIS_3_2 for Redis 3.2 compatibility
Region string: The name of the Redis region of the instance.
ReservedIpRange string: The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
Tier string: The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances

memorySizeGb number: Redis memory size in GiB.
alternativeLocationId string: Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId].
authorizedNetwork string: The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
connectMode string: The connection mode of the Redis instance.
displayName string: An arbitrary and optional user-provided name for the instance.
labels {[key: string]: string}: Resource labels to represent user provided metadata.
locationId string: The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId].
name string: The ID of the instance or a fully qualified identifier for the instance.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
redisConfigs {[key: string]: string}: Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs
redisVersion string: The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: - REDIS_4_0 for Redis 4.0 compatibility - REDIS_3_2 for Redis 3.2 compatibility
region string: The name of the Redis region of the instance.
reservedIpRange string: The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
tier string: The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances

memory_size_gb float: Redis memory size in GiB.
alternative_location_id str: Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId].
authorized_network str: The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
connect_mode str: The connection mode of the Redis instance.
display_name str: An arbitrary and optional user-provided name for the instance.
labels Dict[str, str]: Resource labels to represent user provided metadata.
location_id str: The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId].
name str: The ID of the instance or a fully qualified identifier for the instance.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
redis_configs Dict[str, str]: Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs
redis_version str: The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: - REDIS_4_0 for Redis 4.0 compatibility - REDIS_3_2 for Redis 3.2 compatibility
region str: The name of the Redis region of the instance.
reserved_ip_range str: The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
tier str: The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances

Outputs

All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

CreateTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
CurrentLocationId string: The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [locationId] provided by the user at creation time. For Standard Tier instances, this can be either [locationId] or [alternativeLocationId] and can change after a failover event.
Host string: Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
Id string: The provider-assigned unique ID for this managed resource.
Port int: The port number of the exposed Redis endpoint.

CreateTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
CurrentLocationId string: The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [locationId] provided by the user at creation time. For Standard Tier instances, this can be either [locationId] or [alternativeLocationId] and can change after a failover event.
Host string: Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
Id string: The provider-assigned unique ID for this managed resource.
Port int: The port number of the exposed Redis endpoint.

createTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
currentLocationId string: The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [locationId] provided by the user at creation time. For Standard Tier instances, this can be either [locationId] or [alternativeLocationId] and can change after a failover event.
host string: Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
id string: The provider-assigned unique ID for this managed resource.
port number: The port number of the exposed Redis endpoint.

create_time str: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
current_location_id str: The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [locationId] provided by the user at creation time. For Standard Tier instances, this can be either [locationId] or [alternativeLocationId] and can change after a failover event.
host str: Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
id str: The provider-assigned unique ID for this managed resource.
port float: The port number of the exposed Redis endpoint.

Look up an Existing Instance Resource

Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance

static get(resource_name, id, opts=None, alternative_location_id=None, authorized_network=None, connect_mode=None, create_time=None, current_location_id=None, display_name=None, host=None, labels=None, location_id=None, memory_size_gb=None, name=None, port=None, project=None, redis_configs=None, redis_version=None, region=None, reserved_ip_range=None, tier=None, __props__=None);

func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)

public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AlternativeLocationId string: Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId].
AuthorizedNetwork string: The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
ConnectMode string: The connection mode of the Redis instance.
CreateTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
CurrentLocationId string: The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [locationId] provided by the user at creation time. For Standard Tier instances, this can be either [locationId] or [alternativeLocationId] and can change after a failover event.
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.
LocationId string: The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId].
MemorySizeGb int: Redis memory size in GiB.
Name string: The ID of the instance or a fully qualified identifier for the instance.
Port int: The port number of the exposed Redis endpoint.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RedisConfigs Dictionary<string, string>: Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs
RedisVersion string: The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: - REDIS_4_0 for Redis 4.0 compatibility - REDIS_3_2 for Redis 3.2 compatibility
Region string: The name of the Redis region of the instance.
ReservedIpRange string: The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
Tier string: The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances

AlternativeLocationId string: Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId].
AuthorizedNetwork string: The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
ConnectMode string: The connection mode of the Redis instance.
CreateTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
CurrentLocationId string: The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [locationId] provided by the user at creation time. For Standard Tier instances, this can be either [locationId] or [alternativeLocationId] and can change after a failover event.
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.
LocationId string: The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId].
MemorySizeGb int: Redis memory size in GiB.
Name string: The ID of the instance or a fully qualified identifier for the instance.
Port int: The port number of the exposed Redis endpoint.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RedisConfigs map[string]string: Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs
RedisVersion string: The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: - REDIS_4_0 for Redis 4.0 compatibility - REDIS_3_2 for Redis 3.2 compatibility
Region string: The name of the Redis region of the instance.
ReservedIpRange string: The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
Tier string: The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances

alternativeLocationId string: Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId].
authorizedNetwork string: The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
connectMode string: The connection mode of the Redis instance.
createTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
currentLocationId string: The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [locationId] provided by the user at creation time. For Standard Tier instances, this can be either [locationId] or [alternativeLocationId] and can change after a failover event.
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.
locationId string: The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId].
memorySizeGb number: Redis memory size in GiB.
name string: The ID of the instance or a fully qualified identifier for the instance.
port number: The port number of the exposed Redis endpoint.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
redisConfigs {[key: string]: string}: Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs
redisVersion string: The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: - REDIS_4_0 for Redis 4.0 compatibility - REDIS_3_2 for Redis 3.2 compatibility
region string: The name of the Redis region of the instance.
reservedIpRange string: The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
tier string: The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances

alternative_location_id str: Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId].
authorized_network str: The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
connect_mode str: The connection mode of the Redis instance.
create_time str: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
current_location_id str: The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [locationId] provided by the user at creation time. For Standard Tier instances, this can be either [locationId] or [alternativeLocationId] and can change after a failover event.
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 Dict[str, str]: Resource labels to represent user provided metadata.
location_id str: The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId].
memory_size_gb float: Redis memory size in GiB.
name str: The ID of the instance or a fully qualified identifier for the instance.
port float: The port number of the exposed Redis endpoint.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
redis_configs Dict[str, str]: Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs
redis_version str: The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: - REDIS_4_0 for Redis 4.0 compatibility - REDIS_3_2 for Redis 3.2 compatibility
region str: The name of the Redis region of the instance.
reserved_ip_range str: The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
tier str: The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud