cluster

Gets an individual cluster resource

Overview

Name	cluster
Type	Resource
Description	cluster
Id	awscc.docdbelastic.cluster

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
kms_key_id	string
tags	array
auth_type	string
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
cluster_name,
cluster_arn,
cluster_endpoint,
admin_user_name,
admin_user_password,
shard_capacity,
shard_count,
vpc_security_group_ids,
subnet_ids,
preferred_maintenance_window,
kms_key_id,
tags,
auth_type
FROM awscc.docdbelastic.cluster
WHERE data__Identifier = '<ClusterArn>';

Permissions

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

Read

docdb-elastic:GetCluster,
docdb-elastic:ListTagsForResource

Update

docdb-elastic:UpdateCluster,
docdb-elastic:TagResource,
docdb-elastic:UntagResource,
ec2:CreateVpcEndpoint,
ec2:DescribeVpcEndpoints,
ec2:DeleteVpcEndpoints,
ec2:ModifyVpcEndpoint,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcAttribute,
ec2:DescribeVpcs,
ec2:DescribeAvailabilityZones,
secretsmanager:ListSecrets,
secretsmanager:ListSecretVersionIds,
secretsmanager:DescribeSecret,
secretsmanager:GetSecretValue,
secretsmanager:GetResourcePolicy,
kms:DescribeKey,
kms:CreateGrant,
kms:GenerateDataKey,
kms:Decrypt

Delete

docdb-elastic:DeleteCluster,
ec2:DescribeVpcEndpoints,
ec2:DeleteVpcEndpoints,
ec2:ModifyVpcEndpoint,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:DescribeVpcAttribute,
ec2:DescribeVpcs,
ec2:DescribeAvailabilityZones