---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_alloydb_cluster{% #gcp_alloydb_cluster %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `annotations`{% #annotations %}

**Type**: `MAP_STRING_STRING`**Provider name**: `annotations`**Description**: Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. [https://google.aip.dev/128](https://google.aip.dev/128)

## `automated_backup_policy`{% #automated_backup_policy %}

**Type**: `STRUCT`**Provider name**: `automatedBackupPolicy`**Description**: 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_window`**Type**: `STRING`**Provider name**: `backupWindow`**Description**: 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`**Type**: `BOOLEAN`**Provider name**: `enabled`**Description**: Whether automated automated backups are enabled. If not set, defaults to true.
- `encryption_config`**Type**: `STRUCT`**Provider name**: `encryptionConfig`**Description**: 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.
  - `kms_key_name`**Type**: `STRING`**Provider name**: `kmsKeyName`**Description**: 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]
- `location`**Type**: `STRING`**Provider name**: `location`**Description**: 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`**Type**: `STRUCT`**Provider name**: `quantityBasedRetention`**Description**: Quantity-based Backup retention policy to retain recent backups.
  - `count`**Type**: `INT32`**Provider name**: `count`**Description**: The number of backups to retain.
- `time_based_retention`**Type**: `STRUCT`**Provider name**: `timeBasedRetention`**Description**: Time-based Backup retention policy.
  - `retention_period`**Type**: `STRING`**Provider name**: `retentionPeriod`**Description**: The retention period.
- `weekly_schedule`**Type**: `STRUCT`**Provider name**: `weeklySchedule`**Description**: Weekly schedule for the Backup.
  - `days_of_week`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `daysOfWeek`**Description**: 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`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `startTimes`**Description**: 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.
    - `hours`**Type**: `INT32`**Provider name**: `hours`**Description**: Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
    - `minutes`**Type**: `INT32`**Provider name**: `minutes`**Description**: Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
    - `nanos`**Type**: `INT32`**Provider name**: `nanos`**Description**: Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
    - `seconds`**Type**: `INT32`**Provider name**: `seconds`**Description**: Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

## `backup_source`{% #backup_source %}

**Type**: `STRUCT`**Provider name**: `backupSource`**Description**: Output only. Cluster created from backup.

- `backup_name`**Type**: `STRING`**Provider name**: `backupName`**Description**: Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
- `backup_uid`**Type**: `STRING`**Provider name**: `backupUid`**Description**: Output only. 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.

## `cluster_type`{% #cluster_type %}

**Type**: `STRING`**Provider name**: `clusterType`**Description**: Output only. 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`**Possible values**:

- `CLUSTER_TYPE_UNSPECIFIED` - The type of the cluster is unknown.
- `PRIMARY` - Primary cluster that support read and write operations.
- `SECONDARY` - Secondary cluster that is replicating from another region. This only supports read.

## `continuous_backup_config`{% #continuous_backup_config %}

**Type**: `STRUCT`**Provider name**: `continuousBackupConfig`**Description**: Optional. Continuous backup configuration for this cluster.

- `enabled`**Type**: `BOOLEAN`**Provider name**: `enabled`**Description**: Whether ContinuousBackup is enabled.
- `encryption_config`**Type**: `STRUCT`**Provider name**: `encryptionConfig`**Description**: 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.
  - `kms_key_name`**Type**: `STRING`**Provider name**: `kmsKeyName`**Description**: 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]
- `recovery_window_days`**Type**: `INT32`**Provider name**: `recoveryWindowDays`**Description**: 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.

## `continuous_backup_info`{% #continuous_backup_info %}

**Type**: `STRUCT`**Provider name**: `continuousBackupInfo`**Description**: Output only. Continuous backup properties for this cluster.

- `earliest_restorable_time`**Type**: `TIMESTAMP`**Provider name**: `earliestRestorableTime`**Description**: Output only. The earliest restorable time that can be restored to. Output only field.
- `enabled_time`**Type**: `TIMESTAMP`**Provider name**: `enabledTime`**Description**: Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
- `encryption_info`**Type**: `STRUCT`**Provider name**: `encryptionInfo`**Description**: Output only. The encryption information for the WALs and backups required for ContinuousBackup.
  - `encryption_type`**Type**: `STRING`**Provider name**: `encryptionType`**Description**: Output only. Type of encryption.**Possible values**:
    - `TYPE_UNSPECIFIED` - Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.
    - `GOOGLE_DEFAULT_ENCRYPTION` - The data is encrypted at rest with a key that is fully managed by Google. No key version will be populated. This is the default state.
    - `CUSTOMER_MANAGED_ENCRYPTION` - The data is encrypted at rest with a key that is managed by the customer. KMS key versions will be populated.
  - `kms_key_versions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `kmsKeyVersions`**Description**: Output only. Cloud KMS key versions that are being used to protect the database or the backup.
- `schedule`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `schedule`**Description**: Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.

## `create_time`{% #create_time %}

**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. Create time stamp

## `database_version`{% #database_version %}

**Type**: `STRING`**Provider name**: `databaseVersion`**Description**: 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.**Possible values**:

- `DATABASE_VERSION_UNSPECIFIED` - This is an unknown database version.
- `POSTGRES_13` - DEPRECATED - The database version is Postgres 13.
- `POSTGRES_14` - The database version is Postgres 14.
- `POSTGRES_15` - The database version is Postgres 15.
- `POSTGRES_16` - The database version is Postgres 16.

## `delete_time`{% #delete_time %}

**Type**: `TIMESTAMP`**Provider name**: `deleteTime`**Description**: Output only. Delete time stamp

## `encryption_config`{% #encryption_config %}

**Type**: `STRUCT`**Provider name**: `encryptionConfig`**Description**: 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.

- `kms_key_name`**Type**: `STRING`**Provider name**: `kmsKeyName`**Description**: 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]

## `encryption_info`{% #encryption_info %}

**Type**: `STRUCT`**Provider name**: `encryptionInfo`**Description**: Output only. The encryption information for the cluster.

- `encryption_type`**Type**: `STRING`**Provider name**: `encryptionType`**Description**: Output only. Type of encryption.**Possible values**:
  - `TYPE_UNSPECIFIED` - Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.
  - `GOOGLE_DEFAULT_ENCRYPTION` - The data is encrypted at rest with a key that is fully managed by Google. No key version will be populated. This is the default state.
  - `CUSTOMER_MANAGED_ENCRYPTION` - The data is encrypted at rest with a key that is managed by the customer. KMS key versions will be populated.
- `kms_key_versions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `kmsKeyVersions`**Description**: Output only. Cloud KMS key versions that are being used to protect the database or the backup.

## `etag`{% #etag %}

**Type**: `STRING`**Provider name**: `etag`**Description**: For Resource freshness validation ([https://google.aip.dev/154](https://google.aip.dev/154))

## `gcp_display_name`{% #gcp_display_name %}

**Type**: `STRING`**Provider name**: `displayName`**Description**: User-settable and human-readable display name for the Cluster.

## `initial_user`{% #initial_user %}

**Type**: `STRUCT`**Provider name**: `initialUser`**Description**: Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.

- `password`**Type**: `STRING`**Provider name**: `password`**Description**: The initial password for the user.
- `user`**Type**: `STRING`**Provider name**: `user`**Description**: The database username.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `maintenance_schedule`{% #maintenance_schedule %}

**Type**: `STRUCT`**Provider name**: `maintenanceSchedule`**Description**: Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.

- `start_time`**Type**: `TIMESTAMP`**Provider name**: `startTime`**Description**: Output only. The scheduled start time for the maintenance.

## `maintenance_update_policy`{% #maintenance_update_policy %}

**Type**: `STRUCT`**Provider name**: `maintenanceUpdatePolicy`**Description**: Optional. The maintenance update policy determines when to allow or deny updates.

- `maintenance_windows`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `maintenanceWindows`**Description**: Preferred windows to perform maintenance. Currently limited to 1.
  - `day`**Type**: `STRING`**Provider name**: `day`**Description**: Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.**Possible values**:
    - `DAY_OF_WEEK_UNSPECIFIED` - The day of the week is unspecified.
    - `MONDAY` - Monday
    - `TUESDAY` - Tuesday
    - `WEDNESDAY` - Wednesday
    - `THURSDAY` - Thursday
    - `FRIDAY` - Friday
    - `SATURDAY` - Saturday
    - `SUNDAY` - Sunday
  - `start_time`**Type**: `STRUCT`**Provider name**: `startTime`**Description**: Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time.
    - `hours`**Type**: `INT32`**Provider name**: `hours`**Description**: Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
    - `minutes`**Type**: `INT32`**Provider name**: `minutes`**Description**: Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
    - `nanos`**Type**: `INT32`**Provider name**: `nanos`**Description**: Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
    - `seconds`**Type**: `INT32`**Provider name**: `seconds`**Description**: Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.

## `migration_source`{% #migration_source %}

**Type**: `STRUCT`**Provider name**: `migrationSource`**Description**: Output only. Cluster created via DMS migration.

- `host_port`**Type**: `STRING`**Provider name**: `hostPort`**Description**: Output only. The host and port of the on-premises instance in host:port format
- `reference_id`**Type**: `STRING`**Provider name**: `referenceId`**Description**: Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
- `source_type`**Type**: `STRING`**Provider name**: `sourceType`**Description**: Output only. Type of migration source.**Possible values**:
  - `MIGRATION_SOURCE_TYPE_UNSPECIFIED` - Migration source is unknown.
  - `DMS` - DMS source means the cluster was created via DMS migration job.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Output only. 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](https://google.aip.dev/122). The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}

## `network`{% #network %}

**Type**: `STRING`**Provider name**: `network`**Description**: 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`{% #network_config %}

**Type**: `STRUCT`**Provider name**: `networkConfig`

- `allocated_ip_range`**Type**: `STRING`**Provider name**: `allocatedIpRange`**Description**: 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`**Type**: `STRING`**Provider name**: `network`**Description**: 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.

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `primary_config`{% #primary_config %}

**Type**: `STRUCT`**Provider name**: `primaryConfig`**Description**: Output only. Cross Region replication config specific to PRIMARY cluster.

- `secondary_cluster_names`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `secondaryClusterNames`**Description**: Output only. Names of the clusters that are replicating from this cluster.

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `psc_config`{% #psc_config %}

**Type**: `STRUCT`**Provider name**: `pscConfig`**Description**: Optional. The configuration for Private Service Connect (PSC) for the cluster.

- `psc_enabled`**Type**: `BOOLEAN`**Provider name**: `pscEnabled`**Description**: Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.

## `reconciling`{% #reconciling %}

**Type**: `BOOLEAN`**Provider name**: `reconciling`**Description**: Output only. Reconciling ([https://google.aip.dev/128#reconciliation)](https://google.aip.dev/128#reconciliation%29). 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.

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `satisfies_pzs`{% #satisfies_pzs %}

**Type**: `BOOLEAN`**Provider name**: `satisfiesPzs`**Description**: Output only. Reserved for future use.

## `secondary_config`{% #secondary_config %}

**Type**: `STRUCT`**Provider name**: `secondaryConfig`**Description**: Cross Region replication config specific to SECONDARY cluster.

- `primary_cluster_name`**Type**: `STRING`**Provider name**: `primaryClusterName`**Description**: The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}

## `ssl_config`{% #ssl_config %}

**Type**: `STRUCT`**Provider name**: `sslConfig`**Description**: SSL configuration for this AlloyDB cluster.

- `ca_source`**Type**: `STRING`**Provider name**: `caSource`**Description**: Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.**Possible values**:
  - `CA_SOURCE_UNSPECIFIED` - Certificate Authority (CA) source not specified. Defaults to CA_SOURCE_MANAGED.
  - `CA_SOURCE_MANAGED` - Certificate Authority (CA) managed by the AlloyDB Cluster.
- `ssl_mode`**Type**: `STRING`**Provider name**: `sslMode`**Description**: Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.**Possible values**:
  - `SSL_MODE_UNSPECIFIED` - SSL mode is not specified. Defaults to ENCRYPTED_ONLY.
  - `SSL_MODE_ALLOW` - SSL connections are optional. CA verification not enforced.
  - `SSL_MODE_REQUIRE` - SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior).
  - `SSL_MODE_VERIFY_CA` - SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, for example, using GenerateClientCertificate.
  - `ALLOW_UNENCRYPTED_AND_ENCRYPTED` - SSL connections are optional. CA verification not enforced.
  - `ENCRYPTED_ONLY` - SSL connections are required. CA verification not enforced.

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `state`**Description**: Output only. The current serving state of the cluster.**Possible values**:

- `STATE_UNSPECIFIED` - The state of the cluster is unknown.
- `READY` - The cluster is active and running.
- `STOPPED` - The cluster is stopped. All instances in the cluster are stopped. Customers can start a stopped cluster at any point and all their instances will come back to life with same names and IP resources. In this state, customer pays for storage. Associated backups could also be present in a stopped cluster.
- `EMPTY` - The cluster is empty and has no associated resources. All instances, associated storage and backups have been deleted.
- `CREATING` - The cluster is being created.
- `DELETING` - The cluster is being deleted.
- `FAILED` - The creation of the cluster failed.
- `BOOTSTRAPPING` - The cluster is bootstrapping with data from some other source. Direct mutations to the cluster (e.g. adding read pool) are not allowed.
- `MAINTENANCE` - The cluster is under maintenance. AlloyDB regularly performs maintenance and upgrades on customer clusters. Updates on the cluster are not allowed while the cluster is in this state.
- `PROMOTING` - The cluster is being promoted.

## `subscription_type`{% #subscription_type %}

**Type**: `STRING`**Provider name**: `subscriptionType`**Description**: Optional. Subscription type of the cluster.**Possible values**:

- `SUBSCRIPTION_TYPE_UNSPECIFIED` - This is an unknown subscription type. By default, the subscription type is STANDARD.
- `STANDARD` - Standard subscription.
- `TRIAL` - Trial subscription.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `trial_metadata`{% #trial_metadata %}

**Type**: `STRUCT`**Provider name**: `trialMetadata`**Description**: Output only. Metadata for free trial clusters

- `end_time`**Type**: `TIMESTAMP`**Provider name**: `endTime`**Description**: End time of the trial cluster.
- `grace_end_time`**Type**: `TIMESTAMP`**Provider name**: `graceEndTime`**Description**: grace end time of the cluster.
- `start_time`**Type**: `TIMESTAMP`**Provider name**: `startTime`**Description**: start time of the trial cluster.
- `upgrade_time`**Type**: `TIMESTAMP`**Provider name**: `upgradeTime`**Description**: Upgrade time of trial cluster to Standard cluster.

## `uid`{% #uid %}

**Type**: `STRING`**Provider name**: `uid`**Description**: Output only. 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`{% #update_time %}

**Type**: `TIMESTAMP`**Provider name**: `updateTime`**Description**: Output only. Update time stamp

## `zone_id`{% #zone_id %}

**Type**: `STRING`