ClusterSnapshot - 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.

ClusterSnapshot

Renvoie des informations sur un instantané de 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

clusterArn

ARNIdentifiant du cluster élastique.

Type : String

Obligatoire : oui

clusterCreationTime

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

Type : String

Obligatoire : oui

kmsKeyId

L'identifiant de KMS clé est le nom de ressource Amazon (ARN) de la clé de KMS chiffrement. Si vous créez un cluster en utilisant le même compte Amazon qui possède cette clé de KMS chiffrement, vous pouvez utiliser l'alias de KMS clé au lieu de l'alias ARN comme clé de KMS chiffrement. Si aucune clé de chiffrement n'est spécifiée ici, Amazon DocumentDB utilise la clé de chiffrement par défaut KMS créée pour votre compte. Votre compte possède une clé de chiffrement par défaut différente pour chaque région Amazon.

Type : String

Obligatoire : oui

snapshotArn

ARNIdentifiant de l'instantané du cluster élastique.

Type : String

Obligatoire : oui

snapshotCreationTime

Heure à laquelle l'instantané du cluster élastique a été créé en temps universel coordonné (UTC).

Type : String

Obligatoire : oui

snapshotName

Nom de l'instantané du cluster élastique.

Type : String

Obligatoire : oui

status

État de l'instantané 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 EC2 VPC sécurité à associer au cluster élastique.

Type : tableau de chaînes

Obligatoire : oui

snapshotType

Type de snapshots de cluster à renvoyer. Vous pouvez spécifier l’une des valeurs suivantes :

  • automated- Renvoie tous les instantanés de cluster qu'Amazon DocumentDB a automatiquement créés pour AWS votre compte.

  • manual- Renvoie tous les instantanés de cluster que vous avez créés manuellement pour votre AWS compte.

Type : String

Valeurs valides : MANUAL | AUTOMATED

Obligatoire : non

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :