clusters_list_only
Lists clusters
in a region or regions, for all properties use clusters
Overview
Name | clusters_list_only |
Type | Resource |
Description | The AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster |
Id | aws.docdbelastic.clusters_list_only |
Fields
Name | Datatype | Description |
---|---|---|
cluster_name | string | |
cluster_arn | string | |
cluster_endpoint | string | |
admin_user_name | string | |
admin_user_password | string | |
shard_capacity | integer | |
shard_count | integer | |
vpc_security_group_ids | array | |
subnet_ids | array | |
preferred_maintenance_window | string | |
preferred_backup_window | string | |
backup_retention_period | integer | |
shard_instance_count | integer | |
kms_key_id | string | |
tags | array | |
auth_type | string | |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
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