db_cluster
Gets an individual db_cluster resource
Overview
| Name | db_cluster |
| Type | Resource |
| Description | db_cluster |
| Id | awscc.rds.db_cluster |
Fields
| Name | Datatype | Description |
|---|---|---|
endpoint | object | |
read_endpoint | object | |
allocated_storage | integer | The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. |
associated_roles | array | Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. |
availability_zones | array | A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. |
auto_minor_version_upgrade | boolean | A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. |
backtrack_window | integer | The target backtrack window, in seconds. To disable backtracking, set this value to 0. |
backup_retention_period | integer | The number of days for which automated backups are retained. |
copy_tags_to_snapshot | boolean | A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. |
database_name | string | The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide. |
db_cluster_arn | string | The Amazon Resource Name (ARN) for the DB cluster. |
db_cluster_instance_class | string | The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. |
db_cluster_resource_id | string | The AWS Region-unique, immutable identifier for the DB cluster. |
db_instance_parameter_group_name | string | The name of the DB parameter group to apply to all instances of the DB cluster. |
db_system_id | string | Reserved for future use. |
global_cluster_identifier | string | If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.<br/><br/>If you aren't configuring a global database cluster, don't specify this property. |
db_cluster_identifier | string | The DB cluster identifier. This parameter is stored as a lowercase string. |
db_cluster_parameter_group_name | string | The name of the DB cluster parameter group to associate with this DB cluster. |
db_subnet_group_name | string | A DB subnet group that you want to associate with this DB cluster. |
deletion_protection | boolean | A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. |
domain | string | The Active Directory directory ID to create the DB cluster in. |
domain_iam_role_name | string | Specify the name of the IAM role to be used when making API calls to the Directory Service. |
enable_cloudwatch_logs_exports | array | The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. |
enable_global_write_forwarding | boolean | Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. |
enable_http_endpoint | boolean | A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. |
enable_iam_database_authentication | boolean | A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. |
engine | string | The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql |
engine_mode | string | The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. |
engine_version | string | The version number of the database engine to use. |
manage_master_user_password | boolean | A value that indicates whether to manage the master user password with AWS Secrets Manager. |
iops | integer | The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. |
kms_key_id | string | The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. |
master_username | string | The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername. |
master_user_password | string | The master password for the DB instance. |
master_user_secret | object | Contains the secret managed by RDS in AWS Secrets Manager for the master user password. |
monitoring_interval | integer | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. |
monitoring_role_arn | string | The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. |
network_type | string | The network type of the DB cluster. |
performance_insights_enabled | boolean | A value that indicates whether to turn on Performance Insights for the DB cluster. |
performance_insights_kms_key_id | string | The Amazon Web Services KMS key identifier for encryption of Performance Insights data. |
performance_insights_retention_period | integer | The amount of time, in days, to retain Performance Insights data. |
port | integer | The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql. |
preferred_backup_window | string | The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. |
preferred_maintenance_window | string | The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. |
publicly_accessible | boolean | A value that indicates whether the DB cluster is publicly accessible. |
replication_source_identifier | string | The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. |
restore_to_time | string | The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z |
restore_type | string | The type of restore to be performed. You can specify one of the following values:<br/>full-copy - The new DB cluster is restored as a full copy of the source DB cluster.<br/>copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. |
serverless_v2_scaling_configuration | object | Contains the scaling configuration of an Aurora Serverless v2 DB cluster. |
scaling_configuration | object | The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. |
snapshot_identifier | string | The identifier for the DB snapshot or DB cluster snapshot to restore from.<br/>You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.<br/>After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. |
source_db_cluster_identifier | string | The identifier of the source DB cluster from which to restore. |
source_region | string | The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. |
storage_encrypted | boolean | Indicates whether the DB instance is encrypted.<br/>If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. |
storage_type | string | Specifies the storage type to be associated with the DB cluster. |
tags | array | An array of key-value pairs to apply to this resource. |
use_latest_restorable_time | boolean | A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. |
vpc_security_group_ids | array | A list of EC2 VPC security groups to associate with this DB cluster. |
region | string | AWS region. |
Methods
Currently only SELECT is supported for this resource resource.
Example
SELECT
region,
endpoint,
read_endpoint,
allocated_storage,
associated_roles,
availability_zones,
auto_minor_version_upgrade,
backtrack_window,
backup_retention_period,
copy_tags_to_snapshot,
database_name,
db_cluster_arn,
db_cluster_instance_class,
db_cluster_resource_id,
db_instance_parameter_group_name,
db_system_id,
global_cluster_identifier,
db_cluster_identifier,
db_cluster_parameter_group_name,
db_subnet_group_name,
deletion_protection,
domain,
domain_iam_role_name,
enable_cloudwatch_logs_exports,
enable_global_write_forwarding,
enable_http_endpoint,
enable_iam_database_authentication,
engine,
engine_mode,
engine_version,
manage_master_user_password,
iops,
kms_key_id,
master_username,
master_user_password,
master_user_secret,
monitoring_interval,
monitoring_role_arn,
network_type,
performance_insights_enabled,
performance_insights_kms_key_id,
performance_insights_retention_period,
port,
preferred_backup_window,
preferred_maintenance_window,
publicly_accessible,
replication_source_identifier,
restore_to_time,
restore_type,
serverless_v2_scaling_configuration,
scaling_configuration,
snapshot_identifier,
source_db_cluster_identifier,
source_region,
storage_encrypted,
storage_type,
tags,
use_latest_restorable_time,
vpc_security_group_ids
FROM awscc.rds.db_cluster
WHERE data__Identifier = '<DBClusterIdentifier>';
Permissions
To operate on the db_cluster resource, the following permissions are required:
Read
rds:DescribeDBClusters
Update
ec2:DescribeSecurityGroups,
iam:PassRole,
rds:AddRoleToDBCluster,
rds:AddTagsToResource,
rds:DescribeDBClusters,
rds:DescribeDBSubnetGroups,
rds:DescribeEvents,
rds:DescribeGlobalClusters,
rds:DisableHttpEndpoint,
rds:EnableHttpEndpoint,
rds:ModifyDBCluster,
rds:ModifyDBInstance,
rds:RemoveFromGlobalCluster,
rds:RemoveRoleFromDBCluster,
rds:RemoveTagsFromResource,
secretsmanager:CreateSecret,
secretsmanager:TagResource
Delete
rds:CreateDBClusterSnapshot,
rds:DeleteDBCluster,
rds:DeleteDBInstance,
rds:DescribeDBClusters,
rds:DescribeGlobalClusters,
rds:RemoveFromGlobalCluster