Docs
Packagesgcp.alloydb.Cluster
Explore with Pulumi AI
A managed alloydb cluster.
To get more information about Cluster, see:
- API documentation
- How-to Guides
Warning: All arguments including the following potentially sensitive values will be stored in the raw state as plain text:
initial_user.password. Read more about sensitive data in state.
Example Usage
Alloydb Cluster Basic
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var defaultNetwork = new Gcp.Compute.Network("defaultNetwork");
var defaultCluster = new Gcp.Alloydb.Cluster("defaultCluster", new()
{
ClusterId = "alloydb-cluster",
Location = "us-central1",
Network = defaultNetwork.Id,
});
var project = Gcp.Organizations.GetProject.Invoke();
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/alloydb"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v6/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, "defaultNetwork", nil)
if err != nil {
return err
}
_, err = alloydb.NewCluster(ctx, "defaultCluster", &alloydb.ClusterArgs{
ClusterId: pulumi.String("alloydb-cluster"),
Location: pulumi.String("us-central1"),
Network: defaultNetwork.ID(),
})
if err != nil {
return err
}
_, err = organizations.LookupProject(ctx, nil, nil)
if err != nil {
return err
}
return nil
})
}
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.alloydb.Cluster;
import com.pulumi.gcp.alloydb.ClusterArgs;
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");
var defaultCluster = new Cluster("defaultCluster", ClusterArgs.builder()
.clusterId("alloydb-cluster")
.location("us-central1")
.network(defaultNetwork.id())
.build());
final var project = OrganizationsFunctions.getProject();
}
}
import pulumi
import pulumi_gcp as gcp
default_network = gcp.compute.Network("defaultNetwork")
default_cluster = gcp.alloydb.Cluster("defaultCluster",
cluster_id="alloydb-cluster",
location="us-central1",
network=default_network.id)
project = gcp.organizations.get_project()
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const defaultNetwork = new gcp.compute.Network("defaultNetwork", {});
const defaultCluster = new gcp.alloydb.Cluster("defaultCluster", {
clusterId: "alloydb-cluster",
location: "us-central1",
network: defaultNetwork.id,
});
const project = gcp.organizations.getProject({});
resources:
defaultCluster:
type: gcp:alloydb:Cluster
properties:
clusterId: alloydb-cluster
location: us-central1
network: ${defaultNetwork.id}
defaultNetwork:
type: gcp:compute:Network
variables:
project:
fn::invoke:
Function: gcp:organizations:getProject
Arguments: {}
Alloydb Cluster Full
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var @default = new Gcp.Compute.Network("default");
var full = new Gcp.Alloydb.Cluster("full", new()
{
ClusterId = "alloydb-cluster-full",
Location = "us-central1",
Network = @default.Id,
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 main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/alloydb"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v6/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", nil)
if err != nil {
return err
}
_, err = alloydb.NewCluster(ctx, "full", &alloydb.ClusterArgs{
ClusterId: pulumi.String("alloydb-cluster-full"),
Location: pulumi.String("us-central1"),
Network: _default.ID(),
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
})
}
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.alloydb.Cluster;
import com.pulumi.gcp.alloydb.ClusterArgs;
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");
var full = new Cluster("full", ClusterArgs.builder()
.clusterId("alloydb-cluster-full")
.location("us-central1")
.network(default_.id())
.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();
}
}
import pulumi
import pulumi_gcp as gcp
default = gcp.compute.Network("default")
full = gcp.alloydb.Cluster("full",
cluster_id="alloydb-cluster-full",
location="us-central1",
network=default.id,
initial_user=gcp.alloydb.ClusterInitialUserArgs(
user="alloydb-cluster-full",
password="alloydb-cluster-full",
),
continuous_backup_config=gcp.alloydb.ClusterContinuousBackupConfigArgs(
enabled=True,
recovery_window_days=14,
),
automated_backup_policy=gcp.alloydb.ClusterAutomatedBackupPolicyArgs(
location="us-central1",
backup_window="1800s",
enabled=True,
weekly_schedule=gcp.alloydb.ClusterAutomatedBackupPolicyWeeklyScheduleArgs(
days_of_weeks=["MONDAY"],
start_times=[gcp.alloydb.ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArgs(
hours=23,
minutes=0,
seconds=0,
nanos=0,
)],
),
quantity_based_retention=gcp.alloydb.ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs(
count=1,
),
labels={
"test": "alloydb-cluster-full",
},
),
labels={
"test": "alloydb-cluster-full",
})
project = gcp.organizations.get_project()
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const _default = new gcp.compute.Network("default", {});
const full = new gcp.alloydb.Cluster("full", {
clusterId: "alloydb-cluster-full",
location: "us-central1",
network: _default.id,
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({});
resources:
full:
type: gcp:alloydb:Cluster
properties:
clusterId: alloydb-cluster-full
location: us-central1
network: ${default.id}
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
variables:
project:
fn::invoke:
Function: gcp:organizations:getProject
Arguments: {}
Alloydb Cluster Restore
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var @default = Gcp.Compute.GetNetwork.Invoke(new()
{
Name = "alloydb-network",
});
var sourceCluster = new Gcp.Alloydb.Cluster("sourceCluster", new()
{
ClusterId = "alloydb-source-cluster",
Location = "us-central1",
Network = @default.Apply(@default => @default.Apply(getNetworkResult => getNetworkResult.Id)),
InitialUser = new Gcp.Alloydb.Inputs.ClusterInitialUserArgs
{
Password = "alloydb-source-cluster",
},
});
var privateIpAlloc = new Gcp.Compute.GlobalAddress("privateIpAlloc", new()
{
AddressType = "INTERNAL",
Purpose = "VPC_PEERING",
PrefixLength = 16,
Network = @default.Apply(@default => @default.Apply(getNetworkResult => getNetworkResult.Id)),
});
var vpcConnection = new Gcp.ServiceNetworking.Connection("vpcConnection", new()
{
Network = @default.Apply(@default => @default.Apply(getNetworkResult => getNetworkResult.Id)),
Service = "servicenetworking.googleapis.com",
ReservedPeeringRanges = new[]
{
privateIpAlloc.Name,
},
});
var sourceInstance = new Gcp.Alloydb.Instance("sourceInstance", new()
{
Cluster = sourceCluster.Name,
InstanceId = "alloydb-instance",
InstanceType = "PRIMARY",
MachineConfig = new Gcp.Alloydb.Inputs.InstanceMachineConfigArgs
{
CpuCount = 2,
},
}, new CustomResourceOptions
{
DependsOn = new[]
{
vpcConnection,
},
});
var sourceBackup = new Gcp.Alloydb.Backup("sourceBackup", new()
{
BackupId = "alloydb-backup",
Location = "us-central1",
ClusterName = sourceCluster.Name,
}, new CustomResourceOptions
{
DependsOn = new[]
{
sourceInstance,
},
});
var restoredFromBackup = new Gcp.Alloydb.Cluster("restoredFromBackup", new()
{
ClusterId = "alloydb-backup-restored",
Location = "us-central1",
Network = @default.Apply(@default => @default.Apply(getNetworkResult => getNetworkResult.Id)),
RestoreBackupSource = new Gcp.Alloydb.Inputs.ClusterRestoreBackupSourceArgs
{
BackupName = sourceBackup.Name,
},
});
var restoredViaPitr = new Gcp.Alloydb.Cluster("restoredViaPitr", new()
{
ClusterId = "alloydb-pitr-restored",
Location = "us-central1",
Network = @default.Apply(@default => @default.Apply(getNetworkResult => getNetworkResult.Id)),
RestoreContinuousBackupSource = new Gcp.Alloydb.Inputs.ClusterRestoreContinuousBackupSourceArgs
{
Cluster = sourceCluster.Name,
PointInTime = "2023-08-03T19:19:00.094Z",
},
});
var project = Gcp.Organizations.GetProject.Invoke();
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/alloydb"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/organizations"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/servicenetworking"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_default, err := compute.LookupNetwork(ctx, &compute.LookupNetworkArgs{
Name: "alloydb-network",
}, nil)
if err != nil {
return err
}
sourceCluster, err := alloydb.NewCluster(ctx, "sourceCluster", &alloydb.ClusterArgs{
ClusterId: pulumi.String("alloydb-source-cluster"),
Location: pulumi.String("us-central1"),
Network: *pulumi.String(_default.Id),
InitialUser: &alloydb.ClusterInitialUserArgs{
Password: pulumi.String("alloydb-source-cluster"),
},
})
if err != nil {
return err
}
privateIpAlloc, err := compute.NewGlobalAddress(ctx, "privateIpAlloc", &compute.GlobalAddressArgs{
AddressType: pulumi.String("INTERNAL"),
Purpose: pulumi.String("VPC_PEERING"),
PrefixLength: pulumi.Int(16),
Network: *pulumi.String(_default.Id),
})
if err != nil {
return err
}
vpcConnection, err := servicenetworking.NewConnection(ctx, "vpcConnection", &servicenetworking.ConnectionArgs{
Network: *pulumi.String(_default.Id),
Service: pulumi.String("servicenetworking.googleapis.com"),
ReservedPeeringRanges: pulumi.StringArray{
privateIpAlloc.Name,
},
})
if err != nil {
return err
}
sourceInstance, err := alloydb.NewInstance(ctx, "sourceInstance", &alloydb.InstanceArgs{
Cluster: sourceCluster.Name,
InstanceId: pulumi.String("alloydb-instance"),
InstanceType: pulumi.String("PRIMARY"),
MachineConfig: &alloydb.InstanceMachineConfigArgs{
CpuCount: pulumi.Int(2),
},
}, pulumi.DependsOn([]pulumi.Resource{
vpcConnection,
}))
if err != nil {
return err
}
sourceBackup, err := alloydb.NewBackup(ctx, "sourceBackup", &alloydb.BackupArgs{
BackupId: pulumi.String("alloydb-backup"),
Location: pulumi.String("us-central1"),
ClusterName: sourceCluster.Name,
}, pulumi.DependsOn([]pulumi.Resource{
sourceInstance,
}))
if err != nil {
return err
}
_, err = alloydb.NewCluster(ctx, "restoredFromBackup", &alloydb.ClusterArgs{
ClusterId: pulumi.String("alloydb-backup-restored"),
Location: pulumi.String("us-central1"),
Network: *pulumi.String(_default.Id),
RestoreBackupSource: &alloydb.ClusterRestoreBackupSourceArgs{
BackupName: sourceBackup.Name,
},
})
if err != nil {
return err
}
_, err = alloydb.NewCluster(ctx, "restoredViaPitr", &alloydb.ClusterArgs{
ClusterId: pulumi.String("alloydb-pitr-restored"),
Location: pulumi.String("us-central1"),
Network: *pulumi.String(_default.Id),
RestoreContinuousBackupSource: &alloydb.ClusterRestoreContinuousBackupSourceArgs{
Cluster: sourceCluster.Name,
PointInTime: pulumi.String("2023-08-03T19:19:00.094Z"),
},
})
if err != nil {
return err
}
_, err = organizations.LookupProject(ctx, nil, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetNetworkArgs;
import com.pulumi.gcp.alloydb.Cluster;
import com.pulumi.gcp.alloydb.ClusterArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterInitialUserArgs;
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.Backup;
import com.pulumi.gcp.alloydb.BackupArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterRestoreBackupSourceArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterRestoreContinuousBackupSourceArgs;
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) {
final var default = ComputeFunctions.getNetwork(GetNetworkArgs.builder()
.name("alloydb-network")
.build());
var sourceCluster = new Cluster("sourceCluster", ClusterArgs.builder()
.clusterId("alloydb-source-cluster")
.location("us-central1")
.network(default_.id())
.initialUser(ClusterInitialUserArgs.builder()
.password("alloydb-source-cluster")
.build())
.build());
var privateIpAlloc = new GlobalAddress("privateIpAlloc", GlobalAddressArgs.builder()
.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 sourceInstance = new Instance("sourceInstance", InstanceArgs.builder()
.cluster(sourceCluster.name())
.instanceId("alloydb-instance")
.instanceType("PRIMARY")
.machineConfig(InstanceMachineConfigArgs.builder()
.cpuCount(2)
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(vpcConnection)
.build());
var sourceBackup = new Backup("sourceBackup", BackupArgs.builder()
.backupId("alloydb-backup")
.location("us-central1")
.clusterName(sourceCluster.name())
.build(), CustomResourceOptions.builder()
.dependsOn(sourceInstance)
.build());
var restoredFromBackup = new Cluster("restoredFromBackup", ClusterArgs.builder()
.clusterId("alloydb-backup-restored")
.location("us-central1")
.network(default_.id())
.restoreBackupSource(ClusterRestoreBackupSourceArgs.builder()
.backupName(sourceBackup.name())
.build())
.build());
var restoredViaPitr = new Cluster("restoredViaPitr", ClusterArgs.builder()
.clusterId("alloydb-pitr-restored")
.location("us-central1")
.network(default_.id())
.restoreContinuousBackupSource(ClusterRestoreContinuousBackupSourceArgs.builder()
.cluster(sourceCluster.name())
.pointInTime("2023-08-03T19:19:00.094Z")
.build())
.build());
final var project = OrganizationsFunctions.getProject();
}
}
import pulumi
import pulumi_gcp as gcp
default = gcp.compute.get_network(name="alloydb-network")
source_cluster = gcp.alloydb.Cluster("sourceCluster",
cluster_id="alloydb-source-cluster",
location="us-central1",
network=default.id,
initial_user=gcp.alloydb.ClusterInitialUserArgs(
password="alloydb-source-cluster",
))
private_ip_alloc = gcp.compute.GlobalAddress("privateIpAlloc",
address_type="INTERNAL",
purpose="VPC_PEERING",
prefix_length=16,
network=default.id)
vpc_connection = gcp.servicenetworking.Connection("vpcConnection",
network=default.id,
service="servicenetworking.googleapis.com",
reserved_peering_ranges=[private_ip_alloc.name])
source_instance = gcp.alloydb.Instance("sourceInstance",
cluster=source_cluster.name,
instance_id="alloydb-instance",
instance_type="PRIMARY",
machine_config=gcp.alloydb.InstanceMachineConfigArgs(
cpu_count=2,
),
opts=pulumi.ResourceOptions(depends_on=[vpc_connection]))
source_backup = gcp.alloydb.Backup("sourceBackup",
backup_id="alloydb-backup",
location="us-central1",
cluster_name=source_cluster.name,
opts=pulumi.ResourceOptions(depends_on=[source_instance]))
restored_from_backup = gcp.alloydb.Cluster("restoredFromBackup",
cluster_id="alloydb-backup-restored",
location="us-central1",
network=default.id,
restore_backup_source=gcp.alloydb.ClusterRestoreBackupSourceArgs(
backup_name=source_backup.name,
))
restored_via_pitr = gcp.alloydb.Cluster("restoredViaPitr",
cluster_id="alloydb-pitr-restored",
location="us-central1",
network=default.id,
restore_continuous_backup_source=gcp.alloydb.ClusterRestoreContinuousBackupSourceArgs(
cluster=source_cluster.name,
point_in_time="2023-08-03T19:19:00.094Z",
))
project = gcp.organizations.get_project()
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const default = gcp.compute.getNetwork({
name: "alloydb-network",
});
const sourceCluster = new gcp.alloydb.Cluster("sourceCluster", {
clusterId: "alloydb-source-cluster",
location: "us-central1",
network: _default.then(_default => _default.id),
initialUser: {
password: "alloydb-source-cluster",
},
});
const privateIpAlloc = new gcp.compute.GlobalAddress("privateIpAlloc", {
addressType: "INTERNAL",
purpose: "VPC_PEERING",
prefixLength: 16,
network: _default.then(_default => _default.id),
});
const vpcConnection = new gcp.servicenetworking.Connection("vpcConnection", {
network: _default.then(_default => _default.id),
service: "servicenetworking.googleapis.com",
reservedPeeringRanges: [privateIpAlloc.name],
});
const sourceInstance = new gcp.alloydb.Instance("sourceInstance", {
cluster: sourceCluster.name,
instanceId: "alloydb-instance",
instanceType: "PRIMARY",
machineConfig: {
cpuCount: 2,
},
}, {
dependsOn: [vpcConnection],
});
const sourceBackup = new gcp.alloydb.Backup("sourceBackup", {
backupId: "alloydb-backup",
location: "us-central1",
clusterName: sourceCluster.name,
}, {
dependsOn: [sourceInstance],
});
const restoredFromBackup = new gcp.alloydb.Cluster("restoredFromBackup", {
clusterId: "alloydb-backup-restored",
location: "us-central1",
network: _default.then(_default => _default.id),
restoreBackupSource: {
backupName: sourceBackup.name,
},
});
const restoredViaPitr = new gcp.alloydb.Cluster("restoredViaPitr", {
clusterId: "alloydb-pitr-restored",
location: "us-central1",
network: _default.then(_default => _default.id),
restoreContinuousBackupSource: {
cluster: sourceCluster.name,
pointInTime: "2023-08-03T19:19:00.094Z",
},
});
const project = gcp.organizations.getProject({});
resources:
sourceCluster:
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
properties:
cluster: ${sourceCluster.name}
instanceId: alloydb-instance
instanceType: PRIMARY
machineConfig:
cpuCount: 2
options:
dependson:
- ${vpcConnection}
sourceBackup:
type: gcp:alloydb:Backup
properties:
backupId: alloydb-backup
location: us-central1
clusterName: ${sourceCluster.name}
options:
dependson:
- ${sourceInstance}
restoredFromBackup:
type: gcp:alloydb:Cluster
properties:
clusterId: alloydb-backup-restored
location: us-central1
network: ${default.id}
restoreBackupSource:
backupName: ${sourceBackup.name}
restoredViaPitr:
type: gcp:alloydb:Cluster
properties:
clusterId: alloydb-pitr-restored
location: us-central1
network: ${default.id}
restoreContinuousBackupSource:
cluster: ${sourceCluster.name}
pointInTime: 2023-08-03T19:19:00.094Z
privateIpAlloc:
type: gcp:compute:GlobalAddress
properties:
addressType: INTERNAL
purpose: VPC_PEERING
prefixLength: 16
network: ${default.id}
vpcConnection:
type: gcp:servicenetworking: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
Create Cluster Resource
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
automated_backup_policy: Optional[ClusterAutomatedBackupPolicyArgs] = None,
cluster_id: Optional[str] = None,
continuous_backup_config: Optional[ClusterContinuousBackupConfigArgs] = None,
display_name: Optional[str] = None,
encryption_config: Optional[ClusterEncryptionConfigArgs] = None,
initial_user: Optional[ClusterInitialUserArgs] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
network: Optional[str] = None,
project: Optional[str] = None,
restore_backup_source: Optional[ClusterRestoreBackupSourceArgs] = None,
restore_continuous_backup_source: Optional[ClusterRestoreContinuousBackupSourceArgs] = None)
@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Cluster
Id string The ID of the alloydb cluster.
- Location string
The location where the alloydb cluster should reside.
- Network string
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- Automated
Backup ClusterPolicy Automated Backup Policy The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- Continuous
Backup ClusterConfig Continuous Backup Config 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.
- Display
Name string User-settable and human-readable display name for the Cluster.
- Encryption
Config ClusterEncryption Config 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.
- Initial
User ClusterInitial User Initial user to setup during cluster creation. Structure is documented below.
- Labels Dictionary<string, string>
User-defined labels for the alloydb cluster.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Restore
Backup ClusterSource Restore Backup Source 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 ClusterBackup Source Restore Continuous Backup Source 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.
- Cluster
Id string The ID of the alloydb cluster.
- Location string
The location where the alloydb cluster should reside.
- Network string
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- Automated
Backup ClusterPolicy Automated Backup Policy Args The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- Continuous
Backup ClusterConfig Continuous Backup Config Args 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.
- Display
Name string User-settable and human-readable display name for the Cluster.
- Encryption
Config ClusterEncryption Config Args 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.
- Initial
User ClusterInitial User Args Initial user to setup during cluster creation. Structure is documented below.
- Labels map[string]string
User-defined labels for the alloydb cluster.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Restore
Backup ClusterSource Restore Backup Source Args 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 ClusterBackup Source Restore Continuous Backup Source Args 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.
- cluster
Id String The ID of the alloydb cluster.
- location String
The location where the alloydb cluster should reside.
- network String
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- automated
Backup ClusterPolicy Automated Backup Policy The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- continuous
Backup ClusterConfig Continuous Backup Config 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.
- display
Name String User-settable and human-readable display name for the Cluster.
- encryption
Config ClusterEncryption Config 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.
- initial
User ClusterInitial User Initial user to setup during cluster creation. Structure is documented below.
- labels Map<String,String>
User-defined labels for the alloydb cluster.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore
Backup ClusterSource Restore Backup Source 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 ClusterBackup Source Restore Continuous Backup Source 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.
- cluster
Id string The ID of the alloydb cluster.
- location string
The location where the alloydb cluster should reside.
- network string
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- automated
Backup ClusterPolicy Automated Backup Policy The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- continuous
Backup ClusterConfig Continuous Backup Config 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.
- display
Name string User-settable and human-readable display name for the Cluster.
- encryption
Config ClusterEncryption Config 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.
- initial
User ClusterInitial User Initial user to setup during cluster creation. Structure is documented below.
- labels {[key: string]: string}
User-defined labels for the alloydb cluster.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore
Backup ClusterSource Restore Backup Source 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 ClusterBackup Source Restore Continuous Backup Source 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.
- cluster_
id str The ID of the alloydb cluster.
- location str
The location where the alloydb cluster should reside.
- network str
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- automated_
backup_ Clusterpolicy Automated Backup Policy Args The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- continuous_
backup_ Clusterconfig Continuous Backup Config Args 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.
- display_
name str User-settable and human-readable display name for the Cluster.
- encryption_
config ClusterEncryption Config Args 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.
- initial_
user ClusterInitial User Args Initial user to setup during cluster creation. Structure is documented below.
- labels Mapping[str, str]
User-defined labels for the alloydb cluster.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore_
backup_ Clustersource Restore Backup Source Args 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_ Clusterbackup_ source Restore Continuous Backup Source Args 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.
- cluster
Id String The ID of the alloydb cluster.
- location String
The location where the alloydb cluster should reside.
- network String
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- automated
Backup Property MapPolicy The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- continuous
Backup Property MapConfig 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.
- display
Name String User-settable and human-readable display name for the Cluster.
- encryption
Config 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.
- initial
User Property Map Initial user to setup during cluster creation. Structure is documented below.
- labels Map<String>
User-defined labels for the alloydb cluster.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore
Backup Property MapSource 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 Property MapBackup Source 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:
- Backup
Sources List<ClusterBackup Source> Cluster created from backup. Structure is documented below.
- Continuous
Backup List<ClusterInfos Continuous Backup Info> ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- Database
Version string The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- Encryption
Infos List<ClusterEncryption Info> (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.
- Migration
Sources List<ClusterMigration Source> Cluster created via DMS migration. Structure is documented below.
- Name string
The name of the cluster resource.
- Uid string
The system-generated UID of the resource.
- Backup
Sources []ClusterBackup Source Cluster created from backup. Structure is documented below.
- Continuous
Backup []ClusterInfos Continuous Backup Info ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- Database
Version string The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- Encryption
Infos []ClusterEncryption Info (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.
- Migration
Sources []ClusterMigration Source Cluster created via DMS migration. Structure is documented below.
- Name string
The name of the cluster resource.
- Uid string
The system-generated UID of the resource.
- backup
Sources List<ClusterBackup Source> Cluster created from backup. Structure is documented below.
- continuous
Backup List<ClusterInfos Continuous Backup Info> ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- database
Version String The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- encryption
Infos List<ClusterEncryption Info> (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.
- migration
Sources List<ClusterMigration Source> Cluster created via DMS migration. Structure is documented below.
- name String
The name of the cluster resource.
- uid String
The system-generated UID of the resource.
- backup
Sources ClusterBackup Source[] Cluster created from backup. Structure is documented below.
- continuous
Backup ClusterInfos Continuous Backup Info[] ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- database
Version string The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- encryption
Infos ClusterEncryption Info[] (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.
- migration
Sources ClusterMigration Source[] Cluster created via DMS migration. Structure is documented below.
- name string
The name of the cluster resource.
- uid string
The system-generated UID of the resource.
- backup_
sources Sequence[ClusterBackup Source] Cluster created from backup. Structure is documented below.
- continuous_
backup_ Sequence[Clusterinfos Continuous Backup Info] ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- database_
version str The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- encryption_
infos Sequence[ClusterEncryption Info] (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[ClusterMigration Source] Cluster created via DMS migration. Structure is documented below.
- name str
The name of the cluster resource.
- uid str
The system-generated UID of the resource.
- backup
Sources List<Property Map> Cluster created from backup. Structure is documented below.
- continuous
Backup List<Property Map>Infos ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- database
Version String The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- encryption
Infos 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.
- migration
Sources List<Property Map> Cluster created via DMS migration. Structure is documented below.
- name String
The name of the cluster resource.
- 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,
automated_backup_policy: Optional[ClusterAutomatedBackupPolicyArgs] = None,
backup_sources: Optional[Sequence[ClusterBackupSourceArgs]] = None,
cluster_id: Optional[str] = None,
continuous_backup_config: Optional[ClusterContinuousBackupConfigArgs] = None,
continuous_backup_infos: Optional[Sequence[ClusterContinuousBackupInfoArgs]] = None,
database_version: Optional[str] = None,
display_name: Optional[str] = None,
encryption_config: Optional[ClusterEncryptionConfigArgs] = None,
encryption_infos: Optional[Sequence[ClusterEncryptionInfoArgs]] = None,
initial_user: Optional[ClusterInitialUserArgs] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
migration_sources: Optional[Sequence[ClusterMigrationSourceArgs]] = None,
name: Optional[str] = None,
network: Optional[str] = None,
project: Optional[str] = None,
restore_backup_source: Optional[ClusterRestoreBackupSourceArgs] = None,
restore_continuous_backup_source: Optional[ClusterRestoreContinuousBackupSourceArgs] = None,
uid: Optional[str] = None) -> Clusterfunc 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.
- Automated
Backup ClusterPolicy Automated Backup Policy The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- Backup
Sources List<ClusterBackup Source> Cluster created from backup. Structure is documented below.
- Cluster
Id string The ID of the alloydb cluster.
- Continuous
Backup ClusterConfig Continuous Backup Config 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.
- Continuous
Backup List<ClusterInfos Continuous Backup Info> ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- Database
Version string The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- Display
Name string User-settable and human-readable display name for the Cluster.
- Encryption
Config ClusterEncryption Config 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 List<ClusterEncryption Info> (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
- Initial
User ClusterInitial User Initial user to setup during cluster creation. Structure is documented below.
- Labels Dictionary<string, string>
User-defined labels for the alloydb cluster.
- Location string
The location where the alloydb cluster should reside.
- Migration
Sources List<ClusterMigration Source> Cluster created via DMS migration. Structure is documented below.
- Name string
The name of the cluster resource.
- Network string
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Restore
Backup ClusterSource Restore Backup Source 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 ClusterBackup Source Restore Continuous Backup Source 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.
- Uid string
The system-generated UID of the resource.
- Automated
Backup ClusterPolicy Automated Backup Policy Args The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- Backup
Sources []ClusterBackup Source Args Cluster created from backup. Structure is documented below.
- Cluster
Id string The ID of the alloydb cluster.
- Continuous
Backup ClusterConfig Continuous Backup Config Args 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.
- Continuous
Backup []ClusterInfos Continuous Backup Info Args ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- Database
Version string The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- Display
Name string User-settable and human-readable display name for the Cluster.
- Encryption
Config ClusterEncryption Config Args 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 []ClusterEncryption Info Args (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
- Initial
User ClusterInitial User Args Initial user to setup during cluster creation. Structure is documented below.
- Labels map[string]string
User-defined labels for the alloydb cluster.
- Location string
The location where the alloydb cluster should reside.
- Migration
Sources []ClusterMigration Source Args Cluster created via DMS migration. Structure is documented below.
- Name string
The name of the cluster resource.
- Network string
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Restore
Backup ClusterSource Restore Backup Source Args 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 ClusterBackup Source Restore Continuous Backup Source Args 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.
- Uid string
The system-generated UID of the resource.
- automated
Backup ClusterPolicy Automated Backup Policy The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- backup
Sources List<ClusterBackup Source> Cluster created from backup. Structure is documented below.
- cluster
Id String The ID of the alloydb cluster.
- continuous
Backup ClusterConfig Continuous Backup Config 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.
- continuous
Backup List<ClusterInfos Continuous Backup Info> ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- database
Version String The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- display
Name String User-settable and human-readable display name for the Cluster.
- encryption
Config ClusterEncryption Config 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 List<ClusterEncryption Info> (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
- initial
User ClusterInitial User Initial user to setup during cluster creation. Structure is documented below.
- labels Map<String,String>
User-defined labels for the alloydb cluster.
- location String
The location where the alloydb cluster should reside.
- migration
Sources List<ClusterMigration Source> Cluster created via DMS migration. Structure is documented below.
- name String
The name of the cluster resource.
- network String
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore
Backup ClusterSource Restore Backup Source 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 ClusterBackup Source Restore Continuous Backup Source 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.
- uid String
The system-generated UID of the resource.
- automated
Backup ClusterPolicy Automated Backup Policy The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- backup
Sources ClusterBackup Source[] Cluster created from backup. Structure is documented below.
- cluster
Id string The ID of the alloydb cluster.
- continuous
Backup ClusterConfig Continuous Backup Config 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.
- continuous
Backup ClusterInfos Continuous Backup Info[] ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- database
Version string The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- display
Name string User-settable and human-readable display name for the Cluster.
- encryption
Config ClusterEncryption Config 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 ClusterEncryption Info[] (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
- initial
User ClusterInitial User Initial user to setup during cluster creation. Structure is documented below.
- labels {[key: string]: string}
User-defined labels for the alloydb cluster.
- location string
The location where the alloydb cluster should reside.
- migration
Sources ClusterMigration Source[] Cluster created via DMS migration. Structure is documented below.
- name string
The name of the cluster resource.
- network string
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore
Backup ClusterSource Restore Backup Source 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 ClusterBackup Source Restore Continuous Backup Source 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.
- uid string
The system-generated UID of the resource.
- automated_
backup_ Clusterpolicy Automated Backup Policy Args The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- backup_
sources Sequence[ClusterBackup Source Args] Cluster created from backup. Structure is documented below.
- cluster_
id str The ID of the alloydb cluster.
- continuous_
backup_ Clusterconfig Continuous Backup Config Args 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.
- continuous_
backup_ Sequence[Clusterinfos Continuous Backup Info Args] ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- database_
version str The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- display_
name str User-settable and human-readable display name for the Cluster.
- encryption_
config ClusterEncryption Config Args 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[ClusterEncryption Info Args] (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
- initial_
user ClusterInitial User Args Initial user to setup during cluster creation. Structure is documented below.
- labels Mapping[str, str]
User-defined labels for the alloydb cluster.
- location str
The location where the alloydb cluster should reside.
- migration_
sources Sequence[ClusterMigration Source Args] Cluster created via DMS migration. Structure is documented below.
- name str
The name of the cluster resource.
- network str
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore_
backup_ Clustersource Restore Backup Source Args 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_ Clusterbackup_ source Restore Continuous Backup Source Args 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.
- uid str
The system-generated UID of the resource.
- automated
Backup Property MapPolicy The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. Structure is documented below.
- backup
Sources List<Property Map> Cluster created from backup. Structure is documented below.
- cluster
Id String The ID of the alloydb cluster.
- continuous
Backup Property MapConfig 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.
- continuous
Backup List<Property Map>Infos ContinuousBackupInfo describes the continuous backup properties of a cluster. Structure is documented below.
- database
Version String The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.
- display
Name String User-settable and human-readable display name for the Cluster.
- encryption
Config 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.
- encryption
Infos List<Property Map> (Output) Output only. The encryption information for the WALs and backups required for ContinuousBackup. Structure is documented below.
- initial
User Property Map Initial user to setup during cluster creation. Structure is documented below.
- labels Map<String>
User-defined labels for the alloydb cluster.
- location String
The location where the alloydb cluster should reside.
- migration
Sources List<Property Map> Cluster created via DMS migration. Structure is documented below.
- name String
The name of the cluster resource.
- network String
The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}".
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- restore
Backup Property MapSource 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 Property MapBackup Source 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.
- uid String
The system-generated UID of the resource.
Supporting Types
ClusterAutomatedBackupPolicy, ClusterAutomatedBackupPolicyArgs
- Backup
Window 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.
- Encryption
Config ClusterAutomated Backup Policy Encryption Config 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.
- Quantity
Based ClusterRetention Automated Backup Policy Quantity Based Retention 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 ClusterRetention Automated Backup Policy Time Based Retention Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
- Weekly
Schedule ClusterAutomated Backup Policy Weekly Schedule Weekly schedule for the Backup. Structure is documented below.
- Backup
Window 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.
- Encryption
Config ClusterAutomated Backup Policy Encryption Config 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.
- Quantity
Based ClusterRetention Automated Backup Policy Quantity Based Retention 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 ClusterRetention Automated Backup Policy Time Based Retention Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
- Weekly
Schedule ClusterAutomated Backup Policy Weekly Schedule Weekly schedule for the Backup. Structure is documented below.
- backup
Window 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.
- encryption
Config ClusterAutomated Backup Policy Encryption Config 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.
- quantity
Based ClusterRetention Automated Backup Policy Quantity Based Retention 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 ClusterRetention Automated Backup Policy Time Based Retention Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
- weekly
Schedule ClusterAutomated Backup Policy Weekly Schedule Weekly schedule for the Backup. Structure is documented below.
- backup
Window 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.
- encryption
Config ClusterAutomated Backup Policy Encryption Config 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.
- quantity
Based ClusterRetention Automated Backup Policy Quantity Based Retention 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 ClusterRetention Automated Backup Policy Time Based Retention Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
- weekly
Schedule ClusterAutomated Backup Policy Weekly Schedule 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 ClusterAutomated Backup Policy Encryption Config 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_ Clusterretention Automated Backup Policy Quantity Based Retention 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_ Clusterretention Automated Backup Policy Time Based Retention Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
- weekly_
schedule ClusterAutomated Backup Policy Weekly Schedule Weekly schedule for the Backup. Structure is documented below.
- backup
Window 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.
- encryption
Config 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.
- quantity
Based Property MapRetention 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 Property MapRetention Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. Structure is documented below.
- weekly
Schedule Property Map Weekly schedule for the Backup. Structure is documented below.
ClusterAutomatedBackupPolicyEncryptionConfig, ClusterAutomatedBackupPolicyEncryptionConfigArgs
- Kms
Key stringName 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 stringName 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 StringName 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 stringName 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_ strname 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 StringName 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
- Retention
Period string The retention period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
- Retention
Period string The retention period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
- retention
Period String The retention period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
- retention
Period 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".
- retention
Period String The retention period. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
ClusterAutomatedBackupPolicyWeeklySchedule, ClusterAutomatedBackupPolicyWeeklyScheduleArgs
- Start
Times List<ClusterAutomated Backup Policy Weekly Schedule Start Time> 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 List<string>Weeks 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 []ClusterAutomated Backup Policy Weekly Schedule Start Time 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 []stringWeeks 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 List<ClusterAutomated Backup Policy Weekly Schedule Start Time> 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 List<String>Weeks 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 ClusterAutomated Backup Policy Weekly Schedule Start Time[] 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 string[]Weeks 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[ClusterAutomated Backup Policy Weekly Schedule Start Time] 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_ Sequence[str]weeks 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 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.
- days
Of List<String>Weeks 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
- Backup
Name string The name of the backup that this cluster is restored from.
- Backup
Name string The name of the backup that this cluster is restored from.
- backup
Name String The name of the backup that this cluster is restored from.
- backup
Name 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.
- backup
Name String The name of the backup that this cluster is restored from.
ClusterContinuousBackupConfig, ClusterContinuousBackupConfigArgs
- Enabled bool
Whether continuous backup recovery is enabled. If not set, defaults to true.
- Encryption
Config ClusterContinuous Backup Config Encryption Config 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 intDays 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 ClusterContinuous Backup Config Encryption Config 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 intDays 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.
- encryption
Config ClusterContinuous Backup Config Encryption Config 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 IntegerDays 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.
- encryption
Config ClusterContinuous Backup Config Encryption Config 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 numberDays 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 ClusterContinuous Backup Config Encryption Config 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_ intdays 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.
- encryption
Config 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.
- recovery
Window NumberDays 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
- Kms
Key stringName 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 stringName 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 StringName 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 stringName 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_ strname 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 StringName 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
- Earliest
Restorable stringTime (Output) The earliest restorable time that can be restored to. Output only field.
- Enabled
Time string (Output) When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- Encryption
Infos List<ClusterContinuous Backup Info Encryption Info> (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.
- Earliest
Restorable stringTime (Output) The earliest restorable time that can be restored to. Output only field.
- Enabled
Time string (Output) When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- Encryption
Infos []ClusterContinuous Backup Info Encryption Info (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 StringTime (Output) The earliest restorable time that can be restored to. Output only field.
- enabled
Time String (Output) When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- encryption
Infos List<ClusterContinuous Backup Info Encryption Info> (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.
- earliest
Restorable stringTime (Output) The earliest restorable time that can be restored to. Output only field.
- enabled
Time string (Output) When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- encryption
Infos ClusterContinuous Backup Info Encryption Info[] (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_ strtime (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[ClusterContinuous Backup Info Encryption Info] (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.
- earliest
Restorable StringTime (Output) The earliest restorable time that can be restored to. Output only field.
- enabled
Time String (Output) When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- encryption
Infos 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
- Encryption
Type string (Output) Output only. Type of encryption.
- Kms
Key List<string>Versions (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.
- Encryption
Type string (Output) Output only. Type of encryption.
- Kms
Key []stringVersions (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.
- encryption
Type String (Output) Output only. Type of encryption.
- kms
Key List<String>Versions (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.
- encryption
Type string (Output) Output only. Type of encryption.
- kms
Key string[]Versions (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_ Sequence[str]versions (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.
- encryption
Type String (Output) Output only. Type of encryption.
- kms
Key List<String>Versions (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.
ClusterEncryptionConfig, ClusterEncryptionConfigArgs
- Kms
Key stringName 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 stringName 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 StringName 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 stringName 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_ strname 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 StringName 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
- Encryption
Type string (Output) Output only. Type of encryption.
- Kms
Key List<string>Versions (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.
- Encryption
Type string (Output) Output only. Type of encryption.
- Kms
Key []stringVersions (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.
- encryption
Type String (Output) Output only. Type of encryption.
- kms
Key List<String>Versions (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.
- encryption
Type string (Output) Output only. Type of encryption.
- kms
Key string[]Versions (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_ Sequence[str]versions (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.
- encryption
Type String (Output) Output only. Type of encryption.
- kms
Key List<String>Versions (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.
ClusterInitialUser, ClusterInitialUserArgs
ClusterMigrationSource, ClusterMigrationSourceArgs
- Host
Port string The host and port of the on-premises instance in host:port format
- Reference
Id string Place holder for the external source identifier(e.g DMS job name) that created the cluster.
- Source
Type string Type of migration source.
- Host
Port string The host and port of the on-premises instance in host:port format
- Reference
Id string Place holder for the external source identifier(e.g DMS job name) that created the cluster.
- Source
Type string Type of migration source.
- host
Port String The host and port of the on-premises instance in host:port format
- reference
Id String Place holder for the external source identifier(e.g DMS job name) that created the cluster.
- source
Type String Type of migration source.
- host
Port string The host and port of the on-premises instance in host:port format
- reference
Id string Place holder for the external source identifier(e.g DMS job name) that created the cluster.
- source
Type 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.
- host
Port String The host and port of the on-premises instance in host:port format
- reference
Id String Place holder for the external source identifier(e.g DMS job name) that created the cluster.
- source
Type String Type of migration source.
ClusterRestoreBackupSource, ClusterRestoreBackupSourceArgs
- Backup
Name string The name of the backup that this cluster is restored from.
- Backup
Name string The name of the backup that this cluster is restored from.
- backup
Name String The name of the backup that this cluster is restored from.
- backup
Name 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.
- backup
Name 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.
- Point
In stringTime 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.
- Point
In stringTime 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.
- point
In StringTime 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.
- point
In stringTime 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_ strtime 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.
- point
In StringTime The point in time that this cluster is restored to, in RFC 3339 format.
Import
Cluster can be imported using any of these accepted formats
$ 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}}
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-betaTerraform Provider.