As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
ClusterSnapshot
Retorna informações sobre um snapshot de cluster elástico específico.
Conteúdo
nota
Na lista a seguir, os parâmetros necessários são descritos primeiro.
- adminUserName
-
O nome do administrador do cluster elástico.
Tipo: string
Obrigatório: Sim
- clusterArn
-
O identificador ARN do cluster elástico.
Tipo: string
Obrigatório: Sim
- clusterCreationTime
-
Especifica a hora em que o cluster elástico foi criado, no Tempo Universal Coordenado (UTC).
Tipo: string
Obrigatório: Sim
- kmsKeyId
-
O identificador de chave KMS é o Amazon Resource Name (ARN) da chave de criptografia KMS. Se você estiver criando um cluster usando a mesma conta da Amazon que possui essa chave de criptografia KMS, poderá usar o alias da chave KMS em vez do ARN como chave de criptografia KMS. Se uma chave de criptografia não for especificada aqui, o Amazon DocumentDB usará a chave de criptografia padrão que o KMS cria para sua conta. Sua conta tem uma chave de criptografia padrão diferente para cada região da Amazon.
Tipo: string
Obrigatório: Sim
- snapshotArn
-
O identificador ARN do snapshot do cluster elástico.
Tipo: string
Obrigatório: Sim
- snapshotCreationTime
-
A hora em que o snapshot do cluster elástico foi criado, no Tempo Universal Coordenado (UTC).
Tipo: string
Obrigatório: Sim
- snapshotName
-
O nome do snapshot do cluster elástico.
Tipo: string
Obrigatório: Sim
- status
-
O status do snapshot do cluster elástico.
Tipo: String
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 | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLEObrigatório: Sim
- subnetIds
-
Os IDs de sub-rede do Amazon EC2 do cluster elástico.
Tipo: matriz de strings
Obrigatório: Sim
- vpcSecurityGroupIds
-
Uma lista de grupos de segurança da VPC do EC2 a serem associados a esse cluster elástico.
Tipo: Matriz de strings
Obrigatório: Sim
- snapshotType
-
O tipo de snapshots de cluster a ser retornado. É possível especificar um dos seguintes valores:
-
automated: retorna todos os snapshots de cluster que o Amazon DocumentDB criou automaticamente para sua conta da AWS. -
manual- Retorna todos os snapshots de cluster que você criou manualmente para sua conta da AWS.
Tipo: String
Valores Válidos:
MANUAL | AUTOMATEDObrigatório: Não
-
Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
