gcp.alloydb.Cluster
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}}
Example Usage
Alloydb Cluster Basic
using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var project = Gcp.Organizations.GetProject.Invoke();
var defaultNetwork = new Gcp.Compute.Network("defaultNetwork");
var defaultCluster = new Gcp.Alloydb.Cluster("defaultCluster", new()
{
ClusterId = "alloydb-cluster",
Location = "us-central1",
Network = Output.Tuple(project, defaultNetwork.Name).Apply(values =>
{
var project = values.Item1;
var name = values.Item2;
return $"projects/{project.Apply(getProjectResult => getProjectResult.Number)}/global/networks/{name}";
}),
});
});
package main
import (
"fmt"
"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 {
project, err := organizations.LookupProject(ctx, nil, nil)
if err != nil {
return err
}
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.Name.ApplyT(func(name string) (string, error) {
return fmt.Sprintf("projects/%v/global/networks/%v", project.Number, name), nil
}).(pulumi.StringOutput),
})
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.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.alloydb.Cluster;
import com.pulumi.gcp.alloydb.ClusterArgs;
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 project = OrganizationsFunctions.getProject();
var defaultNetwork = new Network("defaultNetwork");
var defaultCluster = new Cluster("defaultCluster", ClusterArgs.builder()
.clusterId("alloydb-cluster")
.location("us-central1")
.network(defaultNetwork.name().applyValue(name -> String.format("projects/%s/global/networks/%s", project.applyValue(getProjectResult -> getProjectResult.number()),name)))
.build());
}
}
import pulumi
import pulumi_gcp as gcp
project = gcp.organizations.get_project()
default_network = gcp.compute.Network("defaultNetwork")
default_cluster = gcp.alloydb.Cluster("defaultCluster",
cluster_id="alloydb-cluster",
location="us-central1",
network=default_network.name.apply(lambda name: f"projects/{project.number}/global/networks/{name}"))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const project = gcp.organizations.getProject({});
const defaultNetwork = new gcp.compute.Network("defaultNetwork", {});
const defaultCluster = new gcp.alloydb.Cluster("defaultCluster", {
clusterId: "alloydb-cluster",
location: "us-central1",
network: pulumi.all([project, defaultNetwork.name]).apply(([project, name]) => `projects/${project.number}/global/networks/${name}`),
});
resources:
defaultCluster:
type: gcp:alloydb:Cluster
properties:
clusterId: alloydb-cluster
location: us-central1
network: projects/${project.number}/global/networks/${defaultNetwork.name}
defaultNetwork:
type: gcp:compute:Network
variables:
project:
fn::invoke:
Function: gcp:organizations:getProject
Arguments: {}
Alloydb Cluster Full
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.alloydb.Cluster;
import com.pulumi.gcp.alloydb.ClusterArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterAutomatedBackupPolicyArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterAutomatedBackupPolicyWeeklyScheduleArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterInitialUserArgs;
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 project = OrganizationsFunctions.getProject();
var default_ = new Network("default");
var full = new Cluster("full", ClusterArgs.builder()
.automatedBackupPolicy(ClusterAutomatedBackupPolicyArgs.builder()
.backupWindow("1800s")
.enabled(true)
.labels(Map.of("test", "alloydb-cluster-full"))
.location("us-central1")
.quantityBasedRetention(ClusterAutomatedBackupPolicyQuantityBasedRetentionArgs.builder()
.count(1)
.build())
.weeklySchedule(ClusterAutomatedBackupPolicyWeeklyScheduleArgs.builder()
.daysOfWeek("MONDAY")
.startTimes(ClusterAutomatedBackupPolicyWeeklyScheduleStartTimeArgs.builder()
.hours(23)
.minutes(0)
.nanos(0)
.seconds(0)
.build())
.build())
.build())
.clusterId("alloydb-cluster-full")
.initialUser(ClusterInitialUserArgs.builder()
.password("alloydb-cluster-full")
.user("alloydb-cluster-full")
.build())
.labels(Map.of("test", "alloydb-cluster-full"))
.location("us-central1")
.network(default_.name().applyValue(name -> String.format("projects/%s/global/networks/%s", project.applyValue(getProjectResult -> getProjectResult.number()),name)))
.build());
}
}
Coming soon!
Coming soon!
resources:
full:
type: gcp:alloydb:Cluster
properties:
automatedBackupPolicy:
backupWindow: 1800s
enabled: true
labels:
test: alloydb-cluster-full
location: us-central1
quantityBasedRetention:
count: 1
weeklySchedule:
daysOfWeek:
- MONDAY
startTimes:
- hours: 23
minutes: 0
nanos: 0
seconds: 0
clusterId: alloydb-cluster-full
initialUser:
password: alloydb-cluster-full
user: alloydb-cluster-full
labels:
test: alloydb-cluster-full
location: us-central1
network: projects/${project.number}/global/networks/${default.name}
default:
type: gcp:compute:Network
variables:
project:
fn::invoke:
Function: gcp:organizations:getProject
Arguments: {}
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,
display_name: Optional[str] = None,
initial_user: Optional[ClusterInitialUserArgs] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
network: Optional[str] = None,
project: Optional[str] = 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.
- 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. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. Structure is documented below.
- Display
Name string User-settable and human-readable display name for the Cluster.
- Initial
User ClusterInitial User Args 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.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Cluster
Id string The ID of the alloydb cluster.
- 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. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. Structure is documented below.
- Display
Name string User-settable and human-readable display name for the Cluster.
- 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.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- cluster
Id String The ID of the alloydb cluster.
- 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. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. Structure is documented below.
- display
Name String User-settable and human-readable display name for the Cluster.
- 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.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- cluster
Id string The ID of the alloydb cluster.
- 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. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. Structure is documented below.
- display
Name string User-settable and human-readable display name for the Cluster.
- initial
User ClusterInitial User Args 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.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- cluster_
id str The ID of the alloydb cluster.
- 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. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. Structure is documented below.
- display_
name str User-settable and human-readable display name for the Cluster.
- 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.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- cluster
Id String The ID of the alloydb cluster.
- 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. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. Structure is documented below.
- display
Name String User-settable and human-readable display name for the Cluster.
- 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.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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,
database_version: Optional[str] = None,
display_name: Optional[str] = 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,
uid: Optional[str] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Automated
Backup ClusterPolicy Automated Backup Policy Args The automated backup policy for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. Structure is documented below.
- Backup
Sources List<ClusterBackup Source Args> Cluster created from backup. Structure is documented below.
- Cluster
Id string The ID of the alloydb cluster.
- 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.
- Initial
User ClusterInitial User Args 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 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.
- Uid string
The system-generated UID of the resource.
- Automated
Backup ClusterPolicy Automated Backup Policy Args The automated backup policy for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. 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.
- 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.
- 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.
- Uid string
The system-generated UID of the resource.
- automated
Backup ClusterPolicy Automated Backup Policy Args The automated backup policy for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. Structure is documented below.
- backup
Sources List<ClusterBackup Source Args> Cluster created from backup. Structure is documented below.
- cluster
Id String The ID of the alloydb cluster.
- 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.
- 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 List<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.
- uid String
The system-generated UID of the resource.
- automated
Backup ClusterPolicy Automated Backup Policy Args The automated backup policy for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. 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.
- 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.
- initial
User ClusterInitial User Args 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 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.
- uid string
The system-generated UID of the resource.
- automated_
backup_ Clusterpolicy Automated Backup Policy Args The automated backup policy for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. 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.
- 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.
- 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.
- uid str
The system-generated UID of the resource.
- automated
Backup Property MapPolicy The automated backup policy for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. 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.
- 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.
- 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.
- uid String
The system-generated UID of the resource.
Supporting Types
ClusterAutomatedBackupPolicy
- 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.
- 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. Structure is documented below.
- Time
Based ClusterRetention Automated Backup Policy Time Based Retention Time-based Backup retention policy. 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.
- 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. Structure is documented below.
- Time
Based ClusterRetention Automated Backup Policy Time Based Retention Time-based Backup retention policy. 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.
- 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. Structure is documented below.
- time
Based ClusterRetention Automated Backup Policy Time Based Retention Time-based Backup retention policy. 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.
- 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. Structure is documented below.
- time
Based ClusterRetention Automated Backup Policy Time Based Retention Time-based Backup retention policy. 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.
- 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. Structure is documented below.
- time_
based_ Clusterretention Automated Backup Policy Time Based Retention Time-based Backup retention policy. 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.
- 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. Structure is documented below.
- time
Based Property MapRetention Time-based Backup retention policy. Structure is documented below.
- weekly
Schedule Property Map Weekly schedule for the Backup. Structure is documented below.
ClusterAutomatedBackupPolicyQuantityBasedRetention
- 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
- 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
- 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
, andSUNDAY
.
- 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
, andSUNDAY
.
- 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
, andSUNDAY
.
- 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
, andSUNDAY
.
- 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
, andSUNDAY
.
- 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
, andSUNDAY
.
ClusterAutomatedBackupPolicyWeeklyScheduleStartTime
- 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. Must be from 0 to 59.
- Nanos int
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- Seconds int
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- 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. Must be from 0 to 59.
- Nanos int
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- Seconds int
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- 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. Must be from 0 to 59.
- nanos Integer
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- seconds Integer
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- 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. Must be from 0 to 59.
- nanos number
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- seconds number
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- 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. Must be from 0 to 59.
- nanos int
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- seconds int
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- 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. Must be from 0 to 59.
- nanos Number
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- seconds Number
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
ClusterBackupSource
- Backup
Name string The name of the backup resource.
- Backup
Name string The name of the backup resource.
- backup
Name String The name of the backup resource.
- backup
Name string The name of the backup resource.
- backup_
name str The name of the backup resource.
- backup
Name String The name of the backup resource.
ClusterInitialUser
ClusterMigrationSource
- 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.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.