Skip to main content

global_cluster

Gets an individual global_cluster resource

Overview

Nameglobal_cluster
TypeResource
Descriptionglobal_cluster
Idawscc.rds.global_cluster

Fields

NameDatatypeDescription
enginestringThe 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).<br/>If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
engine_versionstringThe version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
deletion_protectionbooleanThe deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
global_cluster_identifierstringThe cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
source_db_cluster_identifierstringThe Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string.
storage_encryptedboolean The storage encryption setting for the new global database cluster.<br/>If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
engine,
engine_version,
deletion_protection,
global_cluster_identifier,
source_db_cluster_identifier,
storage_encrypted
FROM awscc.rds.global_cluster
WHERE data__Identifier = '<GlobalClusterIdentifier>';

Permissions

To operate on the global_cluster resource, the following permissions are required:

Read

rds:DescribeGlobalClusters

Update

rds:ModifyGlobalCluster,
rds:DescribeGlobalClusters

Delete

rds:DescribeGlobalClusters,
rds:DeleteGlobalCluster,
rds:RemoveFromGlobalCluster,
rds:DescribeDBClusters