Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.alloydb/v1beta.getCluster
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets details of a single Cluster.
Using getCluster
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
def get_cluster(cluster_id: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
view: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
view: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput
> Note: This function is named LookupCluster
in the Go SDK.
public static class GetCluster
{
public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:alloydb/v1beta:getCluster
arguments:
# arguments dictionary
The following arguments are supported:
- cluster_
id str - location str
- project str
- view str
getCluster Result
The following output properties are available:
- Annotations Dictionary<string, string>
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- Automated
Backup Pulumi.Policy Google Native. Alloy DB. V1Beta. Outputs. Automated Backup Policy Response - The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
- Backup
Source Pulumi.Google Native. Alloy DB. V1Beta. Outputs. Backup Source Response - Cluster created from backup.
- Cluster
Type string - The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e.
CreateCluster
vs.CreateSecondaryCluster
- Continuous
Backup Pulumi.Config Google Native. Alloy DB. V1Beta. Outputs. Continuous Backup Config Response - Optional. Continuous backup configuration for this cluster.
- Continuous
Backup Pulumi.Info Google Native. Alloy DB. V1Beta. Outputs. Continuous Backup Info Response - Continuous backup properties for this cluster.
- Create
Time string - Create time stamp
- Database
Version string - Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
- Delete
Time string - Delete time stamp
- Display
Name string - User-settable and human-readable display name for the Cluster.
- Encryption
Config Pulumi.Google Native. Alloy DB. V1Beta. Outputs. Encryption Config Response - Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
- Encryption
Info Pulumi.Google Native. Alloy DB. V1Beta. Outputs. Encryption Info Response - The encryption information for the cluster.
- Etag string
- For Resource freshness validation (https://google.aip.dev/154)
- Initial
User Pulumi.Google Native. Alloy DB. V1Beta. Outputs. User Password Response - Input only. Initial user to setup during cluster creation. Required. If used in
RestoreCluster
this is ignored. - Labels Dictionary<string, string>
- Labels as key value pairs
- Migration
Source Pulumi.Google Native. Alloy DB. V1Beta. Outputs. Migration Source Response - Cluster created via DMS migration.
- Name string
- The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression
[a-z0-9-]+
. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} - Network string
- The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project}/global/networks/{network_id}". This is required to create a cluster. Deprecated, use network_config.network instead.
- Network
Config Pulumi.Google Native. Alloy DB. V1Beta. Outputs. Network Config Response - Primary
Config Pulumi.Google Native. Alloy DB. V1Beta. Outputs. Primary Config Response - Cross Region replication config specific to PRIMARY cluster.
- Reconciling bool
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- Secondary
Config Pulumi.Google Native. Alloy DB. V1Beta. Outputs. Secondary Config Response - Cross Region replication config specific to SECONDARY cluster.
- Ssl
Config Pulumi.Google Native. Alloy DB. V1Beta. Outputs. Ssl Config Response - SSL configuration for this AlloyDB cluster.
- State string
- The current serving state of the cluster.
- Uid string
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- Update
Time string - Update time stamp
- Annotations map[string]string
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- Automated
Backup AutomatedPolicy Backup Policy Response - The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
- Backup
Source BackupSource Response - Cluster created from backup.
- Cluster
Type string - The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e.
CreateCluster
vs.CreateSecondaryCluster
- Continuous
Backup ContinuousConfig Backup Config Response - Optional. Continuous backup configuration for this cluster.
- Continuous
Backup ContinuousInfo Backup Info Response - Continuous backup properties for this cluster.
- Create
Time string - Create time stamp
- Database
Version string - Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
- Delete
Time string - Delete time stamp
- Display
Name string - User-settable and human-readable display name for the Cluster.
- Encryption
Config EncryptionConfig Response - Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
- Encryption
Info EncryptionInfo Response - The encryption information for the cluster.
- Etag string
- For Resource freshness validation (https://google.aip.dev/154)
- Initial
User UserPassword Response - Input only. Initial user to setup during cluster creation. Required. If used in
RestoreCluster
this is ignored. - Labels map[string]string
- Labels as key value pairs
- Migration
Source MigrationSource Response - Cluster created via DMS migration.
- Name string
- The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression
[a-z0-9-]+
. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} - Network string
- The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project}/global/networks/{network_id}". This is required to create a cluster. Deprecated, use network_config.network instead.
- Network
Config NetworkConfig Response - Primary
Config PrimaryConfig Response - Cross Region replication config specific to PRIMARY cluster.
- Reconciling bool
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- Secondary
Config SecondaryConfig Response - Cross Region replication config specific to SECONDARY cluster.
- Ssl
Config SslConfig Response - SSL configuration for this AlloyDB cluster.
- State string
- The current serving state of the cluster.
- Uid string
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- Update
Time string - Update time stamp
- annotations Map<String,String>
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- automated
Backup AutomatedPolicy Backup Policy Response - The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
- backup
Source BackupSource Response - Cluster created from backup.
- cluster
Type String - The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e.
CreateCluster
vs.CreateSecondaryCluster
- continuous
Backup ContinuousConfig Backup Config Response - Optional. Continuous backup configuration for this cluster.
- continuous
Backup ContinuousInfo Backup Info Response - Continuous backup properties for this cluster.
- create
Time String - Create time stamp
- database
Version String - Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
- delete
Time String - Delete time stamp
- display
Name String - User-settable and human-readable display name for the Cluster.
- encryption
Config EncryptionConfig Response - Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
- encryption
Info EncryptionInfo Response - The encryption information for the cluster.
- etag String
- For Resource freshness validation (https://google.aip.dev/154)
- initial
User UserPassword Response - Input only. Initial user to setup during cluster creation. Required. If used in
RestoreCluster
this is ignored. - labels Map<String,String>
- Labels as key value pairs
- migration
Source MigrationSource Response - Cluster created via DMS migration.
- name String
- The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression
[a-z0-9-]+
. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} - network String
- The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project}/global/networks/{network_id}". This is required to create a cluster. Deprecated, use network_config.network instead.
- network
Config NetworkConfig Response - primary
Config PrimaryConfig Response - Cross Region replication config specific to PRIMARY cluster.
- reconciling Boolean
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- secondary
Config SecondaryConfig Response - Cross Region replication config specific to SECONDARY cluster.
- ssl
Config SslConfig Response - SSL configuration for this AlloyDB cluster.
- state String
- The current serving state of the cluster.
- uid String
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- update
Time String - Update time stamp
- annotations {[key: string]: string}
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- automated
Backup AutomatedPolicy Backup Policy Response - The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
- backup
Source BackupSource Response - Cluster created from backup.
- cluster
Type string - The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e.
CreateCluster
vs.CreateSecondaryCluster
- continuous
Backup ContinuousConfig Backup Config Response - Optional. Continuous backup configuration for this cluster.
- continuous
Backup ContinuousInfo Backup Info Response - Continuous backup properties for this cluster.
- create
Time string - Create time stamp
- database
Version string - Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
- delete
Time string - Delete time stamp
- display
Name string - User-settable and human-readable display name for the Cluster.
- encryption
Config EncryptionConfig Response - Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
- encryption
Info EncryptionInfo Response - The encryption information for the cluster.
- etag string
- For Resource freshness validation (https://google.aip.dev/154)
- initial
User UserPassword Response - Input only. Initial user to setup during cluster creation. Required. If used in
RestoreCluster
this is ignored. - labels {[key: string]: string}
- Labels as key value pairs
- migration
Source MigrationSource Response - Cluster created via DMS migration.
- name string
- The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression
[a-z0-9-]+
. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} - network string
- The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project}/global/networks/{network_id}". This is required to create a cluster. Deprecated, use network_config.network instead.
- network
Config NetworkConfig Response - primary
Config PrimaryConfig Response - Cross Region replication config specific to PRIMARY cluster.
- reconciling boolean
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- secondary
Config SecondaryConfig Response - Cross Region replication config specific to SECONDARY cluster.
- ssl
Config SslConfig Response - SSL configuration for this AlloyDB cluster.
- state string
- The current serving state of the cluster.
- uid string
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- update
Time string - Update time stamp
- annotations Mapping[str, str]
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- automated_
backup_ Automatedpolicy Backup Policy Response - The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
- backup_
source BackupSource Response - Cluster created from backup.
- cluster_
type str - The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e.
CreateCluster
vs.CreateSecondaryCluster
- continuous_
backup_ Continuousconfig Backup Config Response - Optional. Continuous backup configuration for this cluster.
- continuous_
backup_ Continuousinfo Backup Info Response - Continuous backup properties for this cluster.
- create_
time str - Create time stamp
- database_
version str - Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
- delete_
time str - Delete time stamp
- display_
name str - User-settable and human-readable display name for the Cluster.
- encryption_
config EncryptionConfig Response - Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
- encryption_
info EncryptionInfo Response - The encryption information for the cluster.
- etag str
- For Resource freshness validation (https://google.aip.dev/154)
- initial_
user UserPassword Response - Input only. Initial user to setup during cluster creation. Required. If used in
RestoreCluster
this is ignored. - labels Mapping[str, str]
- Labels as key value pairs
- migration_
source MigrationSource Response - Cluster created via DMS migration.
- name str
- The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression
[a-z0-9-]+
. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} - network str
- The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project}/global/networks/{network_id}". This is required to create a cluster. Deprecated, use network_config.network instead.
- network_
config NetworkConfig Response - primary_
config PrimaryConfig Response - Cross Region replication config specific to PRIMARY cluster.
- reconciling bool
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- secondary_
config SecondaryConfig Response - Cross Region replication config specific to SECONDARY cluster.
- ssl_
config SslConfig Response - SSL configuration for this AlloyDB cluster.
- state str
- The current serving state of the cluster.
- uid str
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- update_
time str - Update time stamp
- annotations Map<String>
- Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
- automated
Backup Property MapPolicy - The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
- backup
Source Property Map - Cluster created from backup.
- cluster
Type String - The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e.
CreateCluster
vs.CreateSecondaryCluster
- continuous
Backup Property MapConfig - Optional. Continuous backup configuration for this cluster.
- continuous
Backup Property MapInfo - Continuous backup properties for this cluster.
- create
Time String - Create time stamp
- database
Version String - Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
- delete
Time String - Delete time stamp
- display
Name String - User-settable and human-readable display name for the Cluster.
- encryption
Config Property Map - Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
- encryption
Info Property Map - The encryption information for the cluster.
- etag String
- For Resource freshness validation (https://google.aip.dev/154)
- initial
User Property Map - Input only. Initial user to setup during cluster creation. Required. If used in
RestoreCluster
this is ignored. - labels Map<String>
- Labels as key value pairs
- migration
Source Property Map - Cluster created via DMS migration.
- name String
- The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression
[a-z0-9-]+
. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} - network String
- The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project}/global/networks/{network_id}". This is required to create a cluster. Deprecated, use network_config.network instead.
- network
Config Property Map - primary
Config Property Map - Cross Region replication config specific to PRIMARY cluster.
- reconciling Boolean
- Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
- secondary
Config Property Map - Cross Region replication config specific to SECONDARY cluster.
- ssl
Config Property Map - SSL configuration for this AlloyDB cluster.
- state String
- The current serving state of the cluster.
- uid String
- The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
- update
Time String - Update time stamp
Supporting Types
AutomatedBackupPolicyResponse
- 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 defaults to 1 hour.
- Enabled bool
- Whether automated automated backups are enabled. If not set, defaults to true.
- Encryption
Config Pulumi.Google Native. Alloy DB. V1Beta. Inputs. Encryption Config Response - Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- 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. If empty, defaults to the region of the cluster.
- Quantity
Based Pulumi.Retention Google Native. Alloy DB. V1Beta. Inputs. Quantity Based Retention Response - Quantity-based Backup retention policy to retain recent backups.
- Time
Based Pulumi.Retention Google Native. Alloy DB. V1Beta. Inputs. Time Based Retention Response - Time-based Backup retention policy.
- Weekly
Schedule Pulumi.Google Native. Alloy DB. V1Beta. Inputs. Weekly Schedule Response - Weekly schedule for the Backup.
- 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 defaults to 1 hour.
- Enabled bool
- Whether automated automated backups are enabled. If not set, defaults to true.
- Encryption
Config EncryptionConfig Response - Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- 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. If empty, defaults to the region of the cluster.
- Quantity
Based QuantityRetention Based Retention Response - Quantity-based Backup retention policy to retain recent backups.
- Time
Based TimeRetention Based Retention Response - Time-based Backup retention policy.
- Weekly
Schedule WeeklySchedule Response - Weekly schedule for the Backup.
- 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 defaults to 1 hour.
- enabled Boolean
- Whether automated automated backups are enabled. If not set, defaults to true.
- encryption
Config EncryptionConfig Response - Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- 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. If empty, defaults to the region of the cluster.
- quantity
Based QuantityRetention Based Retention Response - Quantity-based Backup retention policy to retain recent backups.
- time
Based TimeRetention Based Retention Response - Time-based Backup retention policy.
- weekly
Schedule WeeklySchedule Response - Weekly schedule for the Backup.
- 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 defaults to 1 hour.
- enabled boolean
- Whether automated automated backups are enabled. If not set, defaults to true.
- encryption
Config EncryptionConfig Response - Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- 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. If empty, defaults to the region of the cluster.
- quantity
Based QuantityRetention Based Retention Response - Quantity-based Backup retention policy to retain recent backups.
- time
Based TimeRetention Based Retention Response - Time-based Backup retention policy.
- weekly
Schedule WeeklySchedule Response - Weekly schedule for the Backup.
- 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 defaults to 1 hour.
- enabled bool
- Whether automated automated backups are enabled. If not set, defaults to true.
- encryption_
config EncryptionConfig Response - Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- 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. If empty, defaults to the region of the cluster.
- quantity_
based_ Quantityretention Based Retention Response - Quantity-based Backup retention policy to retain recent backups.
- time_
based_ Timeretention Based Retention Response - Time-based Backup retention policy.
- weekly_
schedule WeeklySchedule Response - Weekly schedule for the Backup.
- 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 defaults to 1 hour.
- enabled Boolean
- Whether automated automated backups are enabled. If not set, defaults to true.
- encryption
Config Property Map - Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- 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. If empty, defaults to the region of the cluster.
- quantity
Based Property MapRetention - Quantity-based Backup retention policy to retain recent backups.
- time
Based Property MapRetention - Time-based Backup retention policy.
- weekly
Schedule Property Map - Weekly schedule for the Backup.
BackupSourceResponse
- Backup
Name string - The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
- Backup
Uid string - The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
- Backup
Name string - The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
- Backup
Uid string - The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
- backup
Name String - The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
- backup
Uid String - The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
- backup
Name string - The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
- backup
Uid string - The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
- backup_
name str - The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
- backup_
uid str - The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
- backup
Name String - The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
- backup
Uid String - The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted.
ContinuousBackupConfigResponse
- Enabled bool
- Whether ContinuousBackup is enabled.
- Encryption
Config Pulumi.Google Native. Alloy DB. V1Beta. Inputs. Encryption Config Response - The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- Recovery
Window intDays - The number 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 ContinuousBackup is enabled.
- Encryption
Config EncryptionConfig Response - The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- Recovery
Window intDays - The number 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 ContinuousBackup is enabled.
- encryption
Config EncryptionConfig Response - The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- recovery
Window IntegerDays - The number 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 ContinuousBackup is enabled.
- encryption
Config EncryptionConfig Response - The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- recovery
Window numberDays - The number 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 ContinuousBackup is enabled.
- encryption_
config EncryptionConfig Response - The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- recovery_
window_ intdays - The number 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 ContinuousBackup is enabled.
- encryption
Config Property Map - The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
- recovery
Window NumberDays - The number 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.
ContinuousBackupInfoResponse
- Earliest
Restorable stringTime - The earliest restorable time that can be restored to. Output only field.
- Enabled
Time string - When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- Encryption
Info Pulumi.Google Native. Alloy DB. V1Beta. Inputs. Encryption Info Response - The encryption information for the WALs and backups required for ContinuousBackup.
- Schedule List<string>
- Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
- Earliest
Restorable stringTime - The earliest restorable time that can be restored to. Output only field.
- Enabled
Time string - When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- Encryption
Info EncryptionInfo Response - The encryption information for the WALs and backups required for ContinuousBackup.
- Schedule []string
- Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
- earliest
Restorable StringTime - The earliest restorable time that can be restored to. Output only field.
- enabled
Time String - When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- encryption
Info EncryptionInfo Response - The encryption information for the WALs and backups required for ContinuousBackup.
- schedule List<String>
- Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
- earliest
Restorable stringTime - The earliest restorable time that can be restored to. Output only field.
- enabled
Time string - When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- encryption
Info EncryptionInfo Response - The encryption information for the WALs and backups required for ContinuousBackup.
- schedule string[]
- Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
- earliest_
restorable_ strtime - The earliest restorable time that can be restored to. Output only field.
- enabled_
time str - When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- encryption_
info EncryptionInfo Response - The encryption information for the WALs and backups required for ContinuousBackup.
- schedule Sequence[str]
- Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
- earliest
Restorable StringTime - The earliest restorable time that can be restored to. Output only field.
- enabled
Time String - When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- encryption
Info Property Map - The encryption information for the WALs and backups required for ContinuousBackup.
- schedule List<String>
- Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
EncryptionConfigResponse
- 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]
EncryptionInfoResponse
- Encryption
Type string - Type of encryption.
- Kms
Key List<string>Versions - Cloud KMS key versions that are being used to protect the database or the backup.
- Encryption
Type string - Type of encryption.
- Kms
Key []stringVersions - Cloud KMS key versions that are being used to protect the database or the backup.
- encryption
Type String - Type of encryption.
- kms
Key List<String>Versions - Cloud KMS key versions that are being used to protect the database or the backup.
- encryption
Type string - Type of encryption.
- kms
Key string[]Versions - Cloud KMS key versions that are being used to protect the database or the backup.
- encryption_
type str - Type of encryption.
- kms_
key_ Sequence[str]versions - Cloud KMS key versions that are being used to protect the database or the backup.
- encryption
Type String - Type of encryption.
- kms
Key List<String>Versions - Cloud KMS key versions that are being used to protect the database or the backup.
GoogleTypeTimeOfDayResponse
- 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.
MigrationSourceResponse
- 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.
NetworkConfigResponse
- Allocated
Ip stringRange - Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?
. Field name is intended to be consistent with Cloud SQL. - Network string
- Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.
- Allocated
Ip stringRange - Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?
. Field name is intended to be consistent with Cloud SQL. - Network string
- Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.
- allocated
Ip StringRange - Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?
. Field name is intended to be consistent with Cloud SQL. - network String
- Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.
- allocated
Ip stringRange - Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?
. Field name is intended to be consistent with Cloud SQL. - network string
- Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.
- allocated_
ip_ strrange - Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?
. Field name is intended to be consistent with Cloud SQL. - network str
- Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.
- allocated
Ip StringRange - Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])?
. Field name is intended to be consistent with Cloud SQL. - network String
- Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster.
PrimaryConfigResponse
- Secondary
Cluster List<string>Names - Names of the clusters that are replicating from this cluster.
- Secondary
Cluster []stringNames - Names of the clusters that are replicating from this cluster.
- secondary
Cluster List<String>Names - Names of the clusters that are replicating from this cluster.
- secondary
Cluster string[]Names - Names of the clusters that are replicating from this cluster.
- secondary_
cluster_ Sequence[str]names - Names of the clusters that are replicating from this cluster.
- secondary
Cluster List<String>Names - Names of the clusters that are replicating from this cluster.
QuantityBasedRetentionResponse
- 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.
SecondaryConfigResponse
- Primary
Cluster stringName - The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
- Primary
Cluster stringName - The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
- primary
Cluster StringName - The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
- primary
Cluster stringName - The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
- primary_
cluster_ strname - The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
- primary
Cluster StringName - The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
SslConfigResponse
TimeBasedRetentionResponse
- Retention
Period string - The retention period.
- Retention
Period string - The retention period.
- retention
Period String - The retention period.
- retention
Period string - The retention period.
- retention_
period str - The retention period.
- retention
Period String - The retention period.
UserPasswordResponse
WeeklyScheduleResponse
- Days
Of List<string>Week - The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
- Start
Times List<Pulumi.Google Native. Alloy DB. V1Beta. Inputs. Google Type Time Of Day Response> - The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
- Days
Of []stringWeek - The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
- Start
Times []GoogleType Time Of Day Response - The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
- days
Of List<String>Week - The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
- start
Times List<GoogleType Time Of Day Response> - The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
- days
Of string[]Week - The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
- start
Times GoogleType Time Of Day Response[] - The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
- days_
of_ Sequence[str]week - The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
- start_
times Sequence[GoogleType Time Of Day Response] - The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
- days
Of List<String>Week - The days of the week to perform a backup. If this field is left empty, the default of every day of the week is used.
- start
Times List<Property Map> - The times during the day to start a backup. The start times are assumed to be in UTC and to be an exact hour (e.g., 04:00:00). If no start times are provided, a single fixed start time is chosen arbitrarily.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi