Cloud.Service.AWS.RDS.Cluster

Cloud.Service.AWS.RDS.Cluster
Cloud.Service.AWS.RDS.Cluster
JSON Example
{
    "apply_immediately": false,
    "arn": "string",
    "availability_zones": [
        "string"
    ],
    "backtrack_window": 0,
    "backup_retention_period": 0,
    "cluster_identifier": "string",
    "cluster_identifier_prefix": "string",
    "cluster_members": [
        "string"
    ],
    "cluster_resource_id": "string",
    "database_name": "string",
    "db_cluster_parameter_group_name": "string",
    "db_subnet_group_name": "string",
    "deletion_protection": false,
    "enabled_cloudwatch_logs_exports": [
        "string"
    ],
    "endpoint": "string",
    "engine": "string",
    "engine_mode": "string",
    "engine_version": "string",
    "final_snapshot_identifier": "string",
    "hosted_zone_id": "string",
    "iam_database_authentication_enabled": false,
    "iam_roles": [
        "string"
    ],
    "kms_key_id": "string",
    "master_password": "string",
    "master_username": "string",
    "port": 0,
    "preferred_backup_window": "string",
    "preferred_maintenance_window": "string",
    "provider": "string",
    "provider_region": "string",
    "reader_endpoint": "string",
    "replication_source_identifier": "string",
    "s3_import": [
        {
            "bucket_name": "string",
            "bucket_prefix": "string",
            "ingestion_role": "string",
            "source_engine": "string",
            "source_engine_version": "string"
        }
    ],
    "scaling_configuration": [
        {
            "auto_pause": false,
            "max_capacity": 0,
            "min_capacity": 0,
            "seconds_until_auto_pause": 0
        }
    ],
    "skip_final_snapshot": false,
    "snapshot_identifier": "string",
    "source_region": "string",
    "storage_encrypted": false,
    "vpc_security_group_ids": [
        "string"
    ]
}
boolean
apply_immediately
Optional

Whether cluster modifications are applied immediately or during the next maintenance window. Default is false (next window).

string
arn
Optional

Amazon Resource Name (ARN) assigned by AWS to the cluster.

array of string
availability_zones
Optional

List of EC2 availability zones that can host the cluster.

integer
backtrack_window
Optional

Target backtracking window, in seconds, for Aurora engine clusters. Range is 0 to 259200 (72 hours). Default is 0 (no backtracking).

integer
backup_retention_period
Optional

Lifespan, in days, of backups. Default is 1.

string
cluster_identifier
Optional

User-assigned identifier for the cluster. If omitted, Cloud Assembly assigns a random, unique identifier. Cannot be used with cluster_identifer_prefix. Forces new resources.

string
cluster_identifier_prefix
Optional

User-assigned prefix added to the automatic, Cloud Assembly identifier. Cannot be used with cluster_identifer. Forces new resources.

array of string
cluster_members
Optional

RDS instances that are a part of this cluster.

string
cluster_resource_id
Optional

Identifier of the resource that hosts the cluster.

string
database_name
Optional

Upon cluster creation, name for the automatically created database. Naming restrictions vary by database engine.

string
db_cluster_parameter_group_name
Optional

Cluster parameter group to associate with the cluster.

string
db_subnet_group_name
Optional

Database subnet group to associate with this database instance.This value must match the db_subnet_group_name specified on every aws_rds_cluster_instance in the cluster.

boolean
deletion_protection
Optional

Whether to prevent the database cluster from being deleted. Default is false.

array of string
enabled_cloudwatch_logs_exports
Optional

List of log types to export to CloudWatch. If omitted, no logs are exported.

string
endpoint
Optional

DNS address of the RDS instance.

string
engine
Optional

Database engine of aurora, aurora-mysql, or aurora-postgresql for this cluster. Default is aurora.

string
engine_mode
Optional

Database cluster engine mode of parallelquery, provisioned, or serverless. Default is provisioned.When using serverless, see the AWS RDS documentation for limitations.

string
engine_version
Optional

Version of the engine used for the database cluster. Changing this value causes an outage.

string
final_snapshot_identifier
Optional

Name for the final database snapshot.

string
hosted_zone_id
Optional

AWS Route53 hosted zone ID of the endpoint.

boolean
iam_database_authentication_enabled
Optional

Whether to map IAM accounts to database accounts. See the AWS IAM documentation for availability and limitations.

array of string
iam_roles
Optional

List of ARNs for the IAM roles to associate to the RDS cluster.

string
kms_key_id
Optional

ARN of the KMS encryption key when storage_encrypted is true.

string
master_password
Optional

Master database user account password. Optional only if using snapshot_identifier.

string
master_username
Optional

Master database user account. Optional only if using snapshot_identifier.

integer
port
Optional

Port on which the database accepts connections.

string
preferred_backup_window
Optional

Daily time range, in UTC, during which automated backups are created, provided that backup_retention_period is also set.

string
preferred_maintenance_window
Optional

Weekly time range, in UTC, during which system maintenance can occur. For example: Wed:04:00-Wed:04:30

string
provider
Required

(Required) The name of the AWS cloud account to use for this resource

string
provider_region
Required

(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.

string
reader_endpoint
Optional

Read-only endpoint for Aurora engine clusters.

string
replication_source_identifier
Optional

If this cluster will be a Read Replica, the ARN of a source database cluster or database instance.

array of object
s3_import
Optional

Settings for database backup to S3.

array of object
scaling_configuration
Optional

Settings for scaling. Only used when engine_mode is serverless.

boolean
skip_final_snapshot
Optional

Whether to prevent a final snapshot before the database cluster is deleted. Default is false. (Before deletion, a snapshot is created according to the value from final_snapshot_identifier.)

string
snapshot_identifier
Optional

When creating the cluster snapshot, the name or ARN of a database cluster snapshot, or the ARN of a database snapshot.

string
source_region
Optional

Region for the encrypted replica database cluster.

boolean
storage_encrypted
Optional

Whether the database cluster is encrypted. Default is false for provisioned engine_mode, and true for serverless engine_mode.

object
tags
Optional

Database cluster resource categorization, in case-sensitive key names, or in key-value pairs.

array of string
vpc_security_group_ids
Optional

List of Virtual Private Cloud (VPC) security groups to associate with the cluster.