Skip to main content

clusters_list_only

Lists clusters in a region or regions, for all properties use clusters

Overview

Nameclusters_list_only
TypeResource
DescriptionThe AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster
Idaws.docdbelastic.clusters_list_only

Fields

NameDatatypeDescription
cluster_namestring
cluster_arnstring
cluster_endpointstring
admin_user_namestring
admin_user_passwordstring
shard_capacityinteger
shard_countinteger
vpc_security_group_idsarray
subnet_idsarray
preferred_maintenance_windowstring
preferred_backup_windowstring
backup_retention_periodinteger
shard_instance_countinteger
kms_key_idstring
tagsarray
auth_typestring
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all clusters in a region.

SELECT
region,
cluster_arn
FROM aws.docdbelastic.clusters_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the clusters_list_only resource, see clusters