Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. alloydb
  5. alloydb/v1beta
  6. Instance

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.alloydb/v1beta.Instance

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

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,
             update_policy: Optional[UpdatePolicyArgs] = 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/v1beta:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 exampleinstanceResourceResourceFromAlloydbv1beta = new GoogleNative.AlloyDB.V1Beta.Instance("exampleinstanceResourceResourceFromAlloydbv1beta", new()
{
    ClusterId = "string",
    InstanceType = GoogleNative.AlloyDB.V1Beta.InstanceInstanceType.InstanceTypeUnspecified,
    InstanceId = "string",
    DatabaseFlags = 
    {
        { "string", "string" },
    },
    Labels = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    Etag = "string",
    GceZone = "string",
    ClientConnectionConfig = new GoogleNative.AlloyDB.V1Beta.Inputs.ClientConnectionConfigArgs
    {
        RequireConnectors = false,
        SslConfig = new GoogleNative.AlloyDB.V1Beta.Inputs.SslConfigArgs
        {
            CaSource = GoogleNative.AlloyDB.V1Beta.SslConfigCaSource.CaSourceUnspecified,
            SslMode = GoogleNative.AlloyDB.V1Beta.SslConfigSslMode.SslModeUnspecified,
        },
    },
    AvailabilityType = GoogleNative.AlloyDB.V1Beta.InstanceAvailabilityType.AvailabilityTypeUnspecified,
    Annotations = 
    {
        { "string", "string" },
    },
    Location = "string",
    MachineConfig = new GoogleNative.AlloyDB.V1Beta.Inputs.MachineConfigArgs
    {
        CpuCount = 0,
    },
    Project = "string",
    QueryInsightsConfig = new GoogleNative.AlloyDB.V1Beta.Inputs.QueryInsightsInstanceConfigArgs
    {
        QueryPlansPerMinute = 0,
        QueryStringLength = 0,
        RecordApplicationTags = false,
        RecordClientAddress = false,
    },
    ReadPoolConfig = new GoogleNative.AlloyDB.V1Beta.Inputs.ReadPoolConfigArgs
    {
        NodeCount = 0,
    },
    RequestId = "string",
    UpdatePolicy = new GoogleNative.AlloyDB.V1Beta.Inputs.UpdatePolicyArgs
    {
        Mode = GoogleNative.AlloyDB.V1Beta.UpdatePolicyMode.ModeUnspecified,
    },
});
Copy
example, err := alloydbv1beta.NewInstance(ctx, "exampleinstanceResourceResourceFromAlloydbv1beta", &alloydbv1beta.InstanceArgs{
	ClusterId:    pulumi.String("string"),
	InstanceType: alloydbv1beta.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: alloydbv1beta.SslConfigCaSourceCaSourceUnspecified,
			SslMode:  alloydbv1beta.SslConfigSslModeSslModeUnspecified,
		},
	},
	AvailabilityType: alloydbv1beta.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"),
	UpdatePolicy: &alloydb.UpdatePolicyArgs{
		Mode: alloydbv1beta.UpdatePolicyModeModeUnspecified,
	},
})
Copy
var exampleinstanceResourceResourceFromAlloydbv1beta = new Instance("exampleinstanceResourceResourceFromAlloydbv1beta", InstanceArgs.builder()
    .clusterId("string")
    .instanceType("INSTANCE_TYPE_UNSPECIFIED")
    .instanceId("string")
    .databaseFlags(Map.of("string", "string"))
    .labels(Map.of("string", "string"))
    .displayName("string")
    .etag("string")
    .gceZone("string")
    .clientConnectionConfig(ClientConnectionConfigArgs.builder()
        .requireConnectors(false)
        .sslConfig(SslConfigArgs.builder()
            .caSource("CA_SOURCE_UNSPECIFIED")
            .sslMode("SSL_MODE_UNSPECIFIED")
            .build())
        .build())
    .availabilityType("AVAILABILITY_TYPE_UNSPECIFIED")
    .annotations(Map.of("string", "string"))
    .location("string")
    .machineConfig(MachineConfigArgs.builder()
        .cpuCount(0)
        .build())
    .project("string")
    .queryInsightsConfig(QueryInsightsInstanceConfigArgs.builder()
        .queryPlansPerMinute(0)
        .queryStringLength(0)
        .recordApplicationTags(false)
        .recordClientAddress(false)
        .build())
    .readPoolConfig(ReadPoolConfigArgs.builder()
        .nodeCount(0)
        .build())
    .requestId("string")
    .updatePolicy(UpdatePolicyArgs.builder()
        .mode("MODE_UNSPECIFIED")
        .build())
    .build());
Copy
exampleinstance_resource_resource_from_alloydbv1beta = google_native.alloydb.v1beta.Instance("exampleinstanceResourceResourceFromAlloydbv1beta",
    cluster_id="string",
    instance_type=google_native.alloydb.v1beta.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.v1beta.SslConfigCaSource.CA_SOURCE_UNSPECIFIED,
            "ssl_mode": google_native.alloydb.v1beta.SslConfigSslMode.SSL_MODE_UNSPECIFIED,
        },
    },
    availability_type=google_native.alloydb.v1beta.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",
    update_policy={
        "mode": google_native.alloydb.v1beta.UpdatePolicyMode.MODE_UNSPECIFIED,
    })
Copy
const exampleinstanceResourceResourceFromAlloydbv1beta = new google_native.alloydb.v1beta.Instance("exampleinstanceResourceResourceFromAlloydbv1beta", {
    clusterId: "string",
    instanceType: google_native.alloydb.v1beta.InstanceInstanceType.InstanceTypeUnspecified,
    instanceId: "string",
    databaseFlags: {
        string: "string",
    },
    labels: {
        string: "string",
    },
    displayName: "string",
    etag: "string",
    gceZone: "string",
    clientConnectionConfig: {
        requireConnectors: false,
        sslConfig: {
            caSource: google_native.alloydb.v1beta.SslConfigCaSource.CaSourceUnspecified,
            sslMode: google_native.alloydb.v1beta.SslConfigSslMode.SslModeUnspecified,
        },
    },
    availabilityType: google_native.alloydb.v1beta.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",
    updatePolicy: {
        mode: google_native.alloydb.v1beta.UpdatePolicyMode.ModeUnspecified,
    },
});
Copy
type: google-native:alloydb/v1beta: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
    updatePolicy:
        mode: MODE_UNSPECIFIED
Copy

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:

ClusterId
This property is required.
Changes to this property will trigger replacement.
string
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
Required. ID of the requesting object.
InstanceType This property is required. Pulumi.GoogleNative.AlloyDB.V1Beta.InstanceInstanceType
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
AvailabilityType Pulumi.GoogleNative.AlloyDB.V1Beta.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).
ClientConnectionConfig Pulumi.GoogleNative.AlloyDB.V1Beta.Inputs.ClientConnectionConfig
Optional. Client connection specific configurations
DatabaseFlags 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.
DisplayName string
User-settable and human-readable display name for the Instance.
Etag string
For Resource freshness validation (https://google.aip.dev/154)
GceZone 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 Changes to this property will trigger replacement. string
MachineConfig Pulumi.GoogleNative.AlloyDB.V1Beta.Inputs.MachineConfig
Configurations for the machines that host the underlying database engine.
Project Changes to this property will trigger replacement. string
QueryInsightsConfig Pulumi.GoogleNative.AlloyDB.V1Beta.Inputs.QueryInsightsInstanceConfig
Configuration for query insights.
ReadPoolConfig Pulumi.GoogleNative.AlloyDB.V1Beta.Inputs.ReadPoolConfig
Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
RequestId 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).
UpdatePolicy Pulumi.GoogleNative.AlloyDB.V1Beta.Inputs.UpdatePolicy
Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
ClusterId
This property is required.
Changes to this property will trigger replacement.
string
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
Required. ID of the requesting object.
InstanceType This property is required. InstanceInstanceType
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
AvailabilityType 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).
ClientConnectionConfig ClientConnectionConfigArgs
Optional. Client connection specific configurations
DatabaseFlags 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.
DisplayName string
User-settable and human-readable display name for the Instance.
Etag string
For Resource freshness validation (https://google.aip.dev/154)
GceZone 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 Changes to this property will trigger replacement. string
MachineConfig MachineConfigArgs
Configurations for the machines that host the underlying database engine.
Project Changes to this property will trigger replacement. string
QueryInsightsConfig QueryInsightsInstanceConfigArgs
Configuration for query insights.
ReadPoolConfig ReadPoolConfigArgs
Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
RequestId 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).
UpdatePolicy UpdatePolicyArgs
Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
clusterId
This property is required.
Changes to this property will trigger replacement.
String
instanceId
This property is required.
Changes to this property will trigger replacement.
String
Required. ID of the requesting object.
instanceType This property is required. InstanceInstanceType
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
availabilityType 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).
clientConnectionConfig ClientConnectionConfig
Optional. Client connection specific configurations
databaseFlags 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.
displayName String
User-settable and human-readable display name for the Instance.
etag String
For Resource freshness validation (https://google.aip.dev/154)
gceZone 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 Changes to this property will trigger replacement. String
machineConfig MachineConfig
Configurations for the machines that host the underlying database engine.
project Changes to this property will trigger replacement. String
queryInsightsConfig QueryInsightsInstanceConfig
Configuration for query insights.
readPoolConfig ReadPoolConfig
Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
requestId 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).
updatePolicy UpdatePolicy
Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
clusterId
This property is required.
Changes to this property will trigger replacement.
string
instanceId
This property is required.
Changes to this property will trigger replacement.
string
Required. ID of the requesting object.
instanceType This property is required. InstanceInstanceType
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
availabilityType 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).
clientConnectionConfig ClientConnectionConfig
Optional. Client connection specific configurations
databaseFlags {[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.
displayName string
User-settable and human-readable display name for the Instance.
etag string
For Resource freshness validation (https://google.aip.dev/154)
gceZone 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 Changes to this property will trigger replacement. string
machineConfig MachineConfig
Configurations for the machines that host the underlying database engine.
project Changes to this property will trigger replacement. string
queryInsightsConfig QueryInsightsInstanceConfig
Configuration for query insights.
readPoolConfig ReadPoolConfig
Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
requestId 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).
updatePolicy UpdatePolicy
Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
cluster_id
This property is required.
Changes to this property will trigger replacement.
str
instance_id
This property is required.
Changes to this property will trigger replacement.
str
Required. ID of the requesting object.
instance_type This property is required. InstanceInstanceType
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 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).
client_connection_config ClientConnectionConfigArgs
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 Changes to this property will trigger replacement. str
machine_config MachineConfigArgs
Configurations for the machines that host the underlying database engine.
project Changes to this property will trigger replacement. str
query_insights_config QueryInsightsInstanceConfigArgs
Configuration for query insights.
read_pool_config ReadPoolConfigArgs
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).
update_policy UpdatePolicyArgs
Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
clusterId
This property is required.
Changes to this property will trigger replacement.
String
instanceId
This property is required.
Changes to this property will trigger replacement.
String
Required. ID of the requesting object.
instanceType This property is required. "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
availabilityType "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).
clientConnectionConfig Property Map
Optional. Client connection specific configurations
databaseFlags 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.
displayName String
User-settable and human-readable display name for the Instance.
etag String
For Resource freshness validation (https://google.aip.dev/154)
gceZone 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 Changes to this property will trigger replacement. String
machineConfig Property Map
Configurations for the machines that host the underlying database engine.
project Changes to this property will trigger replacement. String
queryInsightsConfig Property Map
Configuration for query insights.
readPoolConfig Property Map
Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
requestId 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).
updatePolicy Property Map
Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.

Outputs

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

CreateTime string
Create time stamp
DeleteTime string
Delete time stamp
Id string
The provider-assigned unique ID for this managed resource.
IpAddress 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.GoogleNative.AlloyDB.V1Beta.Outputs.NodeResponse>
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.
UpdateTime string
Update time stamp
WritableNode Pulumi.GoogleNative.AlloyDB.V1Beta.Outputs.NodeResponse
This is set for the read-write VM of the PRIMARY instance only.
CreateTime string
Create time stamp
DeleteTime string
Delete time stamp
Id string
The provider-assigned unique ID for this managed resource.
IpAddress 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 []NodeResponse
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.
UpdateTime string
Update time stamp
WritableNode NodeResponse
This is set for the read-write VM of the PRIMARY instance only.
createTime String
Create time stamp
deleteTime String
Delete time stamp
id String
The provider-assigned unique ID for this managed resource.
ipAddress 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<NodeResponse>
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.
updateTime String
Update time stamp
writableNode NodeResponse
This is set for the read-write VM of the PRIMARY instance only.
createTime string
Create time stamp
deleteTime string
Delete time stamp
id string
The provider-assigned unique ID for this managed resource.
ipAddress 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 NodeResponse[]
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.
updateTime string
Update time stamp
writableNode 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[NodeResponse]
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.
createTime String
Create time stamp
deleteTime String
Delete time stamp
id String
The provider-assigned unique ID for this managed resource.
ipAddress 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.
updateTime String
Update time stamp
writableNode Property Map
This is set for the read-write VM of the PRIMARY instance only.

Supporting Types

ClientConnectionConfig
, ClientConnectionConfigArgs

RequireConnectors bool
Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
SslConfig Pulumi.GoogleNative.AlloyDB.V1Beta.Inputs.SslConfig
Optional. SSL config option for this instance.
RequireConnectors bool
Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
SslConfig SslConfig
Optional. SSL config option for this instance.
requireConnectors Boolean
Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
sslConfig SslConfig
Optional. SSL config option for this instance.
requireConnectors boolean
Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
sslConfig 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.
requireConnectors Boolean
Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
sslConfig Property Map
Optional. SSL config option for this instance.

ClientConnectionConfigResponse
, ClientConnectionConfigResponseArgs

RequireConnectors This property is required. bool
Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
SslConfig This property is required. Pulumi.GoogleNative.AlloyDB.V1Beta.Inputs.SslConfigResponse
Optional. SSL config option for this instance.
RequireConnectors This property is required. bool
Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
SslConfig This property is required. SslConfigResponse
Optional. SSL config option for this instance.
requireConnectors This property is required. Boolean
Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
sslConfig This property is required. SslConfigResponse
Optional. SSL config option for this instance.
requireConnectors This property is required. boolean
Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
sslConfig This property is required. SslConfigResponse
Optional. SSL config option for this instance.
require_connectors This property is required. bool
Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
ssl_config This property is required. SslConfigResponse
Optional. SSL config option for this instance.
requireConnectors This property is required. Boolean
Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
sslConfig This property is required. Property Map
Optional. SSL config option for this instance.

InstanceAvailabilityType
, InstanceAvailabilityTypeArgs

AvailabilityTypeUnspecified
AVAILABILITY_TYPE_UNSPECIFIEDThis is an unknown Availability type.
Zonal
ZONALZonal available instance.
Regional
REGIONALRegional (or Highly) available instance.
InstanceAvailabilityTypeAvailabilityTypeUnspecified
AVAILABILITY_TYPE_UNSPECIFIEDThis is an unknown Availability type.
InstanceAvailabilityTypeZonal
ZONALZonal available instance.
InstanceAvailabilityTypeRegional
REGIONALRegional (or Highly) available instance.
AvailabilityTypeUnspecified
AVAILABILITY_TYPE_UNSPECIFIEDThis is an unknown Availability type.
Zonal
ZONALZonal available instance.
Regional
REGIONALRegional (or Highly) available instance.
AvailabilityTypeUnspecified
AVAILABILITY_TYPE_UNSPECIFIEDThis is an unknown Availability type.
Zonal
ZONALZonal available instance.
Regional
REGIONALRegional (or Highly) available instance.
AVAILABILITY_TYPE_UNSPECIFIED
AVAILABILITY_TYPE_UNSPECIFIEDThis is an unknown Availability type.
ZONAL
ZONALZonal available instance.
REGIONAL
REGIONALRegional (or Highly) available instance.
"AVAILABILITY_TYPE_UNSPECIFIED"
AVAILABILITY_TYPE_UNSPECIFIEDThis is an unknown Availability type.
"ZONAL"
ZONALZonal available instance.
"REGIONAL"
REGIONALRegional (or Highly) available instance.

InstanceInstanceType
, InstanceInstanceTypeArgs

InstanceTypeUnspecified
INSTANCE_TYPE_UNSPECIFIEDThe type of the instance is unknown.
Primary
PRIMARYPRIMARY instances support read and write operations.
ReadPool
READ_POOLREAD 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
SECONDARYSECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica
InstanceInstanceTypeInstanceTypeUnspecified
INSTANCE_TYPE_UNSPECIFIEDThe type of the instance is unknown.
InstanceInstanceTypePrimary
PRIMARYPRIMARY instances support read and write operations.
InstanceInstanceTypeReadPool
READ_POOLREAD 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).
InstanceInstanceTypeSecondary
SECONDARYSECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica
InstanceTypeUnspecified
INSTANCE_TYPE_UNSPECIFIEDThe type of the instance is unknown.
Primary
PRIMARYPRIMARY instances support read and write operations.
ReadPool
READ_POOLREAD 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
SECONDARYSECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica
InstanceTypeUnspecified
INSTANCE_TYPE_UNSPECIFIEDThe type of the instance is unknown.
Primary
PRIMARYPRIMARY instances support read and write operations.
ReadPool
READ_POOLREAD 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
SECONDARYSECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica
INSTANCE_TYPE_UNSPECIFIED
INSTANCE_TYPE_UNSPECIFIEDThe type of the instance is unknown.
PRIMARY
PRIMARYPRIMARY instances support read and write operations.
READ_POOL
READ_POOLREAD 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
SECONDARYSECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica
"INSTANCE_TYPE_UNSPECIFIED"
INSTANCE_TYPE_UNSPECIFIEDThe type of the instance is unknown.
"PRIMARY"
PRIMARYPRIMARY instances support read and write operations.
"READ_POOL"
READ_POOLREAD 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"
SECONDARYSECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica

MachineConfig
, MachineConfigArgs

CpuCount int
The number of CPU's in the VM instance.
CpuCount int
The number of CPU's in the VM instance.
cpuCount Integer
The number of CPU's in the VM instance.
cpuCount number
The number of CPU's in the VM instance.
cpu_count int
The number of CPU's in the VM instance.
cpuCount Number
The number of CPU's in the VM instance.

MachineConfigResponse
, MachineConfigResponseArgs

CpuCount This property is required. int
The number of CPU's in the VM instance.
CpuCount This property is required. int
The number of CPU's in the VM instance.
cpuCount This property is required. Integer
The number of CPU's in the VM instance.
cpuCount This property is required. number
The number of CPU's in the VM instance.
cpu_count This property is required. int
The number of CPU's in the VM instance.
cpuCount This property is required. Number
The number of CPU's in the VM instance.

NodeResponse
, NodeResponseArgs

Ip This property is required. string
The private IP address of the VM e.g. "10.57.0.34".
State This property is required. 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 This property is required. string
The Compute Engine zone of the VM e.g. "us-central1-b".
Ip This property is required. string
The private IP address of the VM e.g. "10.57.0.34".
State This property is required. 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 This property is required. string
The Compute Engine zone of the VM e.g. "us-central1-b".
ip This property is required. String
The private IP address of the VM e.g. "10.57.0.34".
state This property is required. 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 This property is required. String
The Compute Engine zone of the VM e.g. "us-central1-b".
ip This property is required. string
The private IP address of the VM e.g. "10.57.0.34".
state This property is required. 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 This property is required. string
The Compute Engine zone of the VM e.g. "us-central1-b".
ip This property is required. str
The private IP address of the VM e.g. "10.57.0.34".
state This property is required. 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 This property is required. str
The Compute Engine zone of the VM e.g. "us-central1-b".
ip This property is required. String
The private IP address of the VM e.g. "10.57.0.34".
state This property is required. 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 This property is required. String
The Compute Engine zone of the VM e.g. "us-central1-b".

QueryInsightsInstanceConfig
, QueryInsightsInstanceConfigArgs

QueryPlansPerMinute int
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.
QueryStringLength int
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
RecordApplicationTags bool
Record application tags for an instance. This flag is turned "on" by default.
RecordClientAddress bool
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
QueryPlansPerMinute int
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.
QueryStringLength int
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
RecordApplicationTags bool
Record application tags for an instance. This flag is turned "on" by default.
RecordClientAddress bool
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
queryPlansPerMinute Integer
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.
queryStringLength Integer
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
recordApplicationTags Boolean
Record application tags for an instance. This flag is turned "on" by default.
recordClientAddress Boolean
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
queryPlansPerMinute number
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.
queryStringLength number
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
recordApplicationTags boolean
Record application tags for an instance. This flag is turned "on" by default.
recordClientAddress boolean
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
query_plans_per_minute int
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_length int
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
record_application_tags bool
Record application tags for an instance. This flag is turned "on" by default.
record_client_address bool
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
queryPlansPerMinute Number
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.
queryStringLength Number
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
recordApplicationTags Boolean
Record application tags for an instance. This flag is turned "on" by default.
recordClientAddress Boolean
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.

QueryInsightsInstanceConfigResponse
, QueryInsightsInstanceConfigResponseArgs

QueryPlansPerMinute This property is required. int
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.
QueryStringLength This property is required. int
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
RecordApplicationTags This property is required. bool
Record application tags for an instance. This flag is turned "on" by default.
RecordClientAddress This property is required. bool
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
QueryPlansPerMinute This property is required. int
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.
QueryStringLength This property is required. int
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
RecordApplicationTags This property is required. bool
Record application tags for an instance. This flag is turned "on" by default.
RecordClientAddress This property is required. bool
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
queryPlansPerMinute This property is required. Integer
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.
queryStringLength This property is required. Integer
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
recordApplicationTags This property is required. Boolean
Record application tags for an instance. This flag is turned "on" by default.
recordClientAddress This property is required. Boolean
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
queryPlansPerMinute This property is required. number
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.
queryStringLength This property is required. number
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
recordApplicationTags This property is required. boolean
Record application tags for an instance. This flag is turned "on" by default.
recordClientAddress This property is required. boolean
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
query_plans_per_minute This property is required. int
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_length This property is required. int
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
record_application_tags This property is required. bool
Record application tags for an instance. This flag is turned "on" by default.
record_client_address This property is required. bool
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
queryPlansPerMinute This property is required. Number
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.
queryStringLength This property is required. Number
Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
recordApplicationTags This property is required. Boolean
Record application tags for an instance. This flag is turned "on" by default.
recordClientAddress This property is required. Boolean
Record client address for an instance. Client address is PII information. This flag is turned "on" by default.

ReadPoolConfig
, ReadPoolConfigArgs

NodeCount int
Read capacity, i.e. number of nodes in a read pool instance.
NodeCount int
Read capacity, i.e. number of nodes in a read pool instance.
nodeCount Integer
Read capacity, i.e. number of nodes in a read pool instance.
nodeCount 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.
nodeCount Number
Read capacity, i.e. number of nodes in a read pool instance.

ReadPoolConfigResponse
, ReadPoolConfigResponseArgs

NodeCount This property is required. int
Read capacity, i.e. number of nodes in a read pool instance.
NodeCount This property is required. int
Read capacity, i.e. number of nodes in a read pool instance.
nodeCount This property is required. Integer
Read capacity, i.e. number of nodes in a read pool instance.
nodeCount This property is required. number
Read capacity, i.e. number of nodes in a read pool instance.
node_count This property is required. int
Read capacity, i.e. number of nodes in a read pool instance.
nodeCount This property is required. Number
Read capacity, i.e. number of nodes in a read pool instance.

SslConfig
, SslConfigArgs

CaSource Pulumi.GoogleNative.AlloyDB.V1Beta.SslConfigCaSource
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
SslMode Pulumi.GoogleNative.AlloyDB.V1Beta.SslConfigSslMode
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
CaSource SslConfigCaSource
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
SslMode SslConfigSslMode
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
caSource SslConfigCaSource
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
sslMode SslConfigSslMode
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
caSource SslConfigCaSource
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
sslMode SslConfigSslMode
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
ca_source SslConfigCaSource
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
ssl_mode SslConfigSslMode
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
caSource "CA_SOURCE_UNSPECIFIED" | "CA_SOURCE_MANAGED"
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
sslMode "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
, SslConfigCaSourceArgs

CaSourceUnspecified
CA_SOURCE_UNSPECIFIEDCertificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED.
CaSourceManaged
CA_SOURCE_MANAGEDCertificate Authority (CA) managed by the AlloyDB Cluster.
SslConfigCaSourceCaSourceUnspecified
CA_SOURCE_UNSPECIFIEDCertificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED.
SslConfigCaSourceCaSourceManaged
CA_SOURCE_MANAGEDCertificate Authority (CA) managed by the AlloyDB Cluster.
CaSourceUnspecified
CA_SOURCE_UNSPECIFIEDCertificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED.
CaSourceManaged
CA_SOURCE_MANAGEDCertificate Authority (CA) managed by the AlloyDB Cluster.
CaSourceUnspecified
CA_SOURCE_UNSPECIFIEDCertificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED.
CaSourceManaged
CA_SOURCE_MANAGEDCertificate Authority (CA) managed by the AlloyDB Cluster.
CA_SOURCE_UNSPECIFIED
CA_SOURCE_UNSPECIFIEDCertificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED.
CA_SOURCE_MANAGED
CA_SOURCE_MANAGEDCertificate Authority (CA) managed by the AlloyDB Cluster.
"CA_SOURCE_UNSPECIFIED"
CA_SOURCE_UNSPECIFIEDCertificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED.
"CA_SOURCE_MANAGED"
CA_SOURCE_MANAGEDCertificate Authority (CA) managed by the AlloyDB Cluster.

SslConfigResponse
, SslConfigResponseArgs

CaSource This property is required. string
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
SslMode This property is required. string
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
CaSource This property is required. string
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
SslMode This property is required. string
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
caSource This property is required. String
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
sslMode This property is required. String
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
caSource This property is required. string
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
sslMode This property is required. string
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
ca_source This property is required. str
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
ssl_mode This property is required. str
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
caSource This property is required. String
Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
sslMode This property is required. String
Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.

SslConfigSslMode
, SslConfigSslModeArgs

SslModeUnspecified
SSL_MODE_UNSPECIFIEDSSL mode not specified. Defaults to ENCRYPTED_ONLY.
SslModeAllow
SSL_MODE_ALLOWSSL connections are optional. CA verification not enforced.
SslModeRequire
SSL_MODE_REQUIRESSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior).
SslModeVerifyCa
SSL_MODE_VERIFY_CASSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate.
AllowUnencryptedAndEncrypted
ALLOW_UNENCRYPTED_AND_ENCRYPTEDSSL connections are optional. CA verification not enforced.
EncryptedOnly
ENCRYPTED_ONLYSSL connections are required. CA verification not enforced.
SslConfigSslModeSslModeUnspecified
SSL_MODE_UNSPECIFIEDSSL mode not specified. Defaults to ENCRYPTED_ONLY.
SslConfigSslModeSslModeAllow
SSL_MODE_ALLOWSSL connections are optional. CA verification not enforced.
SslConfigSslModeSslModeRequire
SSL_MODE_REQUIRESSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior).
SslConfigSslModeSslModeVerifyCa
SSL_MODE_VERIFY_CASSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate.
SslConfigSslModeAllowUnencryptedAndEncrypted
ALLOW_UNENCRYPTED_AND_ENCRYPTEDSSL connections are optional. CA verification not enforced.
SslConfigSslModeEncryptedOnly
ENCRYPTED_ONLYSSL connections are required. CA verification not enforced.
SslModeUnspecified
SSL_MODE_UNSPECIFIEDSSL mode not specified. Defaults to ENCRYPTED_ONLY.
SslModeAllow
SSL_MODE_ALLOWSSL connections are optional. CA verification not enforced.
SslModeRequire
SSL_MODE_REQUIRESSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior).
SslModeVerifyCa
SSL_MODE_VERIFY_CASSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate.
AllowUnencryptedAndEncrypted
ALLOW_UNENCRYPTED_AND_ENCRYPTEDSSL connections are optional. CA verification not enforced.
EncryptedOnly
ENCRYPTED_ONLYSSL connections are required. CA verification not enforced.
SslModeUnspecified
SSL_MODE_UNSPECIFIEDSSL mode not specified. Defaults to ENCRYPTED_ONLY.
SslModeAllow
SSL_MODE_ALLOWSSL connections are optional. CA verification not enforced.
SslModeRequire
SSL_MODE_REQUIRESSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior).
SslModeVerifyCa
SSL_MODE_VERIFY_CASSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate.
AllowUnencryptedAndEncrypted
ALLOW_UNENCRYPTED_AND_ENCRYPTEDSSL connections are optional. CA verification not enforced.
EncryptedOnly
ENCRYPTED_ONLYSSL connections are required. CA verification not enforced.
SSL_MODE_UNSPECIFIED
SSL_MODE_UNSPECIFIEDSSL mode not specified. Defaults to ENCRYPTED_ONLY.
SSL_MODE_ALLOW
SSL_MODE_ALLOWSSL connections are optional. CA verification not enforced.
SSL_MODE_REQUIRE
SSL_MODE_REQUIRESSL 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_CASSL 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_ENCRYPTEDSSL connections are optional. CA verification not enforced.
ENCRYPTED_ONLY
ENCRYPTED_ONLYSSL connections are required. CA verification not enforced.
"SSL_MODE_UNSPECIFIED"
SSL_MODE_UNSPECIFIEDSSL mode not specified. Defaults to ENCRYPTED_ONLY.
"SSL_MODE_ALLOW"
SSL_MODE_ALLOWSSL connections are optional. CA verification not enforced.
"SSL_MODE_REQUIRE"
SSL_MODE_REQUIRESSL 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_CASSL 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_ENCRYPTEDSSL connections are optional. CA verification not enforced.
"ENCRYPTED_ONLY"
ENCRYPTED_ONLYSSL connections are required. CA verification not enforced.

UpdatePolicy
, UpdatePolicyArgs

Mode UpdatePolicyMode
Mode for updating the instance.
mode UpdatePolicyMode
Mode for updating the instance.
mode UpdatePolicyMode
Mode for updating the instance.
mode UpdatePolicyMode
Mode for updating the instance.

UpdatePolicyMode
, UpdatePolicyModeArgs

ModeUnspecified
MODE_UNSPECIFIEDMode is unknown.
Default
DEFAULTLeast disruptive way to apply the update.
ForceApply
FORCE_APPLYPerforms a forced update when applicable. This will be fast but may incur a downtime.
UpdatePolicyModeModeUnspecified
MODE_UNSPECIFIEDMode is unknown.
UpdatePolicyModeDefault
DEFAULTLeast disruptive way to apply the update.
UpdatePolicyModeForceApply
FORCE_APPLYPerforms a forced update when applicable. This will be fast but may incur a downtime.
ModeUnspecified
MODE_UNSPECIFIEDMode is unknown.
Default
DEFAULTLeast disruptive way to apply the update.
ForceApply
FORCE_APPLYPerforms a forced update when applicable. This will be fast but may incur a downtime.
ModeUnspecified
MODE_UNSPECIFIEDMode is unknown.
Default
DEFAULTLeast disruptive way to apply the update.
ForceApply
FORCE_APPLYPerforms a forced update when applicable. This will be fast but may incur a downtime.
MODE_UNSPECIFIED
MODE_UNSPECIFIEDMode is unknown.
DEFAULT
DEFAULTLeast disruptive way to apply the update.
FORCE_APPLY
FORCE_APPLYPerforms a forced update when applicable. This will be fast but may incur a downtime.
"MODE_UNSPECIFIED"
MODE_UNSPECIFIEDMode is unknown.
"DEFAULT"
DEFAULTLeast disruptive way to apply the update.
"FORCE_APPLY"
FORCE_APPLYPerforms a forced update when applicable. This will be fast but may incur a downtime.

UpdatePolicyResponse
, UpdatePolicyResponseArgs

Mode This property is required. string
Mode for updating the instance.
Mode This property is required. string
Mode for updating the instance.
mode This property is required. String
Mode for updating the instance.
mode This property is required. string
Mode for updating the instance.
mode This property is required. str
Mode for updating the instance.
mode This property is required. String
Mode for updating the instance.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native