1. Packages
  2. Google Cloud Native
  3. API Docs
  4. alloydb
  5. alloydb/v1alpha
  6. getCluster

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/v1alpha.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>
Copy
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]
Copy
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:alloydb/v1alpha:getCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterId This property is required. string
Location This property is required. string
Project string
View string
ClusterId This property is required. string
Location This property is required. string
Project string
View string
clusterId This property is required. String
location This property is required. String
project String
view String
clusterId This property is required. string
location This property is required. string
project string
view string
cluster_id This property is required. str
location This property is required. str
project str
view str
clusterId This property is required. String
location This property is required. String
project String
view String

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
AutomatedBackupPolicy Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.AutomatedBackupPolicyResponse
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.
BackupSource Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.BackupSourceResponse
Cluster created from backup.
ClusterType 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
ContinuousBackupConfig Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.ContinuousBackupConfigResponse
Optional. Continuous backup configuration for this cluster.
ContinuousBackupInfo Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.ContinuousBackupInfoResponse
Continuous backup properties for this cluster.
CreateTime string
Create time stamp
DatabaseVersion 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.
DeleteTime string
Delete time stamp
DisplayName string
User-settable and human-readable display name for the Cluster.
EncryptionConfig Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.EncryptionConfigResponse
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.
EncryptionInfo Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.EncryptionInfoResponse
The encryption information for the cluster.
Etag string
For Resource freshness validation (https://google.aip.dev/154)
InitialUser Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.UserPasswordResponse
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
MigrationSource Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.MigrationSourceResponse
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.

Deprecated: Required. 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.

NetworkConfig Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.NetworkConfigResponse
PrimaryConfig Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.PrimaryConfigResponse
Cross Region replication config specific to PRIMARY cluster.
PscConfig Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.PscConfigResponse
Optional. The configuration for Private Service Connect (PSC) for the 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.
SatisfiesPzs bool
Reserved for future use.
SecondaryConfig Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.SecondaryConfigResponse
Cross Region replication config specific to SECONDARY cluster.
SslConfig Pulumi.GoogleNative.AlloyDB.V1Alpha.Outputs.SslConfigResponse
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.
UpdateTime 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
AutomatedBackupPolicy AutomatedBackupPolicyResponse
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.
BackupSource BackupSourceResponse
Cluster created from backup.
ClusterType 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
ContinuousBackupConfig ContinuousBackupConfigResponse
Optional. Continuous backup configuration for this cluster.
ContinuousBackupInfo ContinuousBackupInfoResponse
Continuous backup properties for this cluster.
CreateTime string
Create time stamp
DatabaseVersion 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.
DeleteTime string
Delete time stamp
DisplayName string
User-settable and human-readable display name for the Cluster.
EncryptionConfig EncryptionConfigResponse
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.
EncryptionInfo EncryptionInfoResponse
The encryption information for the cluster.
Etag string
For Resource freshness validation (https://google.aip.dev/154)
InitialUser UserPasswordResponse
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
MigrationSource MigrationSourceResponse
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.

Deprecated: Required. 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.

NetworkConfig NetworkConfigResponse
PrimaryConfig PrimaryConfigResponse
Cross Region replication config specific to PRIMARY cluster.
PscConfig PscConfigResponse
Optional. The configuration for Private Service Connect (PSC) for the 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.
SatisfiesPzs bool
Reserved for future use.
SecondaryConfig SecondaryConfigResponse
Cross Region replication config specific to SECONDARY cluster.
SslConfig SslConfigResponse
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.
UpdateTime 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
automatedBackupPolicy AutomatedBackupPolicyResponse
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.
backupSource BackupSourceResponse
Cluster created from backup.
clusterType 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
continuousBackupConfig ContinuousBackupConfigResponse
Optional. Continuous backup configuration for this cluster.
continuousBackupInfo ContinuousBackupInfoResponse
Continuous backup properties for this cluster.
createTime String
Create time stamp
databaseVersion 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.
deleteTime String
Delete time stamp
displayName String
User-settable and human-readable display name for the Cluster.
encryptionConfig EncryptionConfigResponse
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.
encryptionInfo EncryptionInfoResponse
The encryption information for the cluster.
etag String
For Resource freshness validation (https://google.aip.dev/154)
initialUser UserPasswordResponse
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
migrationSource MigrationSourceResponse
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.

Deprecated: Required. 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.

networkConfig NetworkConfigResponse
primaryConfig PrimaryConfigResponse
Cross Region replication config specific to PRIMARY cluster.
pscConfig PscConfigResponse
Optional. The configuration for Private Service Connect (PSC) for the 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.
satisfiesPzs Boolean
Reserved for future use.
secondaryConfig SecondaryConfigResponse
Cross Region replication config specific to SECONDARY cluster.
sslConfig SslConfigResponse
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.
updateTime 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
automatedBackupPolicy AutomatedBackupPolicyResponse
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.
backupSource BackupSourceResponse
Cluster created from backup.
clusterType 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
continuousBackupConfig ContinuousBackupConfigResponse
Optional. Continuous backup configuration for this cluster.
continuousBackupInfo ContinuousBackupInfoResponse
Continuous backup properties for this cluster.
createTime string
Create time stamp
databaseVersion 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.
deleteTime string
Delete time stamp
displayName string
User-settable and human-readable display name for the Cluster.
encryptionConfig EncryptionConfigResponse
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.
encryptionInfo EncryptionInfoResponse
The encryption information for the cluster.
etag string
For Resource freshness validation (https://google.aip.dev/154)
initialUser UserPasswordResponse
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
migrationSource MigrationSourceResponse
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.

Deprecated: Required. 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.

networkConfig NetworkConfigResponse
primaryConfig PrimaryConfigResponse
Cross Region replication config specific to PRIMARY cluster.
pscConfig PscConfigResponse
Optional. The configuration for Private Service Connect (PSC) for the 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.
satisfiesPzs boolean
Reserved for future use.
secondaryConfig SecondaryConfigResponse
Cross Region replication config specific to SECONDARY cluster.
sslConfig SslConfigResponse
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.
updateTime 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_policy AutomatedBackupPolicyResponse
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 BackupSourceResponse
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_config ContinuousBackupConfigResponse
Optional. Continuous backup configuration for this cluster.
continuous_backup_info ContinuousBackupInfoResponse
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 EncryptionConfigResponse
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 EncryptionInfoResponse
The encryption information for the cluster.
etag str
For Resource freshness validation (https://google.aip.dev/154)
initial_user UserPasswordResponse
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 MigrationSourceResponse
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.

Deprecated: Required. 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 NetworkConfigResponse
primary_config PrimaryConfigResponse
Cross Region replication config specific to PRIMARY cluster.
psc_config PscConfigResponse
Optional. The configuration for Private Service Connect (PSC) for the 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.
satisfies_pzs bool
Reserved for future use.
secondary_config SecondaryConfigResponse
Cross Region replication config specific to SECONDARY cluster.
ssl_config SslConfigResponse
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
automatedBackupPolicy Property Map
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.
backupSource Property Map
Cluster created from backup.
clusterType 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
continuousBackupConfig Property Map
Optional. Continuous backup configuration for this cluster.
continuousBackupInfo Property Map
Continuous backup properties for this cluster.
createTime String
Create time stamp
databaseVersion 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.
deleteTime String
Delete time stamp
displayName String
User-settable and human-readable display name for the Cluster.
encryptionConfig 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.
encryptionInfo Property Map
The encryption information for the cluster.
etag String
For Resource freshness validation (https://google.aip.dev/154)
initialUser 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
migrationSource 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.

Deprecated: Required. 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.

networkConfig Property Map
primaryConfig Property Map
Cross Region replication config specific to PRIMARY cluster.
pscConfig Property Map
Optional. The configuration for Private Service Connect (PSC) for the 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.
satisfiesPzs Boolean
Reserved for future use.
secondaryConfig Property Map
Cross Region replication config specific to SECONDARY cluster.
sslConfig 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.
updateTime String
Update time stamp

Supporting Types

AutomatedBackupPolicyResponse

BackupWindow This property is required. 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 This property is required. bool
Whether automated automated backups are enabled. If not set, defaults to true.
EncryptionConfig This property is required. Pulumi.GoogleNative.AlloyDB.V1Alpha.Inputs.EncryptionConfigResponse
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 This property is required. Dictionary<string, string>
Labels to apply to backups created using this configuration.
Location This property is required. 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.
QuantityBasedRetention This property is required. Pulumi.GoogleNative.AlloyDB.V1Alpha.Inputs.QuantityBasedRetentionResponse
Quantity-based Backup retention policy to retain recent backups.
TimeBasedRetention This property is required. Pulumi.GoogleNative.AlloyDB.V1Alpha.Inputs.TimeBasedRetentionResponse
Time-based Backup retention policy.
WeeklySchedule This property is required. Pulumi.GoogleNative.AlloyDB.V1Alpha.Inputs.WeeklyScheduleResponse
Weekly schedule for the Backup.
BackupWindow This property is required. 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 This property is required. bool
Whether automated automated backups are enabled. If not set, defaults to true.
EncryptionConfig This property is required. EncryptionConfigResponse
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 This property is required. map[string]string
Labels to apply to backups created using this configuration.
Location This property is required. 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.
QuantityBasedRetention This property is required. QuantityBasedRetentionResponse
Quantity-based Backup retention policy to retain recent backups.
TimeBasedRetention This property is required. TimeBasedRetentionResponse
Time-based Backup retention policy.
WeeklySchedule This property is required. WeeklyScheduleResponse
Weekly schedule for the Backup.
backupWindow This property is required. 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 This property is required. Boolean
Whether automated automated backups are enabled. If not set, defaults to true.
encryptionConfig This property is required. EncryptionConfigResponse
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 This property is required. Map<String,String>
Labels to apply to backups created using this configuration.
location This property is required. 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.
quantityBasedRetention This property is required. QuantityBasedRetentionResponse
Quantity-based Backup retention policy to retain recent backups.
timeBasedRetention This property is required. TimeBasedRetentionResponse
Time-based Backup retention policy.
weeklySchedule This property is required. WeeklyScheduleResponse
Weekly schedule for the Backup.
backupWindow This property is required. 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 This property is required. boolean
Whether automated automated backups are enabled. If not set, defaults to true.
encryptionConfig This property is required. EncryptionConfigResponse
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 This property is required. {[key: string]: string}
Labels to apply to backups created using this configuration.
location This property is required. 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.
quantityBasedRetention This property is required. QuantityBasedRetentionResponse
Quantity-based Backup retention policy to retain recent backups.
timeBasedRetention This property is required. TimeBasedRetentionResponse
Time-based Backup retention policy.
weeklySchedule This property is required. WeeklyScheduleResponse
Weekly schedule for the Backup.
backup_window This property is required. 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 This property is required. bool
Whether automated automated backups are enabled. If not set, defaults to true.
encryption_config This property is required. EncryptionConfigResponse
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 This property is required. Mapping[str, str]
Labels to apply to backups created using this configuration.
location This property is required. 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_retention This property is required. QuantityBasedRetentionResponse
Quantity-based Backup retention policy to retain recent backups.
time_based_retention This property is required. TimeBasedRetentionResponse
Time-based Backup retention policy.
weekly_schedule This property is required. WeeklyScheduleResponse
Weekly schedule for the Backup.
backupWindow This property is required. 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 This property is required. Boolean
Whether automated automated backups are enabled. If not set, defaults to true.
encryptionConfig This property is required. 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 This property is required. Map<String>
Labels to apply to backups created using this configuration.
location This property is required. 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.
quantityBasedRetention This property is required. Property Map
Quantity-based Backup retention policy to retain recent backups.
timeBasedRetention This property is required. Property Map
Time-based Backup retention policy.
weeklySchedule This property is required. Property Map
Weekly schedule for the Backup.

BackupSourceResponse

BackupName This property is required. string
The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
BackupUid This property is required. 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.
BackupName This property is required. string
The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
BackupUid This property is required. 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.
backupName This property is required. String
The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
backupUid This property is required. 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.
backupName This property is required. string
The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
backupUid This property is required. 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 This property is required. str
The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
backup_uid This property is required. 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.
backupName This property is required. String
The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
backupUid This property is required. 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 This property is required. bool
Whether ContinuousBackup is enabled.
EncryptionConfig This property is required. Pulumi.GoogleNative.AlloyDB.V1Alpha.Inputs.EncryptionConfigResponse
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.
RecoveryWindowDays This property is required. int
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 This property is required. bool
Whether ContinuousBackup is enabled.
EncryptionConfig This property is required. EncryptionConfigResponse
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.
RecoveryWindowDays This property is required. int
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 This property is required. Boolean
Whether ContinuousBackup is enabled.
encryptionConfig This property is required. EncryptionConfigResponse
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.
recoveryWindowDays This property is required. Integer
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 This property is required. boolean
Whether ContinuousBackup is enabled.
encryptionConfig This property is required. EncryptionConfigResponse
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.
recoveryWindowDays This property is required. number
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 This property is required. bool
Whether ContinuousBackup is enabled.
encryption_config This property is required. EncryptionConfigResponse
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_days This property is required. int
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 This property is required. Boolean
Whether ContinuousBackup is enabled.
encryptionConfig This property is required. 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.
recoveryWindowDays This property is required. Number
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

EarliestRestorableTime This property is required. string
The earliest restorable time that can be restored to. Output only field.
EnabledTime This property is required. string
When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
EncryptionInfo This property is required. Pulumi.GoogleNative.AlloyDB.V1Alpha.Inputs.EncryptionInfoResponse
The encryption information for the WALs and backups required for ContinuousBackup.
Schedule This property is required. List<string>
Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
EarliestRestorableTime This property is required. string
The earliest restorable time that can be restored to. Output only field.
EnabledTime This property is required. string
When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
EncryptionInfo This property is required. EncryptionInfoResponse
The encryption information for the WALs and backups required for ContinuousBackup.
Schedule This property is required. []string
Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
earliestRestorableTime This property is required. String
The earliest restorable time that can be restored to. Output only field.
enabledTime This property is required. String
When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
encryptionInfo This property is required. EncryptionInfoResponse
The encryption information for the WALs and backups required for ContinuousBackup.
schedule This property is required. List<String>
Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
earliestRestorableTime This property is required. string
The earliest restorable time that can be restored to. Output only field.
enabledTime This property is required. string
When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
encryptionInfo This property is required. EncryptionInfoResponse
The encryption information for the WALs and backups required for ContinuousBackup.
schedule This property is required. string[]
Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
earliest_restorable_time This property is required. str
The earliest restorable time that can be restored to. Output only field.
enabled_time This property is required. str
When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
encryption_info This property is required. EncryptionInfoResponse
The encryption information for the WALs and backups required for ContinuousBackup.
schedule This property is required. Sequence[str]
Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
earliestRestorableTime This property is required. String
The earliest restorable time that can be restored to. Output only field.
enabledTime This property is required. String
When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
encryptionInfo This property is required. Property Map
The encryption information for the WALs and backups required for ContinuousBackup.
schedule This property is required. List<String>
Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.

EncryptionConfigResponse

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

EncryptionInfoResponse

EncryptionType This property is required. string
Type of encryption.
KmsKeyVersions This property is required. List<string>
Cloud KMS key versions that are being used to protect the database or the backup.
EncryptionType This property is required. string
Type of encryption.
KmsKeyVersions This property is required. []string
Cloud KMS key versions that are being used to protect the database or the backup.
encryptionType This property is required. String
Type of encryption.
kmsKeyVersions This property is required. List<String>
Cloud KMS key versions that are being used to protect the database or the backup.
encryptionType This property is required. string
Type of encryption.
kmsKeyVersions This property is required. string[]
Cloud KMS key versions that are being used to protect the database or the backup.
encryption_type This property is required. str
Type of encryption.
kms_key_versions This property is required. Sequence[str]
Cloud KMS key versions that are being used to protect the database or the backup.
encryptionType This property is required. String
Type of encryption.
kmsKeyVersions This property is required. List<String>
Cloud KMS key versions that are being used to protect the database or the backup.

GoogleTypeTimeOfDayResponse

Hours This property is required. 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 This property is required. int
Minutes of hour of day. Must be from 0 to 59.
Nanos This property is required. int
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
Seconds This property is required. 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 This property is required. 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 This property is required. int
Minutes of hour of day. Must be from 0 to 59.
Nanos This property is required. int
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
Seconds This property is required. 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 This property is required. 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 This property is required. Integer
Minutes of hour of day. Must be from 0 to 59.
nanos This property is required. Integer
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
seconds This property is required. 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 This property is required. 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 This property is required. number
Minutes of hour of day. Must be from 0 to 59.
nanos This property is required. number
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
seconds This property is required. 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 This property is required. 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 This property is required. int
Minutes of hour of day. Must be from 0 to 59.
nanos This property is required. int
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
seconds This property is required. 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 This property is required. 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 This property is required. Number
Minutes of hour of day. Must be from 0 to 59.
nanos This property is required. Number
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
seconds This property is required. 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

HostPort This property is required. string
The host and port of the on-premises instance in host:port format
ReferenceId This property is required. string
Place holder for the external source identifier(e.g DMS job name) that created the cluster.
SourceType This property is required. string
Type of migration source.
HostPort This property is required. string
The host and port of the on-premises instance in host:port format
ReferenceId This property is required. string
Place holder for the external source identifier(e.g DMS job name) that created the cluster.
SourceType This property is required. string
Type of migration source.
hostPort This property is required. String
The host and port of the on-premises instance in host:port format
referenceId This property is required. String
Place holder for the external source identifier(e.g DMS job name) that created the cluster.
sourceType This property is required. String
Type of migration source.
hostPort This property is required. string
The host and port of the on-premises instance in host:port format
referenceId This property is required. string
Place holder for the external source identifier(e.g DMS job name) that created the cluster.
sourceType This property is required. string
Type of migration source.
host_port This property is required. str
The host and port of the on-premises instance in host:port format
reference_id This property is required. str
Place holder for the external source identifier(e.g DMS job name) that created the cluster.
source_type This property is required. str
Type of migration source.
hostPort This property is required. String
The host and port of the on-premises instance in host:port format
referenceId This property is required. String
Place holder for the external source identifier(e.g DMS job name) that created the cluster.
sourceType This property is required. String
Type of migration source.

NetworkConfigResponse

AllocatedIpRange This property is required. string
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 This property is required. 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.
AllocatedIpRange This property is required. string
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 This property is required. 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.
allocatedIpRange This property is required. String
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 This property is required. 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.
allocatedIpRange This property is required. string
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 This property is required. 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_range This property is required. str
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 This property is required. 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.
allocatedIpRange This property is required. String
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 This property is required. 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

SecondaryClusterNames This property is required. List<string>
Names of the clusters that are replicating from this cluster.
SecondaryClusterNames This property is required. []string
Names of the clusters that are replicating from this cluster.
secondaryClusterNames This property is required. List<String>
Names of the clusters that are replicating from this cluster.
secondaryClusterNames This property is required. string[]
Names of the clusters that are replicating from this cluster.
secondary_cluster_names This property is required. Sequence[str]
Names of the clusters that are replicating from this cluster.
secondaryClusterNames This property is required. List<String>
Names of the clusters that are replicating from this cluster.

PscConfigResponse

PscEnabled This property is required. bool
Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
PscEnabled This property is required. bool
Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
pscEnabled This property is required. Boolean
Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
pscEnabled This property is required. boolean
Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
psc_enabled This property is required. bool
Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
pscEnabled This property is required. Boolean
Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.

QuantityBasedRetentionResponse

Count This property is required. int
The number of backups to retain.
Count This property is required. int
The number of backups to retain.
count This property is required. Integer
The number of backups to retain.
count This property is required. number
The number of backups to retain.
count This property is required. int
The number of backups to retain.
count This property is required. Number
The number of backups to retain.

SecondaryConfigResponse

PrimaryClusterName This property is required. string
The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
PrimaryClusterName This property is required. string
The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
primaryClusterName This property is required. String
The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
primaryClusterName This property is required. string
The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
primary_cluster_name This property is required. str
The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
primaryClusterName This property is required. String
The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}

SslConfigResponse

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

TimeBasedRetentionResponse

RetentionPeriod This property is required. string
The retention period.
RetentionPeriod This property is required. string
The retention period.
retentionPeriod This property is required. String
The retention period.
retentionPeriod This property is required. string
The retention period.
retention_period This property is required. str
The retention period.
retentionPeriod This property is required. String
The retention period.

UserPasswordResponse

Password This property is required. string
The initial password for the user.
User This property is required. string
The database username.
Password This property is required. string
The initial password for the user.
User This property is required. string
The database username.
password This property is required. String
The initial password for the user.
user This property is required. String
The database username.
password This property is required. string
The initial password for the user.
user This property is required. string
The database username.
password This property is required. str
The initial password for the user.
user This property is required. str
The database username.
password This property is required. String
The initial password for the user.
user This property is required. String
The database username.

WeeklyScheduleResponse

DaysOfWeek This property is required. List<string>
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.
StartTimes This property is required. List<Pulumi.GoogleNative.AlloyDB.V1Alpha.Inputs.GoogleTypeTimeOfDayResponse>
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.
DaysOfWeek This property is required. []string
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.
StartTimes This property is required. []GoogleTypeTimeOfDayResponse
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.
daysOfWeek This property is required. List<String>
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.
startTimes This property is required. List<GoogleTypeTimeOfDayResponse>
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.
daysOfWeek This property is required. string[]
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.
startTimes This property is required. GoogleTypeTimeOfDayResponse[]
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_week This property is required. Sequence[str]
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 This property is required. Sequence[GoogleTypeTimeOfDayResponse]
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.
daysOfWeek This property is required. List<String>
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.
startTimes This property is required. 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