This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
Creates a new Instance in a given project and location. Auto-naming is currently not supported for this resource.
Create Instance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);@overload
def Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_id: Optional[str] = None,
instance_type: Optional[InstanceInstanceType] = None,
instance_id: Optional[str] = None,
database_flags: Optional[Mapping[str, str]] = None,
labels: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
etag: Optional[str] = None,
gce_zone: Optional[str] = None,
client_connection_config: Optional[ClientConnectionConfigArgs] = None,
availability_type: Optional[InstanceAvailabilityType] = None,
annotations: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
machine_config: Optional[MachineConfigArgs] = None,
project: Optional[str] = None,
query_insights_config: Optional[QueryInsightsInstanceConfigArgs] = None,
read_pool_config: Optional[ReadPoolConfigArgs] = None,
request_id: Optional[str] = None)func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: google-native:alloydb/v1:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_alloydb_v1_instance" "name" {
# resource properties
}Parameters
- 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.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control 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.
- name String
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var instanceResource = new GoogleNative.AlloyDB.V1.Instance("instanceResource", new()
{
ClusterId = "string",
InstanceType = GoogleNative.AlloyDB.V1.InstanceInstanceType.InstanceTypeUnspecified,
InstanceId = "string",
DatabaseFlags =
{
{ "string", "string" },
},
Labels =
{
{ "string", "string" },
},
DisplayName = "string",
Etag = "string",
GceZone = "string",
ClientConnectionConfig = new GoogleNative.AlloyDB.V1.Inputs.ClientConnectionConfigArgs
{
RequireConnectors = false,
SslConfig = new GoogleNative.AlloyDB.V1.Inputs.SslConfigArgs
{
CaSource = GoogleNative.AlloyDB.V1.SslConfigCaSource.CaSourceUnspecified,
SslMode = GoogleNative.AlloyDB.V1.SslConfigSslMode.SslModeUnspecified,
},
},
AvailabilityType = GoogleNative.AlloyDB.V1.InstanceAvailabilityType.AvailabilityTypeUnspecified,
Annotations =
{
{ "string", "string" },
},
Location = "string",
MachineConfig = new GoogleNative.AlloyDB.V1.Inputs.MachineConfigArgs
{
CpuCount = 0,
},
Project = "string",
QueryInsightsConfig = new GoogleNative.AlloyDB.V1.Inputs.QueryInsightsInstanceConfigArgs
{
QueryPlansPerMinute = 0,
QueryStringLength = 0,
RecordApplicationTags = false,
RecordClientAddress = false,
},
ReadPoolConfig = new GoogleNative.AlloyDB.V1.Inputs.ReadPoolConfigArgs
{
NodeCount = 0,
},
RequestId = "string",
});
example, err := alloydb.NewInstance(ctx, "instanceResource", &alloydb.InstanceArgs{
ClusterId: pulumi.String("string"),
InstanceType: alloydb.InstanceInstanceTypeInstanceTypeUnspecified,
InstanceId: pulumi.String("string"),
DatabaseFlags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
Etag: pulumi.String("string"),
GceZone: pulumi.String("string"),
ClientConnectionConfig: &alloydb.ClientConnectionConfigArgs{
RequireConnectors: pulumi.Bool(false),
SslConfig: &alloydb.SslConfigArgs{
CaSource: alloydb.SslConfigCaSourceCaSourceUnspecified,
SslMode: alloydb.SslConfigSslModeSslModeUnspecified,
},
},
AvailabilityType: alloydb.InstanceAvailabilityTypeAvailabilityTypeUnspecified,
Annotations: pulumi.StringMap{
"string": pulumi.String("string"),
},
Location: pulumi.String("string"),
MachineConfig: &alloydb.MachineConfigArgs{
CpuCount: pulumi.Int(0),
},
Project: pulumi.String("string"),
QueryInsightsConfig: &alloydb.QueryInsightsInstanceConfigArgs{
QueryPlansPerMinute: pulumi.Int(0),
QueryStringLength: pulumi.Int(0),
RecordApplicationTags: pulumi.Bool(false),
RecordClientAddress: pulumi.Bool(false),
},
ReadPoolConfig: &alloydb.ReadPoolConfigArgs{
NodeCount: pulumi.Int(0),
},
RequestId: pulumi.String("string"),
})
resource "google-native_alloydb_v1_instance" "instanceResource" {
lifecycle {
create_before_destroy = true
}
cluster_id = "string"
instance_type = "INSTANCE_TYPE_UNSPECIFIED"
instance_id = "string"
database_flags = {
"string" = "string"
}
labels = {
"string" = "string"
}
display_name = "string"
etag = "string"
gce_zone = "string"
client_connection_config = {
require_connectors = false
ssl_config = {
ca_source = "CA_SOURCE_UNSPECIFIED"
ssl_mode = "SSL_MODE_UNSPECIFIED"
}
}
availability_type = "AVAILABILITY_TYPE_UNSPECIFIED"
annotations = {
"string" = "string"
}
location = "string"
machine_config = {
cpu_count = 0
}
project = "string"
query_insights_config = {
query_plans_per_minute = 0
query_string_length = 0
record_application_tags = false
record_client_address = false
}
read_pool_config = {
node_count = 0
}
request_id = "string"
}
var instanceResource = new com.pulumi.googlenative.alloydb_v1.Instance("instanceResource", com.pulumi.googlenative.alloydb_v1.InstanceArgs.builder()
.clusterId("string")
.instanceType(com.pulumi.googlenative.alloydb_v1.enums.InstanceInstanceType.InstanceTypeUnspecified)
.instanceId("string")
.databaseFlags(Map.of("string", "string"))
.labels(Map.of("string", "string"))
.displayName("string")
.etag("string")
.gceZone("string")
.clientConnectionConfig(com.pulumi.googlenative.alloydb_v1.inputs.ClientConnectionConfigArgs.builder()
.requireConnectors(false)
.sslConfig(com.pulumi.googlenative.alloydb_v1.inputs.SslConfigArgs.builder()
.caSource(com.pulumi.googlenative.alloydb_v1.enums.SslConfigCaSource.CaSourceUnspecified)
.sslMode(com.pulumi.googlenative.alloydb_v1.enums.SslConfigSslMode.SslModeUnspecified)
.build())
.build())
.availabilityType(com.pulumi.googlenative.alloydb_v1.enums.InstanceAvailabilityType.AvailabilityTypeUnspecified)
.annotations(Map.of("string", "string"))
.location("string")
.machineConfig(com.pulumi.googlenative.alloydb_v1.inputs.MachineConfigArgs.builder()
.cpuCount(0)
.build())
.project("string")
.queryInsightsConfig(com.pulumi.googlenative.alloydb_v1.inputs.QueryInsightsInstanceConfigArgs.builder()
.queryPlansPerMinute(0)
.queryStringLength(0)
.recordApplicationTags(false)
.recordClientAddress(false)
.build())
.readPoolConfig(com.pulumi.googlenative.alloydb_v1.inputs.ReadPoolConfigArgs.builder()
.nodeCount(0)
.build())
.requestId("string")
.build());
instance_resource = google_native.alloydb.v1.Instance("instanceResource",
cluster_id="string",
instance_type=google_native.alloydb.v1.InstanceInstanceType.INSTANCE_TYPE_UNSPECIFIED,
instance_id="string",
database_flags={
"string": "string",
},
labels={
"string": "string",
},
display_name="string",
etag="string",
gce_zone="string",
client_connection_config={
"require_connectors": False,
"ssl_config": {
"ca_source": google_native.alloydb.v1.SslConfigCaSource.CA_SOURCE_UNSPECIFIED,
"ssl_mode": google_native.alloydb.v1.SslConfigSslMode.SSL_MODE_UNSPECIFIED,
},
},
availability_type=google_native.alloydb.v1.InstanceAvailabilityType.AVAILABILITY_TYPE_UNSPECIFIED,
annotations={
"string": "string",
},
location="string",
machine_config={
"cpu_count": 0,
},
project="string",
query_insights_config={
"query_plans_per_minute": 0,
"query_string_length": 0,
"record_application_tags": False,
"record_client_address": False,
},
read_pool_config={
"node_count": 0,
},
request_id="string")
const instanceResource = new google_native.alloydb.v1.Instance("instanceResource", {
clusterId: "string",
instanceType: google_native.alloydb.v1.InstanceInstanceType.InstanceTypeUnspecified,
instanceId: "string",
databaseFlags: {
string: "string",
},
labels: {
string: "string",
},
displayName: "string",
etag: "string",
gceZone: "string",
clientConnectionConfig: {
requireConnectors: false,
sslConfig: {
caSource: google_native.alloydb.v1.SslConfigCaSource.CaSourceUnspecified,
sslMode: google_native.alloydb.v1.SslConfigSslMode.SslModeUnspecified,
},
},
availabilityType: google_native.alloydb.v1.InstanceAvailabilityType.AvailabilityTypeUnspecified,
annotations: {
string: "string",
},
location: "string",
machineConfig: {
cpuCount: 0,
},
project: "string",
queryInsightsConfig: {
queryPlansPerMinute: 0,
queryStringLength: 0,
recordApplicationTags: false,
recordClientAddress: false,
},
readPoolConfig: {
nodeCount: 0,
},
requestId: "string",
});
type: google-native:alloydb/v1:Instance
properties:
annotations:
string: string
availabilityType: AVAILABILITY_TYPE_UNSPECIFIED
clientConnectionConfig:
requireConnectors: false
sslConfig:
caSource: CA_SOURCE_UNSPECIFIED
sslMode: SSL_MODE_UNSPECIFIED
clusterId: string
databaseFlags:
string: string
displayName: string
etag: string
gceZone: string
instanceId: string
instanceType: INSTANCE_TYPE_UNSPECIFIED
labels:
string: string
location: string
machineConfig:
cpuCount: 0
project: string
queryInsightsConfig:
queryPlansPerMinute: 0
queryStringLength: 0
recordApplicationTags: false
recordClientAddress: false
readPoolConfig:
nodeCount: 0
requestId: string
Instance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Instance resource accepts the following input properties:
- Cluster
Id string - Instance
Id string - Required. ID of the requesting object.
- Instance
Type Pulumi.Google Native. Alloy DB. V1. Instance Instance Type - The type of the instance. Specified at creation time.
- Annotations Dictionary<string, string>
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- Availability
Type Pulumi.Google Native. Alloy DB. V1. Instance Availability Type - Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
- Client
Connection Pulumi.Config Google Native. Alloy DB. V1. Inputs. Client Connection Config - Optional. Client connection specific configurations
- Database
Flags Dictionary<string, string> - Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
- Display
Name string - User-settable and human-readable display name for the Instance.
- Etag string
- For Resource freshness validation (https://google.aip.dev/154)
- Gce
Zone string - The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
- Labels Dictionary<string, string>
- Labels as key value pairs
- Location string
- Machine
Config Pulumi.Google Native. Alloy DB. V1. Inputs. Machine Config - Configurations for the machines that host the underlying database engine.
- Project string
- Query
Insights Pulumi.Config Google Native. Alloy DB. V1. Inputs. Query Insights Instance Config - Configuration for query insights.
- Read
Pool Pulumi.Config Google Native. Alloy DB. V1. Inputs. Read Pool Config - Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
- Request
Id string - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Cluster
Id string - Instance
Id string - Required. ID of the requesting object.
- Instance
Type InstanceInstance Type - The type of the instance. Specified at creation time.
- Annotations map[string]string
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- Availability
Type InstanceAvailability Type - Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
- Client
Connection ClientConfig Connection Config Args - Optional. Client connection specific configurations
- Database
Flags map[string]string - Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
- Display
Name string - User-settable and human-readable display name for the Instance.
- Etag string
- For Resource freshness validation (https://google.aip.dev/154)
- Gce
Zone string - The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
- Labels map[string]string
- Labels as key value pairs
- Location string
- Machine
Config MachineConfig Args - Configurations for the machines that host the underlying database engine.
- Project string
- Query
Insights QueryConfig Insights Instance Config Args - Configuration for query insights.
- Read
Pool ReadConfig Pool Config Args - Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
- Request
Id string - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- cluster_
id string - instance_
id string - Required. ID of the requesting object.
- instance_
type "INSTANCE_TYPE_UNSPECIFIED" | "PRIMARY" | "READ_POOL" | "SECONDARY" - The type of the instance. Specified at creation time.
- annotations map(string)
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- availability_
type "AVAILABILITY_TYPE_UNSPECIFIED" | "ZONAL" | "REGIONAL" - Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
- client_
connection_ objectconfig - Optional. Client connection specific configurations
- database_
flags map(string) - Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
- display_
name string - User-settable and human-readable display name for the Instance.
- etag string
- For Resource freshness validation (https://google.aip.dev/154)
- gce_
zone string - The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
- labels map(string)
- Labels as key value pairs
- location string
- machine_
config object - Configurations for the machines that host the underlying database engine.
- project string
- query_
insights_ objectconfig - Configuration for query insights.
- read_
pool_ objectconfig - Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
- request_
id string - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- cluster
Id String - instance
Id String - Required. ID of the requesting object.
- instance
Type InstanceInstance Type - The type of the instance. Specified at creation time.
- annotations Map<String,String>
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- availability
Type InstanceAvailability Type - Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
- client
Connection ClientConfig Connection Config - Optional. Client connection specific configurations
- database
Flags Map<String,String> - Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
- display
Name String - User-settable and human-readable display name for the Instance.
- etag String
- For Resource freshness validation (https://google.aip.dev/154)
- gce
Zone String - The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
- labels Map<String,String>
- Labels as key value pairs
- location String
- machine
Config MachineConfig - Configurations for the machines that host the underlying database engine.
- project String
- query
Insights QueryConfig Insights Instance Config - Configuration for query insights.
- read
Pool ReadConfig Pool Config - Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
- request
Id String - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- cluster
Id string - instance
Id string - Required. ID of the requesting object.
- instance
Type InstanceInstance Type - The type of the instance. Specified at creation time.
- annotations {[key: string]: string}
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- availability
Type InstanceAvailability Type - Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
- client
Connection ClientConfig Connection Config - Optional. Client connection specific configurations
- database
Flags {[key: string]: string} - Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
- display
Name string - User-settable and human-readable display name for the Instance.
- etag string
- For Resource freshness validation (https://google.aip.dev/154)
- gce
Zone string - The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
- labels {[key: string]: string}
- Labels as key value pairs
- location string
- machine
Config MachineConfig - Configurations for the machines that host the underlying database engine.
- project string
- query
Insights QueryConfig Insights Instance Config - Configuration for query insights.
- read
Pool ReadConfig Pool Config - Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
- request
Id string - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- cluster_
id str - instance_
id str - Required. ID of the requesting object.
- instance_
type InstanceInstance Type - The type of the instance. Specified at creation time.
- annotations Mapping[str, str]
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- availability_
type InstanceAvailability Type - Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
- client_
connection_ Clientconfig Connection Config Args - Optional. Client connection specific configurations
- database_
flags Mapping[str, str] - Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
- display_
name str - User-settable and human-readable display name for the Instance.
- etag str
- For Resource freshness validation (https://google.aip.dev/154)
- gce_
zone str - The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
- labels Mapping[str, str]
- Labels as key value pairs
- location str
- machine_
config MachineConfig Args - Configurations for the machines that host the underlying database engine.
- project str
- query_
insights_ Queryconfig Insights Instance Config Args - Configuration for query insights.
- read_
pool_ Readconfig Pool Config Args - Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
- request_
id str - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- cluster
Id String - instance
Id String - Required. ID of the requesting object.
- instance
Type "INSTANCE_TYPE_UNSPECIFIED" | "PRIMARY" | "READ_POOL" | "SECONDARY" - The type of the instance. Specified at creation time.
- annotations Map<String>
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- availability
Type "AVAILABILITY_TYPE_UNSPECIFIED" | "ZONAL" | "REGIONAL" - Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
- client
Connection Property MapConfig - Optional. Client connection specific configurations
- database
Flags Map<String> - Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.
- display
Name String - User-settable and human-readable display name for the Instance.
- etag String
- For Resource freshness validation (https://google.aip.dev/154)
- gce
Zone String - The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
- labels Map<String>
- Labels as key value pairs
- location String
- machine
Config Property Map - Configurations for the machines that host the underlying database engine.
- project String
- query
Insights Property MapConfig - Configuration for query insights.
- read
Pool Property MapConfig - Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
- request
Id String - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Create
Time string - Create time stamp
- Delete
Time string - Delete time stamp
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Address string - The IP address for the Instance. This is the connection endpoint for an end-user application.
- Name string
- The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} - Nodes
List<Pulumi.
Google Native. Alloy DB. V1. Outputs. Node Response> - List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
- Reconciling bool
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- State string
- The current serving state of the instance.
- Uid string
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- Update
Time string - Update time stamp
- Writable
Node Pulumi.Google Native. Alloy DB. V1. Outputs. Node Response - This is set for the read-write VM of the PRIMARY instance only.
- Create
Time string - Create time stamp
- Delete
Time string - Delete time stamp
- Id string
- The provider-assigned unique ID for this managed resource.
- Ip
Address string - The IP address for the Instance. This is the connection endpoint for an end-user application.
- Name string
- The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} - Nodes
[]Node
Response - List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
- Reconciling bool
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- State string
- The current serving state of the instance.
- Uid string
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- Update
Time string - Update time stamp
- Writable
Node NodeResponse - This is set for the read-write VM of the PRIMARY instance only.
- create_
time string - Create time stamp
- delete_
time string - Delete time stamp
- id string
- The provider-assigned unique ID for this managed resource.
- ip_
address string - The IP address for the Instance. This is the connection endpoint for an end-user application.
- name string
- The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} - nodes list(object)
- List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
- reconciling bool
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- state string
- The current serving state of the instance.
- uid string
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- update_
time string - Update time stamp
- writable_
node object - This is set for the read-write VM of the PRIMARY instance only.
- create
Time String - Create time stamp
- delete
Time String - Delete time stamp
- id String
- The provider-assigned unique ID for this managed resource.
- ip
Address String - The IP address for the Instance. This is the connection endpoint for an end-user application.
- name String
- The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} - nodes
List<Node
Response> - List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
- reconciling Boolean
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- state String
- The current serving state of the instance.
- uid String
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- update
Time String - Update time stamp
- writable
Node NodeResponse - This is set for the read-write VM of the PRIMARY instance only.
- create
Time string - Create time stamp
- delete
Time string - Delete time stamp
- id string
- The provider-assigned unique ID for this managed resource.
- ip
Address string - The IP address for the Instance. This is the connection endpoint for an end-user application.
- name string
- The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} - nodes
Node
Response[] - List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
- reconciling boolean
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- state string
- The current serving state of the instance.
- uid string
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- update
Time string - Update time stamp
- writable
Node NodeResponse - This is set for the read-write VM of the PRIMARY instance only.
- create_
time str - Create time stamp
- delete_
time str - Delete time stamp
- id str
- The provider-assigned unique ID for this managed resource.
- ip_
address str - The IP address for the Instance. This is the connection endpoint for an end-user application.
- name str
- The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} - nodes
Sequence[Node
Response] - List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
- reconciling bool
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- state str
- The current serving state of the instance.
- uid str
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- update_
time str - Update time stamp
- writable_
node NodeResponse - This is set for the read-write VM of the PRIMARY instance only.
- create
Time String - Create time stamp
- delete
Time String - Delete time stamp
- id String
- The provider-assigned unique ID for this managed resource.
- ip
Address String - The IP address for the Instance. This is the connection endpoint for an end-user application.
- name String
- The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression
[a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} - nodes List<Property Map>
- List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
- reconciling Boolean
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- state String
- The current serving state of the instance.
- uid String
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- update
Time String - Update time stamp
- writable
Node Property Map - This is set for the read-write VM of the PRIMARY instance only.
Look up 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>, opts?: CustomResourceOptions): Instance@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Instancefunc GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)public static Instance Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Instance get(String name, Output<String> id, CustomResourceOptions options)resources: existingInstance: type: google-native:alloydb/v1:Instance get: id: ${id}import {
to = google-native_alloydb_v1_instance.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state InstanceState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
ClientConnectionConfig, ClientConnectionConfigArgs
Client connection configuration
- Require
Connectors bool - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- Ssl
Config Pulumi.Google Native. Alloy DB. V1. Inputs. Ssl Config - Optional. SSL config option for this instance.
- Require
Connectors bool - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- Ssl
Config SslConfig - Optional. SSL config option for this instance.
- require_
connectors bool - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- ssl_
config object - Optional. SSL config option for this instance.
- require
Connectors Boolean - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- ssl
Config SslConfig - Optional. SSL config option for this instance.
- require
Connectors boolean - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- ssl
Config SslConfig - Optional. SSL config option for this instance.
- require_
connectors bool - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- ssl_
config SslConfig - Optional. SSL config option for this instance.
- require
Connectors Boolean - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- ssl
Config Property Map - Optional. SSL config option for this instance.
ClientConnectionConfigResponse
Client connection configuration
- Require
Connectors bool - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- Ssl
Config Pulumi.Google Native. Alloy DB. V1. Inputs. Ssl Config Response - Optional. SSL config option for this instance.
- Require
Connectors bool - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- Ssl
Config SslConfig Response - Optional. SSL config option for this instance.
- require_
connectors bool - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- ssl_
config object - Optional. SSL config option for this instance.
- require
Connectors Boolean - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- ssl
Config SslConfig Response - Optional. SSL config option for this instance.
- require
Connectors boolean - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- ssl
Config SslConfig Response - Optional. SSL config option for this instance.
- require_
connectors bool - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- ssl_
config SslConfig Response - Optional. SSL config option for this instance.
- require
Connectors Boolean - Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
- ssl
Config Property Map - Optional. SSL config option for this instance.
InstanceAvailabilityType
Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
| Name | Value | Description |
|---|---|---|
| Availability | AVAILABILITY_TYPE_UNSPECIFIED | This is an unknown Availability type. |
| Zonal | ZONAL | Zonal available instance. |
| Regional | REGIONAL | Regional (or Highly) available instance. |
| Name | Value | Description |
|---|---|---|
| Instance | AVAILABILITY_TYPE_UNSPECIFIED | This is an unknown Availability type. |
| Instance | ZONAL | Zonal available instance. |
| Instance | REGIONAL | Regional (or Highly) available instance. |
| Value | Description |
|---|---|
AVAILABILITY_TYPE_UNSPECIFIED | This is an unknown Availability type. |
ZONAL | Zonal available instance. |
REGIONAL | Regional (or Highly) available instance. |
| Name | Value | Description |
|---|---|---|
| Availability | AVAILABILITY_TYPE_UNSPECIFIED | This is an unknown Availability type. |
| Zonal | ZONAL | Zonal available instance. |
| Regional | REGIONAL | Regional (or Highly) available instance. |
| Name | Value | Description |
|---|---|---|
| Availability | AVAILABILITY_TYPE_UNSPECIFIED | This is an unknown Availability type. |
| Zonal | ZONAL | Zonal available instance. |
| Regional | REGIONAL | Regional (or Highly) available instance. |
| Name | Value | Description |
|---|---|---|
| AVAILABILITY_TYPE_UNSPECIFIED | AVAILABILITY_TYPE_UNSPECIFIED | This is an unknown Availability type. |
| ZONAL | ZONAL | Zonal available instance. |
| REGIONAL | REGIONAL | Regional (or Highly) available instance. |
| Value | Description |
|---|---|
AVAILABILITY_TYPE_UNSPECIFIED | This is an unknown Availability type. |
ZONAL | Zonal available instance. |
REGIONAL | Regional (or Highly) available instance. |
InstanceInstanceType
Required. The type of the instance. Specified at creation time.
| Name | Value | Description |
|---|---|---|
| Instance | INSTANCE_TYPE_UNSPECIFIED | The type of the instance is unknown. |
| Primary | PRIMARY | PRIMARY instances support read and write operations. |
| Read | READ_POOL | READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region). |
| Secondary | SECONDARY | SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica |
| Name | Value | Description |
|---|---|---|
| Instance | INSTANCE_TYPE_UNSPECIFIED | The type of the instance is unknown. |
| Instance | PRIMARY | PRIMARY instances support read and write operations. |
| Instance | READ_POOL | READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region). |
| Instance | SECONDARY | SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica |
| Value | Description |
|---|---|
INSTANCE_TYPE_UNSPECIFIED | The type of the instance is unknown. |
PRIMARY | PRIMARY instances support read and write operations. |
READ_POOL | READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region). |
SECONDARY | SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica |
| Name | Value | Description |
|---|---|---|
| Instance | INSTANCE_TYPE_UNSPECIFIED | The type of the instance is unknown. |
| Primary | PRIMARY | PRIMARY instances support read and write operations. |
| Read | READ_POOL | READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region). |
| Secondary | SECONDARY | SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica |
| Name | Value | Description |
|---|---|---|
| Instance | INSTANCE_TYPE_UNSPECIFIED | The type of the instance is unknown. |
| Primary | PRIMARY | PRIMARY instances support read and write operations. |
| Read | READ_POOL | READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region). |
| Secondary | SECONDARY | SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica |
| Name | Value | Description |
|---|---|---|
| INSTANCE_TYPE_UNSPECIFIED | INSTANCE_TYPE_UNSPECIFIED | The type of the instance is unknown. |
| PRIMARY | PRIMARY | PRIMARY instances support read and write operations. |
| READ_POOL | READ_POOL | READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region). |
| SECONDARY | SECONDARY | SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica |
| Value | Description |
|---|---|
INSTANCE_TYPE_UNSPECIFIED | The type of the instance is unknown. |
PRIMARY | PRIMARY instances support read and write operations. |
READ_POOL | READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region). |
SECONDARY | SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica |
MachineConfig, MachineConfigArgs
MachineConfig describes the configuration of a machine.
- Cpu
Count int - The number of CPU's in the VM instance.
- Cpu
Count int - The number of CPU's in the VM instance.
- cpu_
count number - The number of CPU's in the VM instance.
- cpu
Count Integer - The number of CPU's in the VM instance.
- cpu
Count number - The number of CPU's in the VM instance.
- cpu_
count int - The number of CPU's in the VM instance.
- cpu
Count Number - The number of CPU's in the VM instance.
MachineConfigResponse
MachineConfig describes the configuration of a machine.
- Cpu
Count int - The number of CPU's in the VM instance.
- Cpu
Count int - The number of CPU's in the VM instance.
- cpu_
count number - The number of CPU's in the VM instance.
- cpu
Count Integer - The number of CPU's in the VM instance.
- cpu
Count number - The number of CPU's in the VM instance.
- cpu_
count int - The number of CPU's in the VM instance.
- cpu
Count Number - The number of CPU's in the VM instance.
NodeResponse
Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.
- Ip string
- The private IP address of the VM e.g. "10.57.0.34".
- State string
- Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
- Zone string
- The Compute Engine zone of the VM e.g. "us-central1-b".
- Ip string
- The private IP address of the VM e.g. "10.57.0.34".
- State string
- Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
- Zone string
- The Compute Engine zone of the VM e.g. "us-central1-b".
- ip string
- The private IP address of the VM e.g. "10.57.0.34".
- state string
- Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
- zone string
- The Compute Engine zone of the VM e.g. "us-central1-b".
- ip String
- The private IP address of the VM e.g. "10.57.0.34".
- state String
- Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
- zone String
- The Compute Engine zone of the VM e.g. "us-central1-b".
- ip string
- The private IP address of the VM e.g. "10.57.0.34".
- state string
- Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
- zone string
- The Compute Engine zone of the VM e.g. "us-central1-b".
- ip str
- The private IP address of the VM e.g. "10.57.0.34".
- state str
- Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
- zone str
- The Compute Engine zone of the VM e.g. "us-central1-b".
- ip String
- The private IP address of the VM e.g. "10.57.0.34".
- state String
- Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
- zone String
- The Compute Engine zone of the VM e.g. "us-central1-b".
QueryInsightsInstanceConfig, QueryInsightsInstanceConfigArgs
QueryInsights Instance specific configuration.
- Query
Plans intPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- Query
String intLength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- bool
- Record application tags for an instance. This flag is turned "on" by default.
- Record
Client boolAddress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- Query
Plans intPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- Query
String intLength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- bool
- Record application tags for an instance. This flag is turned "on" by default.
- Record
Client boolAddress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- query_
plans_ numberper_ minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- query_
string_ numberlength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- bool
- Record application tags for an instance. This flag is turned "on" by default.
- record_
client_ booladdress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- query
Plans IntegerPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- query
String IntegerLength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- Boolean
- Record application tags for an instance. This flag is turned "on" by default.
- record
Client BooleanAddress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- query
Plans numberPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- query
String numberLength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- boolean
- Record application tags for an instance. This flag is turned "on" by default.
- record
Client booleanAddress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- query_
plans_ intper_ minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- query_
string_ intlength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- bool
- Record application tags for an instance. This flag is turned "on" by default.
- record_
client_ booladdress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- query
Plans NumberPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- query
String NumberLength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- Boolean
- Record application tags for an instance. This flag is turned "on" by default.
- record
Client BooleanAddress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
QueryInsightsInstanceConfigResponse
QueryInsights Instance specific configuration.
- Query
Plans intPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- Query
String intLength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- bool
- Record application tags for an instance. This flag is turned "on" by default.
- Record
Client boolAddress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- Query
Plans intPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- Query
String intLength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- bool
- Record application tags for an instance. This flag is turned "on" by default.
- Record
Client boolAddress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- query_
plans_ numberper_ minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- query_
string_ numberlength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- bool
- Record application tags for an instance. This flag is turned "on" by default.
- record_
client_ booladdress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- query
Plans IntegerPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- query
String IntegerLength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- Boolean
- Record application tags for an instance. This flag is turned "on" by default.
- record
Client BooleanAddress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- query
Plans numberPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- query
String numberLength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- boolean
- Record application tags for an instance. This flag is turned "on" by default.
- record
Client booleanAddress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- query_
plans_ intper_ minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- query_
string_ intlength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- bool
- Record application tags for an instance. This flag is turned "on" by default.
- record_
client_ booladdress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
- query
Plans NumberPer Minute - Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
- query
String NumberLength - Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
- Boolean
- Record application tags for an instance. This flag is turned "on" by default.
- record
Client BooleanAddress - Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
ReadPoolConfig, ReadPoolConfigArgs
Configuration for a read pool instance.
- Node
Count int - Read capacity, i.e. number of nodes in a read pool instance.
- Node
Count int - Read capacity, i.e. number of nodes in a read pool instance.
- node_
count number - Read capacity, i.e. number of nodes in a read pool instance.
- node
Count Integer - Read capacity, i.e. number of nodes in a read pool instance.
- node
Count number - Read capacity, i.e. number of nodes in a read pool instance.
- node_
count int - Read capacity, i.e. number of nodes in a read pool instance.
- node
Count Number - Read capacity, i.e. number of nodes in a read pool instance.
ReadPoolConfigResponse
Configuration for a read pool instance.
- Node
Count int - Read capacity, i.e. number of nodes in a read pool instance.
- Node
Count int - Read capacity, i.e. number of nodes in a read pool instance.
- node_
count number - Read capacity, i.e. number of nodes in a read pool instance.
- node
Count Integer - Read capacity, i.e. number of nodes in a read pool instance.
- node
Count number - Read capacity, i.e. number of nodes in a read pool instance.
- node_
count int - Read capacity, i.e. number of nodes in a read pool instance.
- node
Count Number - Read capacity, i.e. number of nodes in a read pool instance.
SslConfig, SslConfigArgs
SSL configuration.
- Ca
Source Pulumi.Google Native. Alloy DB. V1. Ssl Config Ca Source - Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
- Ssl
Mode Pulumi.Google Native. Alloy DB. V1. Ssl Config Ssl Mode - Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
- Ca
Source SslConfig Ca Source - Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
- Ssl
Mode SslConfig Ssl Mode - Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
- ca_
source "CA_SOURCE_UNSPECIFIED" | "CA_SOURCE_MANAGED" - Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
- ssl_
mode "SSL_MODE_UNSPECIFIED" | "SSL_MODE_ALLOW" | "SSL_MODE_REQUIRE" | "SSL_MODE_VERIFY_CA" | "ALLOW_UNENCRYPTED_AND_ENCRYPTED" | "ENCRYPTED_ONLY" - Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
- ca
Source SslConfig Ca Source - Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
- ssl
Mode SslConfig Ssl Mode - Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
- ca
Source SslConfig Ca Source - Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
- ssl
Mode SslConfig Ssl Mode - Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
- ca_
source SslConfig Ca Source - Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
- ssl_
mode SslConfig Ssl Mode - Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
- ca
Source "CA_SOURCE_UNSPECIFIED" | "CA_SOURCE_MANAGED" - Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
- ssl
Mode "SSL_MODE_UNSPECIFIED" | "SSL_MODE_ALLOW" | "SSL_MODE_REQUIRE" | "SSL_MODE_VERIFY_CA" | "ALLOW_UNENCRYPTED_AND_ENCRYPTED" | "ENCRYPTED_ONLY" - Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
SslConfigCaSource
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
| Name | Value | Description |
|---|---|---|
| Ca | CA_SOURCE_UNSPECIFIED | Certificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED. |
| Ca | CA_SOURCE_MANAGED | Certificate Authority (CA) managed by the AlloyDB Cluster. |
| Name | Value | Description |
|---|---|---|
| Ssl | CA_SOURCE_UNSPECIFIED | Certificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED. |
| Ssl | CA_SOURCE_MANAGED | Certificate Authority (CA) managed by the AlloyDB Cluster. |
| Value | Description |
|---|---|
CA_SOURCE_UNSPECIFIED | Certificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED. |
CA_SOURCE_MANAGED | Certificate Authority (CA) managed by the AlloyDB Cluster. |
| Name | Value | Description |
|---|---|---|
| Ca | CA_SOURCE_UNSPECIFIED | Certificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED. |
| Ca | CA_SOURCE_MANAGED | Certificate Authority (CA) managed by the AlloyDB Cluster. |
| Name | Value | Description |
|---|---|---|
| Ca | CA_SOURCE_UNSPECIFIED | Certificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED. |
| Ca | CA_SOURCE_MANAGED | Certificate Authority (CA) managed by the AlloyDB Cluster. |
| Name | Value | Description |
|---|---|---|
| CA_SOURCE_UNSPECIFIED | CA_SOURCE_UNSPECIFIED | Certificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED. |
| CA_SOURCE_MANAGED | CA_SOURCE_MANAGED | Certificate Authority (CA) managed by the AlloyDB Cluster. |
| Value | Description |
|---|---|
CA_SOURCE_UNSPECIFIED | Certificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED. |
CA_SOURCE_MANAGED | Certificate Authority (CA) managed by the AlloyDB Cluster. |
SslConfigResponse
SSL configuration.
SslConfigSslMode
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
| Name | Value | Description |
|---|---|---|
| Ssl | SSL_MODE_UNSPECIFIED | SSL mode not specified. Defaults to ENCRYPTED_ONLY. |
| Ssl | SSL_MODE_ALLOW | SSL connections are optional. CA verification not enforced. |
| Ssl | SSL_MODE_REQUIRE | SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior). |
| Ssl | SSL_MODE_VERIFY_CA | SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate. |
| Allow | ALLOW_UNENCRYPTED_AND_ENCRYPTED | SSL connections are optional. CA verification not enforced. |
| Encrypted | ENCRYPTED_ONLY | SSL connections are required. CA verification not enforced. |
| Name | Value | Description |
|---|---|---|
| Ssl | SSL_MODE_UNSPECIFIED | SSL mode not specified. Defaults to ENCRYPTED_ONLY. |
| Ssl | SSL_MODE_ALLOW | SSL connections are optional. CA verification not enforced. |
| Ssl | SSL_MODE_REQUIRE | SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior). |
| Ssl | SSL_MODE_VERIFY_CA | SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate. |
| Ssl | ALLOW_UNENCRYPTED_AND_ENCRYPTED | SSL connections are optional. CA verification not enforced. |
| Ssl | ENCRYPTED_ONLY | SSL connections are required. CA verification not enforced. |
| Value | Description |
|---|---|
SSL_MODE_UNSPECIFIED | SSL mode not specified. Defaults to ENCRYPTED_ONLY. |
SSL_MODE_ALLOW | SSL connections are optional. CA verification not enforced. |
SSL_MODE_REQUIRE | SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior). |
SSL_MODE_VERIFY_CA | SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate. |
ALLOW_UNENCRYPTED_AND_ENCRYPTED | SSL connections are optional. CA verification not enforced. |
ENCRYPTED_ONLY | SSL connections are required. CA verification not enforced. |
| Name | Value | Description |
|---|---|---|
| Ssl | SSL_MODE_UNSPECIFIED | SSL mode not specified. Defaults to ENCRYPTED_ONLY. |
| Ssl | SSL_MODE_ALLOW | SSL connections are optional. CA verification not enforced. |
| Ssl | SSL_MODE_REQUIRE | SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior). |
| Ssl | SSL_MODE_VERIFY_CA | SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate. |
| Allow | ALLOW_UNENCRYPTED_AND_ENCRYPTED | SSL connections are optional. CA verification not enforced. |
| Encrypted | ENCRYPTED_ONLY | SSL connections are required. CA verification not enforced. |
| Name | Value | Description |
|---|---|---|
| Ssl | SSL_MODE_UNSPECIFIED | SSL mode not specified. Defaults to ENCRYPTED_ONLY. |
| Ssl | SSL_MODE_ALLOW | SSL connections are optional. CA verification not enforced. |
| Ssl | SSL_MODE_REQUIRE | SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior). |
| Ssl | SSL_MODE_VERIFY_CA | SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate. |
| Allow | ALLOW_UNENCRYPTED_AND_ENCRYPTED | SSL connections are optional. CA verification not enforced. |
| Encrypted | ENCRYPTED_ONLY | SSL connections are required. CA verification not enforced. |
| Name | Value | Description |
|---|---|---|
| SSL_MODE_UNSPECIFIED | SSL_MODE_UNSPECIFIED | SSL mode not specified. Defaults to ENCRYPTED_ONLY. |
| SSL_MODE_ALLOW | SSL_MODE_ALLOW | SSL connections are optional. CA verification not enforced. |
| SSL_MODE_REQUIRE | SSL_MODE_REQUIRE | SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior). |
| SSL_MODE_VERIFY_CA | SSL_MODE_VERIFY_CA | SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate. |
| ALLOW_UNENCRYPTED_AND_ENCRYPTED | ALLOW_UNENCRYPTED_AND_ENCRYPTED | SSL connections are optional. CA verification not enforced. |
| ENCRYPTED_ONLY | ENCRYPTED_ONLY | SSL connections are required. CA verification not enforced. |
| Value | Description |
|---|---|
SSL_MODE_UNSPECIFIED | SSL mode not specified. Defaults to ENCRYPTED_ONLY. |
SSL_MODE_ALLOW | SSL connections are optional. CA verification not enforced. |
SSL_MODE_REQUIRE | SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior). |
SSL_MODE_VERIFY_CA | SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate. |
ALLOW_UNENCRYPTED_AND_ENCRYPTED | SSL connections are optional. CA verification not enforced. |
ENCRYPTED_ONLY | SSL connections are required. CA verification not enforced. |
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi