Cluster - Amazon DocumentDB

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Cluster

Renvoie des informations sur un cluster élastique spécifique.

Table des matières

Note

Dans la liste suivante, les paramètres requis sont décrits en premier.

adminUserName

Nom de l'administrateur du cluster Elastic.

Type : String

Obligatoire : oui

authType

Type d'authentification pour le cluster élastique.

Type : String

Valeurs valides : PLAIN_TEXT | SECRET_ARN

Obligatoire : oui

clusterArn

L'identifiant ARN du cluster élastique.

Type : String

Obligatoire : oui

clusterEndpoint

URL utilisée pour se connecter au cluster élastique.

Type : String

Obligatoire : oui

clusterName

Nom du cluster élastique.

Type : String

Obligatoire : oui

createTime

Heure à laquelle le cluster élastique a été créé en temps universel coordonné (UTC).

Type : String

Obligatoire : oui

kmsKeyId

Identifiant de clé KMS à utiliser pour chiffrer le cluster élastique.

Type : String

Obligatoire : oui

preferredMaintenanceWindow

Intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.

Format : ddd:hh24:mi-ddd:hh24:mi

Type : String

Obligatoire : oui

shardCapacity

Le nombre de v CPUs attribué à chaque partition de cluster élastique. Le maximum est de 64. Les valeurs autorisées sont 2, 4, 8, 16, 32, 64.

Type : entier

Obligatoire : oui

shardCount

Le nombre de partitions attribuées au cluster élastique. Le maximum est de 32.

Type : entier

Obligatoire : oui

status

État du cluster élastique.

Type : String

Valeurs valides : CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE

Obligatoire : oui

subnetIds

Le EC2 sous-réseau Amazon IDs pour le cluster élastique.

Type : tableau de chaînes

Obligatoire : oui

vpcSecurityGroupIds

Liste des groupes de sécurité EC2 VPC associés à ce cluster élastique.

Type : tableau de chaînes

Obligatoire : oui

backupRetentionPeriod

Nombre de jours pendant lesquels les instantanés automatiques sont conservés.

Type : entier

Obligatoire : non

preferredBackupWindow

Plage de temps quotidienne pendant laquelle les sauvegardes automatisées sont créées si les sauvegardes automatisées sont activées, comme déterminé parbackupRetentionPeriod.

Type : chaîne

Obligatoire : non

shardInstanceCount

Le nombre d'instances de répliques s'appliquant à toutes les partitions du cluster. Une shardInstanceCount valeur de 1 signifie qu'il existe une instance d'écriture et que toutes les instances supplémentaires sont des répliques qui peuvent être utilisées pour les lectures et pour améliorer la disponibilité.

Type : entier

Obligatoire : non

shards

Nombre total de partitions dans le cluster.

Type : tableau d’objets Shard

Obligatoire : non

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :