Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
ClusterSnapshot
Devuelve información sobre una instantánea específica del clúster elástico.
Contenido
nota
Los parámetros obligatorios se describen primero en la siguiente tabla.
- adminUserName
-
El nombre del administrador de los clústeres elásticos.
Tipo: cadena
Obligatorio: sí
- clusterArn
-
El identificador ARN del clúster elástico.
Tipo: cadena
Obligatorio: sí
- clusterCreationTime
-
La hora a la que se creó el clúster elástico, en tiempo universal coordinado (UTC).
Tipo: cadena
Obligatorio: sí
- kmsKeyId
-
El identificador de la clave de KMS es el Nombre de recurso de Amazon (ARN) de la clave de cifrado de KMS. Si está creando un clúster con la misma cuenta de Amazon a la que pertenece esta clave de cifrado de KMS, puede utilizar el alias de la clave de KMS en lugar del ARN como clave de cifrado de KMS. Si no se especifica una clave de cifrado, Amazon DocumentDB utiliza la clave de cifrado predeterminada que KMS crea para la cuenta. Su cuenta dispone de una clave de cifrado predeterminada diferente para cada región de Amazon.
Tipo: cadena
Obligatorio: sí
- snapshotArn
-
El identificador ARN de la instantánea del clúster elástico.
Tipo: cadena
Obligatorio: sí
- snapshotCreationTime
-
La hora a la que se creó la instantánea del clúster elástico en Tiempo Universal Coordinado (UTC).
Tipo: cadena
Obligatorio: sí
- snapshotName
-
Nombre de la instantánea del clúster elástico.
Tipo: cadena
Obligatorio: sí
- status
-
Estado de la instantánea del clúster elástico.
Tipo: cadena
Valores válidos:
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
Obligatorio: sí
- subnetIds
-
Los ID de subredes de Amazon EC2 para el clúster elástico.
Tipo: matriz de cadenas
Obligatorio: sí
- vpcSecurityGroupIds
-
Una lista de grupos de seguridad de VPC de EC2 para asociar al clúster elástico.
Tipo: matriz de cadenas
Obligatorio: sí
- snapshotType
-
El tipo de instantáneas del clúster que se van a devolver. Puede especificar uno de los siguientes valores:
-
automated
- Devuelva todas las instantáneas del clúster que Amazon DocumentDB haya creado automáticamente para su AWS cuenta. -
manual
- Devuelva todas las instantáneas del clúster que haya creado manualmente para su cuenta. AWS
Tipo: cadena
Valores válidos:
MANUAL | AUTOMATED
Obligatorio: no
-
Véase también
Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: