Google Cloud Classic v8.3.1, Sep 25 24

Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi

gcp.alloydb.Cluster

Explore with Pulumi AI

Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi

pulumi/pulumi-gcp

Example Usage

Alloydb Cluster Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const defaultNetwork = new gcp.compute.Network("default", {name: "alloydb-cluster"});
const _default = new gcp.alloydb.Cluster("default", {
    clusterId: "alloydb-cluster",
    location: "us-central1",
    networkConfig: {
        network: defaultNetwork.id,
    },
});
const project = gcp.organizations.getProject({});

import pulumi
import pulumi_gcp as gcp

default_network = gcp.compute.Network("default", name="alloydb-cluster")
default = gcp.alloydb.Cluster("default",
    cluster_id="alloydb-cluster",
    location="us-central1",
    network_config={
        "network": default_network.id,
    })
project = gcp.organizations.get_project()

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/alloydb"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		defaultNetwork, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
			Name: pulumi.String("alloydb-cluster"),
		})
		if err != nil {
			return err
		}
		_, err = alloydb.NewCluster(ctx, "default", &alloydb.ClusterArgs{
			ClusterId: pulumi.String("alloydb-cluster"),
			Location:  pulumi.String("us-central1"),
			NetworkConfig: &alloydb.ClusterNetworkConfigArgs{
				Network: defaultNetwork.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = organizations.LookupProject(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var defaultNetwork = new Gcp.Compute.Network("default", new()
    {
        Name = "alloydb-cluster",
    });

    var @default = new Gcp.Alloydb.Cluster("default", new()
    {
        ClusterId = "alloydb-cluster",
        Location = "us-central1",
        NetworkConfig = new Gcp.Alloydb.Inputs.ClusterNetworkConfigArgs
        {
            Network = defaultNetwork.Id,
        },
    });

    var project = Gcp.Organizations.GetProject.Invoke();

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.alloydb.Cluster;
import com.pulumi.gcp.alloydb.ClusterArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterNetworkConfigArgs;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .name("alloydb-cluster")
            .build());

        var default_ = new Cluster("default", ClusterArgs.builder()
            .clusterId("alloydb-cluster")
            .location("us-central1")
            .networkConfig(ClusterNetworkConfigArgs.builder()
                .network(defaultNetwork.id())
                .build())
            .build());

        final var project = OrganizationsFunctions.getProject();

    }
}

resources:
  default:
    type: gcp:alloydb:Cluster
    properties:
      clusterId: alloydb-cluster
      location: us-central1
      networkConfig:
        network: ${defaultNetwork.id}
  defaultNetwork:
    type: gcp:compute:Network
    name: default
    properties:
      name: alloydb-cluster
variables:
  project:
    fn::invoke:
      Function: gcp:organizations:getProject
      Arguments: {}

Alloydb Cluster Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.compute.Network("default", {name: "alloydb-cluster-full"});
const full = new gcp.alloydb.Cluster("full", {
    clusterId: "alloydb-cluster-full",
    location: "us-central1",
    networkConfig: {
        network: _default.id,
    },
    databaseVersion: "POSTGRES_15",
    initialUser: {
        user: "alloydb-cluster-full",
        password: "alloydb-cluster-full",
    },
    continuousBackupConfig: {
        enabled: true,
        recoveryWindowDays: 14,
    },
    automatedBackupPolicy: {
        location: "us-central1",
        backupWindow: "1800s",
        enabled: true,
        weeklySchedule: {
            daysOfWeeks: ["MONDAY"],
            startTimes: [{
                hours: 23,
                minutes: 0,
                seconds: 0,
                nanos: 0,
            }],
        },
        quantityBasedRetention: {
            count: 1,
        },
        labels: {
            test: "alloydb-cluster-full",
        },
    },
    labels: {
        test: "alloydb-cluster-full",
    },
});
const project = gcp.organizations.getProject({});

import pulumi
import pulumi_gcp as gcp

default = gcp.compute.Network("default", name="alloydb-cluster-full")
full = gcp.alloydb.Cluster("full",
    cluster_id="alloydb-cluster-full",
    location="us-central1",
    network_config={
        "network": default.id,
    },
    database_version="POSTGRES_15",
    initial_user={
        "user": "alloydb-cluster-full",
        "password": "alloydb-cluster-full",
    },
    continuous_backup_config={
        "enabled": True,
        "recovery_window_days": 14,
    },
    automated_backup_policy={
        "location": "us-central1",
        "backup_window": "1800s",
        "enabled": True,
        "weekly_schedule": {
            "days_of_weeks": ["MONDAY"],
            "start_times": [{
                "hours": 23,
                "minutes": 0,
                "seconds": 0,
                "nanos": 0,
            }],
        },
        "quantity_based_retention": {
            "count": 1,
        },
        "labels": {
            "test": "alloydb-cluster-full",
        },
    },
    labels={
        "test": "alloydb-cluster-full",
    })
project = gcp.organizations.get_project()

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/alloydb"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
			Name: pulumi.String("alloydb-cluster-full"),
		})
		if err != nil {
			return err
		}
		_, err = alloydb.NewCluster(ctx, "full", &alloydb.ClusterArgs{
			ClusterId: pulumi.String("alloydb-cluster-full"),
			Location:  pulumi.String("us-central1"),
			NetworkConfig: &alloydb.ClusterNetworkConfigArgs{
				Network: _default.ID(),
			},
			DatabaseVersion: pulumi.String("POSTGRES_15"),
			InitialUser: &alloydb.ClusterInitialUserArgs{
				User:     pulumi.String("alloydb-cluster-full"),
				Password: pulumi.String("alloydb-cluster-full"),
			},
			ContinuousBackupConfig: &alloydb.ClusterContinuousBackupConfigArgs{
				Enabled:            pulumi.Bool(true),
				RecoveryWindowDays: pulumi.Int(14),
			},
			AutomatedBackupPolicy: &alloydb.ClusterAutomatedBackupPolicyArgs{
				Location:     pulumi.String("us-central1"),
				BackupWindow: pulumi.String("1800s"),
				Enabled:      pulumi.Bool(true),
				WeeklySchedule: &alloydb.ClusterAutomatedBackupPolicyWeeklyScheduleArgs{
					DaysOfWeeks: pulumi.StringArray{
						pulumi.String("MONDAY"),
					},
					StartTimes: alloydb.ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArray{
						&alloydb.ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArgs{
							Hours:   pulumi.Int(23),
							Minutes: pulumi.Int(0),
							Seconds: pulumi.Int(0),
							Nanos:   pulumi.Int(0),
						},
					},
				},
				QuantityBasedRetention: &alloydb.ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs{
					Count: pulumi.Int(1),
				},
				Labels: pulumi.StringMap{
					"test": pulumi.String("alloydb-cluster-full"),
				},
			},
			Labels: pulumi.StringMap{
				"test": pulumi.String("alloydb-cluster-full"),
			},
		})
		if err != nil {
			return err
		}
		_, err = organizations.LookupProject(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.Compute.Network("default", new()
    {
        Name = "alloydb-cluster-full",
    });

    var full = new Gcp.Alloydb.Cluster("full", new()
    {
        ClusterId = "alloydb-cluster-full",
        Location = "us-central1",
        NetworkConfig = new Gcp.Alloydb.Inputs.ClusterNetworkConfigArgs
        {
            Network = @default.Id,
        },
        DatabaseVersion = "POSTGRES_15",
        InitialUser = new Gcp.Alloydb.Inputs.ClusterInitialUserArgs
        {
            User = "alloydb-cluster-full",
            Password = "alloydb-cluster-full",
        },
        ContinuousBackupConfig = new Gcp.Alloydb.Inputs.ClusterContinuousBackupConfigArgs
        {
            Enabled = true,
            RecoveryWindowDays = 14,
        },
        AutomatedBackupPolicy = new Gcp.Alloydb.Inputs.ClusterAutomatedBackupPolicyArgs
        {
            Location = "us-central1",
            BackupWindow = "1800s",
            Enabled = true,
            WeeklySchedule = new Gcp.Alloydb.Inputs.ClusterAutomatedBackupPolicyWeeklyScheduleArgs
            {
                DaysOfWeeks = new[]
                {
                    "MONDAY",
                },
                StartTimes = new[]
                {
                    new Gcp.Alloydb.Inputs.ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArgs
                    {
                        Hours = 23,
                        Minutes = 0,
                        Seconds = 0,
                        Nanos = 0,
                    },
                },
            },
            QuantityBasedRetention = new Gcp.Alloydb.Inputs.ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs
            {
                Count = 1,
            },
            Labels = 
            {
                { "test", "alloydb-cluster-full" },
            },
        },
        Labels = 
        {
            { "test", "alloydb-cluster-full" },
        },
    });

    var project = Gcp.Organizations.GetProject.Invoke();

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.alloydb.Cluster;
import com.pulumi.gcp.alloydb.ClusterArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterNetworkConfigArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterInitialUserArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterContinuousBackupConfigArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterAutomatedBackupPolicyArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterAutomatedBackupPolicyWeeklyScheduleArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new Network("default", NetworkArgs.builder()
            .name("alloydb-cluster-full")
            .build());

        var full = new Cluster("full", ClusterArgs.builder()
            .clusterId("alloydb-cluster-full")
            .location("us-central1")
            .networkConfig(ClusterNetworkConfigArgs.builder()
                .network(default_.id())
                .build())
            .databaseVersion("POSTGRES_15")
            .initialUser(ClusterInitialUserArgs.builder()
                .user("alloydb-cluster-full")
                .password("alloydb-cluster-full")
                .build())
            .continuousBackupConfig(ClusterContinuousBackupConfigArgs.builder()
                .enabled(true)
                .recoveryWindowDays(14)
                .build())
            .automatedBackupPolicy(ClusterAutomatedBackupPolicyArgs.builder()
                .location("us-central1")
                .backupWindow("1800s")
                .enabled(true)
                .weeklySchedule(ClusterAutomatedBackupPolicyWeeklyScheduleArgs.builder()
                    .daysOfWeeks("MONDAY")
                    .startTimes(ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArgs.builder()
                        .hours(23)
                        .minutes(0)
                        .seconds(0)
                        .nanos(0)
                        .build())
                    .build())
                .quantityBasedRetention(ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs.builder()
                    .count(1)
                    .build())
                .labels(Map.of("test", "alloydb-cluster-full"))
                .build())
            .labels(Map.of("test", "alloydb-cluster-full"))
            .build());

        final var project = OrganizationsFunctions.getProject();

    }
}

resources:
  full:
    type: gcp:alloydb:Cluster
    properties:
      clusterId: alloydb-cluster-full
      location: us-central1
      networkConfig:
        network: ${default.id}
      databaseVersion: POSTGRES_15
      initialUser:
        user: alloydb-cluster-full
        password: alloydb-cluster-full
      continuousBackupConfig:
        enabled: true
        recoveryWindowDays: 14
      automatedBackupPolicy:
        location: us-central1
        backupWindow: 1800s
        enabled: true
        weeklySchedule:
          daysOfWeeks:
            - MONDAY
          startTimes:
            - hours: 23
              minutes: 0
              seconds: 0
              nanos: 0
        quantityBasedRetention:
          count: 1
        labels:
          test: alloydb-cluster-full
      labels:
        test: alloydb-cluster-full
  default:
    type: gcp:compute:Network
    properties:
      name: alloydb-cluster-full
variables:
  project:
    fn::invoke:
      Function: gcp:organizations:getProject
      Arguments: {}

Alloydb Cluster Restore

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  source:
    type: gcp:alloydb:Cluster
    properties:
      clusterId: alloydb-source-cluster
      location: us-central1
      network: ${default.id}
      initialUser:
        password: alloydb-source-cluster
  sourceInstance:
    type: gcp:alloydb:Instance
    name: source
    properties:
      cluster: ${source.name}
      instanceId: alloydb-instance
      instanceType: PRIMARY
      machineConfig:
        cpuCount: 2
    options:
      dependson:
        - ${vpcConnection}
  sourceBackup:
    type: gcp:alloydb:Backup
    name: source
    properties:
      backupId: alloydb-backup
      location: us-central1
      clusterName: ${source.name}
    options:
      dependson:
        - ${sourceInstance}
  restoredFromBackup:
    type: gcp:alloydb:Cluster
    name: restored_from_backup
    properties:
      clusterId: alloydb-backup-restored
      location: us-central1
      networkConfig:
        network: ${default.id}
      restoreBackupSource:
        backupName: ${sourceBackup.name}
  restoredViaPitr:
    type: gcp:alloydb:Cluster
    name: restored_via_pitr
    properties:
      clusterId: alloydb-pitr-restored
      location: us-central1
      networkConfig:
        network: ${default.id}
      restoreContinuousBackupSource:
        cluster: ${source.name}
        pointInTime: 2023-08-03T19:19:00.094Z
  privateIpAlloc:
    type: gcp:compute:GlobalAddress
    name: private_ip_alloc
    properties:
      name: alloydb-source-cluster
      addressType: INTERNAL
      purpose: VPC_PEERING
      prefixLength: 16
      network: ${default.id}
  vpcConnection:
    type: gcp:servicenetworking:Connection
    name: vpc_connection
    properties:
      network: ${default.id}
      service: servicenetworking.googleapis.com
      reservedPeeringRanges:
        - ${privateIpAlloc.name}
variables:
  project:
    fn::invoke:
      Function: gcp:organizations:getProject
      Arguments: {}
  default:
    fn::invoke:
      Function: gcp:compute:getNetwork
      Arguments:
        name: alloydb-network

Alloydb Secondary Cluster Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.compute.Network("default", {name: "alloydb-secondary-cluster"});
const primary = new gcp.alloydb.Cluster("primary", {
    clusterId: "alloydb-primary-cluster",
    location: "us-central1",
    networkConfig: {
        network: _default.id,
    },
});
const privateIpAlloc = new gcp.compute.GlobalAddress("private_ip_alloc", {
    name: "alloydb-secondary-cluster",
    addressType: "INTERNAL",
    purpose: "VPC_PEERING",
    prefixLength: 16,
    network: _default.id,
});
const vpcConnection = new gcp.servicenetworking.Connection("vpc_connection", {
    network: _default.id,
    service: "servicenetworking.googleapis.com",
    reservedPeeringRanges: [privateIpAlloc.name],
});
const primaryInstance = new gcp.alloydb.Instance("primary", {
    cluster: primary.name,
    instanceId: "alloydb-primary-instance",
    instanceType: "PRIMARY",
    machineConfig: {
        cpuCount: 2,
    },
}, {
    dependsOn: [vpcConnection],
});
const secondary = new gcp.alloydb.Cluster("secondary", {
    clusterId: "alloydb-secondary-cluster",
    location: "us-east1",
    networkConfig: {
        network: _default.id,
    },
    clusterType: "SECONDARY",
    continuousBackupConfig: {
        enabled: false,
    },
    secondaryConfig: {
        primaryClusterName: primary.name,
    },
}, {
    dependsOn: [primaryInstance],
});
const project = gcp.organizations.getProject({});

import pulumi
import pulumi_gcp as gcp

default = gcp.compute.Network("default", name="alloydb-secondary-cluster")
primary = gcp.alloydb.Cluster("primary",
    cluster_id="alloydb-primary-cluster",
    location="us-central1",
    network_config={
        "network": default.id,
    })
private_ip_alloc = gcp.compute.GlobalAddress("private_ip_alloc",
    name="alloydb-secondary-cluster",
    address_type="INTERNAL",
    purpose="VPC_PEERING",
    prefix_length=16,
    network=default.id)
vpc_connection = gcp.servicenetworking.Connection("vpc_connection",
    network=default.id,
    service="servicenetworking.googleapis.com",
    reserved_peering_ranges=[private_ip_alloc.name])
primary_instance = gcp.alloydb.Instance("primary",
    cluster=primary.name,
    instance_id="alloydb-primary-instance",
    instance_type="PRIMARY",
    machine_config={
        "cpu_count": 2,
    },
    opts = pulumi.ResourceOptions(depends_on=[vpc_connection]))
secondary = gcp.alloydb.Cluster("secondary",
    cluster_id="alloydb-secondary-cluster",
    location="us-east1",
    network_config={
        "network": default.id,
    },
    cluster_type="SECONDARY",
    continuous_backup_config={
        "enabled": False,
    },
    secondary_config={
        "primary_cluster_name": primary.name,
    },
    opts = pulumi.ResourceOptions(depends_on=[primary_instance]))
project = gcp.organizations.get_project()

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/alloydb"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/servicenetworking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
			Name: pulumi.String("alloydb-secondary-cluster"),
		})
		if err != nil {
			return err
		}
		primary, err := alloydb.NewCluster(ctx, "primary", &alloydb.ClusterArgs{
			ClusterId: pulumi.String("alloydb-primary-cluster"),
			Location:  pulumi.String("us-central1"),
			NetworkConfig: &alloydb.ClusterNetworkConfigArgs{
				Network: _default.ID(),
			},
		})
		if err != nil {
			return err
		}
		privateIpAlloc, err := compute.NewGlobalAddress(ctx, "private_ip_alloc", &compute.GlobalAddressArgs{
			Name:         pulumi.String("alloydb-secondary-cluster"),
			AddressType:  pulumi.String("INTERNAL"),
			Purpose:      pulumi.String("VPC_PEERING"),
			PrefixLength: pulumi.Int(16),
			Network:      _default.ID(),
		})
		if err != nil {
			return err
		}
		vpcConnection, err := servicenetworking.NewConnection(ctx, "vpc_connection", &servicenetworking.ConnectionArgs{
			Network: _default.ID(),
			Service: pulumi.String("servicenetworking.googleapis.com"),
			ReservedPeeringRanges: pulumi.StringArray{
				privateIpAlloc.Name,
			},
		})
		if err != nil {
			return err
		}
		primaryInstance, err := alloydb.NewInstance(ctx, "primary", &alloydb.InstanceArgs{
			Cluster:      primary.Name,
			InstanceId:   pulumi.String("alloydb-primary-instance"),
			InstanceType: pulumi.String("PRIMARY"),
			MachineConfig: &alloydb.InstanceMachineConfigArgs{
				CpuCount: pulumi.Int(2),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			vpcConnection,
		}))
		if err != nil {
			return err
		}
		_, err = alloydb.NewCluster(ctx, "secondary", &alloydb.ClusterArgs{
			ClusterId: pulumi.String("alloydb-secondary-cluster"),
			Location:  pulumi.String("us-east1"),
			NetworkConfig: &alloydb.ClusterNetworkConfigArgs{
				Network: _default.ID(),
			},
			ClusterType: pulumi.String("SECONDARY"),
			ContinuousBackupConfig: &alloydb.ClusterContinuousBackupConfigArgs{
				Enabled: pulumi.Bool(false),
			},
			SecondaryConfig: &alloydb.ClusterSecondaryConfigArgs{
				PrimaryClusterName: primary.Name,
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			primaryInstance,
		}))
		if err != nil {
			return err
		}
		_, err = organizations.LookupProject(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.Compute.Network("default", new()
    {
        Name = "alloydb-secondary-cluster",
    });

    var primary = new Gcp.Alloydb.Cluster("primary", new()
    {
        ClusterId = "alloydb-primary-cluster",
        Location = "us-central1",
        NetworkConfig = new Gcp.Alloydb.Inputs.ClusterNetworkConfigArgs
        {
            Network = @default.Id,
        },
    });

    var privateIpAlloc = new Gcp.Compute.GlobalAddress("private_ip_alloc", new()
    {
        Name = "alloydb-secondary-cluster",
        AddressType = "INTERNAL",
        Purpose = "VPC_PEERING",
        PrefixLength = 16,
        Network = @default.Id,
    });

    var vpcConnection = new Gcp.ServiceNetworking.Connection("vpc_connection", new()
    {
        Network = @default.Id,
        Service = "servicenetworking.googleapis.com",
        ReservedPeeringRanges = new[]
        {
            privateIpAlloc.Name,
        },
    });

    var primaryInstance = new Gcp.Alloydb.Instance("primary", new()
    {
        Cluster = primary.Name,
        InstanceId = "alloydb-primary-instance",
        InstanceType = "PRIMARY",
        MachineConfig = new Gcp.Alloydb.Inputs.InstanceMachineConfigArgs
        {
            CpuCount = 2,
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            vpcConnection,
        },
    });

    var secondary = new Gcp.Alloydb.Cluster("secondary", new()
    {
        ClusterId = "alloydb-secondary-cluster",
        Location = "us-east1",
        NetworkConfig = new Gcp.Alloydb.Inputs.ClusterNetworkConfigArgs
        {
            Network = @default.Id,
        },
        ClusterType = "SECONDARY",
        ContinuousBackupConfig = new Gcp.Alloydb.Inputs.ClusterContinuousBackupConfigArgs
        {
            Enabled = false,
        },
        SecondaryConfig = new Gcp.Alloydb.Inputs.ClusterSecondaryConfigArgs
        {
            PrimaryClusterName = primary.Name,
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            primaryInstance,
        },
    });

    var project = Gcp.Organizations.GetProject.Invoke();

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.alloydb.Cluster;
import com.pulumi.gcp.alloydb.ClusterArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterNetworkConfigArgs;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.alloydb.Instance;
import com.pulumi.gcp.alloydb.InstanceArgs;
import com.pulumi.gcp.alloydb.inputs.InstanceMachineConfigArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterContinuousBackupConfigArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterSecondaryConfigArgs;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new Network("default", NetworkArgs.builder()
            .name("alloydb-secondary-cluster")
            .build());

        var primary = new Cluster("primary", ClusterArgs.builder()
            .clusterId("alloydb-primary-cluster")
            .location("us-central1")
            .networkConfig(ClusterNetworkConfigArgs.builder()
                .network(default_.id())
                .build())
            .build());

        var privateIpAlloc = new GlobalAddress("privateIpAlloc", GlobalAddressArgs.builder()
            .name("alloydb-secondary-cluster")
            .addressType("INTERNAL")
            .purpose("VPC_PEERING")
            .prefixLength(16)
            .network(default_.id())
            .build());

        var vpcConnection = new Connection("vpcConnection", ConnectionArgs.builder()
            .network(default_.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(privateIpAlloc.name())
            .build());

        var primaryInstance = new Instance("primaryInstance", InstanceArgs.builder()
            .cluster(primary.name())
            .instanceId("alloydb-primary-instance")
            .instanceType("PRIMARY")
            .machineConfig(InstanceMachineConfigArgs.builder()
                .cpuCount(2)
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(vpcConnection)
                .build());

        var secondary = new Cluster("secondary", ClusterArgs.builder()
            .clusterId("alloydb-secondary-cluster")
            .location("us-east1")
            .networkConfig(ClusterNetworkConfigArgs.builder()
                .network(default_.id())
                .build())
            .clusterType("SECONDARY")
            .continuousBackupConfig(ClusterContinuousBackupConfigArgs.builder()
                .enabled(false)
                .build())
            .secondaryConfig(ClusterSecondaryConfigArgs.builder()
                .primaryClusterName(primary.name())
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(primaryInstance)
                .build());

        final var project = OrganizationsFunctions.getProject();

    }
}

resources:
  primary:
    type: gcp:alloydb:Cluster
    properties:
      clusterId: alloydb-primary-cluster
      location: us-central1
      networkConfig:
        network: ${default.id}
  primaryInstance:
    type: gcp:alloydb:Instance
    name: primary
    properties:
      cluster: ${primary.name}
      instanceId: alloydb-primary-instance
      instanceType: PRIMARY
      machineConfig:
        cpuCount: 2
    options:
      dependson:
        - ${vpcConnection}
  secondary:
    type: gcp:alloydb:Cluster
    properties:
      clusterId: alloydb-secondary-cluster
      location: us-east1
      networkConfig:
        network: ${default.id}
      clusterType: SECONDARY
      continuousBackupConfig:
        enabled: false
      secondaryConfig:
        primaryClusterName: ${primary.name}
    options:
      dependson:
        - ${primaryInstance}
  default:
    type: gcp:compute:Network
    properties:
      name: alloydb-secondary-cluster
  privateIpAlloc:
    type: gcp:compute:GlobalAddress
    name: private_ip_alloc
    properties:
      name: alloydb-secondary-cluster
      addressType: INTERNAL
      purpose: VPC_PEERING
      prefixLength: 16
      network: ${default.id}
  vpcConnection:
    type: gcp:servicenetworking:Connection
    name: vpc_connection
    properties:
      network: ${default.id}
      service: servicenetworking.googleapis.com
      reservedPeeringRanges:
        - ${privateIpAlloc.name}
variables:
  project:
    fn::invoke:
      Function: gcp:organizations:getProject
      Arguments: {}

Create Cluster Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cluster_id: Optional[str] = None,
            location: Optional[str] = None,
            initial_user: Optional[ClusterInitialUserArgs] = None,
            labels: Optional[Mapping[str, str]] = None,
            continuous_backup_config: Optional[ClusterContinuousBackupConfigArgs] = None,
            database_version: Optional[str] = None,
            deletion_policy: Optional[str] = None,
            display_name: Optional[str] = None,
            encryption_config: Optional[ClusterEncryptionConfigArgs] = None,
            etag: Optional[str] = None,
            annotations: Optional[Mapping[str, str]] = None,
            cluster_type: Optional[str] = None,
            automated_backup_policy: Optional[ClusterAutomatedBackupPolicyArgs] = None,
            maintenance_update_policy: Optional[ClusterMaintenanceUpdatePolicyArgs] = None,
            network_config: Optional[ClusterNetworkConfigArgs] = None,
            project: Optional[str] = None,
            psc_config: Optional[ClusterPscConfigArgs] = None,
            restore_backup_source: Optional[ClusterRestoreBackupSourceArgs] = None,
            restore_continuous_backup_source: Optional[ClusterRestoreContinuousBackupSourceArgs] = None,
            secondary_config: Optional[ClusterSecondaryConfigArgs] = None,
            subscription_type: Optional[str] = None)

func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)

public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

type: gcp:alloydb:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ClusterArgs: 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 ClusterArgs: 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 ClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args ClusterArgs: 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 clusterResource = new Gcp.Alloydb.Cluster("clusterResource", new()
{
    ClusterId = "string",
    Location = "string",
    InitialUser = new Gcp.Alloydb.Inputs.ClusterInitialUserArgs
    {
        Password = "string",
        User = "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    ContinuousBackupConfig = new Gcp.Alloydb.Inputs.ClusterContinuousBackupConfigArgs
    {
        Enabled = false,
        EncryptionConfig = new Gcp.Alloydb.Inputs.ClusterContinuousBackupConfigEncryptionConfigArgs
        {
            KmsKeyName = "string",
        },
        RecoveryWindowDays = 0,
    },
    DatabaseVersion = "string",
    DeletionPolicy = "string",
    DisplayName = "string",
    EncryptionConfig = new Gcp.Alloydb.Inputs.ClusterEncryptionConfigArgs
    {
        KmsKeyName = "string",
    },
    Etag = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    ClusterType = "string",
    AutomatedBackupPolicy = new Gcp.Alloydb.Inputs.ClusterAutomatedBackupPolicyArgs
    {
        BackupWindow = "string",
        Enabled = false,
        EncryptionConfig = new Gcp.Alloydb.Inputs.ClusterAutomatedBackupPolicyEncryptionConfigArgs
        {
            KmsKeyName = "string",
        },
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        QuantityBasedRetention = new Gcp.Alloydb.Inputs.ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs
        {
            Count = 0,
        },
        TimeBasedRetention = new Gcp.Alloydb.Inputs.ClusterAutomatedBackupPolicyTimeBasedRetentionArgs
        {
            RetentionPeriod = "string",
        },
        WeeklySchedule = new Gcp.Alloydb.Inputs.ClusterAutomatedBackupPolicyWeeklyScheduleArgs
        {
            StartTimes = new[]
            {
                new Gcp.Alloydb.Inputs.ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArgs
                {
                    Hours = 0,
                    Minutes = 0,
                    Nanos = 0,
                    Seconds = 0,
                },
            },
            DaysOfWeeks = new[]
            {
                "string",
            },
        },
    },
    MaintenanceUpdatePolicy = new Gcp.Alloydb.Inputs.ClusterMaintenanceUpdatePolicyArgs
    {
        MaintenanceWindows = new[]
        {
            new Gcp.Alloydb.Inputs.ClusterMaintenanceUpdatePolicyMaintenanceWindowArgs
            {
                Day = "string",
                StartTime = new Gcp.Alloydb.Inputs.ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTimeArgs
                {
                    Hours = 0,
                    Minutes = 0,
                    Nanos = 0,
                    Seconds = 0,
                },
            },
        },
    },
    NetworkConfig = new Gcp.Alloydb.Inputs.ClusterNetworkConfigArgs
    {
        AllocatedIpRange = "string",
        Network = "string",
    },
    Project = "string",
    PscConfig = new Gcp.Alloydb.Inputs.ClusterPscConfigArgs
    {
        PscEnabled = false,
    },
    RestoreBackupSource = new Gcp.Alloydb.Inputs.ClusterRestoreBackupSourceArgs
    {
        BackupName = "string",
    },
    RestoreContinuousBackupSource = new Gcp.Alloydb.Inputs.ClusterRestoreContinuousBackupSourceArgs
    {
        Cluster = "string",
        PointInTime = "string",
    },
    SecondaryConfig = new Gcp.Alloydb.Inputs.ClusterSecondaryConfigArgs
    {
        PrimaryClusterName = "string",
    },
    SubscriptionType = "string",
});

example, err := alloydb.NewCluster(ctx, "clusterResource", &alloydb.ClusterArgs{
	ClusterId: pulumi.String("string"),
	Location:  pulumi.String("string"),
	InitialUser: &alloydb.ClusterInitialUserArgs{
		Password: pulumi.String("string"),
		User:     pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ContinuousBackupConfig: &alloydb.ClusterContinuousBackupConfigArgs{
		Enabled: pulumi.Bool(false),
		EncryptionConfig: &alloydb.ClusterContinuousBackupConfigEncryptionConfigArgs{
			KmsKeyName: pulumi.String("string"),
		},
		RecoveryWindowDays: pulumi.Int(0),
	},
	DatabaseVersion: pulumi.String("string"),
	DeletionPolicy:  pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	EncryptionConfig: &alloydb.ClusterEncryptionConfigArgs{
		KmsKeyName: pulumi.String("string"),
	},
	Etag: pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ClusterType: pulumi.String("string"),
	AutomatedBackupPolicy: &alloydb.ClusterAutomatedBackupPolicyArgs{
		BackupWindow: pulumi.String("string"),
		Enabled:      pulumi.Bool(false),
		EncryptionConfig: &alloydb.ClusterAutomatedBackupPolicyEncryptionConfigArgs{
			KmsKeyName: pulumi.String("string"),
		},
		Labels: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Location: pulumi.String("string"),
		QuantityBasedRetention: &alloydb.ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs{
			Count: pulumi.Int(0),
		},
		TimeBasedRetention: &alloydb.ClusterAutomatedBackupPolicyTimeBasedRetentionArgs{
			RetentionPeriod: pulumi.String("string"),
		},
		WeeklySchedule: &alloydb.ClusterAutomatedBackupPolicyWeeklyScheduleArgs{
			StartTimes: alloydb.ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArray{
				&alloydb.ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArgs{
					Hours:   pulumi.Int(0),
					Minutes: pulumi.Int(0),
					Nanos:   pulumi.Int(0),
					Seconds: pulumi.Int(0),
				},
			},
			DaysOfWeeks: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	MaintenanceUpdatePolicy: &alloydb.ClusterMaintenanceUpdatePolicyArgs{
		MaintenanceWindows: alloydb.ClusterMaintenanceUpdatePolicyMaintenanceWindowArray{
			&alloydb.ClusterMaintenanceUpdatePolicyMaintenanceWindowArgs{
				Day: pulumi.String("string"),
				StartTime: &alloydb.ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTimeArgs{
					Hours:   pulumi.Int(0),
					Minutes: pulumi.Int(0),
					Nanos:   pulumi.Int(0),
					Seconds: pulumi.Int(0),
				},
			},
		},
	},
	NetworkConfig: &alloydb.ClusterNetworkConfigArgs{
		AllocatedIpRange: pulumi.String("string"),
		Network:          pulumi.String("string"),
	},
	Project: pulumi.String("string"),
	PscConfig: &alloydb.ClusterPscConfigArgs{
		PscEnabled: pulumi.Bool(false),
	},
	RestoreBackupSource: &alloydb.ClusterRestoreBackupSourceArgs{
		BackupName: pulumi.String("string"),
	},
	RestoreContinuousBackupSource: &alloydb.ClusterRestoreContinuousBackupSourceArgs{
		Cluster:     pulumi.String("string"),
		PointInTime: pulumi.String("string"),
	},
	SecondaryConfig: &alloydb.ClusterSecondaryConfigArgs{
		PrimaryClusterName: pulumi.String("string"),
	},
	SubscriptionType: pulumi.String("string"),
})

var clusterResource = new Cluster("clusterResource", ClusterArgs.builder()
    .clusterId("string")
    .location("string")
    .initialUser(ClusterInitialUserArgs.builder()
        .password("string")
        .user("string")
        .build())
    .labels(Map.of("string", "string"))
    .continuousBackupConfig(ClusterContinuousBackupConfigArgs.builder()
        .enabled(false)
        .encryptionConfig(ClusterContinuousBackupConfigEncryptionConfigArgs.builder()
            .kmsKeyName("string")
            .build())
        .recoveryWindowDays(0)
        .build())
    .databaseVersion("string")
    .deletionPolicy("string")
    .displayName("string")
    .encryptionConfig(ClusterEncryptionConfigArgs.builder()
        .kmsKeyName("string")
        .build())
    .etag("string")
    .annotations(Map.of("string", "string"))
    .clusterType("string")
    .automatedBackupPolicy(ClusterAutomatedBackupPolicyArgs.builder()
        .backupWindow("string")
        .enabled(false)
        .encryptionConfig(ClusterAutomatedBackupPolicyEncryptionConfigArgs.builder()
            .kmsKeyName("string")
            .build())
        .labels(Map.of("string", "string"))
        .location("string")
        .quantityBasedRetention(ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs.builder()
            .count(0)
            .build())
        .timeBasedRetention(ClusterAutomatedBackupPolicyTimeBasedRetentionArgs.builder()
            .retentionPeriod("string")
            .build())
        .weeklySchedule(ClusterAutomatedBackupPolicyWeeklyScheduleArgs.builder()
            .startTimes(ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArgs.builder()
                .hours(0)
                .minutes(0)
                .nanos(0)
                .seconds(0)
                .build())
            .daysOfWeeks("string")
            .build())
        .build())
    .maintenanceUpdatePolicy(ClusterMaintenanceUpdatePolicyArgs.builder()
        .maintenanceWindows(ClusterMaintenanceUpdatePolicyMaintenanceWindowArgs.builder()
            .day("string")
            .startTime(ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTimeArgs.builder()
                .hours(0)
                .minutes(0)
                .nanos(0)
                .seconds(0)
                .build())
            .build())
        .build())
    .networkConfig(ClusterNetworkConfigArgs.builder()
        .allocatedIpRange("string")
        .network("string")
        .build())
    .project("string")
    .pscConfig(ClusterPscConfigArgs.builder()
        .pscEnabled(false)
        .build())
    .restoreBackupSource(ClusterRestoreBackupSourceArgs.builder()
        .backupName("string")
        .build())
    .restoreContinuousBackupSource(ClusterRestoreContinuousBackupSourceArgs.builder()
        .cluster("string")
        .pointInTime("string")
        .build())
    .secondaryConfig(ClusterSecondaryConfigArgs.builder()
        .primaryClusterName("string")
        .build())
    .subscriptionType("string")
    .build());

cluster_resource = gcp.alloydb.Cluster("clusterResource",
    cluster_id="string",
    location="string",
    initial_user={
        "password": "string",
        "user": "string",
    },
    labels={
        "string": "string",
    },
    continuous_backup_config={
        "enabled": False,
        "encryptionConfig": {
            "kmsKeyName": "string",
        },
        "recoveryWindowDays": 0,
    },
    database_version="string",
    deletion_policy="string",
    display_name="string",
    encryption_config={
        "kmsKeyName": "string",
    },
    etag="string",
    annotations={
        "string": "string",
    },
    cluster_type="string",
    automated_backup_policy={
        "backupWindow": "string",
        "enabled": False,
        "encryptionConfig": {
            "kmsKeyName": "string",
        },
        "labels": {
            "string": "string",
        },
        "location": "string",
        "quantityBasedRetention": {
            "count": 0,
        },
        "timeBasedRetention": {
            "retentionPeriod": "string",
        },
        "weeklySchedule": {
            "startTimes": [{
                "hours": 0,
                "minutes": 0,
                "nanos": 0,
                "seconds": 0,
            }],
            "daysOfWeeks": ["string"],
        },
    },
    maintenance_update_policy={
        "maintenanceWindows": [{
            "day": "string",
            "startTime": {
                "hours": 0,
                "minutes": 0,
                "nanos": 0,
                "seconds": 0,
            },
        }],
    },
    network_config={
        "allocatedIpRange": "string",
        "network": "string",
    },
    project="string",
    psc_config={
        "pscEnabled": False,
    },
    restore_backup_source={
        "backupName": "string",
    },
    restore_continuous_backup_source={
        "cluster": "string",
        "pointInTime": "string",
    },
    secondary_config={
        "primaryClusterName": "string",
    },
    subscription_type="string")

const clusterResource = new gcp.alloydb.Cluster("clusterResource", {
    clusterId: "string",
    location: "string",
    initialUser: {
        password: "string",
        user: "string",
    },
    labels: {
        string: "string",
    },
    continuousBackupConfig: {
        enabled: false,
        encryptionConfig: {
            kmsKeyName: "string",
        },
        recoveryWindowDays: 0,
    },
    databaseVersion: "string",
    deletionPolicy: "string",
    displayName: "string",
    encryptionConfig: {
        kmsKeyName: "string",
    },
    etag: "string",
    annotations: {
        string: "string",
    },
    clusterType: "string",
    automatedBackupPolicy: {
        backupWindow: "string",
        enabled: false,
        encryptionConfig: {
            kmsKeyName: "string",
        },
        labels: {
            string: "string",
        },
        location: "string",
        quantityBasedRetention: {
            count: 0,
        },
        timeBasedRetention: {
            retentionPeriod: "string",
        },
        weeklySchedule: {
            startTimes: [{
                hours: 0,
                minutes: 0,
                nanos: 0,
                seconds: 0,
            }],
            daysOfWeeks: ["string"],
        },
    },
    maintenanceUpdatePolicy: {
        maintenanceWindows: [{
            day: "string",
            startTime: {
                hours: 0,
                minutes: 0,
                nanos: 0,
                seconds: 0,
            },
        }],
    },
    networkConfig: {
        allocatedIpRange: "string",
        network: "string",
    },
    project: "string",
    pscConfig: {
        pscEnabled: false,
    },
    restoreBackupSource: {
        backupName: "string",
    },
    restoreContinuousBackupSource: {
        cluster: "string",
        pointInTime: "string",
    },
    secondaryConfig: {
        primaryClusterName: "string",
    },
    subscriptionType: "string",
});

type: gcp:alloydb:Cluster
properties:
    annotations:
        string: string
    automatedBackupPolicy:
        backupWindow: string
        enabled: false
        encryptionConfig:
            kmsKeyName: string
        labels:
            string: string
        location: string
        quantityBasedRetention:
            count: 0
        timeBasedRetention:
            retentionPeriod: string
        weeklySchedule:
            daysOfWeeks:
                - string
            startTimes:
                - hours: 0
                  minutes: 0
                  nanos: 0
                  seconds: 0
    clusterId: string
    clusterType: string
    continuousBackupConfig:
        enabled: false
        encryptionConfig:
            kmsKeyName: string
        recoveryWindowDays: 0
    databaseVersion: string
    deletionPolicy: string
    displayName: string
    encryptionConfig:
        kmsKeyName: string
    etag: string
    initialUser:
        password: string
        user: string
    labels:
        string: string
    location: string
    maintenanceUpdatePolicy:
        maintenanceWindows:
            - day: string
              startTime:
                hours: 0
                minutes: 0
                nanos: 0
                seconds: 0
    networkConfig:
        allocatedIpRange: string
        network: string
    project: string
    pscConfig:
        pscEnabled: false
    restoreBackupSource:
        backupName: string
    restoreContinuousBackupSource:
        cluster: string
        pointInTime: string
    secondaryConfig:
        primaryClusterName: string
    subscriptionType: string

Cluster Resource Properties

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

Inputs

The Cluster resource accepts the following input properties:

ClusterId string

The ID of the alloydb cluster.

Location string

The location where the alloydb cluster should reside.

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 An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

AutomatedBackupPolicy ClusterAutomatedBackupPolicy

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

ClusterType string

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

ContinuousBackupConfig ClusterContinuousBackupConfig

The continuous backup config for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. Structure is documented below.

DatabaseVersion string

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

DeletionPolicy string

Policy to determine if the cluster should be deleted forcefully. Deleting a cluster forcefully, deletes the cluster and all its associated instances within the cluster. Deleting a Secondary cluster with a secondary instance REQUIRES setting deletion_policy = "FORCE" otherwise an error is returned. This is needed as there is no support to delete just the secondary instance, and the only way to delete secondary instance is to delete the associated secondary cluster forcefully which also deletes the secondary instance. Possible values: DEFAULT, FORCE

DisplayName string

User-settable and human-readable display name for the Cluster.

EncryptionConfig ClusterEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

Etag string

For Resource freshness validation (https://google.aip.dev/154)

InitialUser ClusterInitialUser

Initial user to setup during cluster creation. Structure is documented below.

Labels Dictionary<string, string>

User-defined labels for the alloydb cluster. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

MaintenanceUpdatePolicy ClusterMaintenanceUpdatePolicy

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

NetworkConfig ClusterNetworkConfig

Metadata related to network configuration. Structure is documented below.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

PscConfig ClusterPscConfig

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

RestoreBackupSource ClusterRestoreBackupSource

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

RestoreContinuousBackupSource ClusterRestoreContinuousBackupSource

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

SecondaryConfig ClusterSecondaryConfig

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

SubscriptionType string

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

ClusterId string

The ID of the alloydb cluster.

Location string

The location where the alloydb cluster should reside.

Annotations map[string]string

AutomatedBackupPolicy ClusterAutomatedBackupPolicyArgs

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

ClusterType string

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

ContinuousBackupConfig ClusterContinuousBackupConfigArgs

DatabaseVersion string

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

DeletionPolicy string

DisplayName string

User-settable and human-readable display name for the Cluster.

EncryptionConfig ClusterEncryptionConfigArgs

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

Etag string

For Resource freshness validation (https://google.aip.dev/154)

InitialUser ClusterInitialUserArgs

Initial user to setup during cluster creation. Structure is documented below.

Labels map[string]string

MaintenanceUpdatePolicy ClusterMaintenanceUpdatePolicyArgs

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

NetworkConfig ClusterNetworkConfigArgs

Metadata related to network configuration. Structure is documented below.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

PscConfig ClusterPscConfigArgs

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

RestoreBackupSource ClusterRestoreBackupSourceArgs

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

RestoreContinuousBackupSource ClusterRestoreContinuousBackupSourceArgs

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

SecondaryConfig ClusterSecondaryConfigArgs

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

SubscriptionType string

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

clusterId String

The ID of the alloydb cluster.

location String

The location where the alloydb cluster should reside.

annotations Map<String,String>

automatedBackupPolicy ClusterAutomatedBackupPolicy

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

clusterType String

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

continuousBackupConfig ClusterContinuousBackupConfig

databaseVersion String

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

deletionPolicy String

displayName String

User-settable and human-readable display name for the Cluster.

encryptionConfig ClusterEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

etag String

For Resource freshness validation (https://google.aip.dev/154)

initialUser ClusterInitialUser

Initial user to setup during cluster creation. Structure is documented below.

labels Map<String,String>

maintenanceUpdatePolicy ClusterMaintenanceUpdatePolicy

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

networkConfig ClusterNetworkConfig

Metadata related to network configuration. Structure is documented below.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pscConfig ClusterPscConfig

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

restoreBackupSource ClusterRestoreBackupSource

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

restoreContinuousBackupSource ClusterRestoreContinuousBackupSource

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

secondaryConfig ClusterSecondaryConfig

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

subscriptionType String

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

clusterId string

The ID of the alloydb cluster.

location string

The location where the alloydb cluster should reside.

annotations {[key: string]: string}

automatedBackupPolicy ClusterAutomatedBackupPolicy

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

clusterType string

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

continuousBackupConfig ClusterContinuousBackupConfig

databaseVersion string

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

deletionPolicy string

displayName string

User-settable and human-readable display name for the Cluster.

encryptionConfig ClusterEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

etag string

For Resource freshness validation (https://google.aip.dev/154)

initialUser ClusterInitialUser

Initial user to setup during cluster creation. Structure is documented below.

labels {[key: string]: string}

maintenanceUpdatePolicy ClusterMaintenanceUpdatePolicy

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

networkConfig ClusterNetworkConfig

Metadata related to network configuration. Structure is documented below.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pscConfig ClusterPscConfig

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

restoreBackupSource ClusterRestoreBackupSource

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

restoreContinuousBackupSource ClusterRestoreContinuousBackupSource

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

secondaryConfig ClusterSecondaryConfig

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

subscriptionType string

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

cluster_id str

The ID of the alloydb cluster.

location str

The location where the alloydb cluster should reside.

annotations Mapping[str, str]

automated_backup_policy ClusterAutomatedBackupPolicyArgs

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

cluster_type str

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

continuous_backup_config ClusterContinuousBackupConfigArgs

database_version str

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

deletion_policy str

display_name str

User-settable and human-readable display name for the Cluster.

encryption_config ClusterEncryptionConfigArgs

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

etag str

For Resource freshness validation (https://google.aip.dev/154)

initial_user ClusterInitialUserArgs

Initial user to setup during cluster creation. Structure is documented below.

labels Mapping[str, str]

maintenance_update_policy ClusterMaintenanceUpdatePolicyArgs

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

network_config ClusterNetworkConfigArgs

Metadata related to network configuration. Structure is documented below.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

psc_config ClusterPscConfigArgs

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

restore_backup_source ClusterRestoreBackupSourceArgs

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

restore_continuous_backup_source ClusterRestoreContinuousBackupSourceArgs

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

secondary_config ClusterSecondaryConfigArgs

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

subscription_type str

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

clusterId String

The ID of the alloydb cluster.

location String

The location where the alloydb cluster should reside.

annotations Map<String>

automatedBackupPolicy Property Map

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

clusterType String

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

continuousBackupConfig Property Map

databaseVersion String

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

deletionPolicy String

displayName String

User-settable and human-readable display name for the Cluster.

encryptionConfig Property Map

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

etag String

For Resource freshness validation (https://google.aip.dev/154)

initialUser Property Map

Initial user to setup during cluster creation. Structure is documented below.

labels Map<String>

maintenanceUpdatePolicy Property Map

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

networkConfig Property Map

Metadata related to network configuration. Structure is documented below.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pscConfig Property Map

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

restoreBackupSource Property Map

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

restoreContinuousBackupSource Property Map

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

secondaryConfig Property Map

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

subscriptionType String

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

Outputs

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

BackupSources List<ClusterBackupSource>: Cluster created from backup. Structure is documented below.
ContinuousBackupInfos List<ClusterContinuousBackupInfo>: ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
EffectiveAnnotations Dictionary<string, string>
EffectiveLabels Dictionary<string, string>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
EncryptionInfos List<ClusterEncryptionInfo>: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
Id string: The provider-assigned unique ID for this managed resource.
MigrationSources List<ClusterMigrationSource>: Cluster created via DMS migration. Structure is documented below.
Name string: The name of the cluster resource.
PulumiLabels Dictionary<string, string>: The combination of labels configured directly on the resource and default labels configured on the provider.
Reconciling bool: Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster 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: Output only. The current serving state of the cluster.
TrialMetadatas List<ClusterTrialMetadata>: Contains information and all metadata related to TRIAL clusters. Structure is documented below.
Uid string: The system-generated UID of the resource.

BackupSources []ClusterBackupSource: Cluster created from backup. Structure is documented below.
ContinuousBackupInfos []ClusterContinuousBackupInfo: ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
EffectiveAnnotations map[string]string
EffectiveLabels map[string]string: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
EncryptionInfos []ClusterEncryptionInfo: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
Id string: The provider-assigned unique ID for this managed resource.
MigrationSources []ClusterMigrationSource: Cluster created via DMS migration. Structure is documented below.
Name string: The name of the cluster resource.
PulumiLabels map[string]string: The combination of labels configured directly on the resource and default labels configured on the provider.
Reconciling bool: Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster 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: Output only. The current serving state of the cluster.
TrialMetadatas []ClusterTrialMetadata: Contains information and all metadata related to TRIAL clusters. Structure is documented below.
Uid string: The system-generated UID of the resource.

backupSources List<ClusterBackupSource>: Cluster created from backup. Structure is documented below.
continuousBackupInfos List<ClusterContinuousBackupInfo>: ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
effectiveAnnotations Map<String,String>
effectiveLabels Map<String,String>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
encryptionInfos List<ClusterEncryptionInfo>: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
id String: The provider-assigned unique ID for this managed resource.
migrationSources List<ClusterMigrationSource>: Cluster created via DMS migration. Structure is documented below.
name String: The name of the cluster resource.
pulumiLabels Map<String,String>: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling Boolean: Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster 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: Output only. The current serving state of the cluster.
trialMetadatas List<ClusterTrialMetadata>: Contains information and all metadata related to TRIAL clusters. Structure is documented below.
uid String: The system-generated UID of the resource.

backupSources ClusterBackupSource[]: Cluster created from backup. Structure is documented below.
continuousBackupInfos ClusterContinuousBackupInfo[]: ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
effectiveAnnotations {[key: string]: string}
effectiveLabels {[key: string]: string}: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
encryptionInfos ClusterEncryptionInfo[]: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
id string: The provider-assigned unique ID for this managed resource.
migrationSources ClusterMigrationSource[]: Cluster created via DMS migration. Structure is documented below.
name string: The name of the cluster resource.
pulumiLabels {[key: string]: string}: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling boolean: Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster 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: Output only. The current serving state of the cluster.
trialMetadatas ClusterTrialMetadata[]: Contains information and all metadata related to TRIAL clusters. Structure is documented below.
uid string: The system-generated UID of the resource.

backup_sources Sequence[ClusterBackupSource]: Cluster created from backup. Structure is documented below.
continuous_backup_infos Sequence[ClusterContinuousBackupInfo]: ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
effective_annotations Mapping[str, str]
effective_labels Mapping[str, str]: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
encryption_infos Sequence[ClusterEncryptionInfo]: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
id str: The provider-assigned unique ID for this managed resource.
migration_sources Sequence[ClusterMigrationSource]: Cluster created via DMS migration. Structure is documented below.
name str: The name of the cluster resource.
pulumi_labels Mapping[str, str]: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling bool: Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster 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: Output only. The current serving state of the cluster.
trial_metadatas Sequence[ClusterTrialMetadata]: Contains information and all metadata related to TRIAL clusters. Structure is documented below.
uid str: The system-generated UID of the resource.

backupSources List<Property Map>: Cluster created from backup. Structure is documented below.
continuousBackupInfos List<Property Map>: ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
effectiveAnnotations Map<String>
effectiveLabels Map<String>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
encryptionInfos List<Property Map>: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
id String: The provider-assigned unique ID for this managed resource.
migrationSources List<Property Map>: Cluster created via DMS migration. Structure is documented below.
name String: The name of the cluster resource.
pulumiLabels Map<String>: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling Boolean: Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster 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: Output only. The current serving state of the cluster.
trialMetadatas List<Property Map>: Contains information and all metadata related to TRIAL clusters. Structure is documented below.
uid String: The system-generated UID of the resource.

Look up Existing Cluster Resource

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        automated_backup_policy: Optional[ClusterAutomatedBackupPolicyArgs] = None,
        backup_sources: Optional[Sequence[ClusterBackupSourceArgs]] = None,
        cluster_id: Optional[str] = None,
        cluster_type: Optional[str] = None,
        continuous_backup_config: Optional[ClusterContinuousBackupConfigArgs] = None,
        continuous_backup_infos: Optional[Sequence[ClusterContinuousBackupInfoArgs]] = None,
        database_version: Optional[str] = None,
        deletion_policy: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_annotations: Optional[Mapping[str, str]] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        encryption_config: Optional[ClusterEncryptionConfigArgs] = None,
        encryption_infos: Optional[Sequence[ClusterEncryptionInfoArgs]] = None,
        etag: Optional[str] = None,
        initial_user: Optional[ClusterInitialUserArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        maintenance_update_policy: Optional[ClusterMaintenanceUpdatePolicyArgs] = None,
        migration_sources: Optional[Sequence[ClusterMigrationSourceArgs]] = None,
        name: Optional[str] = None,
        network_config: Optional[ClusterNetworkConfigArgs] = None,
        project: Optional[str] = None,
        psc_config: Optional[ClusterPscConfigArgs] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        reconciling: Optional[bool] = None,
        restore_backup_source: Optional[ClusterRestoreBackupSourceArgs] = None,
        restore_continuous_backup_source: Optional[ClusterRestoreContinuousBackupSourceArgs] = None,
        secondary_config: Optional[ClusterSecondaryConfigArgs] = None,
        state: Optional[str] = None,
        subscription_type: Optional[str] = None,
        trial_metadatas: Optional[Sequence[ClusterTrialMetadataArgs]] = None,
        uid: Optional[str] = None) -> Cluster

func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)

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

public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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

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

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

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

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

The following state arguments are supported:

Annotations Dictionary<string, string>

AutomatedBackupPolicy ClusterAutomatedBackupPolicy

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

BackupSources List<ClusterBackupSource>

Cluster created from backup. Structure is documented below.

ClusterId string

The ID of the alloydb cluster.

ClusterType string

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

ContinuousBackupConfig ClusterContinuousBackupConfig

ContinuousBackupInfos List<ClusterContinuousBackupInfo>

ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.

DatabaseVersion string

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

DeletionPolicy string

DisplayName string

User-settable and human-readable display name for the Cluster.

EffectiveAnnotations Dictionary<string, string>

EffectiveLabels Dictionary<string, string>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

EncryptionConfig ClusterEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

EncryptionInfos List<ClusterEncryptionInfo>

(Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.

Etag string

For Resource freshness validation (https://google.aip.dev/154)

InitialUser ClusterInitialUser

Initial user to setup during cluster creation. Structure is documented below.

Labels Dictionary<string, string>

Location string

The location where the alloydb cluster should reside.

MaintenanceUpdatePolicy ClusterMaintenanceUpdatePolicy

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

MigrationSources List<ClusterMigrationSource>

Cluster created via DMS migration. Structure is documented below.

Name string

The name of the cluster resource.

NetworkConfig ClusterNetworkConfig

Metadata related to network configuration. Structure is documented below.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

PscConfig ClusterPscConfig

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

PulumiLabels Dictionary<string, string>

The combination of labels configured directly on the resource and default labels configured on the provider.

Reconciling bool

Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster 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.

RestoreBackupSource ClusterRestoreBackupSource

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

RestoreContinuousBackupSource ClusterRestoreContinuousBackupSource

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

SecondaryConfig ClusterSecondaryConfig

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

State string

Output only. The current serving state of the cluster.

SubscriptionType string

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

TrialMetadatas List<ClusterTrialMetadata>

Contains information and all metadata related to TRIAL clusters. Structure is documented below.

Uid string

The system-generated UID of the resource.

Annotations map[string]string

AutomatedBackupPolicy ClusterAutomatedBackupPolicyArgs

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

BackupSources []ClusterBackupSourceArgs

Cluster created from backup. Structure is documented below.

ClusterId string

The ID of the alloydb cluster.

ClusterType string

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

ContinuousBackupConfig ClusterContinuousBackupConfigArgs

ContinuousBackupInfos []ClusterContinuousBackupInfoArgs

ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.

DatabaseVersion string

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

DeletionPolicy string

DisplayName string

User-settable and human-readable display name for the Cluster.

EffectiveAnnotations map[string]string

EffectiveLabels map[string]string

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

EncryptionConfig ClusterEncryptionConfigArgs

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

EncryptionInfos []ClusterEncryptionInfoArgs

(Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.

Etag string

For Resource freshness validation (https://google.aip.dev/154)

InitialUser ClusterInitialUserArgs

Initial user to setup during cluster creation. Structure is documented below.

Labels map[string]string

Location string

The location where the alloydb cluster should reside.

MaintenanceUpdatePolicy ClusterMaintenanceUpdatePolicyArgs

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

MigrationSources []ClusterMigrationSourceArgs

Cluster created via DMS migration. Structure is documented below.

Name string

The name of the cluster resource.

NetworkConfig ClusterNetworkConfigArgs

Metadata related to network configuration. Structure is documented below.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

PscConfig ClusterPscConfigArgs

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

PulumiLabels map[string]string

The combination of labels configured directly on the resource and default labels configured on the provider.

Reconciling bool

RestoreBackupSource ClusterRestoreBackupSourceArgs

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

RestoreContinuousBackupSource ClusterRestoreContinuousBackupSourceArgs

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

SecondaryConfig ClusterSecondaryConfigArgs

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

State string

Output only. The current serving state of the cluster.

SubscriptionType string

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

TrialMetadatas []ClusterTrialMetadataArgs

Contains information and all metadata related to TRIAL clusters. Structure is documented below.

Uid string

The system-generated UID of the resource.

annotations Map<String,String>

automatedBackupPolicy ClusterAutomatedBackupPolicy

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

backupSources List<ClusterBackupSource>

Cluster created from backup. Structure is documented below.

clusterId String

The ID of the alloydb cluster.

clusterType String

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

continuousBackupConfig ClusterContinuousBackupConfig

continuousBackupInfos List<ClusterContinuousBackupInfo>

ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.

databaseVersion String

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

deletionPolicy String

displayName String

User-settable and human-readable display name for the Cluster.

effectiveAnnotations Map<String,String>

effectiveLabels Map<String,String>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

encryptionConfig ClusterEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

encryptionInfos List<ClusterEncryptionInfo>

(Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.

etag String

For Resource freshness validation (https://google.aip.dev/154)

initialUser ClusterInitialUser

Initial user to setup during cluster creation. Structure is documented below.

labels Map<String,String>

location String

The location where the alloydb cluster should reside.

maintenanceUpdatePolicy ClusterMaintenanceUpdatePolicy

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

migrationSources List<ClusterMigrationSource>

Cluster created via DMS migration. Structure is documented below.

name String

The name of the cluster resource.

networkConfig ClusterNetworkConfig

Metadata related to network configuration. Structure is documented below.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pscConfig ClusterPscConfig

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

pulumiLabels Map<String,String>

The combination of labels configured directly on the resource and default labels configured on the provider.

reconciling Boolean

restoreBackupSource ClusterRestoreBackupSource

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

restoreContinuousBackupSource ClusterRestoreContinuousBackupSource

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

secondaryConfig ClusterSecondaryConfig

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

state String

Output only. The current serving state of the cluster.

subscriptionType String

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

trialMetadatas List<ClusterTrialMetadata>

Contains information and all metadata related to TRIAL clusters. Structure is documented below.

uid String

The system-generated UID of the resource.

annotations {[key: string]: string}

automatedBackupPolicy ClusterAutomatedBackupPolicy

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

backupSources ClusterBackupSource[]

Cluster created from backup. Structure is documented below.

clusterId string

The ID of the alloydb cluster.

clusterType string

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

continuousBackupConfig ClusterContinuousBackupConfig

continuousBackupInfos ClusterContinuousBackupInfo[]

ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.

databaseVersion string

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

deletionPolicy string

displayName string

User-settable and human-readable display name for the Cluster.

effectiveAnnotations {[key: string]: string}

effectiveLabels {[key: string]: string}

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

encryptionConfig ClusterEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

encryptionInfos ClusterEncryptionInfo[]

(Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.

etag string

For Resource freshness validation (https://google.aip.dev/154)

initialUser ClusterInitialUser

Initial user to setup during cluster creation. Structure is documented below.

labels {[key: string]: string}

location string

The location where the alloydb cluster should reside.

maintenanceUpdatePolicy ClusterMaintenanceUpdatePolicy

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

migrationSources ClusterMigrationSource[]

Cluster created via DMS migration. Structure is documented below.

name string

The name of the cluster resource.

networkConfig ClusterNetworkConfig

Metadata related to network configuration. Structure is documented below.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pscConfig ClusterPscConfig

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

pulumiLabels {[key: string]: string}

The combination of labels configured directly on the resource and default labels configured on the provider.

reconciling boolean

restoreBackupSource ClusterRestoreBackupSource

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

restoreContinuousBackupSource ClusterRestoreContinuousBackupSource

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

secondaryConfig ClusterSecondaryConfig

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

state string

Output only. The current serving state of the cluster.

subscriptionType string

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

trialMetadatas ClusterTrialMetadata[]

Contains information and all metadata related to TRIAL clusters. Structure is documented below.

uid string

The system-generated UID of the resource.

annotations Mapping[str, str]

automated_backup_policy ClusterAutomatedBackupPolicyArgs

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

backup_sources Sequence[ClusterBackupSourceArgs]

Cluster created from backup. Structure is documented below.

cluster_id str

The ID of the alloydb cluster.

cluster_type str

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

continuous_backup_config ClusterContinuousBackupConfigArgs

continuous_backup_infos Sequence[ClusterContinuousBackupInfoArgs]

ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.

database_version str

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

deletion_policy str

display_name str

User-settable and human-readable display name for the Cluster.

effective_annotations Mapping[str, str]

effective_labels Mapping[str, str]

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

encryption_config ClusterEncryptionConfigArgs

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

encryption_infos Sequence[ClusterEncryptionInfoArgs]

(Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.

etag str

For Resource freshness validation (https://google.aip.dev/154)

initial_user ClusterInitialUserArgs

Initial user to setup during cluster creation. Structure is documented below.

labels Mapping[str, str]

location str

The location where the alloydb cluster should reside.

maintenance_update_policy ClusterMaintenanceUpdatePolicyArgs

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

migration_sources Sequence[ClusterMigrationSourceArgs]

Cluster created via DMS migration. Structure is documented below.

name str

The name of the cluster resource.

network_config ClusterNetworkConfigArgs

Metadata related to network configuration. Structure is documented below.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

psc_config ClusterPscConfigArgs

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

pulumi_labels Mapping[str, str]

The combination of labels configured directly on the resource and default labels configured on the provider.

reconciling bool

restore_backup_source ClusterRestoreBackupSourceArgs

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

restore_continuous_backup_source ClusterRestoreContinuousBackupSourceArgs

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

secondary_config ClusterSecondaryConfigArgs

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

state str

Output only. The current serving state of the cluster.

subscription_type str

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

trial_metadatas Sequence[ClusterTrialMetadataArgs]

Contains information and all metadata related to TRIAL clusters. Structure is documented below.

uid str

The system-generated UID of the resource.

annotations Map<String>

automatedBackupPolicy Property Map

The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.

backupSources List<Property Map>

Cluster created from backup. Structure is documented below.

clusterId String

The ID of the alloydb cluster.

clusterType String

The type of cluster. If not set, defaults to PRIMARY. Default value is PRIMARY. Possible values are: PRIMARY, SECONDARY.

continuousBackupConfig Property Map

continuousBackupInfos List<Property Map>

ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.

databaseVersion String

The database engine major version. This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

deletionPolicy String

displayName String

User-settable and human-readable display name for the Cluster.

effectiveAnnotations Map<String>

effectiveLabels Map<String>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

encryptionConfig Property Map

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

encryptionInfos List<Property Map>

(Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.

etag String

For Resource freshness validation (https://google.aip.dev/154)

initialUser Property Map

Initial user to setup during cluster creation. Structure is documented below.

labels Map<String>

location String

The location where the alloydb cluster should reside.

maintenanceUpdatePolicy Property Map

MaintenanceUpdatePolicy defines the policy for system updates. Structure is documented below.

migrationSources List<Property Map>

Cluster created via DMS migration. Structure is documented below.

name String

The name of the cluster resource.

networkConfig Property Map

Metadata related to network configuration. Structure is documented below.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pscConfig Property Map

Configuration for Private Service Connect (PSC) for the cluster. Structure is documented below.

pulumiLabels Map<String>

The combination of labels configured directly on the resource and default labels configured on the provider.

reconciling Boolean

restoreBackupSource Property Map

The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. Structure is documented below.

restoreContinuousBackupSource Property Map

The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. Structure is documented below.

secondaryConfig Property Map

Configuration of the secondary cluster for Cross Region Replication. This should be set if and only if the cluster is of type SECONDARY. Structure is documented below.

state String

Output only. The current serving state of the cluster.

subscriptionType String

The subscrition type of cluster. Possible values are: TRIAL, STANDARD.

trialMetadatas List<Property Map>

Contains information and all metadata related to TRIAL clusters. Structure is documented below.

uid String

The system-generated UID of the resource.

Supporting Types

ClusterAutomatedBackupPolicy, ClusterAutomatedBackupPolicyArgs

BackupWindow string: The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
Enabled bool: Whether automated backups are enabled.
EncryptionConfig ClusterAutomatedBackupPolicyEncryptionConfig: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
Labels Dictionary<string, string>: Labels to apply to backups created using this configuration.
Location string: The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.
QuantityBasedRetention ClusterAutomatedBackupPolicyQuantityBasedRetention: Quantity-based Backup retention policy to retain recent backups. Conflicts with 'time_based_retention', both can't be set together. Structure is documented below.
TimeBasedRetention ClusterAutomatedBackupPolicyTimeBasedRetention: Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
WeeklySchedule ClusterAutomatedBackupPolicyWeeklySchedule: Weekly schedule for the Backup. Structure is documented below.

BackupWindow string: The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
Enabled bool: Whether automated backups are enabled.
EncryptionConfig ClusterAutomatedBackupPolicyEncryptionConfig: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
Labels map[string]string: Labels to apply to backups created using this configuration.
Location string: The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.
QuantityBasedRetention ClusterAutomatedBackupPolicyQuantityBasedRetention: Quantity-based Backup retention policy to retain recent backups. Conflicts with 'time_based_retention', both can't be set together. Structure is documented below.
TimeBasedRetention ClusterAutomatedBackupPolicyTimeBasedRetention: Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
WeeklySchedule ClusterAutomatedBackupPolicyWeeklySchedule: Weekly schedule for the Backup. Structure is documented below.

backupWindow String: The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
enabled Boolean: Whether automated backups are enabled.
encryptionConfig ClusterAutomatedBackupPolicyEncryptionConfig: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
labels Map<String,String>: Labels to apply to backups created using this configuration.
location String: The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.
quantityBasedRetention ClusterAutomatedBackupPolicyQuantityBasedRetention: Quantity-based Backup retention policy to retain recent backups. Conflicts with 'time_based_retention', both can't be set together. Structure is documented below.
timeBasedRetention ClusterAutomatedBackupPolicyTimeBasedRetention: Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
weeklySchedule ClusterAutomatedBackupPolicyWeeklySchedule: Weekly schedule for the Backup. Structure is documented below.

backupWindow string: The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
enabled boolean: Whether automated backups are enabled.
encryptionConfig ClusterAutomatedBackupPolicyEncryptionConfig: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
labels {[key: string]: string}: Labels to apply to backups created using this configuration.
location string: The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.
quantityBasedRetention ClusterAutomatedBackupPolicyQuantityBasedRetention: Quantity-based Backup retention policy to retain recent backups. Conflicts with 'time_based_retention', both can't be set together. Structure is documented below.
timeBasedRetention ClusterAutomatedBackupPolicyTimeBasedRetention: Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
weeklySchedule ClusterAutomatedBackupPolicyWeeklySchedule: Weekly schedule for the Backup. Structure is documented below.

backup_window str: The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
enabled bool: Whether automated backups are enabled.
encryption_config ClusterAutomatedBackupPolicyEncryptionConfig: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
labels Mapping[str, str]: Labels to apply to backups created using this configuration.
location str: The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.
quantity_based_retention ClusterAutomatedBackupPolicyQuantityBasedRetention: Quantity-based Backup retention policy to retain recent backups. Conflicts with 'time_based_retention', both can't be set together. Structure is documented below.
time_based_retention ClusterAutomatedBackupPolicyTimeBasedRetention: Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
weekly_schedule ClusterAutomatedBackupPolicyWeeklySchedule: Weekly schedule for the Backup. Structure is documented below.

backupWindow String: The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
enabled Boolean: Whether automated backups are enabled.
encryptionConfig Property Map: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
labels Map<String>: Labels to apply to backups created using this configuration.
location String: The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.
quantityBasedRetention Property Map: Quantity-based Backup retention policy to retain recent backups. Conflicts with 'time_based_retention', both can't be set together. Structure is documented below.
timeBasedRetention Property Map: Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
weeklySchedule Property Map: Weekly schedule for the Backup. Structure is documented below.

ClusterAutomatedBackupPolicyEncryptionConfig, ClusterAutomatedBackupPolicyEncryptionConfigArgs

KmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

KmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName String: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kms_key_name str: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName String: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

ClusterAutomatedBackupPolicyQuantityBasedRetention, ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs

Count int: The number of backups to retain.

Count int: The number of backups to retain.

count Integer: The number of backups to retain.

count number: The number of backups to retain.

count int: The number of backups to retain.

count Number: The number of backups to retain.

ClusterAutomatedBackupPolicyTimeBasedRetention, ClusterAutomatedBackupPolicyTimeBasedRetentionArgs

RetentionPeriod string: The retention period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

RetentionPeriod string: The retention period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

retentionPeriod String: The retention period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

retentionPeriod string: The retention period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

retention_period str: The retention period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

retentionPeriod String: The retention period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

ClusterAutomatedBackupPolicyWeeklySchedule, ClusterAutomatedBackupPolicyWeeklyScheduleArgs

StartTimes List<ClusterAutomatedBackupPolicyWeeklyScheduleStartTime>: The times during the day to start a backup. At least one start time must be provided. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). Structure is documented below.
DaysOfWeeks List<string>: The days of the week to perform a backup. At least one day of the week must be provided. Each value may be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

StartTimes []ClusterAutomatedBackupPolicyWeeklyScheduleStartTime: The times during the day to start a backup. At least one start time must be provided. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). Structure is documented below.
DaysOfWeeks []string: The days of the week to perform a backup. At least one day of the week must be provided. Each value may be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

startTimes List<ClusterAutomatedBackupPolicyWeeklyScheduleStartTime>: The times during the day to start a backup. At least one start time must be provided. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). Structure is documented below.
daysOfWeeks List<String>: The days of the week to perform a backup. At least one day of the week must be provided. Each value may be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

startTimes ClusterAutomatedBackupPolicyWeeklyScheduleStartTime[]: The times during the day to start a backup. At least one start time must be provided. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). Structure is documented below.
daysOfWeeks string[]: The days of the week to perform a backup. At least one day of the week must be provided. Each value may be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

start_times Sequence[ClusterAutomatedBackupPolicyWeeklyScheduleStartTime]: The times during the day to start a backup. At least one start time must be provided. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). Structure is documented below.
days_of_weeks Sequence[str]: The days of the week to perform a backup. At least one day of the week must be provided. Each value may be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

startTimes List<Property Map>: The times during the day to start a backup. At least one start time must be provided. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). Structure is documented below.
daysOfWeeks List<String>: The days of the week to perform a backup. At least one day of the week must be provided. Each value may be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

ClusterAutomatedBackupPolicyWeeklyScheduleStartTime, ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArgs

Hours int: Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
Minutes int: Minutes of hour of day. Currently, only the value 0 is supported.
Nanos int: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
Seconds int: Seconds of minutes of the time. Currently, only the value 0 is supported.

Hours int: Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
Minutes int: Minutes of hour of day. Currently, only the value 0 is supported.
Nanos int: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
Seconds int: Seconds of minutes of the time. Currently, only the value 0 is supported.

hours Integer: Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes Integer: Minutes of hour of day. Currently, only the value 0 is supported.
nanos Integer: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
seconds Integer: Seconds of minutes of the time. Currently, only the value 0 is supported.

hours number: Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes number: Minutes of hour of day. Currently, only the value 0 is supported.
nanos number: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
seconds number: Seconds of minutes of the time. Currently, only the value 0 is supported.

hours int: Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes int: Minutes of hour of day. Currently, only the value 0 is supported.
nanos int: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
seconds int: Seconds of minutes of the time. Currently, only the value 0 is supported.

hours Number: Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes Number: Minutes of hour of day. Currently, only the value 0 is supported.
nanos Number: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
seconds Number: Seconds of minutes of the time. Currently, only the value 0 is supported.

ClusterBackupSource, ClusterBackupSourceArgs

BackupName string: The name of the backup resource.

BackupName string: The name of the backup resource.

backupName String: The name of the backup resource.

backupName string: The name of the backup resource.

backup_name str: The name of the backup resource.

backupName String: The name of the backup resource.

ClusterContinuousBackupConfig, ClusterContinuousBackupConfigArgs

Enabled bool: Whether continuous backup recovery is enabled. If not set, defaults to true.
EncryptionConfig ClusterContinuousBackupConfigEncryptionConfig: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
RecoveryWindowDays int: The numbers of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.

Enabled bool: Whether continuous backup recovery is enabled. If not set, defaults to true.
EncryptionConfig ClusterContinuousBackupConfigEncryptionConfig: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
RecoveryWindowDays int: The numbers of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.

enabled Boolean: Whether continuous backup recovery is enabled. If not set, defaults to true.
encryptionConfig ClusterContinuousBackupConfigEncryptionConfig: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
recoveryWindowDays Integer: The numbers of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.

enabled boolean: Whether continuous backup recovery is enabled. If not set, defaults to true.
encryptionConfig ClusterContinuousBackupConfigEncryptionConfig: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
recoveryWindowDays number: The numbers of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.

enabled bool: Whether continuous backup recovery is enabled. If not set, defaults to true.
encryption_config ClusterContinuousBackupConfigEncryptionConfig: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
recovery_window_days int: The numbers of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.

enabled Boolean: Whether continuous backup recovery is enabled. If not set, defaults to true.
encryptionConfig Property Map: EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.
recoveryWindowDays Number: The numbers of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.

ClusterContinuousBackupConfigEncryptionConfig, ClusterContinuousBackupConfigEncryptionConfigArgs

KmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

KmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName String: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kms_key_name str: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName String: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

ClusterContinuousBackupInfo, ClusterContinuousBackupInfoArgs

EarliestRestorableTime string: (Output) The earliest restorable time that can be restored to. Output only field.
EnabledTime string: (Output) When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
EncryptionInfos List<ClusterContinuousBackupInfoEncryptionInfo>: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
Schedules List<string>: (Output) Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.

EarliestRestorableTime string: (Output) The earliest restorable time that can be restored to. Output only field.
EnabledTime string: (Output) When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
EncryptionInfos []ClusterContinuousBackupInfoEncryptionInfo: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
Schedules []string: (Output) Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.

earliestRestorableTime String: (Output) The earliest restorable time that can be restored to. Output only field.
enabledTime String: (Output) When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
encryptionInfos List<ClusterContinuousBackupInfoEncryptionInfo>: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
schedules List<String>: (Output) Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.

earliestRestorableTime string: (Output) The earliest restorable time that can be restored to. Output only field.
enabledTime string: (Output) When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
encryptionInfos ClusterContinuousBackupInfoEncryptionInfo[]: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
schedules string[]: (Output) Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.

earliest_restorable_time str: (Output) The earliest restorable time that can be restored to. Output only field.
enabled_time str: (Output) When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
encryption_infos Sequence[ClusterContinuousBackupInfoEncryptionInfo]: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
schedules Sequence[str]: (Output) Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.

earliestRestorableTime String: (Output) The earliest restorable time that can be restored to. Output only field.
enabledTime String: (Output) When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
encryptionInfos List<Property Map>: (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
schedules List<String>: (Output) Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.

ClusterContinuousBackupInfoEncryptionInfo, ClusterContinuousBackupInfoEncryptionInfoArgs

EncryptionType string: (Output) Output only. Type of encryption.
KmsKeyVersions List<string>: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

EncryptionType string: (Output) Output only. Type of encryption.
KmsKeyVersions []string: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryptionType String: (Output) Output only. Type of encryption.
kmsKeyVersions List<String>: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryptionType string: (Output) Output only. Type of encryption.
kmsKeyVersions string[]: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryption_type str: (Output) Output only. Type of encryption.
kms_key_versions Sequence[str]: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryptionType String: (Output) Output only. Type of encryption.
kmsKeyVersions List<String>: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

ClusterEncryptionConfig, ClusterEncryptionConfigArgs

KmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

KmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName String: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kms_key_name str: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName String: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

ClusterEncryptionInfo, ClusterEncryptionInfoArgs

EncryptionType string: (Output) Output only. Type of encryption.
KmsKeyVersions List<string>: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

EncryptionType string: (Output) Output only. Type of encryption.
KmsKeyVersions []string: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryptionType String: (Output) Output only. Type of encryption.
kmsKeyVersions List<String>: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryptionType string: (Output) Output only. Type of encryption.
kmsKeyVersions string[]: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryption_type str: (Output) Output only. Type of encryption.
kms_key_versions Sequence[str]: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryptionType String: (Output) Output only. Type of encryption.
kmsKeyVersions List<String>: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

ClusterInitialUser, ClusterInitialUserArgs

Password string: The initial password for the user. Note: This property is sensitive and will not be displayed in the plan.
User string: The database username.

Password string: The initial password for the user. Note: This property is sensitive and will not be displayed in the plan.
User string: The database username.

password String: The initial password for the user. Note: This property is sensitive and will not be displayed in the plan.
user String: The database username.

password string: The initial password for the user. Note: This property is sensitive and will not be displayed in the plan.
user string: The database username.

password str: The initial password for the user. Note: This property is sensitive and will not be displayed in the plan.
user str: The database username.

password String: The initial password for the user. Note: This property is sensitive and will not be displayed in the plan.
user String: The database username.

ClusterMaintenanceUpdatePolicy, ClusterMaintenanceUpdatePolicyArgs

MaintenanceWindows List<ClusterMaintenanceUpdatePolicyMaintenanceWindow>: Preferred windows to perform maintenance. Currently limited to 1. Structure is documented below.

MaintenanceWindows []ClusterMaintenanceUpdatePolicyMaintenanceWindow: Preferred windows to perform maintenance. Currently limited to 1. Structure is documented below.

maintenanceWindows List<ClusterMaintenanceUpdatePolicyMaintenanceWindow>: Preferred windows to perform maintenance. Currently limited to 1. Structure is documented below.

maintenanceWindows ClusterMaintenanceUpdatePolicyMaintenanceWindow[]: Preferred windows to perform maintenance. Currently limited to 1. Structure is documented below.

maintenance_windows Sequence[ClusterMaintenanceUpdatePolicyMaintenanceWindow]: Preferred windows to perform maintenance. Currently limited to 1. Structure is documented below.

maintenanceWindows List<Property Map>: Preferred windows to perform maintenance. Currently limited to 1. Structure is documented below.

ClusterMaintenanceUpdatePolicyMaintenanceWindow, ClusterMaintenanceUpdatePolicyMaintenanceWindowArgs

Day string: Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
StartTime ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTime: Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time. Structure is documented below.

Day string: Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
StartTime ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTime: Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time. Structure is documented below.

day String: Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
startTime ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTime: Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time. Structure is documented below.

day string: Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
startTime ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTime: Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time. Structure is documented below.

day str: Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
start_time ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTime: Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time. Structure is documented below.

day String: Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
startTime Property Map: Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time. Structure is documented below.

ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTime, ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTimeArgs

Hours int: Hours of day in 24 hour format. Should be from 0 to 23.
Minutes int: Minutes of hour of day. Currently, only the value 0 is supported.
Nanos int: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
Seconds int: Seconds of minutes of the time. Currently, only the value 0 is supported.

Hours int: Hours of day in 24 hour format. Should be from 0 to 23.
Minutes int: Minutes of hour of day. Currently, only the value 0 is supported.
Nanos int: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
Seconds int: Seconds of minutes of the time. Currently, only the value 0 is supported.

hours Integer: Hours of day in 24 hour format. Should be from 0 to 23.
minutes Integer: Minutes of hour of day. Currently, only the value 0 is supported.
nanos Integer: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
seconds Integer: Seconds of minutes of the time. Currently, only the value 0 is supported.

hours number: Hours of day in 24 hour format. Should be from 0 to 23.
minutes number: Minutes of hour of day. Currently, only the value 0 is supported.
nanos number: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
seconds number: Seconds of minutes of the time. Currently, only the value 0 is supported.

hours int: Hours of day in 24 hour format. Should be from 0 to 23.
minutes int: Minutes of hour of day. Currently, only the value 0 is supported.
nanos int: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
seconds int: Seconds of minutes of the time. Currently, only the value 0 is supported.

hours Number: Hours of day in 24 hour format. Should be from 0 to 23.
minutes Number: Minutes of hour of day. Currently, only the value 0 is supported.
nanos Number: Fractions of seconds in nanoseconds. Currently, only the value 0 is supported.
seconds Number: Seconds of minutes of the time. Currently, only the value 0 is supported.

ClusterMigrationSource, ClusterMigrationSourceArgs

HostPort string: The host and port of the on-premises instance in host:port format
ReferenceId string: Place holder for the external source identifier(e.g DMS job name) that created the cluster.
SourceType string: Type of migration source.

HostPort string: The host and port of the on-premises instance in host:port format
ReferenceId string: Place holder for the external source identifier(e.g DMS job name) that created the cluster.
SourceType string: Type of migration source.

hostPort String: The host and port of the on-premises instance in host:port format
referenceId String: Place holder for the external source identifier(e.g DMS job name) that created the cluster.
sourceType String: Type of migration source.

hostPort string: The host and port of the on-premises instance in host:port format
referenceId string: Place holder for the external source identifier(e.g DMS job name) that created the cluster.
sourceType string: Type of migration source.

host_port str: The host and port of the on-premises instance in host:port format
reference_id str: Place holder for the external source identifier(e.g DMS job name) that created the cluster.
source_type str: Type of migration source.

hostPort String: The host and port of the on-premises instance in host:port format
referenceId String: Place holder for the external source identifier(e.g DMS job name) that created the cluster.
sourceType String: Type of migration source.

ClusterNetworkConfig, ClusterNetworkConfigArgs

AllocatedIpRange string: The name of the allocated IP range for the private IP AlloyDB cluster. For example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range.
Network string: The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{projectNumber}/global/networks/{network_id}".

AllocatedIpRange string: The name of the allocated IP range for the private IP AlloyDB cluster. For example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range.
Network string: The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{projectNumber}/global/networks/{network_id}".

allocatedIpRange String: The name of the allocated IP range for the private IP AlloyDB cluster. For example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range.
network String: The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{projectNumber}/global/networks/{network_id}".

allocatedIpRange string: The name of the allocated IP range for the private IP AlloyDB cluster. For example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range.
network string: The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{projectNumber}/global/networks/{network_id}".

allocated_ip_range str: The name of the allocated IP range for the private IP AlloyDB cluster. For example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range.
network str: The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{projectNumber}/global/networks/{network_id}".

allocatedIpRange String: The name of the allocated IP range for the private IP AlloyDB cluster. For example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range.
network String: The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{projectNumber}/global/networks/{network_id}".

ClusterPscConfig, ClusterPscConfigArgs

PscEnabled bool: Create an instance that allows connections from Private Service Connect endpoints to the instance.

PscEnabled bool: Create an instance that allows connections from Private Service Connect endpoints to the instance.

pscEnabled Boolean: Create an instance that allows connections from Private Service Connect endpoints to the instance.

pscEnabled boolean: Create an instance that allows connections from Private Service Connect endpoints to the instance.

psc_enabled bool: Create an instance that allows connections from Private Service Connect endpoints to the instance.

pscEnabled Boolean: Create an instance that allows connections from Private Service Connect endpoints to the instance.

ClusterRestoreBackupSource, ClusterRestoreBackupSourceArgs

BackupName string: The name of the backup that this cluster is restored from.

BackupName string: The name of the backup that this cluster is restored from.

backupName String: The name of the backup that this cluster is restored from.

backupName string: The name of the backup that this cluster is restored from.

backup_name str: The name of the backup that this cluster is restored from.

backupName String: The name of the backup that this cluster is restored from.

ClusterRestoreContinuousBackupSource, ClusterRestoreContinuousBackupSourceArgs

Cluster string: The name of the source cluster that this cluster is restored from.
PointInTime string: The point in time that this cluster is restored to, in RFC 3339 format.

Cluster string: The name of the source cluster that this cluster is restored from.
PointInTime string: The point in time that this cluster is restored to, in RFC 3339 format.

cluster String: The name of the source cluster that this cluster is restored from.
pointInTime String: The point in time that this cluster is restored to, in RFC 3339 format.

cluster string: The name of the source cluster that this cluster is restored from.
pointInTime string: The point in time that this cluster is restored to, in RFC 3339 format.

cluster str: The name of the source cluster that this cluster is restored from.
point_in_time str: The point in time that this cluster is restored to, in RFC 3339 format.

cluster String: The name of the source cluster that this cluster is restored from.
pointInTime String: The point in time that this cluster is restored to, in RFC 3339 format.

ClusterSecondaryConfig, ClusterSecondaryConfigArgs

PrimaryClusterName string: Name of the primary cluster must be in the format 'projects/{project}/locations/{location}/clusters/{cluster_id}'

PrimaryClusterName string: Name of the primary cluster must be in the format 'projects/{project}/locations/{location}/clusters/{cluster_id}'

primaryClusterName String: Name of the primary cluster must be in the format 'projects/{project}/locations/{location}/clusters/{cluster_id}'

primaryClusterName string: Name of the primary cluster must be in the format 'projects/{project}/locations/{location}/clusters/{cluster_id}'

primary_cluster_name str: Name of the primary cluster must be in the format 'projects/{project}/locations/{location}/clusters/{cluster_id}'

primaryClusterName String: Name of the primary cluster must be in the format 'projects/{project}/locations/{location}/clusters/{cluster_id}'

ClusterTrialMetadata, ClusterTrialMetadataArgs

EndTime string: End time of the trial cluster.
GraceEndTime string: Grace end time of the trial cluster.
StartTime string: Start time of the trial cluster.
UpgradeTime string: Upgrade time of the trial cluster to standard cluster.

EndTime string: End time of the trial cluster.
GraceEndTime string: Grace end time of the trial cluster.
StartTime string: Start time of the trial cluster.
UpgradeTime string: Upgrade time of the trial cluster to standard cluster.

endTime String: End time of the trial cluster.
graceEndTime String: Grace end time of the trial cluster.
startTime String: Start time of the trial cluster.
upgradeTime String: Upgrade time of the trial cluster to standard cluster.

endTime string: End time of the trial cluster.
graceEndTime string: Grace end time of the trial cluster.
startTime string: Start time of the trial cluster.
upgradeTime string: Upgrade time of the trial cluster to standard cluster.

end_time str: End time of the trial cluster.
grace_end_time str: Grace end time of the trial cluster.
start_time str: Start time of the trial cluster.
upgrade_time str: Upgrade time of the trial cluster to standard cluster.

endTime String: End time of the trial cluster.
graceEndTime String: Grace end time of the trial cluster.
startTime String: Start time of the trial cluster.
upgradeTime String: Upgrade time of the trial cluster to standard cluster.

Import

Cluster can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/clusters/{{cluster_id}}
{{project}}/{{location}}/{{cluster_id}}
{{location}}/{{cluster_id}}
{{cluster_id}}

When using the pulumi import command, Cluster can be imported using one of the formats above. For example:

$ pulumi import gcp:alloydb/cluster:Cluster default projects/{{project}}/locations/{{location}}/clusters/{{cluster_id}}

$ pulumi import gcp:alloydb/cluster:Cluster default {{project}}/{{location}}/{{cluster_id}}

$ pulumi import gcp:alloydb/cluster:Cluster default {{location}}/{{cluster_id}}

$ pulumi import gcp:alloydb/cluster:Cluster default {{cluster_id}}

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi

pulumi/pulumi-gcp

gcp.alloydb.Cluster

On this page

On this page

Example Usage

Alloydb Cluster Basic

Alloydb Cluster Full

Alloydb Cluster Restore

Alloydb Secondary Cluster Basic

Create Cluster Resource

Constructor syntax

Parameters

Constructor example

Cluster Resource Properties

Inputs

Outputs

Look up Existing Cluster Resource

Supporting Types

ClusterAutomatedBackupPolicy, ClusterAutomatedBackupPolicyArgs

ClusterAutomatedBackupPolicyEncryptionConfig, ClusterAutomatedBackupPolicyEncryptionConfigArgs

ClusterAutomatedBackupPolicyQuantityBasedRetention, ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs

ClusterAutomatedBackupPolicyTimeBasedRetention, ClusterAutomatedBackupPolicyTimeBasedRetentionArgs

ClusterAutomatedBackupPolicyWeeklySchedule, ClusterAutomatedBackupPolicyWeeklyScheduleArgs

ClusterAutomatedBackupPolicyWeeklyScheduleStartTime, ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArgs

ClusterBackupSource, ClusterBackupSourceArgs

ClusterContinuousBackupConfig, ClusterContinuousBackupConfigArgs

ClusterContinuousBackupConfigEncryptionConfig, ClusterContinuousBackupConfigEncryptionConfigArgs

ClusterContinuousBackupInfo, ClusterContinuousBackupInfoArgs

ClusterContinuousBackupInfoEncryptionInfo, ClusterContinuousBackupInfoEncryptionInfoArgs

ClusterEncryptionConfig, ClusterEncryptionConfigArgs

ClusterEncryptionInfo, ClusterEncryptionInfoArgs

ClusterInitialUser, ClusterInitialUserArgs

ClusterMaintenanceUpdatePolicy, ClusterMaintenanceUpdatePolicyArgs

ClusterMaintenanceUpdatePolicyMaintenanceWindow, ClusterMaintenanceUpdatePolicyMaintenanceWindowArgs

ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTime, ClusterMaintenanceUpdatePolicyMaintenanceWindowStartTimeArgs

ClusterMigrationSource, ClusterMigrationSourceArgs

ClusterNetworkConfig, ClusterNetworkConfigArgs

ClusterPscConfig, ClusterPscConfigArgs

ClusterRestoreBackupSource, ClusterRestoreBackupSourceArgs

ClusterRestoreContinuousBackupSource, ClusterRestoreContinuousBackupSourceArgs

ClusterSecondaryConfig, ClusterSecondaryConfigArgs

ClusterTrialMetadata, ClusterTrialMetadataArgs

Import

Package Details

On this page

On this page