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

# Referência de API de gerenciamento de recursos, instâncias e clusters do Amazon DocumentDB
<a name="api-reference"></a>

Esta seção descreve o cluster, a instância e as operações de gerenciamento de recursos para o Amazon DocumentDB (compativel com MongoDB) que são acessíveis por meio de HTTP AWS Command Line Interface (AWS CLI) ou SDK AWS. É possível usar essas APIs para criar, excluir e modificar clusters e instâncias.

 

**Importante**  
Essas APIs são usadas apenas para gerenciar clusters, instâncias e recursos relacionados. Para obter informações sobre como se conectar a um cluster do Amazon DocumentDB em execução, consulte [Guia de conceitos básicos](get-started-guide.md).

**Topics**
+ [Ações](API_Operations.md)
+ [Tipos de dados](API_Types.md)
+ [Erros comuns](CommonErrors.md)
+ [Parâmetros gerais](CommonParameters.md)

# Ações
<a name="API_Operations"></a>

As ações a seguir são compatíveis com Amazon DocumentDB (with MongoDB compatibility):
+  [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 
+  [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) 
+  [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) 
+  [CreateDBCluster](API_CreateDBCluster.md) 
+  [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) 
+  [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) 
+  [CreateDBInstance](API_CreateDBInstance.md) 
+  [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) 
+  [CreateEventSubscription](API_CreateEventSubscription.md) 
+  [CreateGlobalCluster](API_CreateGlobalCluster.md) 
+  [DeleteDBCluster](API_DeleteDBCluster.md) 
+  [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) 
+  [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) 
+  [DeleteDBInstance](API_DeleteDBInstance.md) 
+  [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) 
+  [DeleteEventSubscription](API_DeleteEventSubscription.md) 
+  [DeleteGlobalCluster](API_DeleteGlobalCluster.md) 
+  [DescribeCertificates](API_DescribeCertificates.md) 
+  [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) 
+  [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) 
+  [DescribeDBClusters](API_DescribeDBClusters.md) 
+  [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) 
+  [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) 
+  [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) 
+  [DescribeDBInstances](API_DescribeDBInstances.md) 
+  [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) 
+  [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) 
+  [DescribeEventCategories](API_DescribeEventCategories.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) 
+  [DescribeGlobalClusters](API_DescribeGlobalClusters.md) 
+  [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) 
+  [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) 
+  [FailoverDBCluster](API_FailoverDBCluster.md) 
+  [FailoverGlobalCluster](API_FailoverGlobalCluster.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyDBCluster](API_ModifyDBCluster.md) 
+  [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) 
+  [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) 
+  [ModifyDBInstance](API_ModifyDBInstance.md) 
+  [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) 
+  [ModifyEventSubscription](API_ModifyEventSubscription.md) 
+  [ModifyGlobalCluster](API_ModifyGlobalCluster.md) 
+  [RebootDBInstance](API_RebootDBInstance.md) 
+  [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) 
+  [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) 
+  [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) 
+  [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) 
+  [StartDBCluster](API_StartDBCluster.md) 
+  [StopDBCluster](API_StopDBCluster.md) 
+  [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) 

As ações a seguir são compatíveis com os clusters elásticos do Amazon DocumentDB:
+  [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) 
+  [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) 
+  [CreateCluster](API_elastic_CreateCluster.md) 
+  [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) 
+  [DeleteCluster](API_elastic_DeleteCluster.md) 
+  [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) 
+  [GetCluster](API_elastic_GetCluster.md) 
+  [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) 
+  [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) 
+  [ListClusters](API_elastic_ListClusters.md) 
+  [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) 
+  [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) 
+  [ListTagsForResource](API_elastic_ListTagsForResource.md) 
+  [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) 
+  [StartCluster](API_elastic_StartCluster.md) 
+  [StopCluster](API_elastic_StopCluster.md) 
+  [TagResource](API_elastic_TagResource.md) 
+  [UntagResource](API_elastic_UntagResource.md) 
+  [UpdateCluster](API_elastic_UpdateCluster.md) 

# Amazon DocumentDB (with MongoDB compatibility)
<a name="API_Operations_Amazon_DocumentDB_with_MongoDB_compatibility"></a>

As ações a seguir são compatíveis com Amazon DocumentDB (with MongoDB compatibility):
+  [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 
+  [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) 
+  [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) 
+  [CreateDBCluster](API_CreateDBCluster.md) 
+  [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) 
+  [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) 
+  [CreateDBInstance](API_CreateDBInstance.md) 
+  [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) 
+  [CreateEventSubscription](API_CreateEventSubscription.md) 
+  [CreateGlobalCluster](API_CreateGlobalCluster.md) 
+  [DeleteDBCluster](API_DeleteDBCluster.md) 
+  [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) 
+  [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) 
+  [DeleteDBInstance](API_DeleteDBInstance.md) 
+  [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) 
+  [DeleteEventSubscription](API_DeleteEventSubscription.md) 
+  [DeleteGlobalCluster](API_DeleteGlobalCluster.md) 
+  [DescribeCertificates](API_DescribeCertificates.md) 
+  [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) 
+  [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) 
+  [DescribeDBClusters](API_DescribeDBClusters.md) 
+  [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) 
+  [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) 
+  [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) 
+  [DescribeDBInstances](API_DescribeDBInstances.md) 
+  [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) 
+  [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) 
+  [DescribeEventCategories](API_DescribeEventCategories.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) 
+  [DescribeGlobalClusters](API_DescribeGlobalClusters.md) 
+  [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) 
+  [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) 
+  [FailoverDBCluster](API_FailoverDBCluster.md) 
+  [FailoverGlobalCluster](API_FailoverGlobalCluster.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyDBCluster](API_ModifyDBCluster.md) 
+  [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) 
+  [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) 
+  [ModifyDBInstance](API_ModifyDBInstance.md) 
+  [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) 
+  [ModifyEventSubscription](API_ModifyEventSubscription.md) 
+  [ModifyGlobalCluster](API_ModifyGlobalCluster.md) 
+  [RebootDBInstance](API_RebootDBInstance.md) 
+  [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) 
+  [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) 
+  [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) 
+  [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) 
+  [StartDBCluster](API_StartDBCluster.md) 
+  [StopDBCluster](API_StopDBCluster.md) 
+  [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) 

# AddSourceIdentifierToSubscription
<a name="API_AddSourceIdentifierToSubscription"></a>

Adiciona um identificador de origem a uma assinatura de notificações de eventos existente.

## Parâmetros da solicitação
<a name="API_AddSourceIdentifierToSubscription_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** SourceIdentifier **   
O identificador da origem do evento a ser adicionado:  
+ Se o tipo de origem for uma instância, um `DBInstanceIdentifier` deverá ser fornecido.
+ Se o tipo de origem for um grupo de segurança, um `DBSecurityGroupName` deverá ser fornecido.
+ Se o tipo de origem for um grupo de parâmetros, um `DBParameterGroupName` deverá ser fornecido.
+ Se o tipo de origem for uma captura de tela, um `DBSnapshotIdentifier` deverá ser fornecido.
Tipo: String  
Obrigatório: Sim

 ** SubscriptionName **   
O nome da assinatura de notificação de eventos Amazon DocumentDB a qual você deseja adicionar um identificador de origem.  
Tipo: String  
Obrigatório: Sim

## Elementos de resposta
<a name="API_AddSourceIdentifierToSubscription_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** EventSubscription **   
Informações detalhadas sobre um evento em você se inscreveu.  
Tipo: objeto [EventSubscription](API_EventSubscription.md)

## Erros
<a name="API_AddSourceIdentifierToSubscription_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

 ** SourceNotFound **   
Não foi possível encontrar a origem solicitada.   
Código de status HTTP: 404

 ** SubscriptionNotFound **   
O nome da assinatura não existe.   
Código de Status HTTP: 404

## Consulte Também
<a name="API_AddSourceIdentifierToSubscription_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 

# AddTagsToResource
<a name="API_AddTagsToResource"></a>

Adiciona tags de metadados a um recurso do Amazon DocumentDB. Você pode usar essas tags com relatórios de alocação de custos para rastrear os custos associados aos recursos do Amazon DocumentDB ou em `Condition` uma declaração em AWS Identity and Access Management uma política (IAM) para o Amazon DocumentDB.

## Parâmetros da solicitação
<a name="API_AddTagsToResource_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** ResourceName **   
O recurso do Amazon DocumentDB ao qual as tags são adicionadas. Esse valor é um nome do recurso da Amazon.  
Tipo: String  
Obrigatório: Sim

 **Tags.Tag.N**   
As tags a serem atribuídas ao recurso do Amazon DocumentDB.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: Sim

## Erros
<a name="API_AddTagsToResource_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` não se refere a uma instância existente.   
Código de status HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` não se refere a um snapshot existente.   
Código de status HTTP: 404

## Consulte Também
<a name="API_AddTagsToResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddTagsToResource) 

# ApplyPendingMaintenanceAction
<a name="API_ApplyPendingMaintenanceAction"></a>

Aplica uma ação de manutenção pendente a um recurso (por exemplo, a uma instância do Amazon DocumentDB).

## Parâmetros da solicitação
<a name="API_ApplyPendingMaintenanceAction_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** ApplyAction **   
A ação de manutenção pendente a ser aplicada a esse recurso.  
Valores válidos: `system-update`, `db-upgrade`   
Tipo: String  
Obrigatório: Sim

 ** OptInType **   
Um valor que especifica o tipo de solicitação de inclusão ou desfaz uma solicitação de inclusão. Uma solicitação de inclusão do tipo `immediate` não pode ser desfeita.  
Valores válidos:  
+  `immediate` – aplique a ação de manutenção imediatamente.
+  `next-maintenance` – aplique a ação de manutenção durante a próxima janela de manutenção do recurso. 
+  `undo-opt-in` – Cancela todas as solicitações de inclusão `next-maintenance` existentes.
Tipo: String  
Obrigatório: Sim

 ** ResourceIdentifier **   
O nome de recurso da Amazon (ARN) do recurso ao qual a ação de manutenção pendente se aplica.  
Tipo: String  
Obrigatório: Sim

## Elementos de resposta
<a name="API_ApplyPendingMaintenanceAction_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** ResourcePendingMaintenanceActions **   
Representa o resultado de [ApplyPendingMaintenanceAction](#API_ApplyPendingMaintenanceAction).   
Tipo: objeto [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)

## Erros
<a name="API_ApplyPendingMaintenanceAction_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de Status HTTP: 400

 ** InvalidDBInstanceState **   
 A instância especificada não está no estado *disponível*.   
Código de status HTTP: 400

 ** ResourceNotFoundFault **   
O ID do recurso especificado não foi encontrado.  
Código de status HTTP: 404

## Consulte Também
<a name="API_ApplyPendingMaintenanceAction_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 

# CopyDBClusterParameterGroup
<a name="API_CopyDBClusterParameterGroup"></a>

Copia o grupo de parâmetros de cluster especificado.

## Parâmetros da solicitação
<a name="API_CopyDBClusterParameterGroup_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** SourceDBClusterParameterGroupIdentifier **   
O identificador ou o nome do recurso da Amazon (ARN) do grupo de parâmetros de cluster de origem.  
Restrições:  
+ É necessário especificar um grupo de parâmetros de cluster válido.
+ Se o grupo de parâmetros do cluster de origem estiver no Região da AWS mesmo da cópia, especifique um identificador de grupo de parâmetros válido; por exemplo,`my-db-cluster-param-group`, ou um ARN válido.
+ Se o grupo de parâmetros de origem estiver em um local Região da AWS diferente da cópia, especifique um ARN de grupo de parâmetros de cluster válido; por exemplo,. `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`
Tipo: String  
Obrigatório: Sim

 ** TargetDBClusterParameterGroupDescription **   
Uma descrição do grupo de parâmetros de cluster copiado.  
Tipo: String  
Obrigatório: Sim

 ** TargetDBClusterParameterGroupIdentifier **   
O identificador do grupo de parâmetros de cluster copiado.  
Restrições:  
+ Não pode ser nulo, vazio ou estar em branco.
+ Deve conter de 1 a 255 caracteres, incluindo letras, números ou hífens. 
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos. 
Exemplo: `my-cluster-param-group1`   
Tipo: String  
Obrigatório: Sim

 **Tags.Tag.N**   
As tags a serem atribuídas ao grupo de parâmetros.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: não

## Elementos de Resposta
<a name="API_CopyDBClusterParameterGroup_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBClusterParameterGroup **   
Informações detalhadas sobre o grupo de parâmetros de cluster.   
Tipo: objeto [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

## Erros
<a name="API_CopyDBClusterParameterGroup_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBParameterGroupAlreadyExists **   
Já existe um grupo de parâmetros com o mesmo nome.  
Código de status HTTP: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` não se refere a um grupo de parâmetros existente.   
Código de status HTTP: 404

 ** DBParameterGroupQuotaExceeded **   
Esta solicitação faria com que você excedesse o número permitido de grupos de parâmetros.  
Código de Status HTTP: 400

## Consulte também
<a name="API_CopyDBClusterParameterGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 

# CopyDBClusterSnapshot
<a name="API_CopyDBClusterSnapshot"></a>

Copia um snapshot de um cluster.

Para copiar um snapshot de um snapshot manual do cluster de banco de dados compartilhado, `SourceDBClusterSnapshotIdentifier` deve ser o nome do recurso da Amazon (ARN) do snapshot do cluster compartilhado. Só é possível copiar um snapshot de cluster de banco de dados compartilhado, criptografado ou não, na mesma Região da AWS.

Para cancelar uma operação de cópia depois que ela estiver em andamento, exclua o snapshot do cluster de banco de dados de destino identificado por `TargetDBClusterSnapshotIdentifier` enquanto ele estiver no status *cópia*.

## Parâmetros da solicitação
<a name="API_CopyDBClusterSnapshot_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** SourceDBClusterSnapshotIdentifier **   
O identificador do snapshot de cluster a ser copiado. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ É necessário especificar um snapshot de cluster válido no estado *disponível*.
+ Se o instantâneo do cluster de origem estiver Região da AWS igual à cópia, especifique um identificador de instantâneo válido.
+ Se o snapshot do cluster de origem estiver em uma conta diferente Região da AWS ou pertencer a outra AWS conta, especifique o ARN do snapshot.
Exemplo: `my-cluster-snapshot1`   
Tipo: String  
Obrigatório: Sim

 ** TargetDBClusterSnapshotIdentifier **   
O identificador do novo snapshot de cluster a ser criado a partir do snapshot de cluster de origem. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens. 
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos. 
Exemplo: `my-cluster-snapshot2`   
Tipo: String  
Obrigatório: Sim

 ** CopyTags **   
Defina como `true` para copiar todas as tags do snapshot do cluster de origem no snapshot do cluster do cluster de destino. Caso contrário, `false`. O padrão é `false`.  
Tipo: booliano  
Obrigatório: não

 ** KmsKeyId **   
O ID da AWS KMS chave para um snapshot de cluster criptografado. O ID da AWS KMS chave é o Amazon Resource Name (ARN), o identificador da AWS KMS chave ou o alias da AWS KMS chave de criptografia. AWS KMS   
Se você copiar um snapshot de cluster criptografado do seu Conta da AWS, poderá especificar um valor para `KmsKeyId` criptografar a cópia com uma nova chave de AWS KMS criptografia. Se você não especificar um valor para`KmsKeyId`, a cópia do snapshot do cluster será criptografada com a mesma AWS KMS chave do snapshot do cluster de origem.  
Se você copiar um snapshot de cluster criptografado compartilhado de outro Conta da AWS, deverá especificar um valor para`KmsKeyId`.  
Para copiar um snapshot de cluster criptografado para outro Região da AWS, `KmsKeyId` defina a ID de AWS KMS chave que você deseja usar para criptografar a cópia do snapshot de cluster na região de destino. AWS KMS as chaves de criptografia são específicas Região da AWS daquelas em que foram criadas, e você não pode usar chaves de criptografia uma Região da AWS na outra Região da AWS.  
Se você copiar um snapshot de cluster não criptografado e especificar um valor para o parâmetro `KmsKeyId`, um erro será retornado.  
Tipo: string  
Obrigatório: não

 ** PreSignedUrl **   
O URL que contém uma solicitação assinada do Signature versão 4 para a ação da `CopyDBClusterSnapshot` API no Região da AWS que contém o instantâneo do cluster de origem a ser copiado. É necessário usar o parâmetro `PreSignedUrl` ao copiar um snapshot de cluster de outro Região da AWS.  
Se você estiver usando uma ferramenta AWS SDK ou a AWS CLI, poderá especificar `SourceRegion` (ou `--source-region` para a AWS CLI) em vez de especificar manualmente`PreSignedUrl`. A especificação `SourceRegion` gera automaticamente um URL pré-assinado que é uma solicitação válida para a operação que pode ser executada na Região da AWS de origem.  
O URL pré-assinado deve ser uma solicitação válida para a ação da `CopyDBClusterSnapshot` API que pode ser executada na fonte Região da AWS que contém o instantâneo do cluster a ser copiado. A solicitação de URL pré-assinada deve conter os seguintes valores de parâmetros:  
+  `SourceRegion` - O ID da região que contém o instantâneo a ser copiado.
+  `SourceDBClusterSnapshotIdentifier` - O identificador do snapshot do cluster criptografado a ser copiado. Esse identificador deve estar no formato de nome do recurso da Amazon (ARN) da Região da AWS de origem Por exemplo, se você estiver copiando um snapshot de cluster criptografado da região us-east-1 Região da AWS, seu `SourceDBClusterSnapshotIdentifier` se parecerá com o seguinte exemplo: `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
+  `TargetDBClusterSnapshotIdentifier` - o identificador para o novo snapshot de cluster de cluster a ser criado. Esse parâmetro não diferencia maiúsculas de minúsculas.
Tipo: string  
Obrigatório: não

 **Tags.Tag.N**   
As tags a serem atribuídas ao snapshot do cluster.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: não

## Elementos de Resposta
<a name="API_CopyDBClusterSnapshot_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBClusterSnapshot **   
Informações detalhadas sobre um snapshot de cluster.   
Tipo: objeto [DBClusterSnapshot](API_DBClusterSnapshot.md)

## Erros
<a name="API_CopyDBClusterSnapshot_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterSnapshotAlreadyExistsFault **   
O usuário já tem um snapshot de cluster com o identificador determinado.  
Código de status HTTP: 400

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` não se refere a um snapshot de cluster existente.   
Código de Status HTTP: 404

 ** InvalidDBClusterSnapshotStateFault **   
O valor fornecido não é um estado de snapshot de cluster válido.  
Código de status HTTP: 400

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de status HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Ocorreu um erro ao acessar uma AWS KMS chave.  
Código de status HTTP: 400

 ** SnapshotQuotaExceeded **   
A solicitação faria com que você excedesse o número de snapshots permitidos.  
Código de Status HTTP: 400

## Consulte também
<a name="API_CopyDBClusterSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterSnapshot) 

# CreateDBCluster
<a name="API_CreateDBCluster"></a>

Cria um novo cluster do Amazon DocumentDB.

## Parâmetros da solicitação
<a name="API_CreateDBCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
O identificador do cluster. Este parâmetro é armazenado como uma string com letras minúsculas.  
Restrições:  
+ Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens. 
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos. 
Exemplo: `my-cluster`   
Tipo: String  
Obrigatório: Sim

 ** Engine **   
O nome do mecanismo de banco de dados a ser usado para esse cluster.  
Valores válidos: `docdb`   
Tipo: String  
Obrigatório: Sim

 **AvailabilityZones. AvailabilityZoneN.**   
Uma lista de zonas de disponibilidade do Amazon EC2 nas quais as instâncias no cluster podem ser criadas.  
Tipo: matriz de strings  
Obrigatório: Não

 ** BackupRetentionPeriod **   
O número de dias durante os quais os backups automatizados são retidos. É necessário especificar o valor mínimo de 1.  
Padrão: 1  
Restrições:  
+ Deve ser um valor de 1 a 35.
Tipo: inteiro  
Obrigatório: não

 ** DBClusterParameterGroupName **   
O nome do grupo de parâmetros do cluster a ser associado a esse cluster.  
Tipo: string  
Obrigatório: não

 ** DBSubnetGroupName **   
Um grupo de sub-redes a ser associado a esse cluster.  
Restrições: deve corresponder ao nome de um `DBSubnetGroup` existente. Não deve ser padrão.  
Exemplo: `mySubnetgroup`   
Tipo: string  
Obrigatório: não

 ** DeletionProtection **   
Especifica se esse cluster pode ser excluído. Se `DeletionProtection` estiver ativado, o cluster não pode ser excluído, a menos que seja modificado e `DeletionProtection` esteja desabilitado. `DeletionProtection` protege clusters contra exclusão acidental.  
Tipo: booliano  
Obrigatório: não

 **EnableCloudwatchLogsExports.Membro.**   
Uma lista de tipos de log que precisam ser habilitados para exportação para o Amazon CloudWatch Logs. É possível habilitar logs de auditoria ou logs de profiler. Para obter mais informações, consulte [Realização de auditoria nos eventos do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) e [Criação de perfil das operações do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).   
Tipo: matriz de strings  
Obrigatório: Não

 ** EngineVersion **   
O número da versão do mecanismo de banco de dados a ser usado. A `--engine-version` assumirá como padrão a versão mais recente do mecanismo principal. Para workloads de produção, recomendamos declarar explicitamente esse parâmetro com a versão do mecanismo principal pretendida.  
Tipo: string  
Obrigatório: não

 ** GlobalClusterIdentifier **   
O identificador de cluster do novo cluster de banco de dados global.  
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: não

 ** KmsKeyId **   
O identificador de AWS KMS chave para um cluster criptografado.  
O identificador da AWS KMS chave é o Amazon Resource Name (ARN) da chave de AWS KMS criptografia. Se você estiver criando um cluster usando o mesmo Conta da AWS que possui a chave de AWS KMS criptografia usada para criptografar o novo cluster, você pode usar o alias da AWS KMS chave em vez do ARN da chave de criptografia. AWS KMS   
Se uma chave de criptografia não for especificada em `KmsKeyId`:   
+ Se o parâmetro `StorageEncrypted` for `true`, o Amazon DocumentDB usará a chave de criptografia padrão. 
 AWS KMS cria a chave de criptografia padrão para o seu Conta da AWS. Conta da AWS A sua tem uma chave de criptografia padrão diferente para cada uma Regiões da AWS.  
Tipo: string  
Obrigatório: não

 ** ManageMasterUserPassword **   
Especifica se a senha do usuário principal deve ser gerenciada com o Amazon Web Services Secrets Manager.  
Restrição: não será possível gerenciar a senha do usuário principal com o Amazon Web Services Secrets Manager se `MasterUserPassword` estiver especificado.  
Tipo: booliano  
Obrigatório: não

 ** MasterUsername **   
O nome do usuário principal do cluster.  
Restrições:  
+ Deve ter de 1 a 63 letras ou números.
+ O primeiro caractere deve ser uma letra.
+ Não pode ser uma palavra reservada para o mecanismo de banco de dados escolhido. 
Tipo: string  
Obrigatório: não

 ** MasterUserPassword **   
A senha para o usuário do banco de dados principal. Ela pode conter qualquer caractere ASCII imprimível, exceto barra (/), aspas duplas (") ou arroba ("@").  
Restrições: deve conter de 8 a 100 caracteres.  
Tipo: String  
Obrigatório: não

 ** MasterUserSecretKmsKeyId **   
O identificador de chave do KMS do Amazon Web Services para criptografar um segredo que é gerado e gerenciado automaticamente no Amazon Web Services Secrets Manager. Essa configuração é válida somente se a senha do usuário principal for gerenciada pelo Amazon DocumentDB no Amazon Web Services Secrets Manager para o cluster de banco de dados.  
O identificador de chave do Amazon Web Services KMS é o ARN da chave, o ID da chave, o ARN do alias ou o nome do alias da chave do KMS. Para usar uma chave do KMS em outra da Amazon Web Services, é necessário usar o ARN da chave ou o ARN do alias.  
Se você não especificar `MasterUserSecretKmsKeyId`, a chave do KMS `aws/secretsmanager` será usada para criptografar o segredo. Se o segredo estiver em uma conta da Amazon Web Services diferente, você não poderá usar a chave do `aws/secretsmanager` KMS para criptografar o segredo e deverá usar uma chave do KMS gerenciada pelo cliente.  
Há uma chave KMS padrão para sua conta do Amazon Web Services. Sua conta do Amazon Web Services tem uma chave KMS padrão diferente para cada região do Amazon Web Services.  
Tipo: String  
Obrigatório: não

 ** NetworkType **   
O tipo de rede do cluster.  
O tipo de rede é determinado usando o `DBSubnetGroup` especificado para o cluster. A `DBSubnetGroup` pode suportar somente o IPv4 protocolo ou o IPv4 e os IPv6 protocolos (`DUAL`).  
Para obter mais informações, consulte [Clusters do DocumentDB em uma VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) no Guia do desenvolvedor do Amazon DocumentDB.  
Valores válidos: `IPV4` \$1 `DUAL`   
Tipo: string  
Obrigatório: não

 ** Port **   
O número de porta em que as instâncias no cluster de banco de dados aceitam conexões.  
Tipo: inteiro  
Obrigatório: não

 ** PreferredBackupWindow **   
O intervalo de tempo diário durante o qual os backups automatizados serão criados se eles forem habilitados com o parâmetro `BackupRetentionPeriod`.   
O padrão é uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de 8 horas para cada uma. Região da AWS  
Restrições:  
+ Deve estar no formato `hh24:mi-hh24:mi`.
+ Deve estar expresso no Tempo Universal Coordenado (UTC).
+ Não pode entrar em conflito com a janela de manutenção preferencial. 
+ Deve ser, pelo menos, 30 minutos.
Tipo: string  
Obrigatório: não

 ** PreferredMaintenanceWindow **   
O intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, no Tempo Universal Coordenado (UTC).  
Formato: `ddd:hh24:mi-ddd:hh24:mi`.   
O padrão é uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de 8 horas para cada uma Região da AWS, ocorrendo em um dia aleatório da semana.  
Dias válidos: Seg, Ter, Qua, Qui, Sex, Sáb, Dom  
Restrições: janela mínima de 30 minutos.  
Tipo: String  
Obrigatório: não

 ** PreSignedUrl **   
Sem suporte no momento.   
Tipo: string  
Obrigatório: não

 ** ServerlessV2ScalingConfiguration **   
Contém a configuração de escalabilidade de um cluster do Amazon DocumentDB Sem Servidor.  
Tipo: objeto [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obrigatório: não

 ** StorageEncrypted **   
Especifica se o cluster é criptografado.  
Tipo: booliano  
Obrigatório: não

 ** StorageType **   
O tipo de armazenamento a ser associado ao cluster de banco de dados.  
Para obter informações sobre os tipos de armazenamento para clusters do Amazon DocumentDB, consulte Configurações de armazenamento do cluster no *Guia do desenvolvedor do Amazon DocumentDB*.  
Valores válidos para o tipo de armazenamento - `standard | iopt1`   
O valor padrão é `standard `.   
Quando você cria um cluster do Amazon DocumentDB com o tipo de armazenamento definido como `iopt1`, o tipo de armazenamento é retornado na resposta. O tipo de armazenamento não é retornado quando você o define como `standard`.
Tipo: string  
Obrigatório: não

 **Tags.Tag.N**   
As tags a serem atribuídas ao cluster.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: não

 **VpcSecurityGroupIds. VpcSecurityGroupIdN.**   
Uma lista de grupos de segurança da VPC do EC2 a serem associados a esse cluster.   
Tipo: matriz de strings  
Obrigatório: Não

## Elementos de Resposta
<a name="API_CreateDBCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBCluster **   
Informações detalhadas sobre um cluster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Erros
<a name="API_CreateDBCluster_Errors"></a>

Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
Você já tem um cluster com o identificador determinado.  
Código de status HTTP: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` não se refere a um grupo de parâmetros de cluster existente.   
Código de status HTTP: 404

 ** DBClusterQuotaExceededFault **   
O cluster não pode ser criado porque você atingiu a cota máxima permitida de clusters.  
Código de status HTTP: 403

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` não se refere a uma instância existente.   
Código de status HTTP: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
As sub-redes no grupo de sub-redes de banco de dados devem abranger pelo menos duas zonas de disponibilidade, a menos que haja apenas uma zona de disponibilidade.  
Código de status HTTP: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` não se refere a um grupo de sub-redes existente.   
Código de status HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` não se refere a um cluster global existente.  
Código de status HTTP: 404

 ** InsufficientStorageClusterCapacity **   
Não há armazenamento suficiente disponível para a ação atual. É possível resolver esse erro atualizando seu grupo de sub-redes para usar outras zonas de disponibilidade que tenham mais espaço de armazenamento disponível.   
Código de status HTTP: 400

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de Status HTTP: 400

 ** InvalidDBInstanceState **   
 A instância especificada não está no estado *disponível*.   
Código de status HTTP: 400

 ** InvalidDBSubnetGroupStateFault **   
O grupo de sub-redes não pode ser excluído porque está em uso.  
Código de status HTTP: 400

 ** InvalidGlobalClusterStateFault **   
A operação solicitada não pode ser executada enquanto o cluster estiver nesse estado.  
Código de status HTTP: 400

 ** InvalidSubnet **   
A sub-rede solicitada é inválida ou foram solicitadas várias sub-redes que não estão em uma nuvem privada virtual (VPC) comum.  
Código de status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
O grupo de sub-rede não cobre todas as zonas de disponibilidade depois de ter sido criado devido às alterações feitas.  
Código de status HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Ocorreu um erro ao acessar uma AWS KMS chave.  
Código de status HTTP: 400

 ** NetworkTypeNotSupported **   
Não há suporte para o tipo de rede em nenhuma das versões do `DBSubnetGroup` ou do mecanismo de banco de dados.  
Código de status HTTP: 400

 ** StorageQuotaExceeded **   
A solicitação faria com que você excedesse a quantidade permitida de armazenamento disponível em todas as instâncias.  
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateDBCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBCluster) 

# CreateDBClusterParameterGroup
<a name="API_CreateDBClusterParameterGroup"></a>

Cria um novo grupo de parâmetros de cluster.

Os parâmetros em um grupo de parâmetros do cluster aplicam-se a todas as instâncias em um cluster.

Um grupo de parâmetros de cluster é inicialmente criado com os parâmetros padrão para o mecanismo de banco de dados usado pelas instâncias no cluster. No Amazon DocumentDB, você não pode fazer modificações diretamente no grupo de parâmetros do cluster `default.docdb3.6`, Se o seu cluster do Amazon DocumentDB estiver usando o grupo de parâmetros padrão do cluster e você quiser modificar um valor nele, deverá primeiro [ criar um novo grupo de parâmetros ](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html) ou [ copiar um grupo de parâmetros existente](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html), modificá-lo e, em seguida, aplicar o grupo de parâmetros modificado ao seu cluster. Para que o novo grupo de parâmetros do cluster e as configurações entrem em vigor, você deverá reiniciar as instâncias de banco de dados no cluster sem failover. Para obter mais informações, consulte [Modificar grupos de parâmetros do cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html). 

## Parâmetros da solicitação
<a name="API_CreateDBClusterParameterGroup_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterParameterGroupName **   
O nome do grupo de parâmetros de cluster.  
Restrições:  
+ Não deve corresponder ao nome de um `DBClusterParameterGroup` existente.
Esse valor é armazenado como uma string em minúsculas.
Tipo: String  
Obrigatório: Sim

 ** DBParameterGroupFamily **   
O nome da família de grupos de parâmetros de cluster.  
Tipo: String  
Obrigatório: Sim

 ** Description **   
A descrição do grupo de parâmetros de cluster.  
Tipo: String  
Obrigatório: Sim

 **Tags.Tag.N**   
As tags a serem atribuídas ao grupo de parâmetros do cluster.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: não

## Elementos de Resposta
<a name="API_CreateDBClusterParameterGroup_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBClusterParameterGroup **   
Informações detalhadas sobre o grupo de parâmetros de cluster.   
Tipo: objeto [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

## Erros
<a name="API_CreateDBClusterParameterGroup_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBParameterGroupAlreadyExists **   
Já existe um grupo de parâmetros com o mesmo nome.  
Código de status HTTP: 400

 ** DBParameterGroupQuotaExceeded **   
Esta solicitação faria com que você excedesse o número permitido de grupos de parâmetros.  
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateDBClusterParameterGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 

# CreateDBClusterSnapshot
<a name="API_CreateDBClusterSnapshot"></a>

Cria um instantâneo de um cluster. 

## Parâmetros da solicitação
<a name="API_CreateDBClusterSnapshot_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns que todas as ações utilizam, consulte [Parâmetros comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
O identificador do cluster para o qual criar um instantâneo. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Deve corresponder ao identificador de um `DBCluster` existente.
Exemplo: `my-cluster`   
Tipo: String  
Obrigatório: Sim

 ** DBClusterSnapshotIdentifier **   
O identificador do instantâneo do cluster. Este parâmetro é armazenado como uma string com letras minúsculas.  
Restrições:  
+ Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos. 
Exemplo: `my-cluster-snapshot1`   
Tipo: String  
Obrigatório: Sim

 **Tags.Tag.N**   
As tags a serem atribuídas ao snapshot do cluster.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: não

## Elementos de Resposta
<a name="API_CreateDBClusterSnapshot_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBClusterSnapshot **   
Informações detalhadas sobre um snapshot de cluster.   
Tipo: objeto [DBClusterSnapshot](API_DBClusterSnapshot.md)

## Erros
<a name="API_CreateDBClusterSnapshot_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** DBClusterSnapshotAlreadyExistsFault **   
O usuário já tem um snapshot de cluster com o identificador determinado.  
Código de status HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
O valor fornecido não é um estado de snapshot de cluster válido.  
Código de status HTTP: 400

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de status HTTP: 400

 ** SnapshotQuotaExceeded **   
A solicitação faria com que você excedesse o número de snapshots permitidos.  
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateDBClusterSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterSnapshot) 

# CreateDBInstance
<a name="API_CreateDBInstance"></a>

Cria uma nova instância de banco de dados.

## Parâmetros da solicitação
<a name="API_CreateDBInstance_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
O identificador do cluster ao qual a instância pertencerá.  
Tipo: String  
Obrigatório: Sim

 ** DBInstanceClass **   
A capacidade de computação e memória da instância. Por exemplo, `db.r5.large`.   
Tipo: String  
Obrigatório: Sim

 ** DBInstanceIdentifier **   
O identificador da instância. Este parâmetro é armazenado como uma string com letras minúsculas.  
Restrições:  
+ Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
Exemplo: `mydbinstance`   
Tipo: String  
Obrigatório: Sim

 ** Engine **   
O nome do mecanismo de banco de dados a ser usado para essa instância.  
Valor válido: `docdb`   
Tipo: String  
Obrigatório: Sim

 ** AutoMinorVersionUpgrade **   
Esse parâmetro não é aplicável ao Amazon DocumentDB. O Amazon DocumentDB não faz upgrades de versão secundários, independentemente do valor definido.  
Padrão: `false`   
Tipo: booliano  
Obrigatório: não

 ** AvailabilityZone **   
A zona de disponibilidade do Amazon EC2 na qual a instância é criada.   
Padrão: uma zona de disponibilidade aleatória escolhida pelo sistema no endpoint. Região da AWS  
Exemplo: `us-east-1d`   
Tipo: string  
Obrigatório: não

 ** CACertificateIdentifier **   
O identificador do certificado CA a ser usado para o certificado do servidor da instância de banco de dados.  
Para obter mais informações, consulte [Atualização dos certificados TLS do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) e [Criptografia de dados em trânsito](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) no *Guia do desenvolvedor do Amazon DocumentDB*.  
Tipo: string  
Obrigatório: não

 ** CopyTagsToSnapshot **   
Um valor que indica se as tags devem ser copiadas da instância DB nas capturas de tela da mesma. Por padrão, as tags não são copiadas.  
Tipo: Booliano  
Obrigatório: não

 ** EnablePerformanceInsights **   
Um valor que indica se deve ser ativado o Performance Insights para a instância de BD. Para obter mais informações, consulte [Usando insights de desempenho da Amazon](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).  
Tipo: Booliano  
Obrigatório: não

 ** PerformanceInsightsKMSKeyId **   
O identificador AWS KMS chave para criptografia dos dados do Performance Insights.  
O identificador da AWS KMS chave é o ARN da chave, o ID da chave, o ARN do alias ou o nome do alias da chave KMS.  
Se você não especificar um valor para PerformanceInsights KMSKey Id, o Amazon DocumentDB usará sua chave KMS padrão. Há uma chave KMS padrão para sua conta do Amazon Web Services. Sua conta do Amazon Web Services tem uma chave KMS padrão diferente para cada região do Amazon Web Services.  
Tipo: String  
Obrigatório: não

 ** PreferredMaintenanceWindow **   
O intervalo de tempo em cada semana durante o qual ocorre a manutenção do sistema, no Tempo Universal Coordenado (UTC).  
 Formato: `ddd:hh24:mi-ddd:hh24:mi`.   
O padrão é uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de 8 horas para cada uma Região da AWS, ocorrendo em um dia aleatório da semana.   
Dias válidos: Seg, Ter, Qua, Qui, Sex, Sáb, Dom  
Restrições: janela mínima de 30 minutos.  
Tipo: String  
Obrigatório: Não

 ** PromotionTier **   
Um valor que especifica a ordem em que uma réplica do Amazon DocumentDB é promovida para a instância primária após uma falha da instância primária existente.  
Padrão: 1  
Valores válidos: 0 a 15  
Tipo: Inteiro  
Obrigatório: não

 **Tags.Tag.N**   
As tags a serem atribuídas à instância. É possível atribuir até 10 tags a uma instância.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: não

## Elementos de Resposta
<a name="API_CreateDBInstance_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBInstance **   
Informações detalhadas sobre uma instância.   
Tipo: objeto [DBInstance](API_DBInstance.md)

## Erros
<a name="API_CreateDBInstance_Errors"></a>

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros comuns](CommonErrors.md).

 ** AuthorizationNotFound **   
O IP CIDR ou o grupo de segurança do Amazon EC2 especificado não está autorizado para o grupo de segurança especificado.  
O Amazon DocumentDB também pode não estar autorizado a executar as ações necessárias em seu nome usando o IAM.  
Código de status HTTP: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** DBInstanceAlreadyExists **   
Você já tem uma instância com o identificador informado.  
Código de status HTTP: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` não se refere a um grupo de parâmetros existente.   
Código de Status HTTP: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` não se refere a um grupo de segurança existente.   
Código de status HTTP: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
As sub-redes no grupo de sub-redes de banco de dados devem abranger pelo menos duas zonas de disponibilidade, a menos que haja apenas uma zona de disponibilidade.  
Código de status HTTP: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` não se refere a um grupo de sub-redes existente.   
Código de status HTTP: 404

 ** InstanceQuotaExceeded **   
A solicitação faria com que você excedesse o número de instâncias permitidas.  
Código de status HTTP: 400

 ** InsufficientDBInstanceCapacity **   
A classe de instância especificada não está disponível na Zona de Disponibilidade especificada.  
Código de status HTTP: 400

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de status HTTP: 400

 ** InvalidSubnet **   
A sub-rede solicitada é inválida ou foram solicitadas várias sub-redes que não estão em uma nuvem privada virtual (VPC) comum.  
Código de status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
O grupo de sub-rede não cobre todas as zonas de disponibilidade depois de ter sido criado devido às alterações feitas.  
Código de status HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Ocorreu um erro ao acessar uma AWS KMS chave.  
Código de status HTTP: 400

 ** StorageQuotaExceeded **   
A solicitação faria com que você excedesse a quantidade permitida de armazenamento disponível em todas as instâncias.  
Código de status HTTP: 400

 ** StorageTypeNotSupported **   
O armazenamento do `StorageType` especificado não pode ser associado à instância do banco de dados.   
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateDBInstance_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBInstance) 

# CreateDBSubnetGroup
<a name="API_CreateDBSubnetGroup"></a>

Os grupos de sub-redes de banco de dados devem conter pelo menos uma sub-rede em pelo menos duas zonas de disponibilidade no Região da AWS.

## Parâmetros da solicitação
<a name="API_CreateDBSubnetGroup_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBSubnetGroupDescription **   
A descrição do grupo de sub-redes.  
Tipo: String  
Obrigatório: Sim

 ** DBSubnetGroupName **   
O nome do grupo de sub-redes. Esse valor é armazenado como uma string em minúsculas.  
Restrições: deve conter não mais do que 255 letras, números, pontos, sublinhados, espaços ou hífens. Não deve ser padrão.  
Exemplo: `mySubnetgroup`   
Tipo: String  
Obrigatório: Sim

 **SubnetIds. SubnetIdentifierN.**   
A sub-rede Amazon EC2 IDs para o grupo de sub-redes.  
Tipo: matriz de strings  
Obrigatório: Sim

 **Tags.Tag.N**   
As tags a serem atribuídas ao grupo de sub-redes.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: não

## Elementos de Resposta
<a name="API_CreateDBSubnetGroup_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBSubnetGroup **   
Informações detalhadas sobre um grupo de sub-redes.   
Tipo: objeto [DBSubnetGroup](API_DBSubnetGroup.md)

## Erros
<a name="API_CreateDBSubnetGroup_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBSubnetGroupAlreadyExists **   
 `DBSubnetGroupName` já está sendo usado por um grupo de sub-redes existente.   
Código de status HTTP: 400

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
As sub-redes no grupo de sub-redes de banco de dados devem abranger pelo menos duas zonas de disponibilidade, a menos que haja apenas uma zona de disponibilidade.  
Código de status HTTP: 400

 ** DBSubnetGroupQuotaExceeded **   
A solicitação faria com que o usuário excedesse o número permitido de grupos de sub-redes.  
Código de status HTTP: 400

 ** DBSubnetQuotaExceededFault **   
A solicitação faria com que o usuário excedesse o número permitido de sub-redes em um grupo de sub-redes.  
Código de status HTTP: 400

 ** InvalidSubnet **   
A sub-rede solicitada é inválida ou foram solicitadas várias sub-redes que não estão em uma nuvem privada virtual (VPC) comum.  
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateDBSubnetGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBSubnetGroup) 

# CreateEventSubscription
<a name="API_CreateEventSubscription"></a>

Cria uma assinatura de notificação de evento do Amazon DocumentDB. Essa ação exige um AFRN (nome de recurso da Amazon) de tópico criado pelo console do Amazon DocumentDB, pelo console do SNS ou pela API do SNS. Para obter um ARN com o SNS, crie um tópico no Amazon SNS e assine o ao tópico. O ARN é exibido no console do Amazon SNS.

É possível especificar o tipo de origem (`SourceType`) sobre o qual deseja ser notificado. Você também pode fornecer uma lista das fontes do Amazon DocumentDB (`SourceIds`) que acionam os eventos, e você pode fornecer uma lista de categorias de eventos (`EventCategories`) para eventos sobre os quais você deseja ser notificado. Por exemplo, é possível especificar `SourceType = db-instance`, `SourceIds = mydbinstance1, mydbinstance2` e `EventCategories = Availability, Backup`.

Se você especificar o `SourceType` e `SourceIds` (como `SourceType = db-instance` e `SourceIdentifier = myDBInstance1`), você será notificado de todos os eventos `db-instance` da fonte especificada. Se você especificar um `SourceType`, mas não especificar uma `SourceIdentifier`, você receberá um aviso dos eventos desse tipo de origem para todas as suas origens do Amazon DocumentDB. Se você não especificar o `SourceType` ou o `SourceIdentifier`, você receberá notificações de eventos gerados de todas as origens do Amazon DocumentDB que pertencem à sua conta de cliente.

## Parâmetros da solicitação
<a name="API_CreateEventSubscription_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** SnsTopicArn **   
O Amazon Resource Name (ARN) do tópico do SNS criado para notificação de eventos. O Amazon SNS cria o SNS quando você cria um tópico e o assina.  
Tipo: String  
Obrigatório: Sim

 ** SubscriptionName **   
O nome da inscrição.  
Restrições: o nome deve ter menos de 255 caracteres.  
Tipo: String  
Obrigatório: Sim

 ** Enabled **   
 Um valor booliano, definido como `true` para ativar a assinatura, e definido como `false` para criar a assinatura, mas não ativá-la.   
Tipo: booliano  
Obrigatório: não

 **EventCategories. EventCategoryN.**   
 Uma lista de categorias de eventos para um `SourceType` em que você deseja se inscrever.   
Tipo: Matriz de strings  
Obrigatório: Não

 **SourceIds. SourceIdN.**   
A lista de identificadores das origens de eventos para as quais os eventos são retornados. Se não for especificado, todas as origens serão incluídas na resposta. Um identificador deve começar com uma letra e conter apenas letras ASCII, dígitos e hifens e não terminar com um hífen nem conter dois hifens consecutivos.  
Restrições:  
+ Se `SourceIds` forem fornecidos, `SourceType` também deve ser fornecido.
+ Se o tipo de fonte for uma instância, um `DBInstanceIdentifier` deverá ser fornecido.
+ Se o tipo de origem for um grupo de segurança, um `DBSecurityGroupName` deverá ser fornecido.
+ Se o tipo de origem for um grupo de parâmetros, um `DBParameterGroupName` deverá ser fornecido.
+ Se o tipo de origem for um snapshot, um `DBSnapshotIdentifier` deverá ser fornecido.
Tipo: matriz de strings  
Obrigatório: Não

 ** SourceType **   
O tipo de origem gerando os eventos. Por exemplo, caso você queira ser notificado de eventos gerados por uma instância, defina esse parâmetro como `db-instance`. Se esse valor não for especificado, todos os eventos serão retornados.  
Valores válidos: `db-instance`, `db-cluster`, `db-parameter-group`, `db-security-group`, `db-cluster-snapshot`   
Tipo: string  
Obrigatório: não

 **Tags.Tag.N**   
Uma ou mais tags a serem atribuídas à assinatura do evento.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: não

## Elementos de Resposta
<a name="API_CreateEventSubscription_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** EventSubscription **   
Informações detalhadas sobre um evento em você se inscreveu.  
Tipo: objeto [EventSubscription](API_EventSubscription.md)

## Erros
<a name="API_CreateEventSubscription_Errors"></a>

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros comuns](CommonErrors.md).

 ** EventSubscriptionQuotaExceeded **   
O número máximo de assinaturas de eventos.   
Código de Status HTTP: 400

 ** SNSInvalidTopic **   
O Amazon SNS respondeu que há um problema com o tópico especificado.   
Código de Status HTTP: 400

 ** SNSNoAuthorization **   
Você não tem permissão para publicar no tópico do SNS nome do recurso da Amazon (ARN).   
Código de Status HTTP: 400

 ** SNSTopicArnNotFound **   
Não existe o tópico SNS nome do recurso da Amazon (ARN).   
Código de status HTTP: 404

 ** SourceNotFound **   
Não foi possível encontrar a origem solicitada.   
Código de status HTTP: 404

 ** SubscriptionAlreadyExist **   
O nome da assinatura fornecido já existe.   
Código de status HTTP: 400

 ** SubscriptionCategoryNotFound **   
A categoria fornecida não existe.   
Código de status HTTP: 404

## Consulte Também
<a name="API_CreateEventSubscription_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateEventSubscription) 

# CreateGlobalCluster
<a name="API_CreateGlobalCluster"></a>

Cria um cluster global do Amazon DocumentDB que pode abranger vários Regiões da AWS. O cluster global contém um cluster primário com capacidade de leitura e gravação, e até 10 clusters secundários somente de leitura. Clusters globais usam replicação rápida, baseada em armazenamento entre regiões com latências de menos de um segundo e infraestrutura dedicada sem impacto no desempenho da sua workload.



É possível criar um banco de dados global inicialmente vazio e, em seguida, adicionar um cluster primário e um secundário. Ou pode especificar um cluster existente durante a operação de criação, para que esse cluster torne-se o primário do cluster global. 

**nota**  
Essa ação se aplica somente aos clusters do Amazon DocumentDB.

## Parâmetros da solicitação
<a name="API_CreateGlobalCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

 ** GlobalClusterIdentifier **   
O identificador de cluster do novo cluster global.  
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: sim

 ** DatabaseName **   
O nome para o seu banco de dados, com até 64 caracteres alfanuméricos. Se um nome não for fornecido, o Amazon DocumentDB não criará um banco de dados no cluster global que você estiver criando.  
Tipo: string  
Obrigatório: não

 ** DeletionProtection **   
A configuração de proteção contra exclusão para o novo cluster global. O cluster global não pode ser excluído quando a proteção contra exclusão estiver habilitada.   
Tipo: booleano  
Obrigatório: não

 ** Engine **   
O nome do mecanismo de banco de dados a ser usado para esse cluster.  
Tipo: string  
Obrigatório: não

 ** EngineVersion **   
A versão do mecanismo do cluster global.  
Tipo: string  
Obrigatório: não

 ** SourceDBClusterIdentifier **   
O nome do recurso da Amazon (ARN) a ser usado como o cluster primário do cluster global. Esse parâmetro é opcional.  
Tipo: string  
Obrigatório: não

 ** StorageEncrypted **   
A configuração de criptografia de armazenamento para o novo cluster global.   
Tipo: booliano  
Obrigatório: Não

## Elementos de Resposta
<a name="API_CreateGlobalCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** GlobalCluster **   
Um tipo de dado que representa um cluster global do Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

## Erros
<a name="API_CreateGlobalCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** GlobalClusterAlreadyExistsFault **   
O `GlobalClusterIdentifier` já existe. Escolha um novo identificador de cluster global (nome exclusivo) para criar um novo cluster global.   
Código de status HTTP: 400

 ** GlobalClusterQuotaExceededFault **   
O número de clusters globais para essa conta já atingiu no máximo permitido.  
Código de status HTTP: 400

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_CreateGlobalCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateGlobalCluster) 

# DeleteDBCluster
<a name="API_DeleteDBCluster"></a>

Exclui um cluster provisionado anteriormente. Quando você exclui um cluster, todos os backups automatizados para esse cluster são excluídos e não podem ser recuperados. Os snapshots manuais do cluster especificado não são excluídos.



## Parâmetros da solicitação
<a name="API_DeleteDBCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
O identificador do cluster para o cluster a ser excluído. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Deve corresponder a um `DBClusterIdentifier` existente.
Tipo: String  
Obrigatório: Sim

 ** FinalDBSnapshotIdentifier **   
 O identificador do snapshot do novo snapshot do cluster criado quando `SkipFinalSnapshot` é definido como `false`.   
 Especificar esse parâmetro e também definir o parâmetro `SkipFinalShapshot` para `true` resultará em um erro. 
Restrições:  
+ Deve ter de 1 a 255 letras, números ou hífens.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
Tipo: string  
Obrigatório: não

 ** SkipFinalSnapshot **   
 Determina se um snapshot de cluster foi criado antes de o cluster ser excluído. Se `true` for especificado, nenhum snapshot de cluster será criado. Se `false` for especificado, um snapshot de cluster será criado antes de o cluster do banco de dados ser excluído.   
É necessário especificar um parâmetro `SkipFinalSnapshot` se `false` for `FinalDBSnapshotIdentifier`.
Padrão: `false`   
Tipo: booliano  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DeleteDBCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBCluster **   
Informações detalhadas sobre um cluster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Erros
<a name="API_DeleteDBCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** DBClusterSnapshotAlreadyExistsFault **   
O usuário já tem um snapshot de cluster com o identificador determinado.  
Código de status HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
O valor fornecido não é um estado de snapshot de cluster válido.  
Código de status HTTP: 400

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de status HTTP: 400

 ** SnapshotQuotaExceeded **   
A solicitação faria com que você excedesse o número de snapshots permitidos.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteDBCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBCluster) 

# DeleteDBClusterParameterGroup
<a name="API_DeleteDBClusterParameterGroup"></a>

Exclui um grupo de parâmetros de cluster especificado. O grupo de parâmetros de cluster a ser excluído não pode ser associado a nenhum outro cluster.

## Parâmetros da solicitação
<a name="API_DeleteDBClusterParameterGroup_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterParameterGroupName **   
O nome do grupo de parâmetros de cluster.  
Restrições:  
+ Deve ser o nome de um grupo de parâmetros de cluster existente.
+ Não é possível excluir um grupo de parâmetros de cluster padrão.
+ Não pode ser associado a nenhum cluster.
Tipo: String  
Obrigatório: Sim

## Erros
<a name="API_DeleteDBClusterParameterGroup_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` não se refere a um grupo de parâmetros existente.   
Código de status HTTP: 404

 ** InvalidDBParameterGroupState **   
O grupo de parâmetros está em uso ou está em um estado que não é válido. Se estiver tentando excluir o grupo de parâmetros, não poderá excluí-lo quando o grupo estiver nesse estado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteDBClusterParameterGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 

# DeleteDBClusterSnapshot
<a name="API_DeleteDBClusterSnapshot"></a>

Exclui um snapshot do cluster. Se o snapshot estiver sendo copiado, a operação de cópia será encerrada.

**nota**  
O snapshot do cluster de banco de dados deve estar no estado `available` para ser excluído.

## Parâmetros da solicitação
<a name="API_DeleteDBClusterSnapshot_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns que todas as ações utilizam, consulte [Parâmetros comuns](CommonParameters.md).

 ** DBClusterSnapshotIdentifier **   
O identificador do snapshot do cluster a ser excluído.  
Restrições: deve ser o nome de um snapshot do cluster existente no estado `available`.  
Tipo: String  
Obrigatório: Sim

## Elementos de resposta
<a name="API_DeleteDBClusterSnapshot_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBClusterSnapshot **   
Informações detalhadas sobre um snapshot de cluster.   
Tipo: objeto [DBClusterSnapshot](API_DBClusterSnapshot.md)

## Erros
<a name="API_DeleteDBClusterSnapshot_Errors"></a>

Para obter informações sobre erros comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` não se refere a um snapshot de cluster existente.   
Código de Status HTTP: 404

 ** InvalidDBClusterSnapshotStateFault **   
O valor fornecido não é um estado de snapshot de cluster válido.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteDBClusterSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 

# DeleteDBInstance
<a name="API_DeleteDBInstance"></a>

Exclui uma instância provisionada anteriormente.

## Parâmetros da solicitação
<a name="API_DeleteDBInstance_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBInstanceIdentifier **   
O identificador de instância para a instância a ser excluída. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Deve corresponder ao nome de uma instância existente.
Tipo: String  
Obrigatório: Sim

## Elementos de resposta
<a name="API_DeleteDBInstance_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBInstance **   
Informações detalhadas sobre uma instância.   
Tipo: objeto [DBInstance](API_DBInstance.md)

## Erros
<a name="API_DeleteDBInstance_Errors"></a>

Para obter informações sobre os erros comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` não se refere a uma instância existente.   
Código de status HTTP: 404

 ** DBSnapshotAlreadyExists **   
 `DBSnapshotIdentifier` já está sendo usado por uma captura de tela existente.   
Código de status HTTP: 400

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de Status HTTP: 400

 ** InvalidDBInstanceState **   
 A instância especificada não está no estado *disponível*.   
Código de status HTTP: 400

 ** SnapshotQuotaExceeded **   
A solicitação faria com que você excedesse o número de snapshots permitidos.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteDBInstance_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBInstance) 

# DeleteDBSubnetGroup
<a name="API_DeleteDBSubnetGroup"></a>

Exclui um grupo de sub-rede.

**nota**  
O grupo de sub-rede de banco de dados especificado não pode estar associado a nenhuma instância DB.

## Parâmetros da solicitação
<a name="API_DeleteDBSubnetGroup_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBSubnetGroupName **   
O nome do grupo de sub-rede de banco de dados a ser excluído.  
Você não pode excluir o grupo de sub-rede padrão.
Restrições:  
Deve corresponder ao nome de um `DBSubnetGroup` existente. Não deve ser padrão.  
Exemplo: `mySubnetgroup`   
Tipo: String  
Obrigatório: Sim

## Erros
<a name="API_DeleteDBSubnetGroup_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` não se refere a um grupo de sub-redes existente.   
Código de status HTTP: 404

 ** InvalidDBSubnetGroupStateFault **   
O grupo de sub-rede não pode ser excluído porque está em uso.  
Código de status HTTP: 400

 ** InvalidDBSubnetStateFault **   
 A sub-rede não está no estado *disponível*.   
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteDBSubnetGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBSubnetGroup) 

# DeleteEventSubscription
<a name="API_DeleteEventSubscription"></a>

Exclui uma assinatura de notificação de evento do Amazon DocumentDB.

## Parâmetros da solicitação
<a name="API_DeleteEventSubscription_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** SubscriptionName **   
O nome da assinatura de notificação de evento Amazon DocumentDB que você deseja excluir.  
Tipo: String  
Obrigatório: Sim

## Elementos de resposta
<a name="API_DeleteEventSubscription_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** EventSubscription **   
Informações detalhadas sobre um evento em você se inscreveu.  
Tipo: objeto [EventSubscription](API_EventSubscription.md)

## Erros
<a name="API_DeleteEventSubscription_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** InvalidEventSubscriptionState **   
Outra pessoa pode estar modificando uma assinatura. Espere alguns segundos e tente novamente.  
Código de status HTTP: 400

 ** SubscriptionNotFound **   
O nome da assinatura não existe.   
Código de Status HTTP: 404

## Consulte Também
<a name="API_DeleteEventSubscription_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteEventSubscription) 

# DeleteGlobalCluster
<a name="API_DeleteGlobalCluster"></a>

Exclui um cluster global. Os clusters primário e secundário já precisam estar desanexados ou terem sido excluídos antes da tentativa de excluir um cluster global.

**nota**  
Essa ação se aplica somente aos clusters do Amazon DocumentDB.

## Parâmetros da solicitação
<a name="API_DeleteGlobalCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** GlobalClusterIdentifier **   
O identificador de cluster do cluster global sendo deletado.  
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: sim

## Elementos de resposta
<a name="API_DeleteGlobalCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** GlobalCluster **   
Um tipo de dado que representa um cluster global do Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

## Erros
<a name="API_DeleteGlobalCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` não se refere a um cluster global existente.  
Código de status HTTP: 404

 ** InvalidGlobalClusterStateFault **   
A operação solicitada não pode ser executada enquanto o cluster estiver nesse estado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_DeleteGlobalCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteGlobalCluster) 

# DescribeCertificates
<a name="API_DescribeCertificates"></a>

Retorna uma lista de certificados de autoridade de certificação (certificate authority, CA) fornecidos pelo Amazon DocumentDB para este Conta da AWS.

## Parâmetros da solicitação
<a name="API_DescribeCertificates_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** CertificateIdentifier **   
O identificador do certificado fornecido pelo usuário. Se esse parâmetro for especificado, somente as informações para o certificado especificado serão retornadas. Caso esse parâmetro seja omitido, uma lista de até `MaxRecords` certificados será retornada. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições  
+ Deve corresponder a um `CertificateIdentifier` existente.
Tipo: string  
Obrigatório: Não

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação `DescribeCertificates` anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o valor `MaxRecords` especificado, um token de paginação chamado de marcador será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições:  
+ Mínimo: 20
+ Maximum (Máximo): 100
Tipo: inteiro  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeCertificates_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 **Certificates.Certificate.N**   
Uma lista de certificados para essa Conta da AWS.  
Tipo: matriz de objetos [Certificate](API_Certificate.md)

 ** Marker **   
Um token de paginação opcional fornecido se o número de registros recuperados for maior que `MaxRecords`. Caso esse parâmetro seja especificado, o marcador especificará o próximo registro na lista. Incluindo o valor de `Marker` na próxima chamada de `DescribeCertificates` obter resultados na próxima página de certificados.  
Tipo: string

## Erros
<a name="API_DescribeCertificates_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

 ** CertificateNotFound **   
 `CertificateIdentifier` não se refere a um certificado existente.   
Código de status HTTP: 404

## Consulte Também
<a name="API_DescribeCertificates_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeCertificates) 

# DescribeDBClusterParameterGroups
<a name="API_DescribeDBClusterParameterGroups"></a>

Retorna uma lista de descrições de `DBClusterParameterGroup`. Se um parâmetro `DBClusterParameterGroupName` for especificado, a lista conterá apenas a descrição do grupo de parâmetros de cluster especificado. 

## Parâmetros da solicitação
<a name="API_DescribeDBClusterParameterGroups_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterParameterGroupName **   
O nome de um grupo de parâmetros de cluster específico para o qual retornar detalhes.  
Restrições:  
+ Caso fornecido, deve corresponder ao nome de um `DBClusterParameterGroup` existente.
Tipo: string  
Obrigatório: Não

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeDBClusterParameterGroups_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 **DBClusterParameterGroups. DBClusterParameterGroupN.**   
Uma lista de grupos de parâmetros de cluster.  
Tipo: matriz de objetos [DBClusterParameterGroup](API_DBClusterParameterGroup.md)

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string

## Erros
<a name="API_DescribeDBClusterParameterGroups_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` não se refere a um grupo de parâmetros existente.   
Código de status HTTP: 404

## Consulte Também
<a name="API_DescribeDBClusterParameterGroups_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 

# DescribeDBClusterParameters
<a name="API_DescribeDBClusterParameters"></a>

Retorna a lista de parâmetros detalhada de um grupo de parâmetros de cluster.

## Parâmetros da solicitação
<a name="API_DescribeDBClusterParameters_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterParameterGroupName **   
O nome de um grupo de parâmetros de cluster específico do qual retornar detalhes de parâmetros.  
Restrições:  
+ Caso fornecido, deve corresponder ao nome de um `DBClusterParameterGroup` existente.
Tipo: String  
Obrigatório: Sim

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: não

 ** Source **   
 Um valor que indica para retornar apenas parâmetros para uma origem específica. As origens de parâmetros podem ser `engine`, `service` ou `customer`.   
Tipo: string  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeDBClusterParameters_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string

 **Parameters.Parameter.N**   
Fornece uma lista de parâmetros para o grupo de parâmetros de cluster.  
Tipo: matriz de objetos [Parameter](API_Parameter.md)

## Erros
<a name="API_DescribeDBClusterParameters_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` não se refere a um grupo de parâmetros existente.   
Código de status HTTP: 404

## Consulte Também
<a name="API_DescribeDBClusterParameters_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameters) 

# DescribeDBClusters
<a name="API_DescribeDBClusters"></a>

Retorna informações sobre clusters provisionados Amazon DocumentDB. A operação API oferece suporte à paginação. Para determinados atributos de gerenciamento, como o gerenciamento do ciclo de vida de clusters e instâncias, o Amazon DocumentDB aproveita a tecnologia operacional compartilhada com o Amazon RDS e Amazon Neptune. Use o parâmetro de filtro `filterName=engine,Values=docdb` para retornar somente clusters do Amazon DocumentDB.

## Parâmetros da solicitação
<a name="API_DescribeDBClusters_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
O identificador de cluster fornecido pelo usuário. Se esse parâmetro for especificado, somente as informações do cluster especificado serão retornadas. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Se fornecido, deve corresponder a um `DBClusterIdentifier` existente.
Tipo: string  
Obrigatório: Não

 **Filters.Filter.N**   
Um filtro que especifica um ou mais clusters a serem descritos.  
Filtros com suporte:  
+  `db-cluster-id`- Aceita identificadores de cluster e clusters Amazon Resource Names (ARNs). A lista de resultados inclui apenas informações sobre os clusters identificados por eles ARNs.
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeDBClusters_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 **DBClusters. DBClusterN.**   
Uma lista de clusters.  
Tipo: matriz de objetos [DBCluster](API_DBCluster.md)

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string

## Erros
<a name="API_DescribeDBClusters_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

## Consulte Também
<a name="API_DescribeDBClusters_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusters) 

# DescribeDBClusterSnapshotAttributes
<a name="API_DescribeDBClusterSnapshotAttributes"></a>

Retorna uma lista de nomes e valores de atributos de snapshot do manual cluster do banco de dados.

Quando você compartilha instantâneos com outros Contas da AWS, `DescribeDBClusterSnapshotAttributes` retorna o `restore` atributo e uma lista dos IDs Contas da AWS que estão autorizados a copiar ou restaurar o instantâneo manual do cluster. Se `all` estiver incluído na lista de valores para o atributo `restore`, o snapshot manual do cluster será público e poderá ser copiado ou restaurado por todas as Contas da AWS.

## Parâmetros da solicitação
<a name="API_DescribeDBClusterSnapshotAttributes_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterSnapshotIdentifier **   
O identificador do snapshot do cluster cujos atributos serão descritos.  
Tipo: String  
Obrigatório: Sim

## Elementos de resposta
<a name="API_DescribeDBClusterSnapshotAttributes_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBClusterSnapshotAttributesResult **   
Informações detalhadas sobre os atributos associados a um snapshot de cluster.  
Tipo: objeto [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)

## Erros
<a name="API_DescribeDBClusterSnapshotAttributes_Errors"></a>

Para obter informações sobre erros comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` não se refere a um snapshot de cluster existente.   
Código de status HTTP: 404

## Consulte Também
<a name="API_DescribeDBClusterSnapshotAttributes_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 

# DescribeDBClusterSnapshots
<a name="API_DescribeDBClusterSnapshots"></a>

Retorna informações sobre captura de tela do cluster. A operação API oferece suporte à paginação.

## Parâmetros da solicitação
<a name="API_DescribeDBClusterSnapshots_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
ID do cluster para recuperar a lista de captura de tela de cluster. Esse parâmetro não pode ser usado com o parâmetro `DBClusterSnapshotIdentifier`. Esse parâmetro não diferencia maiúsculas de minúsculas.   
Restrições:  
+ Caso fornecido, deve corresponder ao identificador de um `DBCluster` existente.
Tipo: string  
Obrigatório: não

 ** DBClusterSnapshotIdentifier **   
Um identificador de captura de tela de cluster específico a ser descrito. Esse parâmetro não pode ser usado com o parâmetro `DBClusterIdentifier`. Esse valor é armazenado como uma string em minúsculas.   
Restrições:  
+ Caso fornecido, deve corresponder ao identificador de um `DBClusterSnapshot` existente.
+ Se esse identificador for uma captura de tela automatizada, o parâmetro `SnapshotType` também deverá ser especificado.
Tipo: string  
Obrigatório: Não

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** IncludePublic **   
Defina `true` para incluir instantâneos manuais de cluster que sejam públicos e possam ser copiados ou restaurados por qualquer pessoa Conta da AWS, ou de outra forma. `false` O padrão é `false`.  
Tipo: booliano  
Obrigatório: não

 ** IncludeShared **   
Defina `true` para incluir instantâneos de cluster manuais compartilhados de outros Contas da AWS que Conta da AWS tenham permissão para copiar ou restaurar, entre outros. `false` O padrão é `false`.  
Tipo: booliano  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: não

 ** SnapshotType **   
O tipo de snapshots de cluster a ser retornado. É possível especificar um dos seguintes valores:  
+  `automated` - Retorne todas as capturas de tela de cluster que o Amazon DocumentDB criou automaticamente para sua Conta da AWS.
+  `manual` - Retorne todas as capturas de tela de cluster que você criou manualmente para sua Conta da AWS.
+  `shared` – retorna todas as capturas de tela manuais do cluster compartilhadas para a minha Conta da AWS.
+  `public` – retorna todos os snapshots do cluster que foram marcados como públicos.
Se você não especificar um valor `SnapshotType`, as captura de tela de cluster automatizadas e manuais serão retornadas. É possível incluir capturas de tela do cluster compartilhadas com esses resultados configurando o parâmetro `IncludeShared` para `true`. É possível incluir capturas de tela públicas do cluster com esses resultados configurando o parâmetro `IncludePublic` para `true`.  
Os parâmetros `IncludeShared` e `IncludePublic` não se aplicam aos valores `SnapshotType` de `manual` ou `automated`. O parâmetro `IncludePublic` não se aplica quando `SnapshotType` está definido como `shared`. O parâmetro `IncludeShared` não se aplica quando `SnapshotType` está definido como `public`.  
Tipo: string  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeDBClusterSnapshots_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 **DBClusterInstantâneos. DBClusterInstantâneo**. N   
Fornece uma lista de capturas de tela do cluster.  
Tipo: matriz de objetos [DBClusterSnapshot](API_DBClusterSnapshot.md)

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string

## Erros
<a name="API_DescribeDBClusterSnapshots_Errors"></a>

Para obter informações sobre erros comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` não se refere a um snapshot de cluster existente.   
Código de status HTTP: 404

## Consulte Também
<a name="API_DescribeDBClusterSnapshots_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 

# DescribeDBEngineVersions
<a name="API_DescribeDBEngineVersions"></a>

Retorna uma lista dos mecanismos disponíveis.

## Parâmetros da solicitação
<a name="API_DescribeDBEngineVersions_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

 ** DBParameterGroupFamily **   
O nome de uma família de grupo de parâmetros específica para onde retornar detalhes.  
Restrições:  
+ Se fornecido, deve corresponder a um `DBParameterGroupFamily` existente.
Tipo: string  
Obrigatório: não

 ** DefaultOnly **   
Indica que somente a versão padrão do mecanismo especificado ou a combinação de mecanismo e versão principal é retornada.  
Tipo: booliano  
Obrigatório: não

 ** Engine **   
O mecanismo de banco de dados a ser retornado.  
Tipo: string  
Obrigatório: não

 ** EngineVersion **   
A versão do mecanismo de banco de dados a ser retornado.  
Exemplo: `3.6.0`   
Tipo: string  
Obrigatório: Não

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** ListSupportedCharacterSets **   
Se esse parâmetro for especificado e o mecanismo solicitado for compatível com o parâmetro `CharacterSetName` para `CreateDBInstance`, a resposta incluirá uma lista de conjuntos de caracteres com suporte para cada versão do mecanismo.   
Tipo: booliano  
Obrigatório: não

 ** ListSupportedTimezones **   
Se esse parâmetro for especificado e o mecanismo solicitado for compatível com o parâmetro `TimeZone` para `CreateDBInstance`, a resposta incluirá uma lista de fusos horários com suporte para cada versão do mecanismo.   
Tipo: booliano  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeDBEngineVersions_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 **DBEngineVersões. DBEngine**Versão.N   
Informações detalhadas sobre uma ou mais versões de mecanismo.  
Tipo: matriz de objetos [DBEngineVersion](API_DBEngineVersion.md)

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string

## Erros
<a name="API_DescribeDBEngineVersions_Errors"></a>

Para obter informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

## Consulte também
<a name="API_DescribeDBEngineVersions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBEngineVersions) 

# DescribeDBInstances
<a name="API_DescribeDBInstances"></a>

Retorna informações sobre instâncias do Amazon DocumentDB provisionadas. Essa API dá suporte à paginação.

## Parâmetros da solicitação
<a name="API_DescribeDBInstances_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBInstanceIdentifier **   
O identificador da instância fornecido pelo usuário. Se esse parâmetro for especificado, somente as informações da instância específica serão retornadas. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Caso fornecido, deve corresponder ao identificador de um `DBInstance` existente.
Tipo: string  
Obrigatório: Não

 **Filters.Filter.N**   
Um filtro que especifica uma ou mais instâncias a serem descritas.  
Filtros com suporte:  
+  `db-cluster-id`- Aceita identificadores de cluster e clusters Amazon Resource Names (ARNs). A lista de resultados inclui somente as informações sobre as instâncias associadas aos clusters identificados por elas ARNs.
+  `db-instance-id`- Aceita identificadores de instância e instância ARNs. A lista de resultados inclui somente as informações sobre as instâncias identificadas por elas ARNs.
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeDBInstances_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 **DBInstances. DBInstanceN.**   
: informações detalhadas sobre uma ou mais instâncias.   
Tipo: matriz de objetos [DBInstance](API_DBInstance.md)

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string

## Erros
<a name="API_DescribeDBInstances_Errors"></a>

Para obter informações sobre os erros comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` não se refere a uma instância existente.   
Código de status HTTP: 404

## Consulte Também
<a name="API_DescribeDBInstances_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBInstances) 

# DescribeDBSubnetGroups
<a name="API_DescribeDBSubnetGroups"></a>

Retorna uma lista de descrições de `DBSubnetGroup`. Se um `DBSubnetGroupName` for especificado, a lista conterá apenas a descrição do grupo de parâmetros do `DBSubnetGroup` especificado.

## Parâmetros da solicitação
<a name="API_DescribeDBSubnetGroups_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBSubnetGroupName **   
O nome do grupo de sub-rede para o qual retornar detalhes.  
Tipo: string  
Obrigatório: Não

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeDBSubnetGroups_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 **DBSubnetGrupos. DBSubnet**Grupo. N   
Informações detalhadas sobre um ou mais grupos de sub-rede.  
Tipo: matriz de objetos [DBSubnetGroup](API_DBSubnetGroup.md)

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string

## Erros
<a name="API_DescribeDBSubnetGroups_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` não se refere a um grupo de sub-redes existente.   
Código de status HTTP: 404

## Consulte Também
<a name="API_DescribeDBSubnetGroups_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBSubnetGroups) 

# DescribeEngineDefaultClusterParameters
<a name="API_DescribeEngineDefaultClusterParameters"></a>

Retorna as informações sobre o mecanismo padrão e parâmetros do sistema para mecanismo de banco de dados do cluster.

## Parâmetros da solicitação
<a name="API_DescribeEngineDefaultClusterParameters_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBParameterGroupFamily **   
O nome da família de grupos de parâmetros de cluster a qual retornar informações de parâmetros do mecanismo.  
Tipo: String  
Obrigatório: Sim

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeEngineDefaultClusterParameters_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** EngineDefaults **   
Contém o resultado de uma invocação bem-sucedida da operação `DescribeEngineDefaultClusterParameters`.   
Tipo: objeto [EngineDefaults](API_EngineDefaults.md)

## Erros
<a name="API_DescribeEngineDefaultClusterParameters_Errors"></a>

Para obter informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

## Consulte também
<a name="API_DescribeEngineDefaultClusterParameters_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 

# DescribeEventCategories
<a name="API_DescribeEventCategories"></a>

Exibe uma lista de categorias de todos os tipos de origem de eventos ou, se especificado, de um determinado tipo de origem. 

## Parâmetros da solicitação
<a name="API_DescribeEventCategories_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** SourceType **   
O tipo de origem gerando os eventos.  
Valores válidos: `db-instance`, `db-parameter-group`, `db-security-group`   
Tipo: string  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeEventCategories_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 **EventCategoriesMapList. EventCategoriesMapN.**   
Uma lista de mapas da categoria do evento.  
Tipo: matriz de objetos [EventCategoriesMap](API_EventCategoriesMap.md)

## Erros
<a name="API_DescribeEventCategories_Errors"></a>

Para obter informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

## Consulte também
<a name="API_DescribeEventCategories_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventCategories) 

# DescribeEvents
<a name="API_DescribeEvents"></a>

Retorna os eventos relacionados a instâncias, grupos de segurança, snapshots e grupos de parâmetros de banco de dados dos últimos 14 dias. É possível obter eventos específicos para uma determinada instância, grupo de segurança, snapchot,ou grupo de parâmetros de banco de dados, fornecendo o nome como um parâmetro. Por padrão, os eventos da última hora são retornados.

## Parâmetros da solicitação
<a name="API_DescribeEvents_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** Duration **   
O número de minutos dos quais recuperar eventos.  
Padrão: 60  
Tipo: inteiro  
Obrigatório: não

 ** EndTime **   
 O fim do intervalo de tempo do qual recuperar eventos, especificado no formato ISO 8601.   
Exemplo: 2009-07-08T18:00Z  
Tipo: Carimbo de data/hora  
Obrigatório: não

 **EventCategories. EventCategoryN.**   
Uma lista de categorias que disparam notificações para uma assinatura de notificações de um evento.  
Tipo: matriz de strings  
Obrigatório: Não

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: não

 ** SourceIdentifier **   
O identificador da origem do evento para o qual os eventos são retornados. Se não for especificado, todas as origens serão incluídas na resposta.  
Restrições:  
+ Se `SourceIdentifier` for fornecido, `SourceType` também deve ser fornecido.
+ Se o tipo de fonte for `DBInstance`, um `DBInstanceIdentifier` deve ser fornecido.
+ Se o tipo de fonte for `DBSecurityGroup`, um `DBSecurityGroupName` deve ser fornecido.
+ Se o tipo de fonte for `DBParameterGroup`, um `DBParameterGroupName` deve ser fornecido.
+ Se o tipo de fonte for `DBSnapshot`, um `DBSnapshotIdentifier` deve ser fornecido.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
Tipo: string  
Obrigatório: não

 ** SourceType **   
A origem do evento da qual recuperar eventos. Se nenhum valor for especificado, todos os eventos serão retornados.  
Tipo: string  
Valores válidos: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`   
Obrigatório: não

 ** StartTime **   
 O início do intervalo de tempo do qual recuperar eventos, especificado no formato ISO 8601.   
Exemplo: 2009-07-08T18:00Z  
Tipo: Carimbo de data/hora  
Obrigatório: não

## Elementos de Resposta
<a name="API_DescribeEvents_ResponseElements"></a>

O serviço retorna os seguintes elementos.

 **Events.Event.N**   
: informações detalhadas sobre um ou mais eventos.   
Tipo: matriz de objetos [Event](API_Event.md)

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string

## Erros
<a name="API_DescribeEvents_Errors"></a>

Para obter informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

## Consulte também
<a name="API_DescribeEvents_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEvents) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEvents) 

# DescribeEventSubscriptions
<a name="API_DescribeEventSubscriptions"></a>

Lista todas as descrições de assinaturas de uma conta de cliente. A descrição de uma assinatura inclui `SubscriptionName`, `SNSTopicARN`, `CustomerID`, `SourceType`, `SourceID`, `CreationTime`, e `Status`.

Se você especificar um `SubscriptionName`, listará a descrição dessa assinatura.

## Parâmetros da solicitação
<a name="API_DescribeEventSubscriptions_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: não

 ** SubscriptionName **   
O nome da assinatura de notificações de eventos do Amazon DocumentDB que você deseja descrever.  
Tipo: string  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeEventSubscriptions_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 **EventSubscriptionsList. EventSubscriptionN.**   
Uma lista de assinaturas de eventos.   
Tipo: matriz de objetos [EventSubscription](API_EventSubscription.md)

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string

## Erros
<a name="API_DescribeEventSubscriptions_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

 ** SubscriptionNotFound **   
O nome da assinatura não existe.   
Código de Status HTTP: 404

## Consulte Também
<a name="API_DescribeEventSubscriptions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventSubscriptions) 

# DescribeGlobalClusters
<a name="API_DescribeGlobalClusters"></a>

Retorna informações sobre os clusters globais do Amazon DocumentDB. Essa API dá suporte à paginação.

**nota**  
Essa ação se aplica somente aos clusters do Amazon DocumentDB.

## Parâmetros da solicitação
<a name="API_DescribeGlobalClusters_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 **Filters.Filter.N**   
Um filtro que especifica um ou mais clusters de banco de dados global a serem descritos.  
Filtros compatíveis: `db-cluster-id` aceita identificadores de cluster e agrupa Amazon Resource Names (ARNs). A lista de resultados incluirá apenas informações sobre os clusters identificados por eles ARNs.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** GlobalClusterIdentifier **   
O identificador de cluster fornecido pelo usuário. Se esse parâmetro for especificado, somente as informações do cluster especificado serão retornadas. Este parâmetro não diferencia maiúsculas de minúsculas.  
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação `DescribeGlobalClusters` anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o valor `MaxRecords` especificado, um token de paginação chamado de marcador será incluído na resposta para que os resultados restantes possam ser recuperados.   
Tipo: inteiro  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeGlobalClusters_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 **GlobalClusters. GlobalClusterMemberN.**   
  
Tipo: matriz de objetos [GlobalCluster](API_GlobalCluster.md)

 ** Marker **   
  
Tipo: string

## Erros
<a name="API_DescribeGlobalClusters_Errors"></a>

Para obter informações sobre os erros comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` não se refere a um cluster global existente.  
Código de status HTTP: 404

## Consulte Também
<a name="API_DescribeGlobalClusters_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeGlobalClusters) 

# DescribeOrderableDBInstanceOptions
<a name="API_DescribeOrderableDBInstanceOptions"></a>

Retorna uma lista de opções de instância de banco de dados que podem ser solicitadas para o mecanismo especificado.

## Parâmetros de Solicitação
<a name="API_DescribeOrderableDBInstanceOptions_RequestParameters"></a>

 Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

 ** Engine **   
O nome do mecanismo para o qual recuperar as opções de instância.  
Tipo: String  
Obrigatório: Sim

 ** DBInstanceClass **   
O valor do filtro da classe da instância de banco de dados. Especifique esse parâmetro para mostrar somente as ofertas disponíveis correspondentes à classe da instância de banco de dados especificada.  
Tipo: String  
Obrigatório: Não

 ** EngineVersion **   
O valor do filtro da versão do mecanismo. Especifique esse parâmetro para mostrar somente as ofertas disponíveis correspondentes à versão do mecanismo especificado.  
Tipo: String  
Obrigatório: Não

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: Não

 ** LicenseModel **   
O valor do filtro do modelo de licença. Especifique esse parâmetro para mostrar somente as ofertas disponíveis correspondentes ao modelo de licença especificado.  
Tipo: String  
Obrigatório: Não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: Não

 ** Vpc **   
O valor do filtro da nuvem privada virtual (VPC). Especifique esse parâmetro para mostrar somente a VPC disponível ou ofertas que não sejam de VPC.  
Tipo: Booliano  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribeOrderableDBInstanceOptions_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string

 **Opções solicitáveis.Opção solicitável.N DBInstance DBInstance**   
As opções que estão disponíveis para uma instância ordenável específica.  
Tipo: matriz de objetos [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md)

## Erros
<a name="API_DescribeOrderableDBInstanceOptions_Errors"></a>

Para obter informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

## Consulte também
<a name="API_DescribeOrderableDBInstanceOptions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 

# DescribePendingMaintenanceActions
<a name="API_DescribePendingMaintenanceActions"></a>

Retorna uma lista de recursos (por exemplo, instâncias) que têm pelo menos uma ação de manutenção pendente.

## Parâmetros da solicitação
<a name="API_DescribePendingMaintenanceActions_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 **Filters.Filter.N**   
Um filtro que especifica um ou mais recursos para os quais retornar ações de manutenção pendentes.  
Filtros compatíveis:  
+  `db-cluster-id`- Aceita identificadores de cluster e clusters Amazon Resource Names (ARNs). A lista de resultados inclui somente ações de manutenção pendentes para os clusters identificados por elas ARNs.
+  `db-instance-id`- Aceita identificadores de instância e instância ARNs. A lista de resultados inclui somente ações de manutenção pendentes para as instâncias de banco de dados identificadas por elas ARNs.
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** MaxRecords **   
 O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `MaxRecords` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Padrão: 100  
Restrições: mínimo de 20, máximo de 100.  
Tipo: número inteiro  
Obrigatório: não

 ** ResourceIdentifier **   
O ARN de um recurso para o qual retornar ações de manutenção pendentes.  
Tipo: string  
Obrigatório: Não

## Elementos de Resposta
<a name="API_DescribePendingMaintenanceActions_ResponseElements"></a>

Os seguintes elementos são retornados pelo serviço.

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string

 **PendingMaintenanceActions. ResourcePendingMaintenanceActionsN.**   
As ações de manutenção a serem aplicadas.  
Tipo: matriz de objetos [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)

## Erros
<a name="API_DescribePendingMaintenanceActions_Errors"></a>

Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** ResourceNotFoundFault **   
O ID do recurso especificado não foi encontrado.  
Código de status HTTP: 404

## Consulte Também
<a name="API_DescribePendingMaintenanceActions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 

# FailoverDBCluster
<a name="API_FailoverDBCluster"></a>

Força um failover para um cluster de banco de dados.

Um failover para um cluster promove uma das réplicas do Amazon DocumentDB (instâncias somente leitura) no cluster para ser a instância primária (o gravador do cluster).

Se a instância primária falhar, o Amazon DocumentDB fará o failover automaticamente para uma réplica do Amazon DocumentDB, se houver uma. É possível forçar um failover quando quiser simular uma falha de uma instância principal para testes.

## Parâmetros de Solicitação
<a name="API_FailoverDBCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
Um identificador de cluster para forçar um failover. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Deve corresponder ao identificador de um `DBCluster` existente.
Tipo: String  
Obrigatório: Não

 ** TargetDBInstanceIdentifier **   
O nome da instância a ser promovida a instância principal.  
É necessário especificar o identificador da instância para uma réplica de leitura do Amazon DocumentDB no cluster. Por exemplo, .`mydbcluster-replica1`  
Tipo: String  
Obrigatório: Não

## Elementos de Resposta
<a name="API_FailoverDBCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBCluster **   
Informações detalhadas sobre um cluster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Erros
<a name="API_FailoverDBCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de Status HTTP: 404

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de Status HTTP: 400

 ** InvalidDBInstanceState **   
 A instância especificada não está no estado *disponível*.   
Código de Status HTTP: 400

## Consulte também
<a name="API_FailoverDBCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverDBCluster) 

# FailoverGlobalCluster
<a name="API_FailoverGlobalCluster"></a>

Promove o cluster de banco de dados secundário especificado a cluster de banco de dados primário no cluster global quando ocorre o failover de um cluster global.

Use essa operação para responder a um evento não planejado, como um desastre regional na região primária. O failover pode ocasionar a perda dos dados da transação de gravação que não foram replicados para o secundário escolhido antes da ocorrência do evento de failover. No entanto, o processo de recuperação que promove uma instância de banco de dados no cluster de banco de dados principal escolhido para ser a instância de banco de dados primário do gravador garante que os dados estejam em um estado transacionalmente consistente.

## Parâmetros da solicitação
<a name="API_FailoverGlobalCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** GlobalClusterIdentifier **   
O identificador do cluster global do Amazon DocumentDB para aplicar essa operação. O identificador é a chave exclusiva atribuída pelo usuário quando o cluster é criado. Em outras palavras, é o nome do cluster global.  
Restrições:  
+ Deve ser o identificador de um cluster existente.
+ Tamanho mínimo de 1. Comprimento máximo de 255.
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: Sim

 ** TargetDbClusterIdentifier **   
O identificador do cluster do Amazon DocumentDB que você deseja promover a primário para o cluster global. Use o Amazon Resource Name (ARN) como identificador para que o Amazon DocumentDB possa localizar o cluster em sua região. AWS   
Restrições:  
+ Deve ser o identificador de um cluster secundário existente.
+ Tamanho mínimo de 1. Comprimento máximo de 255.
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: Sim

 ** AllowDataLoss **   
Especifica se a perda de dados deve ser permitida para essa operação de cluster global. Permitir a perda de dados aciona uma operação de failover global.  
Se você não especificar `AllowDataLoss`, a operação do cluster global assumirá como padrão uma transição.  
Restrições:  
+ Não pode ser especificado junto com o parâmetro `Switchover`.
Tipo: booliano  
Obrigatório: não

 ** Switchover **   
Especifica se é necessário fazer a transição desse cluster de banco de dados global.  
Restrições:  
+ Não pode ser especificado junto com o parâmetro `AllowDataLoss`.
Tipo: booliano  
Obrigatório: Não

## Elementos de Resposta
<a name="API_FailoverGlobalCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** GlobalCluster **   
Um tipo de dado que representa um cluster global do Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

## Erros
<a name="API_FailoverGlobalCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` não se refere a um cluster global existente.  
Código de status HTTP: 404

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de status HTTP: 400

 ** InvalidGlobalClusterStateFault **   
A operação solicitada não pode ser executada enquanto o cluster estiver nesse estado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_FailoverGlobalCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverGlobalCluster) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lista todas as tags em um recurso do Amazon DocumentDB.

## Parâmetros da solicitação
<a name="API_ListTagsForResource_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns que todas as ações utilizam, consulte [Parâmetros comuns](CommonParameters.md).

 ** ResourceName **   
O recurso do Amazon DocumentDB com as tags a serem listadas. Esse valor é um nome do recurso da Amazon (ARN).  
Tipo: String  
Obrigatório: Sim

 **Filters.Filter.N**   
Não há suporte para esse parâmetro atualmente.  
Tipo: matriz de objetos [Filter](API_Filter.md)  
Obrigatório: não

## Elementos de Resposta
<a name="API_ListTagsForResource_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 **TagList.Etiqueta.N**   
Uma lista de uma ou mais tags.  
Tipo: matriz de objetos [Tag](API_Tag.md)

## Erros
<a name="API_ListTagsForResource_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` não se refere a uma instância existente.   
Código de status HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` não se refere a um snapshot existente.   
Código de status HTTP: 404

## Consulte Também
<a name="API_ListTagsForResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ListTagsForResource) 

# ModifyDBCluster
<a name="API_ModifyDBCluster"></a>

Modifica uma configuração de um cluster do Amazon DocumentDB. É possível alterar um ou mais parâmetros de configuração do banco de dados especificando esses parâmetros e os novos valores na solicitação. 

## Parâmetros de solicitação
<a name="API_ModifyDBCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns que todas as ações utilizam, consulte [Parâmetros comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
O identificador do cluster que está sendo modificado. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Deve corresponder ao identificador de um `DBCluster` existente.
Tipo: String  
Obrigatório: Sim

 ** AllowMajorVersionUpgrade **   
Um valor que indica se as atualizações de versões principais são permitidas.  
Restrições:  
+ As atualizações de versões principais devem ser permitidas ao especificar um valor para o parâmetro `EngineVersion` que é uma versão principal diferente da versão atual do cluster.
+ Como alguns parâmetros são específicos da versão, alterá-los requer a execução de uma nova chamada da API `ModifyDBCluster` após a conclusão da MVU local.
A execução de uma MVU afeta diretamente os parâmetros a seguir:  
+  `MasterUserPassword` 
+  `NewDBClusterIdentifier` 
+  `VpcSecurityGroupIds` 
+  `Port` 
Tipo: booliano  
Obrigatório: não

 ** ApplyImmediately **   
Um valor que especifica se as alterações feitas nesta solicitação e todas as alterações pendentes serão aplicadas de maneira assíncrona assim que possível, independentemente da configuração `PreferredMaintenanceWindow` do cluster. Caso esse parâmetro seja definido como `false`, as alterações feitas no cluster serão aplicadas durante a próxima janela de manutenção.  
O parâmetro `ApplyImmediately` afeta somente os valores `NewDBClusterIdentifier` e `MasterUserPassword`. Se você definir o valor do parâmetro como `false`, as alterações nos valores `NewDBClusterIdentifier` e `MasterUserPassword` serão aplicados durante a próxima janela de manutenção. Todas as demais alterações serão aplicadas de imediato, independentemente do valor do parâmetro `ApplyImmediately`.  
Padrão: `false`   
Tipo: booliano  
Obrigatório: não

 ** BackupRetentionPeriod **   
O número de dias durante os quais os backups automatizados são retidos. É necessário especificar o valor mínimo de 1.  
Padrão: 1  
Restrições:  
+ Deve ser um valor de 1 a 35.
Tipo: inteiro  
Obrigatório: não

 ** CloudwatchLogsExportConfiguration **   
A configuração dos tipos de log a serem habilitados para exportação para o Amazon CloudWatch Logs para uma instância ou cluster específico. As `DisableLogTypes` matrizes `EnableLogTypes` e determinam quais registros são exportados (ou não exportados) para o Logs. CloudWatch   
Tipo: objeto [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md)  
Obrigatório: não

 ** DBClusterParameterGroupName **   
O nome do grupo de parâmetros do cluster a ser usado.  
Tipo: string  
Obrigatório: não

 ** DeletionProtection **   
Especifica se esse cluster pode ser excluído. Se `DeletionProtection` estiver ativado, o cluster não pode ser excluído, a menos que seja modificado e `DeletionProtection` esteja desabilitado. `DeletionProtection` protege clusters contra exclusão acidental.  
Tipo: booliano  
Obrigatório: não

 ** EngineVersion **   
O número da versão do mecanismo de banco de dados para o qual você deseja atualizar. Alterar esse parâmetro resulta em uma interrupção. A alteração será aplicada durante a próxima janela de manutenção, a menos que `ApplyImmediately` seja definido.  
Para listar todas as versões do mecanismo disponíveis para o Amazon DocumentDB, use o seguinte comando:  
 `aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"`   
Tipo: string  
Obrigatório: não

 ** ManageMasterUserPassword **   
Especifica se a senha do usuário principal deve ser gerenciada com o Amazon Web Services Secrets Manager. Se o cluster não gerenciar a senha do usuário principal com o Amazon Web Services Secrets Manager, será possível ativar esse gerenciamento. Nesse caso, você não pode especificar `MasterUserPassword`. Se o cluster já gerencia a senha do usuário principal com o Amazon Web Services Secrets Manager e você especifica que a senha do usuário principal não é gerenciada com o Amazon Web Services Secrets Manager, então você deve especificar `MasterUserPassword`. Nesse caso, o Amazon DocumentDB exclui o segredo e usa a nova senha para o usuário principal especificada por `MasterUserPassword`  
Tipo: booliano  
Obrigatório: não

 ** MasterUserPassword **   
A senha para o usuário do banco de dados principal. Ela pode conter qualquer caractere ASCII imprimível, exceto barra (/), aspas duplas (") ou arroba ("@").  
Restrições: deve conter de 8 a 100 caracteres.  
Tipo: String  
Obrigatório: não

 ** MasterUserSecretKmsKeyId **   
O identificador de chave do KMS do Amazon Web Services para criptografar um segredo que é gerado e gerenciado automaticamente no Amazon Web Services Secrets Manager.  
Essa configuração é válida somente caso ambas as condições a seguir sejam atendidas:  
+ O cluster não gerencia a senha do usuário principal no Amazon Web Services Secrets Manager. Se o cluster já estiver gerenciando a senha do usuário principal no Amazon Web Services Secrets Manager, não será possível alterar a chave do KMS usada para criptografar o segredo.
+ Você está habilitando `ManageMasterUserPassword` para gerenciar a senha do usuário principal no Amazon Web Services Secrets Manager. Se você estiver ativando `ManageMasterUserPassword` e não especificar `MasterUserSecretKmsKeyId`, a chave do `aws/secretsmanager` KMS será usada para criptografar o segredo. Se o segredo estiver em uma conta da Amazon Web Services diferente, você não poderá usar a chave do `aws/secretsmanager` KMS para criptografar o segredo e deverá usar uma chave do KMS gerenciada pelo cliente.
O identificador de chave do Amazon Web Services KMS é o ARN da chave, o ID da chave, o ARN do alias ou o nome do alias da chave do KMS. Para usar uma chave do KMS em outra da Amazon Web Services, é necessário usar o ARN da chave ou o ARN do alias.  
Há uma chave KMS padrão para sua conta do Amazon Web Services. Sua conta do Amazon Web Services tem uma chave KMS padrão diferente para cada região do Amazon Web Services.  
Tipo: String  
Obrigatório: não

 ** NetworkType **   
O tipo de rede do cluster.  
O tipo de rede é determinado usando o `DBSubnetGroup` especificado para o cluster. A `DBSubnetGroup` pode suportar somente o IPv4 protocolo ou o IPv4 e os IPv6 protocolos (`DUAL`).  
Para obter mais informações, consulte [Clusters do DocumentDB em uma VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) no Guia do desenvolvedor do Amazon DocumentDB.  
Valores válidos: `IPV4` \$1 `DUAL`   
Tipo: string  
Obrigatório: não

 ** NewDBClusterIdentifier **   
O novo identificador do cluster durante a renomeação de um cluster. Esse valor é armazenado como uma string em minúsculas.  
Restrições:  
+ Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
Exemplo: `my-cluster2`   
Tipo: string  
Obrigatório: não

 ** Port **   
O número da porta na qual o cluster aceita conexões.  
Restrições: deve ser um valor entre `1150` e `65535`.   
Padrão: a mesma porta que a do cluster original.  
Tipo: inteiro  
Obrigatório: não

 ** PreferredBackupWindow **   
O intervalo de tempo diário durante o qual os backups automatizados serão criados se eles forem habilitados com o parâmetro `BackupRetentionPeriod`.   
O padrão é uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de 8 horas para cada uma. Região da AWS  
Restrições:  
+ Deve estar no formato `hh24:mi-hh24:mi`.
+ Deve estar expresso no Tempo Universal Coordenado (UTC).
+ Não pode entrar em conflito com a janela de manutenção preferencial.
+ Deve ser, pelo menos, 30 minutos.
Tipo: string  
Obrigatório: não

 ** PreferredMaintenanceWindow **   
O intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, no Tempo Universal Coordenado (UTC).  
Formato: `ddd:hh24:mi-ddd:hh24:mi`.   
O padrão é uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de 8 horas para cada uma Região da AWS, ocorrendo em um dia aleatório da semana.   
Dias válidos: Seg, Ter, Qua, Qui, Sex, Sáb, Dom  
Restrições: janela mínima de 30 minutos.  
Tipo: String  
Obrigatório: não

 ** RotateMasterUserPassword **   
Especifica se o segredo gerenciado pelo Amazon Web Services Secrets Manager para a senha do usuário principal deve ser alternado.  
Essa configuração é válida somente se a senha do usuário principal for gerenciada pelo Amazon DocumentDB no Amazon Web Services Secrets Manager para o cluster. O valor do segredo contém a senha atualizada.  
Restrição: você deve aplicar a alteração imediatamente ao alternar a senha do usuário principal.  
Tipo: booliano  
Obrigatório: não

 ** ServerlessV2ScalingConfiguration **   
Contém a configuração de escalabilidade de um cluster do Amazon DocumentDB Sem Servidor.  
Tipo: objeto [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obrigatório: não

 ** StorageType **   
O tipo de armazenamento a ser associado ao cluster de banco de dados.  
Para obter informações sobre os tipos de armazenamento para clusters do Amazon DocumentDB, consulte Configurações de armazenamento do cluster no *Guia do desenvolvedor do Amazon DocumentDB*.  
Valores válidos para o tipo de armazenamento - `standard | iopt1`   
O valor padrão é `standard `.   
Tipo: string  
Obrigatório: não

 **VpcSecurityGroupIds. VpcSecurityGroupIdN.**   
Uma lista de grupos de segurança da nuvem privada virtual (VPC) a serem associados ao cluster.  
Tipo: matriz de strings  
Obrigatório: Não

## Elementos de Resposta
<a name="API_ModifyDBCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBCluster **   
Informações detalhadas sobre um cluster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Erros
<a name="API_ModifyDBCluster_Errors"></a>

Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
Você já tem um cluster com o identificador determinado.  
Código de status HTTP: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` não se refere a um grupo de parâmetros de cluster existente.   
Código de status HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` não se refere a um grupo de sub-redes existente.   
Código de status HTTP: 404

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de Status HTTP: 400

 ** InvalidDBInstanceState **   
 A instância especificada não está no estado *disponível*.   
Código de Status HTTP: 400

 ** InvalidDBSecurityGroupState **   
O estado do grupo de segurança não permite a exclusão.  
Código de status HTTP: 400

 ** InvalidDBSubnetGroupStateFault **   
O grupo de sub-redes não pode ser excluído porque está em uso.  
Código de status HTTP: 400

 ** InvalidSubnet **   
A sub-rede solicitada é inválida ou foram solicitadas várias sub-redes que não estão em uma nuvem privada virtual (VPC) comum.  
Código de status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
O grupo de sub-rede não cobre todas as zonas de disponibilidade depois de ter sido criado devido às alterações feitas.  
Código de status HTTP: 400

 ** NetworkTypeNotSupported **   
Não há suporte para o tipo de rede em nenhuma das versões do `DBSubnetGroup` ou do mecanismo de banco de dados.  
Código de status HTTP: 400

 ** StorageQuotaExceeded **   
A solicitação faria com que você excedesse a quantidade permitida de armazenamento disponível em todas as instâncias.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ModifyDBCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBCluster) 

# ModifyDBClusterParameterGroup
<a name="API_ModifyDBClusterParameterGroup"></a>

 Modifica os parâmetros de um grupo de parâmetros de cluster. Para modificar mais de um parâmetro, envie uma lista do seguinte: `ParameterName`, `ParameterValue` e `ApplyMethod`. No máximo, 20 parâmetros pode ser modificado em uma única solicitação. 

**nota**  
As alterações em parâmetros dinâmicos são aplicadas imediatamente. Alterações nos parâmetros estáticos exigem uma janela de reinicialização ou manutenção antes que a alteração possa entrar em vigor.

**Importante**  
Depois de criar um grupo de parâmetros do cluster, espere pelo menos 5 minutos para criar seu primeiro cluster que use esse grupo de parâmetros do clusters como o grupo de parâmetros padrão. Isso permite que o Amazon DocumentDB conclua totalmente a ação de criação antes que o grupo de parâmetros seja usado como padrão para um novo cluster. Esta etapa é especialmente importante para parâmetros que são críticos durante a criação do banco de dados padrão para um cluster, como o conjunto de caracteres para o banco de dados padrão definido pelo parâmetro `character_set_database`.

## Parâmetros da solicitação
<a name="API_ModifyDBClusterParameterGroup_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterParameterGroupName **   
O nome do grupo de parâmetros de cluster a ser modificado.  
Tipo: String  
Obrigatório: Sim

 **Parameters.Parameter.N**   
Uma lista de parâmetros no grupo de parâmetros de cluster a ser modificado.  
Tipo: matriz de objetos [Parameter](API_Parameter.md)  
Obrigatório: Sim

## Elementos de resposta
<a name="API_ModifyDBClusterParameterGroup_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBClusterParameterGroupName **   
O nome do grupo de parâmetros de um cluster.  
Restrições:  
+ Deve ter de 1 a 255 letras ou números.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
Esse valor é armazenado como uma string em minúsculas.
Tipo: string

## Erros
<a name="API_ModifyDBClusterParameterGroup_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` não se refere a um grupo de parâmetros existente.   
Código de status HTTP: 404

 ** InvalidDBParameterGroupState **   
O grupo de parâmetros está em uso ou está em um estado que não é válido. Se estiver tentando excluir o grupo de parâmetros, não poderá excluí-lo quando o grupo estiver nesse estado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ModifyDBClusterParameterGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 

# ModifyDBClusterSnapshotAttribute
<a name="API_ModifyDBClusterSnapshotAttribute"></a>

Adiciona um atributo e os valores ou remove um atributo e os valores de um snapshot do cluster de banco de dados manual.

Para compartilhar um snapshot manual do cluster com outros Contas da AWS, especifique `restore` como e use o `ValuesToAdd` parâmetro para adicionar uma lista IDs dos Contas da AWS que estão autorizados a restaurar o snapshot manual do cluster. `AttributeName` Use o valor `all` para tornar público o instantâneo manual do cluster, o que significa que ele pode ser copiado ou restaurado por todos os Contas da AWS. Não adicione o valor `all` de nenhum snapshot de cluster manual que contenha informações privadas que você não deseja que estejam disponíveis para todos Contas da AWS. Se um snapshot manual do cluster for criptografado, ele poderá ser compartilhado, mas somente especificando uma lista de autorizados Conta da AWS IDs para o `ValuesToAdd` parâmetro. Você não pode usar `all` como um valor para esse parâmetro nesse caso.

## Parâmetros da solicitação
<a name="API_ModifyDBClusterSnapshotAttribute_RequestParameters"></a>

 Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

 ** AttributeName **   
O nome do atributo do snapshot do cluster de banco de dados a ser modificado.  
Para gerenciar a autorização para Contas da AWS que outra pessoa copie ou restaure um snapshot manual do cluster, defina `restore` esse valor como.  
Tipo: String  
Obrigatório: sim

 ** DBClusterSnapshotIdentifier **   
O identificador do snapshot do cluster de banco de dados cujos atributos serão modificados.  
Tipo: String  
Obrigatório: Sim

 **ValuesToAdd. AttributeValueN.**   
Uma lista de atributos de snapshot do cluster de banco de dados a serem adicionados ao atributo especificado por `AttributeName`.  
Para autorizar outra pessoa Contas da AWS a copiar ou restaurar um snapshot manual do cluster, defina essa lista para incluir um ou mais. Conta da AWS IDs Para tornar o snapshot manual do cluster restaurável por qualquer um Conta da AWS, defina-o como. `all` Não adicione o valor `all` para nenhum snapshot de cluster manual que contenha informações privadas que você não deseja que estejam disponíveis para todos os Contas da AWS.  
Tipo: matriz de strings  
Obrigatório: Não

 **ValuesToRemove. AttributeValueN.**   
Uma lista de atributos de snapshot do cluster de banco de dados a serem removidos do atributo especificado por `AttributeName`.  
Para remover a autorização para Contas da AWS que outra pessoa copie ou restaure um snapshot manual do cluster, defina essa lista para incluir um ou mais Conta da AWS identificadores. Para remover a autorização de qualquer Conta da AWS pessoa para copiar ou restaurar o snapshot do cluster, defina-o como. `all` Se você especificar`all`, um Conta da AWS cujo ID de conta seja explicitamente adicionado ao `restore` atributo ainda poderá copiar ou restaurar um snapshot manual do cluster.  
Tipo: matriz de strings  
Obrigatório: Não

## Elementos de Resposta
<a name="API_ModifyDBClusterSnapshotAttribute_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBClusterSnapshotAttributesResult **   
Informações detalhadas sobre os atributos associados a um snapshot de cluster.  
Tipo: objeto [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)

## Erros
<a name="API_ModifyDBClusterSnapshotAttribute_Errors"></a>

Para obter informações sobre erros comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` não se refere a um snapshot de cluster existente.   
Código de Status HTTP: 404

 ** InvalidDBClusterSnapshotStateFault **   
O valor fornecido não é um estado de snapshot de cluster válido.  
Código de Status HTTP: 400

 ** SharedSnapshotQuotaExceeded **   
Você excedeu o número máximo de contas com as quais você pode compartilhar um DB snapshot manual.   
Código de Status HTTP: 400

## Consulte também
<a name="API_ModifyDBClusterSnapshotAttribute_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 

# ModifyDBInstance
<a name="API_ModifyDBInstance"></a>

Modifica as configurações de uma instância. É possível alterar um ou mais parâmetros de configuração do banco de dados especificando esses parâmetros e os novos valores na solicitação.

## Parâmetros de solicitação
<a name="API_ModifyDBInstance_RequestParameters"></a>

 Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

 ** DBInstanceIdentifier **   
O identificador da instância. Esse valor é armazenado como uma string em minúsculas.  
Restrições:  
+ Deve corresponder ao identificador de um `DBInstance` existente.
Tipo: String  
Obrigatório: Sim

 ** ApplyImmediately **   
Especifica se as modificações feitas nessa solicitação e todas as modificações pendentes serão aplicadas de maneira assíncrona logo que possível, independentemente da configuração `PreferredMaintenanceWindow` da instância de banco de dados.   
 Caso esse parâmetro seja definido como `false`, as alterações feitas na instância de banco de dados serão aplicadas durante a próxima janela de manutenção. Algumas alterações de parâmetro podem causar uma interrupção e serão aplicadas na próxima reinicialização.  
Padrão: `false`   
Tipo: booliano  
Obrigatório: Não

 ** AutoMinorVersionUpgrade **   
Esse parâmetro não é aplicável ao Amazon DocumentDB. O Amazon DocumentDB não faz atualizações de versões inferiores, independente do valor definido.  
Tipo: Booliano  
Obrigatório: Não

 ** CACertificateIdentifier **   
Indica o certificado que deve ser associado à instância.  
Tipo: String  
Obrigatório: não

 ** CertificateRotationRestart **   
Especifica se a instância de banco de dados é reiniciada quando você alterna seu certificado. SSL/TLS   
Por padrão, a instância de banco de dados é reiniciada quando você alterna seu SSL/TLS certificado. O certificado não é atualizado até que a instância de banco de dados seja reiniciada.  
Defina esse parâmetro somente se você *não* estiver usando SSL/TLS para se conectar à instância de banco de dados.
*Se você estiver usando SSL/TLS para se conectar à instância de banco de dados, consulte [Como atualizar seus certificados TLS do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) e [criptografar dados em trânsito no](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) Guia do desenvolvedor do Amazon DocumentDB.*  
Tipo: booliano  
Obrigatório: Não

 ** CopyTagsToSnapshot **   
Um valor que indica se todas as tags da instância de BD devem ser copiadas para snapshots da instância de BD. Por padrão, as tags não são copiadas.  
Tipo: Booliano  
Obrigatório: Não

 ** DBInstanceClass **   
A nova capacidade de computação e memória da instância. Por exemplo, `db.r5.large`. Nem todas as classes de instância estão disponíveis em todos os Regiões da AWS.   
Se você modificar a classe da instância, ocorrerá uma interrupção durante a alteração. A alteração será aplicada durante a próxima janela de manutenção, a menos que `ApplyImmediately` seja especificado como `true` para essa solicitação.   
Padrão: usa a configuração existente  
Tipo: String  
Obrigatório: Não

 ** EnablePerformanceInsights **   
Um valor que indica se deve ser ativado o Performance Insights para a instância de BD. Para obter mais informações, consulte [Usando insights de desempenho da Amazon](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).  
Tipo: Booliano  
Obrigatório: Não

 ** NewDBInstanceIdentifier **   
 O novo identificador da instância de banco de dados durante a renomeação de uma instância de banco de dados. Quando você altera o identificador da instância, a reinicialização da instância ocorre imediatamente se você definir `Apply Immediately` para `true`. Isso ocorrerá durante a próxima janela de manutenção se você definir `Apply Immediately` para `false`. Esse valor é armazenado como uma string em minúsculas.   
Restrições:  
+ Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
Exemplo: `mydbinstance`   
Tipo: string  
Obrigatório: não

 ** PerformanceInsightsKMSKeyId **   
O identificador AWS KMS chave para criptografia dos dados do Performance Insights.  
O identificador da AWS KMS chave é o ARN da chave, o ID da chave, o ARN do alias ou o nome do alias da chave KMS.  
Se você não especificar um valor para PerformanceInsights KMSKey Id, o Amazon DocumentDB usará sua chave KMS padrão. Há uma chave KMS padrão para sua conta do Amazon Web Services. Sua conta do Amazon Web Services tem uma chave KMS padrão diferente para cada região do Amazon Web Services.  
Tipo: String  
Obrigatório: Não

 ** PreferredMaintenanceWindow **   
O período semanal (em UTC) durante o qual pode ocorrer a manutenção do sistema, o que pode resultar em uma interrupção. A alteração desse parâmetro não resultará em uma interrupção, exceto na situação a seguir, e a alteração será aplicada de maneira assíncrona logo que possível. Se houver ações pendentes que causem uma reinicialização e a janela de manutenção for alterada para incluir a hora atual, a alteração desse parâmetro causará uma reinicialização da instância. Se essa janela for mudada para a hora atual, deverá haver pelo menos 30 minutos entre a hora atual e o final da janela para garantir que as alterações pendentes sejam aplicadas.  
Padrão: Usa a configuração existente  
Formato: `ddd:hh24:mi-ddd:hh24:mi`.   
Dias válidos: Seg, Ter, Qua, Qui, Sex, Sáb, Dom  
Restrições: deve ser, pelo menos, 30 minutos  
Tipo: String  
Obrigatório: Não

 ** PromotionTier **   
Um valor que especifica a ordem em que uma réplica do Amazon DocumentDB é promovida para a instância primária após uma falha da instância primária existente.  
Padrão: 1  
Valores válidos: 0 a 15  
Tipo: Inteiro  
Obrigatório: Não

## Elementos de Resposta
<a name="API_ModifyDBInstance_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBInstance **   
Informações detalhadas sobre uma instância.   
Tipo: objeto [DBInstance](API_DBInstance.md)

## Erros
<a name="API_ModifyDBInstance_Errors"></a>

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros comuns](CommonErrors.md).

 ** AuthorizationNotFound **   
O IP CIDR ou o grupo de segurança do Amazon EC2 especificado não está autorizado para o grupo de segurança especificado.  
O Amazon DocumentDB também pode não estar autorizado a executar as ações necessárias em seu nome usando o IAM.  
Código de Status HTTP: 404

 ** CertificateNotFound **   
 `CertificateIdentifier` não se refere a um certificado existente.   
Código de Status HTTP: 404

 ** DBInstanceAlreadyExists **   
Você já tem uma instância com o identificador informado.  
Código de Status HTTP: 400

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` não se refere a uma instância existente.   
Código de Status HTTP: 404

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` não se refere a um grupo de parâmetros existente.   
Código de Status HTTP: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` não se refere a um grupo de segurança existente.   
Código de status HTTP: 404

 ** DBUpgradeDependencyFailure **   
O upgrade falhou porque um recurso do qual ele depende não pode ser modificado.  
Código de Status HTTP: 400

 ** InsufficientDBInstanceCapacity **   
A classe de instância especificada não está disponível na Zona de Disponibilidade especificada.  
Código de Status HTTP: 400

 ** InvalidDBInstanceState **   
 A instância especificada não está no estado *disponível*.   
Código de Status HTTP: 400

 ** InvalidDBSecurityGroupState **   
O estado do grupo de segurança não permite a exclusão.  
Código de Status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
O grupo de sub-rede não cobre todas as zonas de disponibilidade depois de ter sido criado devido às alterações feitas.  
Código de Status HTTP: 400

 ** StorageQuotaExceeded **   
A solicitação faria com que você excedesse a quantidade permitida de armazenamento disponível em todas as instâncias.  
Código de status HTTP: 400

 ** StorageTypeNotSupported **   
O armazenamento do `StorageType` especificado não pode ser associado à instância do banco de dados.   
Código de Status HTTP: 400

## Consulte também
<a name="API_ModifyDBInstance_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBInstance) 

# ModifyDBSubnetGroup
<a name="API_ModifyDBSubnetGroup"></a>

Modifica um grupo de sub-rede. Grupos de sub-rede devem conter pelo menos uma sub-rede em pelo menos duas zonas de disponibilidade na Região da AWS.

## Parâmetros da solicitação
<a name="API_ModifyDBSubnetGroup_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns que todas as ações utilizam, consulte [Parâmetros comuns](CommonParameters.md).

 ** DBSubnetGroupName **   
O nome do grupo de sub-redes. Esse valor é armazenado como uma string em minúsculas. Você não pode modificar o grupo de sub-redes padrão.   
Restrições: deve corresponder ao nome de um `DBSubnetGroup` existente. Não deve ser padrão.  
Exemplo: `mySubnetgroup`   
Tipo: String  
Obrigatório: Sim

 **SubnetIds. SubnetIdentifierN.**   
A sub-rede Amazon EC2 IDs para o grupo de sub-redes.  
Tipo: matriz de strings  
Obrigatório: Sim

 ** DBSubnetGroupDescription **   
A descrição do grupo de sub-redes.  
Tipo: string  
Obrigatório: Não

## Elementos de Resposta
<a name="API_ModifyDBSubnetGroup_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBSubnetGroup **   
Informações detalhadas sobre um grupo de sub-redes.   
Tipo: objeto [DBSubnetGroup](API_DBSubnetGroup.md)

## Erros
<a name="API_ModifyDBSubnetGroup_Errors"></a>

Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
As sub-redes no grupo de sub-redes devem abranger pelo menos duas zonas de disponibilidade, a menos que haja apenas uma zona de disponibilidade.  
Código de status HTTP: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` não se refere a um grupo de sub-redes existente.   
Código de status HTTP: 404

 ** DBSubnetQuotaExceededFault **   
A solicitação faria com que o usuário excedesse o número permitido de grupos de sub-redes.  
Código de status HTTP: 400

 ** InvalidSubnet **   
A sub-rede solicitada é inválida ou foram solicitadas várias sub-redes que não estão em uma nuvem privada virtual (VPC) comum.  
Código de status HTTP: 400

 ** SubnetAlreadyInUse **   
A sub-rede já está em uso na zona de disponibilidade.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ModifyDBSubnetGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBSubnetGroup) 

# ModifyEventSubscription
<a name="API_ModifyEventSubscription"></a>

Modifica uma assinatura de notificação de evento existente do Amazon DocumentDB.

## Parâmetros de Solicitação
<a name="API_ModifyEventSubscription_RequestParameters"></a>

 Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

 ** SubscriptionName **   
O nome da assinatura de notificação de eventos do Amazon DocumentDB.  
Tipo: String  
Obrigatório: Sim

 ** Enabled **   
 Um valor Booleano; definido como `true` para ativar a assinatura.   
Tipo: Booliano  
Obrigatório: não

 **EventCategories. EventCategoryN.**   
 Uma lista de categorias de eventos para um `SourceType` em que você deseja se inscrever.  
Tipo: Matriz de strings  
Obrigatório: Não

 ** SnsTopicArn **   
O Amazon Resource Name (ARN) do tópico do SNS criado para notificação de eventos. O ARN é criado pelo Amazon SNS quando você cria um tópico e se inscreve nele.  
Tipo: String  
Obrigatório: Não

 ** SourceType **   
O tipo de origem gerando os eventos. Por exemplo, caso você queira ser notificado de eventos gerados por uma instância de banco de dados, defina esse parâmetro como `db-instance`. Se esse valor não for especificado, todos os eventos serão retornados.  
Valores válidos: `db-instance`, `db-parameter-group`, `db-security-group`   
Tipo: string  
Obrigatório: Não

## Elementos de Resposta
<a name="API_ModifyEventSubscription_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** EventSubscription **   
Informações detalhadas sobre um evento em você se inscreveu.  
Tipo: objeto [EventSubscription](API_EventSubscription.md)

## Erros
<a name="API_ModifyEventSubscription_Errors"></a>

Para obter informações sobre os erros comuns que todas as ações retornam, consulte [Erros comuns](CommonErrors.md).

 ** EventSubscriptionQuotaExceeded **   
O número máximo de assinaturas de eventos.   
Código de Status HTTP: 400

 ** SNSInvalidTopic **   
O Amazon SNS respondeu que há um problema com o tópico especificado.   
Código de Status HTTP: 400

 ** SNSNoAuthorization **   
Você não tem permissão para publicar no tópico do SNS nome do recurso da Amazon (ARN).   
Código de Status HTTP: 400

 ** SNSTopicArnNotFound **   
Não existe o tópico SNS nome do recurso da Amazon (ARN).   
Código de Status HTTP: 404

 ** SubscriptionCategoryNotFound **   
A categoria fornecida não existe.   
Código de Status HTTP: 404

 ** SubscriptionNotFound **   
O nome da assinatura não existe.   
Código de Status HTTP: 404

## Consulte Também
<a name="API_ModifyEventSubscription_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyEventSubscription) 

# ModifyGlobalCluster
<a name="API_ModifyGlobalCluster"></a>

Modificar uma configuração de um cluster do Amazon DocumentDB global. É possível alterar um ou mais parâmetros de configuração (por exemplo: proteção contra exclusão) ou o identificador global do cluster especificando esses parâmetros e os novos valores na solicitação.

**nota**  
Essa ação se aplica somente aos clusters do Amazon DocumentDB.

## Parâmetros da solicitação
<a name="API_ModifyGlobalCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** GlobalClusterIdentifier **   
O identificador do cluster global que está sendo modificado. Este parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Deve ser o identificador de um cluster existente.
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: Sim

 ** DeletionProtection **   
Indica se o cluster global tem a proteção contra exclusão habilitada. O cluster global não pode ser excluído quando a proteção contra exclusão estiver habilitada.   
Tipo: booleano  
Obrigatório: não

 ** NewGlobalClusterIdentifier **   
O novo identificador de um cluster global quando você modifica um cluster global. Esse valor é armazenado como uma string em minúsculas.  
+ Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens

  O primeiro caractere deve ser uma letra

  Não pode terminar com um hífen nem conter dois hifens consecutivos
Exemplo: `my-cluster2`   
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: Não

## Elementos de Resposta
<a name="API_ModifyGlobalCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** GlobalCluster **   
Um tipo de dado que representa um cluster global do Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

## Erros
<a name="API_ModifyGlobalCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` não se refere a um cluster global existente.  
Código de status HTTP: 404

 ** InvalidGlobalClusterStateFault **   
A operação solicitada não pode ser executada enquanto o cluster estiver nesse estado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ModifyGlobalCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyGlobalCluster) 

# RebootDBInstance
<a name="API_RebootDBInstance"></a>

É possível precisar reinicializar sua instância, geralmente, por motivos de manutenção. Por exemplo, se você fizer determinadas modificações ou alterar o grupo de parâmetros de cluster associado à instância, deverá reiniciar a instância para que as alterações sejam implementadas. 

Reinicializar uma instância reinicia o serviço de mecanismo de banco de dados. Reinicializar uma instância resulta em uma interrupção momentânea, durante a qual o status da instância é definido como *reinicialização*. 

## Parâmetros da solicitação
<a name="API_RebootDBInstance_RequestParameters"></a>

 Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

 ** DBInstanceIdentifier **   
O identificador da instância. Este parâmetro é armazenado como uma string com letras minúsculas.  
Restrições:  
+ Deve corresponder ao identificador de um `DBInstance` existente.
Tipo: String  
Obrigatório: Sim

 ** ForceFailover **   
 Quando `true`, a reinicialização é feita por meio de um failover de Multi-AZ.   
Restrição: não será possível especificar `true` se a instância não estiver configurada para Multi-AZ.  
Tipo: booliano  
Obrigatório: Não

## Elementos de Resposta
<a name="API_RebootDBInstance_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBInstance **   
Informações detalhadas sobre uma instância.   
Tipo: objeto [DBInstance](API_DBInstance.md)

## Erros
<a name="API_RebootDBInstance_Errors"></a>

Para obter informações sobre os erros comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` não se refere a uma instância existente.   
Código de status HTTP: 404

 ** InvalidDBInstanceState **   
 A instância especificada não está no estado *disponível*.   
Código de Status HTTP: 400

## Consulte também
<a name="API_RebootDBInstance_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RebootDBInstance) 

# RemoveFromGlobalCluster
<a name="API_RemoveFromGlobalCluster"></a>

Separa um cluster secundário do Amazon DocumentDB de um cluster global. O cluster se torna um cluster autônomo com capacidade de leitura e gravação em vez de ser somente para leitura e receber dados de um primário em uma região diferente. 

**nota**  
Essa ação se aplica somente aos clusters do Amazon DocumentDB.

## Parâmetros da solicitação
<a name="API_RemoveFromGlobalCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DbClusterIdentifier **   
O Nome do recurso da Amazon (ARN) identificando o cluster que foi separado do cluster global do Amazon DocumentDB.   
Tipo: String  
Obrigatório: Sim

 ** GlobalClusterIdentifier **   
O identificador de cluster a ser separado do cluster global Amazon DocumentDB.   
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: sim

## Elementos de resposta
<a name="API_RemoveFromGlobalCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** GlobalCluster **   
Um tipo de dado que representa um cluster global do Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

## Erros
<a name="API_RemoveFromGlobalCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` não se refere a um cluster global existente.  
Código de status HTTP: 404

 ** InvalidGlobalClusterStateFault **   
A operação solicitada não pode ser executada enquanto o cluster estiver nesse estado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_RemoveFromGlobalCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveFromGlobalCluster) 

# RemoveSourceIdentifierFromSubscription
<a name="API_RemoveSourceIdentifierFromSubscription"></a>

Remove um identificador de origem de uma assinatura de notificações de eventos Amazon DocumentDB existente.

## Parâmetros da solicitação
<a name="API_RemoveSourceIdentifierFromSubscription_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** SourceIdentifier **   
 O identificador de origem a ser removido da assinatura, como o identificador de instância de banco de dados para uma instância ou o nome de um grupo de segurança.   
Tipo: String  
Obrigatório: Sim

 ** SubscriptionName **   
O nome da assinatura de notificações de eventos Amazon DocumentDB da qual você deseja remover um identificador de origem.  
Tipo: String  
Obrigatório: Sim

## Elementos de resposta
<a name="API_RemoveSourceIdentifierFromSubscription_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** EventSubscription **   
Informações detalhadas sobre um evento em você se inscreveu.  
Tipo: objeto [EventSubscription](API_EventSubscription.md)

## Erros
<a name="API_RemoveSourceIdentifierFromSubscription_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Erros comuns](CommonErrors.md).

 ** SourceNotFound **   
Não foi possível encontrar a origem solicitada.   
Código de status HTTP: 404

 ** SubscriptionNotFound **   
O nome da assinatura não existe.   
Código de Status HTTP: 404

## Consulte Também
<a name="API_RemoveSourceIdentifierFromSubscription_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 

# RemoveTagsFromResource
<a name="API_RemoveTagsFromResource"></a>

Remove as tags de metadados de um recurso do Amazon DocumentDB.

## Parâmetros da solicitação
<a name="API_RemoveTagsFromResource_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** ResourceName **   
O recurso do Amazon DocumentDB do qual as tags são removidas. Esse valor é um nome do recurso da Amazon (ARN).  
Tipo: String  
Obrigatório: Sim

 **TagKeys.Membro.**   
A chave (nome) da tag a ser removida.  
Tipo: matriz de strings  
Obrigatório: Sim

## Erros
<a name="API_RemoveTagsFromResource_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` não se refere a uma instância existente.   
Código de status HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` não se refere a um snapshot existente.   
Código de status HTTP: 404

## Consulte Também
<a name="API_RemoveTagsFromResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveTagsFromResource) 

# ResetDBClusterParameterGroup
<a name="API_ResetDBClusterParameterGroup"></a>

 Modifica os parâmetros de um grupo de parâmetros de cluster para o valor padrão. Para redefinir parâmetros específicos, envie uma lista do seguinte: `ParameterName` e `ApplyMethod`. Para redefinir todo o grupo de parâmetros de cluster, especifique os parâmetros `DBClusterParameterGroupName` e `ResetAllParameters`. 

 Quando você redefine todo o grupo, os parâmetros dinâmicos são atualizados imediatamente e os parâmetros estáticos são definidos como `pending-reboot` para entrar em vigor na próxima reinicialização da instância de banco de dados.

## Parâmetros da solicitação
<a name="API_ResetDBClusterParameterGroup_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterParameterGroupName **   
O nome do grupo de parâmetro de cluster a ser redefinido.  
Tipo: String  
Obrigatório: Sim

 **Parâmetros.Parâmetro.N**   
Uma lista de nomes de parâmetros no grupo de parâmetros de cluster de banco de dados a serem redefinidos como valores padrão. Você não poderá usar esse parâmetro se o parâmetro `ResetAllParameters` estiver definido como `true`.  
Tipo: matriz de objetos [Parameter](API_Parameter.md)  
Obrigatório: não

 ** ResetAllParameters **   
Um valor definido como `true` para redefinir todos os parâmetros do grupo de parâmetros de cluster de banco de dados como seus valores padrão; caso contrário, `false`. Você não poderá usar esse parâmetro se houver uma lista de nomes de parâmetros especificados para o parâmetro `Parameters`.  
Tipo: booliano  
Obrigatório: Não

## Elementos de Resposta
<a name="API_ResetDBClusterParameterGroup_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBClusterParameterGroupName **   
O nome do grupo de parâmetros de um cluster.  
Restrições:  
+ Deve ter de 1 a 255 letras ou números.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
Esse valor é armazenado como uma string em minúsculas.
Tipo: string

## Erros
<a name="API_ResetDBClusterParameterGroup_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` não se refere a um grupo de parâmetros existente.   
Código de status HTTP: 404

 ** InvalidDBParameterGroupState **   
O grupo de parâmetros está em uso ou está em um estado que não é válido. Se estiver tentando excluir o grupo de parâmetros, não poderá excluí-lo quando o grupo estiver nesse estado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_ResetDBClusterParameterGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 

# RestoreDBClusterFromSnapshot
<a name="API_RestoreDBClusterFromSnapshot"></a>

Cria um novo cluster a partir de um snapshot ou de um snapshot de cluster.

Se um snapshot for especificado, o cluster de destino será criado a partir do DB snapshot de origem com uma configuração e um grupo de segurança padrão.

Se um snapshot do cluster for especificado, o cluster de destino será criado a partir do ponto de restauração do cluster de origem com a mesma configuração do cluster de banco de dados original, exceto pelo fato de que o novo cluster será criado com o grupo de segurança padrão.

## Parâmetros da solicitação
<a name="API_RestoreDBClusterFromSnapshot_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
O nome do cluster a ser criado a partir do snapshot ou do snapshot do cluster. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
Exemplo: `my-snapshot-id`   
Tipo: String  
Obrigatório: Sim

 ** Engine **   
O mecanismo de banco de dados a utilizar para o novo cluster.  
Padrão: o mesmo que a origem  
Restrição: deve ser compatível com o mecanismo da origem  
Tipo: String  
Obrigatório: Sim

 ** SnapshotIdentifier **   
O identificador do qual restaurar o snapshot ou o snapshot do cluster.  
É possível usar o nome ou o nome de recurso da Amazon (ARN) para especificar um snapshot de cluster. No entanto, para especificar um snapshot você só pode usar o ARN.  
Restrições:  
+ Deve corresponder ao identificador de um snapshot existente.
Tipo: String  
Obrigatório: Sim

 **AvailabilityZones. AvailabilityZoneN.**   
Fornece a lista de zonas de disponibilidade do Amazon EC2 nas quais as instâncias no snapshot de cluster de banco de dados restaurado podem ser criadas.  
Tipo: matriz de strings  
Obrigatório: Não

 ** DBClusterParameterGroupName **   
O nome do grupo de parâmetros de cluster de banco de dados para associar a este cluster de banco de dados.  
 *Tipo*: string       *Obrigatório*: não  
Se esse argumento for omitido, o grupo de parâmetros de cluster de banco de dados padrão será usado. Se fornecido, deverá corresponder ao nome de um grupo de parâmetros de cluster de banco de dados padrão. A string deve consistir de 1 a 255 letras, números ou hifens. Seu primeiro caractere deve ser uma letra e não pode terminar com hífen ou conter dois hífens consecutivos.  
Tipo: string  
Obrigatório: não

 ** DBSubnetGroupName **   
O nome do grupo de sub-redes a ser usado no novo cluster.  
Restrições: se fornecidas, devem corresponder ao nome de um `DBSubnetGroup` existente.  
Exemplo: `mySubnetgroup`   
Tipo: string  
Obrigatório: não

 ** DeletionProtection **   
Especifica se esse cluster pode ser excluído. Se `DeletionProtection` estiver ativado, o cluster não pode ser excluído, a menos que seja modificado e `DeletionProtection` esteja desabilitado. `DeletionProtection` protege clusters contra exclusão acidental.  
Tipo: booliano  
Obrigatório: não

 **EnableCloudwatchLogsExports.Membro.**   
Uma lista de tipos de log que devem ser habilitados para exportação para o Amazon CloudWatch Logs.  
Tipo: matriz de strings  
Obrigatório: Não

 ** EngineVersion **   
A versão do mecanismo de banco de dados a ser usada para o novo cluster.  
Tipo: string  
Obrigatório: não

 ** KmsKeyId **   
O identificador de AWS KMS chave a ser usado ao restaurar um cluster criptografado a partir de um DB snapshot ou cluster snapshot.  
O identificador da AWS KMS chave é o Amazon Resource Name (ARN) da chave de AWS KMS criptografia. Se você estiver restaurando um cluster com o mesmo Conta da AWS proprietário da chave de AWS KMS criptografia usada para criptografar o novo cluster, poderá usar o alias da AWS KMS chave em vez do ARN da chave de criptografia. AWS KMS   
Se você não especificar um valor para o parâmetro `KmsKeyId`, ocorrerá o seguinte:  
+ Se o snapshot ou o snapshot do cluster `SnapshotIdentifier` estiver criptografado, o cluster restaurado será criptografado usando a AWS KMS chave usada para criptografar o snapshot ou o snapshot do cluster.
+ Se o snapshot ou o snapshot do cluster em `SnapshotIdentifier` não estiver criptografado, o cluster de banco de dados restaurado não será criptografado.
Tipo: string  
Obrigatório: não

 ** NetworkType **   
O tipo de rede do cluster.  
O tipo de rede é determinado usando o `DBSubnetGroup` especificado para o cluster. A `DBSubnetGroup` pode suportar somente o IPv4 protocolo ou o IPv4 e os IPv6 protocolos (`DUAL`).  
Para obter mais informações, consulte [Clusters do DocumentDB em uma VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) no Guia do desenvolvedor do Amazon DocumentDB.  
Valores válidos: `IPV4` \$1 `DUAL`   
Tipo: string  
Obrigatório: não

 ** Port **   
O número da porta na qual o novo cluster aceita conexões.  
Restrições: deve ser um valor entre `1150` e `65535`.  
Padrão: a mesma porta que a do cluster original.  
Tipo: inteiro  
Obrigatório: não

 ** ServerlessV2ScalingConfiguration **   
Contém a configuração de escalabilidade de um cluster do Amazon DocumentDB Sem Servidor.  
Tipo: objeto [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obrigatório: não

 ** StorageType **   
O tipo de armazenamento a ser associado ao cluster de banco de dados.  
Para obter informações sobre os tipos de armazenamento para clusters do Amazon DocumentDB, consulte Configurações de armazenamento do cluster no *Guia do desenvolvedor do Amazon DocumentDB*.  
Valores válidos para o tipo de armazenamento - `standard | iopt1`   
O valor padrão é `standard `.   
Tipo: string  
Obrigatório: não

 **Tags.Tag.N**   
As tags a serem atribuídas ao cluster restaurado.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: não

 **VpcSecurityGroupIds. VpcSecurityGroupIdN.**   
Uma lista de grupos de segurança da nuvem privada virtual (VPC) à qual o novo cluster pertencerá.  
Tipo: matriz de strings  
Obrigatório: Não

## Elementos de Resposta
<a name="API_RestoreDBClusterFromSnapshot_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBCluster **   
Informações detalhadas sobre um cluster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Erros
<a name="API_RestoreDBClusterFromSnapshot_Errors"></a>

Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
Você já tem um cluster com o identificador determinado.  
Código de status HTTP: 400

 ** DBClusterQuotaExceededFault **   
O cluster não pode ser criado porque você atingiu a cota máxima permitida de clusters.  
Código de status HTTP: 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` não se refere a um snapshot de cluster existente.   
Código de status HTTP: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` não se refere a um snapshot existente.   
Código de status HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` não se refere a um grupo de sub-redes existente.   
Código de status HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` não se refere a um grupo de sub-redes existente.   
Código de status HTTP: 404

 ** InsufficientDBClusterCapacityFault **   
O cluster não tem capacidade suficiente para a operação atual.  
Código de status HTTP: 403

 ** InsufficientStorageClusterCapacity **   
Não há armazenamento suficiente disponível para a ação atual. É possível resolver esse erro atualizando seu grupo de sub-redes para usar outras zonas de disponibilidade que tenham mais espaço de armazenamento disponível.   
Código de status HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
O valor fornecido não é um estado de snapshot de cluster válido.  
Código de status HTTP: 400

 ** InvalidDBSnapshotState **   
O estado do snapshot não permite a exclusão.  
Código de status HTTP: 400

 ** InvalidRestoreFault **   
Não é possível restaurar de um backup de nuvem privada virtual (VPC) para uma instância de banco de dados que não seja da VPC.  
Código de status HTTP: 400

 ** InvalidSubnet **   
A sub-rede solicitada é inválida ou foram solicitadas várias sub-redes que não estão em uma nuvem privada virtual (VPC) comum.  
Código de status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
O grupo de sub-rede não cobre todas as zonas de disponibilidade depois de ter sido criado devido às alterações feitas.  
Código de status HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Ocorreu um erro ao acessar uma AWS KMS chave.  
Código de status HTTP: 400

 ** NetworkTypeNotSupported **   
Não há suporte para o tipo de rede em nenhuma das versões do `DBSubnetGroup` ou do mecanismo de banco de dados.  
Código de status HTTP: 400

 ** StorageQuotaExceeded **   
A solicitação faria com que você excedesse a quantidade permitida de armazenamento disponível em todas as instâncias.  
Código de status HTTP: 400

 ** StorageQuotaExceeded **   
A solicitação faria com que você excedesse a quantidade permitida de armazenamento disponível em todas as instâncias.  
Código de Status HTTP: 400

## Consulte também
<a name="API_RestoreDBClusterFromSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 

# RestoreDBClusterToPointInTime
<a name="API_RestoreDBClusterToPointInTime"></a>

Restaura um cluster para um momento arbitrário. Os usuários podem restaurar para qualquer point-in-time antes de `LatestRestorableTime` por até `BackupRetentionPeriod` dias. O cluster de banco de destino é criado a partir do cluster de de origem com a mesma configuração do cluster original, exceto pelo fato de que o novo cluster será criado com o grupo de segurança padrão. 

## Parâmetros da solicitação
<a name="API_RestoreDBClusterToPointInTime_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
O nome do novo cluster a ser criado.  
Restrições:  
+ Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
Tipo: String  
Obrigatório: Sim

 ** SourceDBClusterIdentifier **   
O identificador do cluster de origem do qual restaurar.  
Restrições:  
+ Deve corresponder ao identificador de um `DBCluster` existente.
Tipo: String  
Obrigatório: Sim

 ** DBSubnetGroupName **   
O nome do grupo de sub-redes de a ser usado para o novo cluster.  
Restrições: se fornecidas, devem corresponder ao nome de um `DBSubnetGroup` existente.  
Exemplo: `mySubnetgroup`   
Tipo: string  
Obrigatório: não

 ** DeletionProtection **   
Especifica se esse cluster pode ser excluído. Se `DeletionProtection` estiver ativado, o cluster não pode ser excluído, a menos que seja modificado e `DeletionProtection` esteja desabilitado. `DeletionProtection` protege clusters contra exclusão acidental.  
Tipo: booliano  
Obrigatório: não

 **EnableCloudwatchLogsExports.Membro.**   
Uma lista de tipos de log que devem ser habilitados para exportação para o Amazon CloudWatch Logs.  
Tipo: matriz de strings  
Obrigatório: Não

 ** KmsKeyId **   
O identificador de AWS KMS chave a ser usado ao restaurar um cluster criptografado a partir de um cluster criptografado.  
O identificador da AWS KMS chave é o Amazon Resource Name (ARN) da chave de AWS KMS criptografia. Se você estiver restaurando um cluster com o mesmo Conta da AWS proprietário da chave de AWS KMS criptografia usada para criptografar o novo cluster, poderá usar o alias da AWS KMS chave em vez do ARN da chave de criptografia. AWS KMS   
Você pode restaurar em um novo cluster e criptografar o novo cluster com uma AWS KMS chave diferente da AWS KMS chave usada para criptografar o cluster de origem. O novo cluster de banco de dados é criptografado com a AWS KMS chave identificada pelo `KmsKeyId` parâmetro.  
Se você não especificar um valor para o parâmetro `KmsKeyId`, ocorrerá o seguinte:  
+ Se o cluster for criptografado, o cluster restaurado será criptografado usando a AWS KMS chave usada para criptografar o cluster de origem.
+ Se o cluster não estiver criptografado, o cluster restaurado não será criptografado.
Se `DBClusterIdentifier` referir-se a um cluster não criptografado, a solicitação de restauração será rejeitada.  
Tipo: string  
Obrigatório: não

 ** NetworkType **   
O tipo de rede do cluster.  
O tipo de rede é determinado usando o `DBSubnetGroup` especificado para o cluster. A `DBSubnetGroup` pode suportar somente o IPv4 protocolo ou o IPv4 e os IPv6 protocolos (`DUAL`).  
Para obter mais informações, consulte [Clusters do DocumentDB em uma VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) no Guia do desenvolvedor do Amazon DocumentDB.  
Valores válidos: `IPV4` \$1 `DUAL`   
Tipo: string  
Obrigatório: não

 ** Port **   
O número da porta na qual o novo cluster aceita conexões.  
Restrições: deve ser um valor entre `1150` e `65535`.   
Padrão: A porta padrão do mecanismo.  
Tipo: inteiro  
Obrigatório: não

 ** RestoreToTime **   
A data e a hora para as quais restaurar o cluster.  
Valores válidos: um horário no formato Universal Coordinated Time (UTC).  
Restrições:  
+ Devem ser anteriores ao último horário restaurável da instância.
+ Devem ser especificadas se o parâmetro `UseLatestRestorableTime` não for especificado.
+ Não podem ser especificadas se o parâmetro `UseLatestRestorableTime` for `true`.
+ Não podem ser especificadas se o parâmetro `RestoreType` for `copy-on-write`.
Exemplo: `2015-03-07T23:45:00Z`   
Tipo: carimbo de hora  
Obrigatório: não

 ** RestoreType **   
O tipo de restauração a ser realizada. É possível especificar um dos seguintes valores:  
+  `full-copy` - o novo cluster de banco de dados é restaurado como uma cópia completa do cluster de banco de dados de origem.
+  `copy-on-write` - o novo cluster de banco de dados é restaurado como um clone do cluster de banco de dados de origem.
Restrições: você não pode especificar `copy-on-write` se a versão do mecanismo do cluster de banco de dados de origem for anterior à 1.11.  
Se você não especificar um valor `RestoreType`, o novo cluster de banco de dados será restaurado como uma cópia completa do cluster de banco de dados de origem.  
Tipo: string  
Obrigatório: não

 ** ServerlessV2ScalingConfiguration **   
Contém a configuração de escalabilidade de um cluster do Amazon DocumentDB Sem Servidor.  
Tipo: objeto [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)  
Obrigatório: não

 ** StorageType **   
O tipo de armazenamento a ser associado ao cluster de banco de dados.  
Para obter informações sobre os tipos de armazenamento para clusters do Amazon DocumentDB, consulte Configurações de armazenamento do cluster no *Guia do desenvolvedor do Amazon DocumentDB*.  
Valores válidos para o tipo de armazenamento - `standard | iopt1`   
O valor padrão é `standard `.   
Tipo: string  
Obrigatório: não

 **Tags.Tag.N**   
As tags a serem atribuídas ao cluster restaurado.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: não

 ** UseLatestRestorableTime **   
Um valor que é definido como `true` para restaurar o cluster para o horário do backup restaurável mais recente. Caso contrário, `false`.   
Padrão: `false`   
Restrições: não poderão ser especificadas se o parâmetro `RestoreToTime` for fornecido.  
Tipo: booliano  
Obrigatório: não

 **VpcSecurityGroupIds. VpcSecurityGroupIdN.**   
Uma lista de grupos de segurança da VPC à qual o novo cluster pertence.  
Tipo: matriz de strings  
Obrigatório: Não

## Elementos de Resposta
<a name="API_RestoreDBClusterToPointInTime_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBCluster **   
Informações detalhadas sobre um cluster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Erros
<a name="API_RestoreDBClusterToPointInTime_Errors"></a>

Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterAlreadyExistsFault **   
Você já tem um cluster com o identificador determinado.  
Código de status HTTP: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** DBClusterQuotaExceededFault **   
O cluster não pode ser criado porque você atingiu a cota máxima permitida de clusters.  
Código de status HTTP: 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` não se refere a um snapshot de cluster existente.   
Código de status HTTP: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` não se refere a um grupo de sub-redes existente.   
Código de status HTTP: 404

 ** InsufficientDBClusterCapacityFault **   
O cluster não tem capacidade suficiente para a operação atual.  
Código de status HTTP: 403

 ** InsufficientStorageClusterCapacity **   
Não há armazenamento suficiente disponível para a ação atual. É possível resolver esse erro atualizando seu grupo de sub-redes para usar outras zonas de disponibilidade que tenham mais espaço de armazenamento disponível.   
Código de status HTTP: 400

 ** InvalidDBClusterSnapshotStateFault **   
O valor fornecido não é um estado de snapshot de cluster válido.  
Código de status HTTP: 400

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de status HTTP: 400

 ** InvalidDBSnapshotState **   
O estado do snapshot não permite a exclusão.  
Código de status HTTP: 400

 ** InvalidRestoreFault **   
Não é possível restaurar de um backup de nuvem privada virtual (VPC) para uma instância de banco de dados que não seja da VPC.  
Código de status HTTP: 400

 ** InvalidSubnet **   
A sub-rede solicitada é inválida ou foram solicitadas várias sub-redes que não estão em uma nuvem privada virtual (VPC) comum.  
Código de status HTTP: 400

 ** InvalidVPCNetworkStateFault **   
O grupo de sub-rede não cobre todas as zonas de disponibilidade depois de ter sido criado devido às alterações feitas.  
Código de status HTTP: 400

 ** KMSKeyNotAccessibleFault **   
Ocorreu um erro ao acessar uma AWS KMS chave.  
Código de status HTTP: 400

 ** NetworkTypeNotSupported **   
Não há suporte para o tipo de rede em nenhuma das versões do `DBSubnetGroup` ou do mecanismo de banco de dados.  
Código de status HTTP: 400

 ** StorageQuotaExceeded **   
A solicitação faria com que você excedesse a quantidade permitida de armazenamento disponível em todas as instâncias.  
Código de Status HTTP: 400

## Consulte também
<a name="API_RestoreDBClusterToPointInTime_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 

# StartDBCluster
<a name="API_StartDBCluster"></a>

Reinicia o cluster interrompido especificado por `DBClusterIdentifier`. Para obter mais informações, consulte [Interromper e iniciar um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).

## Parâmetros da solicitação
<a name="API_StartDBCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
O identificador do cluster a ser reiniciado. Exemplo: `docdb-2019-05-28-15-24-52`   
Tipo: String  
Obrigatório: Sim

## Elementos de resposta
<a name="API_StartDBCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBCluster **   
Informações detalhadas sobre um cluster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Erros
<a name="API_StartDBCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de Status HTTP: 404

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de Status HTTP: 400

 ** InvalidDBInstanceState **   
 A instância especificada não está no estado *disponível*.   
Código de Status HTTP: 400

## Consulte também
<a name="API_StartDBCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StartDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StartDBCluster) 

# StopDBCluster
<a name="API_StopDBCluster"></a>

Interrompe o cluster em execução especificado por `DBClusterIdentifier`. O cluster deve estar no estado *disponível*. Para obter mais informações, consulte [Interromper e iniciar um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).

## Parâmetros da solicitação
<a name="API_StopDBCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** DBClusterIdentifier **   
O identificador do cluster a ser interrompido. Exemplo: `docdb-2019-05-28-15-24-52`   
Tipo: String  
Obrigatório: Sim

## Elementos de resposta
<a name="API_StopDBCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBCluster **   
Informações detalhadas sobre um cluster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Erros
<a name="API_StopDBCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de Status HTTP: 404

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de Status HTTP: 400

 ** InvalidDBInstanceState **   
 A instância especificada não está no estado *disponível*.   
Código de Status HTTP: 400

## Consulte também
<a name="API_StopDBCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StopDBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StopDBCluster) 

# SwitchoverGlobalCluster
<a name="API_SwitchoverGlobalCluster"></a>

Alterna o cluster secundário especificado do Amazon DocumentDB para ser o novo cluster primário do Amazon DocumentDB no cluster de banco de dados global.

## Parâmetros da solicitação
<a name="API_SwitchoverGlobalCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** GlobalClusterIdentifier **   
O identificador do cluster de banco de dados global do Amazon DocumentDB para alternar. O identificador é a chave exclusiva atribuída pelo usuário quando o cluster é criado. Em outras palavras, é o nome do cluster global. Este parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Deve ser o identificador de um cluster global existente (banco de dados global do Amazon DocumentDB).
+ Tamanho mínimo de 1. Comprimento máximo de 255.
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: Sim

 ** TargetDbClusterIdentifier **   
O identificador do cluster secundário do Amazon DocumentDB a ser promovido ao novo primário do cluster de banco de dados global. Use o Amazon Resource Name (ARN) como identificador para que o Amazon DocumentDB possa localizar o cluster em sua região. AWS   
Restrições:  
+ Deve ser o identificador de um cluster secundário existente.
+ Tamanho mínimo de 1. Comprimento máximo de 255.
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: sim

## Elementos de resposta
<a name="API_SwitchoverGlobalCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** GlobalCluster **   
Um tipo de dado que representa um cluster global do Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

## Erros
<a name="API_SwitchoverGlobalCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` não se refere a um cluster global existente.  
Código de status HTTP: 404

 ** InvalidDBClusterStateFault **   
O cluster não está em um estado válido.  
Código de status HTTP: 400

 ** InvalidGlobalClusterStateFault **   
A operação solicitada não pode ser executada enquanto o cluster estiver nesse estado.  
Código de Status HTTP: 400

## Consulte também
<a name="API_SwitchoverGlobalCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/SwitchoverGlobalCluster) 

# Amazon DocumentDB Elastic Clusters
<a name="API_Operations_Amazon_DocumentDB_Elastic_Clusters"></a>

As seguintes ações são compatíveis com Amazon DocumentDB Elastic Clusters:
+  [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) 
+  [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) 
+  [CreateCluster](API_elastic_CreateCluster.md) 
+  [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) 
+  [DeleteCluster](API_elastic_DeleteCluster.md) 
+  [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) 
+  [GetCluster](API_elastic_GetCluster.md) 
+  [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) 
+  [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) 
+  [ListClusters](API_elastic_ListClusters.md) 
+  [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) 
+  [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) 
+  [ListTagsForResource](API_elastic_ListTagsForResource.md) 
+  [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) 
+  [StartCluster](API_elastic_StartCluster.md) 
+  [StopCluster](API_elastic_StopCluster.md) 
+  [TagResource](API_elastic_TagResource.md) 
+  [UntagResource](API_elastic_UntagResource.md) 
+  [UpdateCluster](API_elastic_UpdateCluster.md) 

# ApplyPendingMaintenanceAction
<a name="API_elastic_ApplyPendingMaintenanceAction"></a>

O tipo de ação de manutenção pendente a ser aplicada ao recurso.

## Sintaxe da Solicitação
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestSyntax"></a>

```
POST /pending-action HTTP/1.1
Content-type: application/json

{
   "applyAction": "string",
   "applyOn": "string",
   "optInType": "string",
   "resourceArn": "string"
}
```

## Parâmetros da solicitação de URI
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyAction"></a>
A ação de manutenção pendente a ser aplicada ao recurso.  
As ações válidas são:  
+  `ENGINE_UPDATE ` 
+  `ENGINE_UPGRADE` 
+  `SECURITY_UPDATE` 
+  `OS_UPDATE` 
+  `MASTER_USER_PASSWORD_UPDATE` 
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256.  
Obrigatório: sim

 ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-optInType"></a>
Um valor que especifica o tipo de solicitação de inclusão ou desfaz uma solicitação de inclusão. Uma solicitação de inclusão do tipo `IMMEDIATE` não pode ser desfeita.  
Tipo: string  
Valores válidos: `IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN`   
Obrigatório: Sim

 ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-resourceArn"></a>
O nome do recurso da Amazon (ARN) do Amazon DocumentDB do recurso ao qual a ação de manutenção pendente se aplica.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256.  
Obrigatório: sim

 ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyOn"></a>
Uma data específica para aplicar a ação de manutenção pendente. Obrigatório se opt-in-type for `APPLY_ON`. Formato: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm`.   
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}
```

## Elementos de resposta
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
A saída da ação de manutenção pendente sendo aplicada.  
Tipo: objeto [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

## Erros
<a name="API_elastic_ApplyPendingMaintenanceAction_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de Status HTTP: 403

 ** ConflictException **   
Houve um conflito de acesso.    
 ** resourceId **   
O ID do recurso em que houve um conflito de acesso.  
 ** resourceType **   
O tipo do recurso em que houve um conflito de acesso.
Código de Status HTTP: 409

 ** InternalServerException **   
Ocorreu um erro interno no servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_ApplyPendingMaintenanceAction_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 

# CopyClusterSnapshot
<a name="API_elastic_CopyClusterSnapshot"></a>

Copia um snapshot de um cluster elástico.

## Sintaxe da Solicitação
<a name="API_elastic_CopyClusterSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot/snapshotArn/copy HTTP/1.1
Content-type: application/json

{
   "copyTags": boolean,
   "kmsKeyId": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetSnapshotName": "string"
}
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_CopyClusterSnapshot_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-uri-snapshotArn"></a>
O identificador de nome do recurso da Amazon (ARN) do snapshot do cluster elástico.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_CopyClusterSnapshot_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-targetSnapshotName"></a>
O identificador do snapshot de cluster elástico novo a ser criado a partir do snapshot de cluster de origem. Esse parâmetro não diferencia maiúsculas de minúsculas.  
Restrições:  
+ Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
Exemplo: `elastic-cluster-snapshot-5`   
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Obrigatório: Sim

 ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-copyTags"></a>
Defina `true` para copiar todas as tags do snapshot do cluster de origem no snapshot do cluster elástico de destino. O padrão é `false`.  
Tipo: booliano  
Obrigatório: não

 ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-kmsKeyId"></a>
O ID da chave AWS KMS para um snapshot de cluster elástico criptografado. O ID da chave AWS KMS é o Amazon Resource Name (ARN) AWS , o identificador da chave KMS ou AWS o alias da chave KMS da chave de criptografia KMS. AWS   
Se você copiar um snapshot de cluster elástico criptografado da sua AWS conta, poderá especificar um valor para `KmsKeyId` criptografar a cópia com uma nova chave de criptografia AWS S KMS. Se você não especificar um valor para `KmsKeyId`, a cópia do snapshot do cluster elástico será criptografada com a mesma chave do `AWS` KMS que o snapshot do cluster elástico de origem.  
Se você copiar um snapshot do cluster elástico não criptografado e especificar um valor para o parâmetro `KmsKeyId`, um erro será retornado.  
Tipo: string  
Obrigatório: não

 ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-tags"></a>
As tags a serem atribuídas ao snapshot do cluster elástico.  
Tipo: mapa de string para string  
Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128.  
Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_elastic_CopyClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_CopyClusterSnapshot_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-response-snapshot"></a>
Retorna informações sobre um snapshot de cluster elástico específico.  
Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

## Erros
<a name="API_elastic_CopyClusterSnapshot_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de Status HTTP: 403

 ** ConflictException **   
Houve um conflito de acesso.    
 ** resourceId **   
O ID do recurso em que houve um conflito de acesso.  
 ** resourceType **   
O tipo do recurso em que houve um conflito de acesso.
Código de Status HTTP: 409

 ** InternalServerException **   
Ocorreu um erro interno no servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ServiceQuotaExceededException **   
O Service Quotas para a ação foi excedida.  
Código de status HTTP: 402

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_CopyClusterSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 

# CreateCluster
<a name="API_elastic_CreateCluster"></a>

Cria um novo cluster elástico do Amazon DocumentDB e retorna sua estrutura de cluster.

## Sintaxe da Solicitação
<a name="API_elastic_CreateCluster_RequestSyntax"></a>

```
POST /cluster HTTP/1.1
Content-type: application/json

{
   "adminUserName": "string",
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "clusterName": "string",
   "kmsKeyId": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}
```

## Parâmetros da solicitação de URI
<a name="API_elastic_CreateCluster_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_elastic_CreateCluster_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserName"></a>
O nome do administrador dos clusters elásticos do Amazon DocumentDB.  
 *Restrições*:  
+ Deve ter de 1 a 63 letras ou números.
+ O primeiro caractere deve ser uma letra.
+ Não pode ser uma palavra reservada.
Tipo: String  
Obrigatório: Sim

 ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserPassword"></a>
A senha do administrador dos clusters elásticos do Amazon DocumentDB. A senha pode conter qualquer caractere ASCII imprimível.  
 *Restrições*:  
+ Deve conter de 8 a 100 caracteres.
+ Não pode conter barra (/), aspas duplas (“) ou arroba (“@”).
Tipo: String  
Obrigatório: Sim

 ** [authType](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-authType"></a>
O tipo de autenticação usado para determinar onde buscar a senha usada para acessar o cluster elástico. Os tipos válidos são `PLAIN_TEXT` e `SECRET_ARN`.  
Tipo: String  
Valores válidos: `PLAIN_TEXT | SECRET_ARN`   
Obrigatório: Sim

 ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clusterName"></a>
O nome do novo cluster elástico. Este parâmetro é armazenado como uma string com letras minúsculas.  
 *Restrições*:  
+ Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
 *Exemplo*: `my-cluster`   
Tipo: String  
Obrigatório: Sim

 ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCapacity"></a>
O número de v CPUs atribuído a cada fragmento elástico do cluster. O máximo é 64. Os valores permitidos são 2, 4, 8, 16, 32, 64.  
Tipo: Inteiro  
Obrigatório: Sim

 ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCount"></a>
O número de fragmentos atribuídos ao cluster elástico. O máximo é 32.  
Tipo: inteiro  
Obrigatório: Sim

 ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-backupRetentionPeriod"></a>
O número de dias durante os quais os snapshots automáticos são retidos.  
Tipo: inteiro  
Obrigatório: não

 ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clientToken"></a>
O token do cliente para o cluster elástico.  
Tipo: String  
Obrigatório: Não

 ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-kmsKeyId"></a>
O identificador da chave do KMS a ser usado para criptografar o novo cluster elástico.  
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, 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: não

 ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredBackupWindow"></a>
O intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por `backupRetentionPeriod`.  
Tipo: string  
Obrigatório: não

 ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredMaintenanceWindow"></a>
O intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, no Tempo Universal Coordenado (UTC).  
 *Formato*: `ddd:hh24:mi-ddd:hh24:mi`   
 *Padrão*: uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de 8 horas para cada uma Região da AWS, ocorrendo em um dia aleatório da semana.  
 *Dias válidos*: Seg, Ter, Qua, Qui, Sex, Sáb, Dom  
 *Restrições*: janela mínima de 30 minutos.  
Tipo: String  
Obrigatório: não

 ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardInstanceCount"></a>
O número de instâncias de réplica aplicadas a todos os fragmentos no cluster elástico. O valor 1 em `shardInstanceCount` significa que há uma instância de gravação, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade.  
Tipo: inteiro  
Obrigatório: não

 ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-subnetIds"></a>
A sub-rede Amazon EC2 IDs para o novo cluster elástico.  
Tipo: matriz de strings  
Obrigatório: Não

 ** [tags](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-tags"></a>
As tags a serem atribuídas ao cluster.  
Tipo: mapa de string para string  
Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128.  
Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256.  
Obrigatório: Não

 ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-vpcSecurityGroupIds"></a>
Uma lista de grupos de segurança da VPC do EC2 a serem associados a esse novo cluster elástico.  
Tipo: Matriz de strings  
Obrigatório: Não

## Sintaxe da resposta
<a name="API_elastic_CreateCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_CreateCluster_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) **   <a name="documentdb-elastic_CreateCluster-response-cluster"></a>
O novo cluster elástico que foi criado.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

## Erros
<a name="API_elastic_CreateCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de Status HTTP: 403

 ** ConflictException **   
Houve um conflito de acesso.    
 ** resourceId **   
O ID do recurso em que houve um conflito de acesso.  
 ** resourceType **   
O tipo do recurso em que houve um conflito de acesso.
Código de Status HTTP: 409

 ** InternalServerException **   
Ocorreu um erro interno no servidor.  
Código de Status HTTP: 500

 ** ServiceQuotaExceededException **   
O Service Quotas para a ação foi excedida.  
Código de status HTTP: 402

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_CreateCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) 

# CreateClusterSnapshot
<a name="API_elastic_CreateClusterSnapshot"></a>

Cria um snapshot de um cluster elástico.

## Sintaxe da Solicitação
<a name="API_elastic_CreateClusterSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot HTTP/1.1
Content-type: application/json

{
   "clusterArn": "string",
   "snapshotName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Parâmetros da solicitação de URI
<a name="API_elastic_CreateClusterSnapshot_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_elastic_CreateClusterSnapshot_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-clusterArn"></a>
O identificador ARN do cluster elástico do qual você deseja criar um snapshot.  
Tipo: String  
Obrigatório: Sim

 ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-snapshotName"></a>
O nome do novo snapshot do cluster elástico.  
Tipo: string  
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.  
Obrigatório: Sim

 ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-tags"></a>
As tags a serem atribuídas ao snapshot do cluster elástico.  
Tipo: Mapa de string para string  
Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128.  
Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_elastic_CreateClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_CreateClusterSnapshot_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-response-snapshot"></a>
Retorna informações sobre o novo snapshot do cluster elástico.  
Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

## Erros
<a name="API_elastic_CreateClusterSnapshot_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de Status HTTP: 403

 ** ConflictException **   
Houve um conflito de acesso.    
 ** resourceId **   
O ID do recurso em que houve um conflito de acesso.  
 ** resourceType **   
O tipo do recurso em que houve um conflito de acesso.
Código de Status HTTP: 409

 ** InternalServerException **   
Ocorreu um erro interno no servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ServiceQuotaExceededException **   
O Service Quotas para a ação foi excedida.  
Código de status HTTP: 402

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_CreateClusterSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 

# DeleteCluster
<a name="API_elastic_DeleteCluster"></a>

Exclua um cluster elástico.

## Sintaxe da Solicitação
<a name="API_elastic_DeleteCluster_RequestSyntax"></a>

```
DELETE /cluster/clusterArn HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_DeleteCluster_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) **   <a name="documentdb-elastic_DeleteCluster-request-uri-clusterArn"></a>
O identificador ARN da captura de tela do cluster elástico que deve ser excluído.  
Obrigatório: sim

## Corpo da Solicitação
<a name="API_elastic_DeleteCluster_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_DeleteCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_DeleteCluster_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) **   <a name="documentdb-elastic_DeleteCluster-response-cluster"></a>
Retorna informações sobre a captura de tela do cluster elástico recém excluído.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

## Erros
<a name="API_elastic_DeleteCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de Status HTTP: 403

 ** ConflictException **   
Houve um conflito de acesso.    
 ** resourceId **   
O ID do recurso em que houve um conflito de acesso.  
 ** resourceType **   
O tipo do recurso em que houve um conflito de acesso.
Código de Status HTTP: 409

 ** InternalServerException **   
Ocorreu um erro interno no servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_DeleteCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) 

# DeleteClusterSnapshot
<a name="API_elastic_DeleteClusterSnapshot"></a>

Exclua um instantâneo do cluster elástico.

## Sintaxe da Solicitação
<a name="API_elastic_DeleteClusterSnapshot_RequestSyntax"></a>

```
DELETE /cluster-snapshot/snapshotArn HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_DeleteClusterSnapshot_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-request-uri-snapshotArn"></a>
O identificador ARN do snapshot do cluster elástico que deve ser excluído.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_DeleteClusterSnapshot_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_DeleteClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_DeleteClusterSnapshot_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-response-snapshot"></a>
Retorna informações sobre o snapshot do cluster elástico recém-excluído.  
Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

## Erros
<a name="API_elastic_DeleteClusterSnapshot_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de Status HTTP: 403

 ** ConflictException **   
Houve um conflito de acesso.    
 ** resourceId **   
O ID do recurso em que houve um conflito de acesso.  
 ** resourceType **   
O tipo do recurso em que houve um conflito de acesso.
Código de Status HTTP: 409

 ** InternalServerException **   
Ocorreu um erro interno no servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_DeleteClusterSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 

# GetCluster
<a name="API_elastic_GetCluster"></a>

Retorna informações sobre um cluster elástico específico.

## Sintaxe da Solicitação
<a name="API_elastic_GetCluster_RequestSyntax"></a>

```
GET /cluster/clusterArn HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_GetCluster_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) **   <a name="documentdb-elastic_GetCluster-request-uri-clusterArn"></a>
O identificador ARN do cluster elástico.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_GetCluster_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_GetCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_GetCluster_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [cluster](#API_elastic_GetCluster_ResponseSyntax) **   <a name="documentdb-elastic_GetCluster-response-cluster"></a>
Retorna informações sobre um cluster elástico específico.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

## Erros
<a name="API_elastic_GetCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de status HTTP: 403

 ** InternalServerException **   
Ocorreu um erro interno do servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_GetCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) 

# GetClusterSnapshot
<a name="API_elastic_GetClusterSnapshot"></a>

Retorna informações sobre um snapshot de cluster elástico específico.

## Sintaxe da Solicitação
<a name="API_elastic_GetClusterSnapshot_RequestSyntax"></a>

```
GET /cluster-snapshot/snapshotArn HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_GetClusterSnapshot_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-request-uri-snapshotArn"></a>
O identificador ARN do snapshot do cluster elástico.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_GetClusterSnapshot_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_GetClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_GetClusterSnapshot_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-response-snapshot"></a>
Retorna informações sobre um snapshot de cluster elástico específico.  
Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md)

## Erros
<a name="API_elastic_GetClusterSnapshot_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de status HTTP: 403

 ** InternalServerException **   
Ocorreu um erro interno do servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_GetClusterSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 

# GetPendingMaintenanceAction
<a name="API_elastic_GetPendingMaintenanceAction"></a>

Recupera todas as ações de manutenção que estão pendentes.

## Sintaxe da Solicitação
<a name="API_elastic_GetPendingMaintenanceAction_RequestSyntax"></a>

```
GET /pending-action/resourceArn HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_GetPendingMaintenanceAction_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-request-uri-resourceArn"></a>
Recupera ações de manutenção pendentes para um determinado nome do recurso da Amazon (ARN).  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256.  
Obrigatório: sim

## Corpo da Solicitação
<a name="API_elastic_GetPendingMaintenanceAction_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_GetPendingMaintenanceAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}
```

## Elementos de resposta
<a name="API_elastic_GetPendingMaintenanceAction_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
Fornece informações sobre uma ação de manutenção pendente para um recurso.  
Tipo: objeto [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

## Erros
<a name="API_elastic_GetPendingMaintenanceAction_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de Status HTTP: 403

 ** ConflictException **   
Houve um conflito de acesso.    
 ** resourceId **   
O ID do recurso em que houve um conflito de acesso.  
 ** resourceType **   
O tipo do recurso em que houve um conflito de acesso.
Código de Status HTTP: 409

 ** InternalServerException **   
Ocorreu um erro interno no servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_GetPendingMaintenanceAction_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 

# ListClusters
<a name="API_elastic_ListClusters"></a>

Retorna informações sobre clusters elásticos do Amazon DocumentDB provisionados.

## Sintaxe da Solicitação
<a name="API_elastic_ListClusters_RequestSyntax"></a>

```
GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_ListClusters_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [maxResults](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-maxResults"></a>
O número máximo de resultados de instantâneos de cluster elástico a ser recebido na resposta.  
Faixa válida: valor mínimo de 1. Valor máximo de 100.

 ** [nextToken](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-nextToken"></a>
Um token de paginação fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além desse token, até o valor especificado por `max-results`.  
Se não houver mais dados na resposta, `nextToken` não será retornado.

## Corpo da Solicitação
<a name="API_elastic_ListClusters_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_ListClusters_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "clusters": [ 
      { 
         "clusterArn": "string",
         "clusterName": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Elementos de resposta
<a name="API_elastic_ListClusters_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [clusters](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-clusters"></a>
Uma lista de clusters elásticos do Amazon DocumentDB.  
Tipo: matriz de objetos [ClusterInList](API_elastic_ClusterInList.md)

 ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-nextToken"></a>
Um token de paginação fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além desse token, até o valor especificado por `max-results`.  
Se não houver mais dados na resposta, `nextToken` não será retornado.  
Tipo: string

## Erros
<a name="API_elastic_ListClusters_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de status HTTP: 403

 ** InternalServerException **   
Ocorreu um erro interno do servidor.  
Código de Status HTTP: 500

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_ListClusters_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) 

# ListClusterSnapshots
<a name="API_elastic_ListClusterSnapshots"></a>

Retorna informações sobre instantâneos para um cluster elástico específico.

## Sintaxe da Solicitação
<a name="API_elastic_ListClusterSnapshots_RequestSyntax"></a>

```
GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_ListClusterSnapshots_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-clusterArn"></a>
O identificador ARN do cluster elástico.

 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-maxResults"></a>
O número máximo de resultados de instantâneos de cluster elástico a ser recebido na resposta.  
Intervalo válido: valor mínimo de 20. Valor máximo de 100.

 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-nextToken"></a>
Um token de paginação fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além desse token, até o valor especificado por `max-results`.  
Se não houver mais dados na resposta, `nextToken` não será retornado.

 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-snapshotType"></a>
O tipo de snapshots de cluster a ser retornado. É possível especificar um dos seguintes valores:  
+  `automated`- Retorne todos os snapshots de cluster que o Amazon DocumentDB criou automaticamente para AWS sua conta.
+  `manual`- Retorne todos os instantâneos do cluster que você criou manualmente para sua AWS conta.

## Corpo da Solicitação
<a name="API_elastic_ListClusterSnapshots_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_ListClusterSnapshots_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "snapshots": [ 
      { 
         "clusterArn": "string",
         "snapshotArn": "string",
         "snapshotCreationTime": "string",
         "snapshotName": "string",
         "status": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_elastic_ListClusterSnapshots_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-nextToken"></a>
Um token de paginação fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além desse token, até o valor especificado por `max-results`.  
Se não houver mais dados na resposta, `nextToken` não será retornado.  
Tipo: string

 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-snapshots"></a>
Uma lista de instantâneos para um cluster elástico especificado.  
Tipo: matriz de objetos [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md)

## Erros
<a name="API_elastic_ListClusterSnapshots_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de status HTTP: 403

 ** InternalServerException **   
Ocorreu um erro interno do servidor.  
Código de Status HTTP: 500

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_ListClusterSnapshots_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 

# ListPendingMaintenanceActions
<a name="API_elastic_ListPendingMaintenanceActions"></a>

Recupera uma lista de todas as ações de manutenção que estão pendentes.

## Sintaxe da Solicitação
<a name="API_elastic_ListPendingMaintenanceActions_RequestSyntax"></a>

```
GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_ListPendingMaintenanceActions_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-maxResults"></a>
O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `maxResults` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.  
Faixa válida: valor mínimo de 1. Valor máximo de 100.

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-nextToken"></a>
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `maxResults`.

## Corpo da Solicitação
<a name="API_elastic_ListPendingMaintenanceActions_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_ListPendingMaintenanceActions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "resourcePendingMaintenanceActions": [ 
      { 
         "pendingMaintenanceActionDetails": [ 
            { 
               "action": "string",
               "autoAppliedAfterDate": "string",
               "currentApplyDate": "string",
               "description": "string",
               "forcedApplyDate": "string",
               "optInStatus": "string"
            }
         ],
         "resourceArn": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_elastic_ListPendingMaintenanceActions_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-resourcePendingMaintenanceActions"></a>
Fornece informações sobre uma ação de manutenção pendente para um recurso.  
Tipo: matriz de objetos [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-nextToken"></a>
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for exibido, as respostas incluirão apenas os registros além do marcador, até o valor especificado por `maxResults`.  
Tipo: string

## Erros
<a name="API_elastic_ListPendingMaintenanceActions_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de status HTTP: 403

 ** InternalServerException **   
Ocorreu um erro interno do servidor.  
Código de Status HTTP: 500

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_ListPendingMaintenanceActions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 

# ListTagsForResource
<a name="API_elastic_ListTagsForResource"></a>

Lista todas as tags em um recurso de cluster elástico

## Sintaxe da Solicitação
<a name="API_elastic_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_ListTagsForResource_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) **   <a name="documentdb-elastic_ListTagsForResource-request-uri-resourceArn"></a>
O identificador ARN do recurso cluster elástico.  
Restrições de Tamanho: tamanho mínimo 1. O comprimento máximo é 1011.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_ListTagsForResource_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Elementos de resposta
<a name="API_elastic_ListTagsForResource_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) **   <a name="documentdb-elastic_ListTagsForResource-response-tags"></a>
A lista de tags do recurso de cluster elástico especificado.  
Tipo: Mapa de string para string  
Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128.  
Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256.

## Erros
<a name="API_elastic_ListTagsForResource_Errors"></a>

Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** InternalServerException **   
Ocorreu um erro interno do servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_ListTagsForResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) 

# RestoreClusterFromSnapshot
<a name="API_elastic_RestoreClusterFromSnapshot"></a>

Para restaurar um cluster a partir de um snapshot

## Sintaxe da Solicitação
<a name="API_elastic_RestoreClusterFromSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot/snapshotArn/restore HTTP/1.1
Content-type: application/json

{
   "clusterName": "string",
   "kmsKeyId": "string",
   "shardCapacity": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_RestoreClusterFromSnapshot_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-uri-snapshotArn"></a>
O identificador ARN do snapshot do cluster elástico.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_RestoreClusterFromSnapshot_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-clusterName"></a>
O nome do cluster.  
Tipo: String  
Obrigatório: Sim

 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-kmsKeyId"></a>
O identificador de chave KMS a ser usado para criptografar o novo cluster de clusters elásticos Amazon DocumentDB.  
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: não

 ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardCapacity"></a>
A capacidade de cada fragmento no novo cluster elástico restaurado.  
Tipo: inteiro  
Obrigatório: não

 ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardInstanceCount"></a>
O número de instâncias de réplica aplicadas a todos os fragmentos no cluster elástico. O valor 1 em `shardInstanceCount` significa que há uma instância de gravação, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade.  
Tipo: inteiro  
Obrigatório: não

 ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-subnetIds"></a>
A sub-rede Amazon EC2 IDs para o cluster elástico.  
Tipo: matriz de strings  
Obrigatório: Não

 ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-tags"></a>
Uma lista dos nomes de tags a serem atribuídos ao cluster elástico restaurado, na forma de uma matriz de pares de valores-chave em que a chave é o nome da tag e o valor é o valor da chave.  
Tipo: mapa de strings para string  
Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128.  
Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256.  
Obrigatório: Não

 ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-vpcSecurityGroupIds"></a>
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: Não

## Sintaxe da resposta
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-response-cluster"></a>
Retorna informações sobre um cluster elástico restaurado.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

## Erros
<a name="API_elastic_RestoreClusterFromSnapshot_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de Status HTTP: 403

 ** ConflictException **   
Houve um conflito de acesso.    
 ** resourceId **   
O ID do recurso em que houve um conflito de acesso.  
 ** resourceType **   
O tipo do recurso em que houve um conflito de acesso.
Código de Status HTTP: 409

 ** InternalServerException **   
Ocorreu um erro interno no servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ServiceQuotaExceededException **   
O Service Quotas para a ação foi excedida.  
Código de status HTTP: 402

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_RestoreClusterFromSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 

# StartCluster
<a name="API_elastic_StartCluster"></a>

Reinicia o cluster elástico interrompido especificado por `clusterARN`.

## Sintaxe da Solicitação
<a name="API_elastic_StartCluster_RequestSyntax"></a>

```
POST /cluster/clusterArn/start HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_StartCluster_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) **   <a name="documentdb-elastic_StartCluster-request-uri-clusterArn"></a>
O identificador ARN do cluster elástico.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_StartCluster_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_StartCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_StartCluster_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [cluster](#API_elastic_StartCluster_ResponseSyntax) **   <a name="documentdb-elastic_StartCluster-response-cluster"></a>
Retorna informações sobre um cluster elástico específico.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

## Erros
<a name="API_elastic_StartCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de status HTTP: 403

 ** InternalServerException **   
Ocorreu um erro interno do servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_StartCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) 

# StopCluster
<a name="API_elastic_StopCluster"></a>

Interrompe o cluster elástico em execução especificado por `clusterArn`. O cluster elástico deve estar no estado *disponível*. 

## Sintaxe da Solicitação
<a name="API_elastic_StopCluster_RequestSyntax"></a>

```
POST /cluster/clusterArn/stop HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_StopCluster_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) **   <a name="documentdb-elastic_StopCluster-request-uri-clusterArn"></a>
O identificador ARN do cluster elástico.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_StopCluster_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_StopCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_StopCluster_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [cluster](#API_elastic_StopCluster_ResponseSyntax) **   <a name="documentdb-elastic_StopCluster-response-cluster"></a>
Retorna informações sobre um cluster elástico específico.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

## Erros
<a name="API_elastic_StopCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de status HTTP: 403

 ** InternalServerException **   
Ocorreu um erro interno do servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_StopCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) 

# TagResource
<a name="API_elastic_TagResource"></a>

Adiciona tags de metadados a um recurso de cluster elástico

## Sintaxe da Solicitação
<a name="API_elastic_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_TagResource_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [resourceArn](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-uri-resourceArn"></a>
O identificador ARN do recurso cluster elástico.  
Restrições de Tamanho: tamanho mínimo 1. O comprimento máximo é 1011.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_TagResource_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [tags](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-tags"></a>
As tags atribuídas ao recurso de cluster elástico.  
Tipo: Mapa de string para string  
Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128.  
Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Restrições de comprimento do valor: comprimento mínimo de 0. O comprimento máximo é 256.  
Obrigatório: sim

## Sintaxe da resposta
<a name="API_elastic_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_elastic_TagResource_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_elastic_TagResource_Errors"></a>

Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** InternalServerException **   
Ocorreu um erro interno do servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_TagResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) 

# UntagResource
<a name="API_elastic_UntagResource"></a>

Remove tags de metadados de um recurso de cluster elástico.

## Sintaxe da Solicitação
<a name="API_elastic_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_UntagResource_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-resourceArn"></a>
O identificador ARN do recurso cluster elástico.  
Restrições de Tamanho: tamanho mínimo 1. O comprimento máximo é 1011.  
Obrigatório: Sim

 ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-tagKeys"></a>
As chaves de tag a serem removidas do recurso de cluster elástico.  
Membros da Matriz: Número mínimo de 0 itens. Número máximo de 50 itens.  
Restrições de Tamanho: Tamanho mínimo 1. O tamanho máximo é 128.  
Padrão: `(?!aws:)[a-zA-Z+-=._:/]+`   
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_UntagResource_RequestBody"></a>

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_elastic_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_elastic_UntagResource_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_elastic_UntagResource_Errors"></a>

Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** InternalServerException **   
Ocorreu um erro interno do servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_UntagResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) 

# UpdateCluster
<a name="API_elastic_UpdateCluster"></a>

Modifica um cluster elástico. Isso inclui atualizar o nome de usuário/senha do administrador, atualizar a versão da API e configurar uma janela de backup e uma janela de manutenção

## Sintaxe da Solicitação
<a name="API_elastic_UpdateCluster_RequestSyntax"></a>

```
PUT /cluster/clusterArn HTTP/1.1
Content-type: application/json

{
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "vpcSecurityGroupIds": [ "string" ]
}
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_UpdateCluster_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-uri-clusterArn"></a>
O identificador ARN do cluster elástico.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_UpdateCluster_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-adminUserPassword"></a>
A senha associada ao administrador do cluster elástico. Ela pode conter qualquer caractere ASCII imprimível, exceto barra (/), aspas duplas (") ou arroba ("@").  
 *Restrições*: deve conter de 8 a 100 caracteres.  
Tipo: String  
Obrigatório: Não

 ** [authType](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-authType"></a>
O tipo de autenticação usado para determinar onde buscar a senha usada para acessar o cluster elástico. Os tipos válidos são `PLAIN_TEXT` e `SECRET_ARN`.  
Tipo: String  
Valores válidos: `PLAIN_TEXT | SECRET_ARN`   
Obrigatório: não

 ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-backupRetentionPeriod"></a>
O número de dias durante os quais os snapshots automáticos são retidos.  
Tipo: inteiro  
Obrigatório: não

 ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-clientToken"></a>
O token do cliente para o cluster elástico.  
Tipo: String  
Obrigatório: não

 ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredBackupWindow"></a>
O intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por `backupRetentionPeriod`.  
Tipo: string  
Obrigatório: não

 ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredMaintenanceWindow"></a>
O intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, no Tempo Universal Coordenado (UTC).  
 *Formato*: `ddd:hh24:mi-ddd:hh24:mi`   
 *Padrão*: uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de 8 horas para cada uma Região da AWS, ocorrendo em um dia aleatório da semana.  
 *Dias válidos*: Seg, Ter, Qua, Qui, Sex, Sáb, Dom  
 *Restrições*: janela mínima de 30 minutos.  
Tipo: String  
Obrigatório: não

 ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCapacity"></a>
O número de v CPUs atribuído a cada fragmento elástico do cluster. O máximo é 64. Os valores permitidos são 2, 4, 8, 16, 32, 64.  
Tipo: Inteiro  
Obrigatório: Não

 ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCount"></a>
O número de fragmentos atribuídos ao cluster elástico. O máximo é 32.  
Tipo: Inteiro  
Obrigatório: não

 ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardInstanceCount"></a>
O número de instâncias de réplica aplicadas a todos os fragmentos no cluster elástico. O valor 1 em `shardInstanceCount` significa que há uma instância de gravação, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade.  
Tipo: inteiro  
Obrigatório: não

 ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-subnetIds"></a>
A sub-rede Amazon EC2 IDs para o cluster elástico.  
Tipo: matriz de strings  
Obrigatório: Não

 ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-vpcSecurityGroupIds"></a>
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: Não

## Sintaxe da resposta
<a name="API_elastic_UpdateCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_UpdateCluster_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) **   <a name="documentdb-elastic_UpdateCluster-response-cluster"></a>
Retorna informações sobre o cluster elástico atualizado.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

## Erros
<a name="API_elastic_UpdateCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de Status HTTP: 403

 ** ConflictException **   
Houve um conflito de acesso.    
 ** resourceId **   
O ID do recurso em que houve um conflito de acesso.  
 ** resourceType **   
O tipo do recurso em que houve um conflito de acesso.
Código de Status HTTP: 409

 ** InternalServerException **   
Ocorreu um erro interno no servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_UpdateCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster) 

# Tipos de dados
<a name="API_Types"></a>

Os seguintes tipos de dados são compatíveis com Amazon DocumentDB (with MongoDB compatibility):
+  [AvailabilityZone](API_AvailabilityZone.md) 
+  [Certificate](API_Certificate.md) 
+  [CertificateDetails](API_CertificateDetails.md) 
+  [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 
+  [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 
+  [DBCluster](API_DBCluster.md) 
+  [DBClusterMember](API_DBClusterMember.md) 
+  [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 
+  [DBClusterRole](API_DBClusterRole.md) 
+  [DBClusterSnapshot](API_DBClusterSnapshot.md) 
+  [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 
+  [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 
+  [DBEngineVersion](API_DBEngineVersion.md) 
+  [DBInstance](API_DBInstance.md) 
+  [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 
+  [DBSubnetGroup](API_DBSubnetGroup.md) 
+  [Endpoint](API_Endpoint.md) 
+  [EngineDefaults](API_EngineDefaults.md) 
+  [Event](API_Event.md) 
+  [EventCategoriesMap](API_EventCategoriesMap.md) 
+  [EventSubscription](API_EventSubscription.md) 
+  [FailoverState](API_FailoverState.md) 
+  [Filter](API_Filter.md) 
+  [GlobalCluster](API_GlobalCluster.md) 
+  [GlobalClusterMember](API_GlobalClusterMember.md) 
+  [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 
+  [Parameter](API_Parameter.md) 
+  [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 
+  [PendingMaintenanceAction](API_PendingMaintenanceAction.md) 
+  [PendingModifiedValues](API_PendingModifiedValues.md) 
+  [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 
+  [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 
+  [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 
+  [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 
+  [Subnet](API_Subnet.md) 
+  [Tag](API_Tag.md) 
+  [UpgradeTarget](API_UpgradeTarget.md) 
+  [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 

Os seguintes tipos de dados são compatíveis com os cluster elásticos do Amazon DocumentDB:
+  [Cluster](API_elastic_Cluster.md) 
+  [ClusterInList](API_elastic_ClusterInList.md) 
+  [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 
+  [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 
+  [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 
+  [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 
+  [Shard](API_elastic_Shard.md) 
+  [ValidationExceptionField](API_elastic_ValidationExceptionField.md) 

# Amazon DocumentDB (with MongoDB compatibility)
<a name="API_Types_Amazon_DocumentDB_with_MongoDB_compatibility"></a>

Os seguintes tipos de dados são compatíveis com Amazon DocumentDB (with MongoDB compatibility):
+  [AvailabilityZone](API_AvailabilityZone.md) 
+  [Certificate](API_Certificate.md) 
+  [CertificateDetails](API_CertificateDetails.md) 
+  [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 
+  [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 
+  [DBCluster](API_DBCluster.md) 
+  [DBClusterMember](API_DBClusterMember.md) 
+  [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 
+  [DBClusterRole](API_DBClusterRole.md) 
+  [DBClusterSnapshot](API_DBClusterSnapshot.md) 
+  [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 
+  [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 
+  [DBEngineVersion](API_DBEngineVersion.md) 
+  [DBInstance](API_DBInstance.md) 
+  [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 
+  [DBSubnetGroup](API_DBSubnetGroup.md) 
+  [Endpoint](API_Endpoint.md) 
+  [EngineDefaults](API_EngineDefaults.md) 
+  [Event](API_Event.md) 
+  [EventCategoriesMap](API_EventCategoriesMap.md) 
+  [EventSubscription](API_EventSubscription.md) 
+  [FailoverState](API_FailoverState.md) 
+  [Filter](API_Filter.md) 
+  [GlobalCluster](API_GlobalCluster.md) 
+  [GlobalClusterMember](API_GlobalClusterMember.md) 
+  [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 
+  [Parameter](API_Parameter.md) 
+  [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 
+  [PendingMaintenanceAction](API_PendingMaintenanceAction.md) 
+  [PendingModifiedValues](API_PendingModifiedValues.md) 
+  [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 
+  [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 
+  [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 
+  [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 
+  [Subnet](API_Subnet.md) 
+  [Tag](API_Tag.md) 
+  [UpgradeTarget](API_UpgradeTarget.md) 
+  [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 

# AvailabilityZone
<a name="API_AvailabilityZone"></a>

Informações sobre uma Zona de Disponibilidade.

## Conteúdo
<a name="API_AvailabilityZone_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros obrigatórios são descritos primeiro.

 ** Name **   
O nome da Zona de Disponibilidade.  
Tipo: string  
Obrigatório: Não

## Consulte também
<a name="API_AvailabilityZone_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AvailabilityZone) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AvailabilityZone) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AvailabilityZone) 

# Certificate
<a name="API_Certificate"></a>

Certificado de autoridade de certificado (CA) para um Conta da AWS.

## Conteúdo
<a name="API_Certificate_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros obrigatórios são descritos primeiro.

 ** CertificateArn **   
O Nome do recurso da Amazon (ARN) para o certificado.  
Exemplo: `arn:aws:rds:us-east-1::cert:rds-ca-2019`   
Tipo: string  
Obrigatório: Não

 ** CertificateIdentifier **   
A chave exclusiva que identifica um certificado.  
Exemplo: `rds-ca-2019`   
Tipo: string  
Obrigatório: Não

 ** CertificateType **   
O tipo de certificado.  
Exemplo: `CA`   
Tipo: string  
Obrigatório: Não

 ** Thumbprint **   
A impressão digital do certificado.  
Tipo: String  
Obrigatório: Não

 ** ValidFrom **   
A data e hora de início a partir das quais o certificado passa a ser válido.  
Exemplo: `2019-07-31T17:57:09Z`   
Tipo: carimbo de hora  
Obrigatório: Não

 ** ValidTill **   
Data e hora a partir das quais o certificado deixa de ser válido.  
Exemplo: `2024-07-31T17:57:09Z`   
Tipo: carimbo de hora  
Obrigatório: Não

## Consulte também
<a name="API_Certificate_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Certificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Certificate) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Certificate) 

# CertificateDetails
<a name="API_CertificateDetails"></a>

Retorna os detalhes do certificado de servidor de instância DB.

Para obter mais informações, consulte [Atualizando seus Certificados TLS do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) e [Criptografando Dados em Trânsito](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) no *Guia do Desenvolvedor do Amazon DocumentDB*.

## Conteúdo
<a name="API_CertificateDetails_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros obrigatórios são descritos primeiro.

 ** CAIdentifier **   
O identificador CA do certificado CA usado para o certificado do servidor da instância DB.  
Tipo: String  
Obrigatório: Não

 ** ValidTill **   
A data de vencimento do certificado de servidor da instância DB.  
Tipo: Timestamp  
Obrigatório: Não

## Consulte também
<a name="API_CertificateDetails_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CertificateDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CertificateDetails) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CertificateDetails) 

# CloudwatchLogsExportConfiguration
<a name="API_CloudwatchLogsExportConfiguration"></a>

A definição de configuração para os tipos de log a serem habilitados para exportação para o Amazon CloudWatch Logs para um determinado cluster ou instância.

As matrizes `EnableLogTypes` e `DisableLogTypes` determinam os logs que serão exportados (ou não) para o CloudWatch Logs. Os valores dentro dessas matrizes dependem do mecanismo que está sendo usado.

## Conteúdo
<a name="API_CloudwatchLogsExportConfiguration_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** DisableLogTypes.member.N **   
A lista de tipos de logs a serem desabilitados.  
Tipo: matriz de strings  
Obrigatório: Não

 ** EnableLogTypes.member.N **   
A lista de tipos de logs a serem habilitados.  
Tipo: matriz de strings  
Obrigatório: Não

## Consulte também
<a name="API_CloudwatchLogsExportConfiguration_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 

# ClusterMasterUserSecret
<a name="API_ClusterMasterUserSecret"></a>

Contém o segredo gerenciado pelo Amazon DocumentDB no AWS Secrets Manager para a senha do usuário principal.

## Conteúdo
<a name="API_ClusterMasterUserSecret_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** KmsKeyId **   
O identificador de chave do AWS KMS que é usado para criptografar o segredo.  
Tipo: String  
Obrigatório: Não

 ** SecretArn **   
O nome do recurso da Amazon (ARN) do segredo.  
Tipo: String  
Obrigatório: Não

 ** SecretStatus **   
O status do segredo.  
Os valores de status possíveis são os seguintes:  
+ em criação: o segredo está sendo criado.
+ ativo: o segredo está disponível para uso e alternância normais.
+ em alternância: o segredo está sendo alternado.
+ prejudicado: o segredo pode ser usado para acessar as credenciais do banco de dados, mas não pode ser alternado. Um segredo pode ter esse status se, por exemplo, as permissões forem alteradas para que o Amazon DocumentDB não possa mais acessar o segredo ou a chave do KMS do segredo.

  Quando um segredo tem esse status, você pode corrigir a condição que o causou. Como alternativa, modifique a instância para desativar o gerenciamento automático das credenciais do banco de dados e, depois, modifique a instância novamente para ativar o gerenciamento automático das credenciais do banco de dados.
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_ClusterMasterUserSecret_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ClusterMasterUserSecret) 

# DBCluster
<a name="API_DBCluster"></a>

Informações detalhadas sobre um cluster. 

## Conteúdo
<a name="API_DBCluster_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** AssociatedRoles.DBClusterRole.N **   
Fornece uma lista dos perfis (IAM) do AWS Identity and Access Management que estão associadas ao cluster. Os perfis (IAM) associados a uma permissão de concessão do cluster para acessar outros serviços da AWS em seu nome.  
Tipo: matriz de objetos [DBClusterRole](API_DBClusterRole.md)  
Obrigatório: Não

 ** AvailabilityZones.AvailabilityZone.N **   
Fornece a lista de zonas de disponibilidade do Amazon EC2 nas quais as instâncias no cluster podem ser criadas.  
Tipo: matriz de strings  
Obrigatório: Não

 ** BackupRetentionPeriod **   
Especifica o número de dias durante os quais os snapshots automáticos são retidos.  
Tipo: inteiro  
Obrigatório: Não

 ** CloneGroupId **   
Identifica o grupo de clones ao qual o cluster do banco de dados está associado.  
Tipo: String  
Obrigatório: Não

 ** ClusterCreateTime **   
Especifica a hora em que o cluster foi criado, no Tempo Universal Coordenado (UTC).  
Tipo: carimbo de hora  
Obrigatório: Não

 ** DBClusterArn **   
O nome de recurso da Amazon (ARN) para o cluster.  
Tipo: String  
Obrigatório: Não

 ** DBClusterIdentifier **   
Contém um identificador de cluster fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um cluster.  
Tipo: String  
Obrigatório: Não

 ** DBClusterMembers.DBClusterMember.N **   
Fornece a lista de instâncias que compõem o cluster.  
Tipo: matriz de objetos [DBClusterMember](API_DBClusterMember.md)  
Obrigatório: Não

 ** DBClusterParameterGroup **   
Especifica o nome do grupo de parâmetros do cluster para o cluster.  
Tipo: String  
Obrigatório: Não

 ** DbClusterResourceId **   
O identificador imutável e exclusivo da Região da AWS para o cluster. Esse identificador é encontrado nas entradas de log do AWS CloudTrail sempre que a chave do AWS KMS para o cluster é acessada.  
Tipo: String  
Obrigatório: Não

 ** DBSubnetGroup **   
Especifica informações sobre o grupo de sub-redes associado ao cluster, incluindo o nome, a descrição e as sub-redes no grupo de sub-redes.  
Tipo: String  
Obrigatório: Não

 ** DeletionProtection **   
Especifica se esse cluster pode ser excluído. Se `DeletionProtection` estiver ativado, o cluster não pode ser excluído, a menos que seja modificado e `DeletionProtection` esteja desabilitado. `DeletionProtection` protege clusters contra exclusão acidental.  
Tipo: booliano  
Obrigatório: Não

 ** EarliestRestorableTime **   
Especifica a data mais antiga para a qual um banco de dados pode ser restaurado com restauração ponto no tempo.  
Tipo: Timestamp  
Obrigatório: Não

 ** EnabledCloudwatchLogsExports.member.N **   
Uma lista de tipos de logs que esse cluster está configurado para exportar para o Amazon CloudWatch Logs.  
Tipo: matriz de strings  
Obrigatório: Não

 ** Endpoint **   
Especifica o endpoint de conexão para a instância principal do cluster.  
Tipo: string  
Obrigatório: Não

 ** Engine **   
Fornece o nome do mecanismo de banco de dados a ser usado para esse cluster.  
Tipo: String  
Obrigatório: Não

 ** EngineVersion **   
Indica a versão do mecanismo do banco de dados.  
Tipo: String  
Obrigatório: Não

 ** HostedZoneId **   
Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.  
Tipo: String  
Obrigatório: Não

 ** IOOptimizedNextAllowedModificationTime **   
Na próxima vez será possível modificar o cluster do Amazon DocumentDB para usar o tipo de armazenamento iopt1.  
Tipo: Timestamp  
Obrigatório: Não

 ** KmsKeyId **   
Se `StorageEncrypted` for `true`, o identificador da chave AWS KMS para o cluster criptografado.  
Tipo: String  
Obrigatório: Não

 ** LatestRestorableTime **   
Especifica a data mais recente até a qual um banco de dados pode ser restaurado com restauração pontual.  
Tipo: carimbo de hora  
Obrigatório: Não

 ** MasterUsername **   
Contém o nome de usuário principal para o cluster.  
Tipo: String  
Obrigatório: Não

 ** MasterUserSecret **   
O segredo gerenciado pelo Amazon DocumentDB no AWS Secrets Manager para a senha do usuário principal.  
Tipo: objeto [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md)  
Obrigatório: Não

 ** MultiAZ **   
Especifica se o cluster tem instâncias em várias zonas de disponibilidade.  
Tipo: booliano  
Obrigatório: Não

 ** NetworkType **   
O tipo de rede do cluster.  
O tipo de rede é determinado usando o `DBSubnetGroup` especificado para o cluster. Um `DBSubnetGroup` pode oferecer suporte somente para o protocolo IPv4 ou para os protocolos IPv4 e IPv6 (`DUAL`).  
Para obter mais informações, consulte [Clusters do DocumentDB em uma VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) no Guia do desenvolvedor do Amazon DocumentDB.  
Valores válidos: `IPV4` \$1 `DUAL`   
Tipo: String  
Obrigatório: Não

 ** PercentProgress **   
Especifica o andamento da operação como um percentual.  
Tipo: String  
Obrigatório: Não

 ** Port **   
Especifica a porta onde o mecanismo de banco de dados está realizando a recepção.  
Tipo: inteiro  
Obrigatório: Não

 ** PreferredBackupWindow **   
Especifica o intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por `BackupRetentionPeriod`.   
Tipo: String  
Obrigatório: Não

 ** PreferredMaintenanceWindow **   
Especifica o período semanal durante o qual pode ocorrer a manutenção do sistema, em Tempo Universal Coordenado (UTC).  
Tipo: String  
Obrigatório: Não

 ** ReaderEndpoint **   
O endpoint do leitor do cluster. O endpoint do leitor para balanceadores de carga do cluster das conexões entre réplicas do Amazon DocumentDB que estão disponíveis em um cluster. À medida em que os clientes solicitam novas conexões ao endpoint do leitor, o Amazon DocumentDB distribui as solicitações de conexão entre as réplicas de Amazon DocumentDB no cluster. Essa funcionalidade pode ajudar a equilibrar sua workload de leitura entre várias réplicas do Amazon DocumentDB em seu cluster.   
Se ocorrer um failover e a réplica do Amazon DocumentDB à qual você estiver conectado for promovida à instância principal, a sua conexão será interrompida. Para continuar a enviar sua workload de leitura para outras réplicas do Amazon DocumentDB no cluster, reconecte-se ao endpoint do leitor.  
Tipo: String  
Obrigatório: Não

 ** ReadReplicaIdentifiers.ReadReplicaIdentifier.N **   
Contém um ou mais identificadores dos clusters secundários associados a esse cluster.  
Tipo: matriz de strings  
Obrigatório: Não

 ** ReplicationSourceIdentifier **   
Contém o identificador do cluster de origem, se esse cluster for um cluster secundário.  
Tipo: String  
Obrigatório: Não

 ** ServerlessV2ScalingConfiguration **   
A configuração de escalabilidade de um cluster do Amazon DocumentDB Sem Servidor.  
Tipo: objeto [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md)  
Obrigatório: Não

 ** Status **   
Especifica o estado atual desse cluster.  
Tipo: String  
Obrigatório: Não

 ** StorageEncrypted **   
Especifica se o cluster é criptografado.  
Tipo: booliano  
Obrigatório: Não

 ** StorageType **   
Tipo de armazenamento associado ao cluster  
Para obter informações sobre os tipos de armazenamento para clusters do Amazon DocumentDB, consulte Configurações de armazenamento em cluster no *Guia do desenvolvedor do Amazon DocumentDB*.  
Valores válidos para o tipo de armazenamento - `standard | iopt1`   
O valor padrão é . `standard `   
Tipo: String  
Obrigatório: Não

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
Uma lista de grupos de segurança da nuvem privada virtual (VPC) a serem associados ao que o cluster pertence.  
Tipo: matriz de objetos [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)  
Obrigatório: Não

## Consulte também
<a name="API_DBCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBCluster) 

# DBClusterMember
<a name="API_DBClusterMember"></a>

Contém informações sobre uma instância que faz parte de um cluster.

## Conteúdo
<a name="API_DBClusterMember_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros obrigatórios são descritos primeiro.

 ** DBClusterParameterGroupStatus **   
Especifica o status do grupo de parâmetros do cluster para esse membro do cluster DB.  
Tipo: String  
Obrigatório: Não

 ** DBInstanceIdentifier **   
Especifica o identificador da instância para esse membro do cluster.  
Tipo: String  
Obrigatório: Não

 ** IsClusterWriter **   
Valor igual a `true` caso o membro do cluster seja a instância principal para o cluster e `false`, caso contrário.  
Tipo: booleano  
Obrigatório: Não

 ** PromotionTier **   
Um valor que especifica a ordem em que uma réplica do Amazon DocumentDB é promovida para a instância primária após uma falha da instância primária existente.   
Tipo: número inteiro  
Obrigatório: Não

## Consulte também
<a name="API_DBClusterMember_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterMember) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterMember) 

# DBClusterParameterGroup
<a name="API_DBClusterParameterGroup"></a>

Informações detalhadas sobre o grupo de parâmetros de cluster. 

## Conteúdo
<a name="API_DBClusterParameterGroup_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** DBClusterParameterGroupArn **   
O nome do recurso da Amazon (ARN) do grupo de parâmetros de cluster.  
Tipo: String  
Obrigatório: Não

 ** DBClusterParameterGroupName **   
Fornece o nome do grupo de parâmetro do cluster.  
Tipo: String  
Obrigatório: Não

 ** DBParameterGroupFamily **   
Fornece o nome da família do grupo de parâmetro com o qual esse grupo de parâmetro de cluster é compatível.  
Tipo: String  
Obrigatório: Não

 ** Description **   
Fornece a descrição especificada pelo cliente para este grupo de parâmetro do cluster.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_DBClusterParameterGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterParameterGroup) 

# DBClusterRole
<a name="API_DBClusterRole"></a>

Descreve um perfil do (IAM) AWS Identity and Access Management associada a um cluster.

## Conteúdo
<a name="API_DBClusterRole_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros obrigatórios são descritos primeiro.

 ** RoleArn **   
O Nome do Recurso da Amazon (ARN) do perfil do IAM associado ao cluster DB.  
Tipo: string  
Obrigatório: Não

 ** Status **   
Descreve o estado de associação entre o perfil do IAM e o cluster. A propriedade `Status` retorna um dos valores a seguir:  
+  `ACTIVE` - o ARN do perfil do IAM é associado ao cluster e pode ser usado para acessar outros serviços AWS em seu nome.
+  `PENDING` – o ARN do perfil do IAM está sendo associado ao cluster.
+  `INVALID` - o ARN do perfil do IAM é associado ao cluster, mas o cluster não consegue presumir o perfil do IAM para acessar outros serviços AWS em seu nome.
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_DBClusterRole_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterRole) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterRole) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterRole) 

# DBClusterSnapshot
<a name="API_DBClusterSnapshot"></a>

Informações detalhadas sobre um snapshot de cluster. 

## Conteúdo
<a name="API_DBClusterSnapshot_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** AvailabilityZones.AvailabilityZone.N **   
Fornece a lista de Zonas de Disponibilidade do Amazon EC2 nas quais as instâncias na captura de tela do cluster podem ser restauradas.  
Tipo: matriz de strings  
Obrigatório: Não

 ** ClusterCreateTime **   
Especifica a hora em que o cluster foi criado, no Tempo Universal Coordenado (UTC).  
Tipo: carimbo de hora  
Obrigatório: Não

 ** DBClusterIdentifier **   
Especifica o identificador do cluster a partir do qual essa captura de tela de cluster foi criada.  
Tipo: string  
Obrigatório: Não

 ** DBClusterSnapshotArn **   
O nome do recurso da Amazon (ARN) da captura de tela do cluster.  
Tipo: String  
Obrigatório: Não

 ** DBClusterSnapshotIdentifier **   
Especifica o identificador da captura de tela do cluster de banco de dados.  
Tipo: String  
Obrigatório: Não

 ** Engine **   
Especifica o nome do mecanismo de banco de dados.  
Tipo: String  
Obrigatório: Não

 ** EngineVersion **   
Fornece a versão do mecanismo de banco de dados para essa captura de tela do cluster.  
Tipo: String  
Obrigatório: Não

 ** KmsKeyId **   
Se `StorageEncrypted` for `true`, o identificador de chave AWS KMS para a captura de tela do cluster criptografado.  
Tipo: String  
Obrigatório: Não

 ** MasterUsername **   
Fornece o nome de usuário mestre para a captura de tela do cluster.  
Tipo: String  
Obrigatório: Não

 ** PercentProgress **   
Especifica a porcentagem dos dados estimados transferidos.  
Tipo: inteiro  
Obrigatório: Não

 ** Port **   
Especifica a porta da qual o cluster de banco de dados estava receptando no momento da captura de tela.  
Tipo: inteiro  
Obrigatório: Não

 ** SnapshotCreateTime **   
Fornece a hora na qual a captura de tela foi criada, em Tempo Universal Coordenado (UTC).  
Tipo: Timestamp  
Obrigatório: Não

 ** SnapshotType **   
Fornece o tipo de captura de tela do cluster.  
Tipo: String  
Obrigatório: Não

 ** SourceDBClusterSnapshotArn **   
Se a captura de tela do cluster foi copiada de outra do cluster origem, o ARN para a captura de tela do cluster de origem; caso contrário, um valor nulo.  
Tipo: String  
Obrigatório: Não

 ** Status **   
Especifica o status dessa captura de tela de cluster.  
Tipo: String  
Obrigatório: Não

 ** StorageEncrypted **   
Especifica se a captura de tela do cluster está criptografada.  
Tipo: booleano  
Obrigatório: Não

 ** StorageType **   
O tipo de armazenamento associado ao snapshot de cluster  
Para obter informações sobre os tipos de armazenamento para clusters do Amazon DocumentDB, consulte Configurações de armazenamento em cluster no *Guia do desenvolvedor do Amazon DocumentDB*.  
Valores válidos para o tipo de armazenamento - `standard | iopt1`   
O valor padrão é . `standard `   
Tipo: String  
Obrigatório: Não

 ** VpcId **   
Fornece a ID da Nuvem Privada Virtual (VPC) associada à captura de tela de cluster.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_DBClusterSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshot) 

# DBClusterSnapshotAttribute
<a name="API_DBClusterSnapshotAttribute"></a>

Contém o nome e os valores de um atributo de captura de tela do cluster manual.

Os atributos de uma captura de tela de um cluster manual são usados para autorizar outros Contas da AWS a restaurarem uma captura de tela de cluster manual.

## Conteúdo
<a name="API_DBClusterSnapshotAttribute_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros obrigatórios são descritos primeiro.

 ** AttributeName **   
O nome do atributo da captura de tela do cluster manual.  
O atributo chamado `restore` refere-se à lista de contas de Contas da AWS com permissão para copiar ou restaurar a captura de tela do cluster manual.  
Tipo: string  
Obrigatório: Não

 ** AttributeValues.AttributeValue.N **   
Os valores do atributo da captura de tela do cluster manual.  
Se o campo `AttributeName` for definido como `restore`, esse elemento retornará uma lista de IDs de Contas da AWS autorizados a copiar ou restaurar a captura de tela do cluster manual. Se um valor de `all` estiver na lista, a captura de tela do cluster manual será pública e estará disponível para qualquer Conta da AWS copiar ou restaurar.  
Tipo: matriz de strings  
Obrigatório: Não

## Consulte também
<a name="API_DBClusterSnapshotAttribute_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttribute) 

# DBClusterSnapshotAttributesResult
<a name="API_DBClusterSnapshotAttributesResult"></a>

Informações detalhadas sobre os atributos associados a um snapshot de cluster.

## Conteúdo
<a name="API_DBClusterSnapshotAttributesResult_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros obrigatórios são descritos primeiro.

 ** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N **   
A lista de atributos e valores para captura de tela de cluster.  
Tipo: matriz de objetos [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md)  
Obrigatório: Não

 ** DBClusterSnapshotIdentifier **   
O identificador da captura de tela do cluster a qual os atributos se aplicam.  
Tipo: string  
Obrigatório: Não

## Consulte também
<a name="API_DBClusterSnapshotAttributesResult_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 

# DBEngineVersion
<a name="API_DBEngineVersion"></a>

 Informações detalhadas sobre uma versão do mecanismo. 

## Conteúdo
<a name="API_DBEngineVersion_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** DBEngineDescription **   
A descrição do mecanismo de banco de dados.  
Tipo: String  
Obrigatório: Não

 ** DBEngineVersionDescription **   
A descrição da versão do mecanismo de banco de dados.  
Tipo: String  
Obrigatório: Não

 ** DBParameterGroupFamily **   
O nome da família de grupos de parâmetro para o mecanismo de banco de dados.  
Tipo: String  
Obrigatório: Não

 ** Engine **   
O nome do mecanismo de banco de dados.  
Tipo: String  
Obrigatório: Não

 ** EngineVersion **   
O número da versão do mecanismo de banco de dados.  
Tipo: String  
Obrigatório: Não

 ** ExportableLogTypes.member.N **   
Os tipos de logs que o mecanismo de banco de dados tem disponíveis para exportar para o Amazon CloudWatch Logs.  
Tipo: matriz de strings  
Obrigatório: Não

 ** ServerlessV2FeaturesSupport **   
Especifica quaisquer propriedades ou limites do Amazon DocumentDB Sem Servidor que sejam diferentes entre as versões do mecanismo do Amazon DocumentDB. É possível testar os valores desse atributo ao decidir qual versão do Amazon DocumentDB usar em um cluster novo ou atualizado. Também é possível recuperar a versão de um cluster existente e verificar se essa versão oferece suporte a determinados recursos do Amazon DocumentDB Sem Servidor antes de tentar usar esses recursos.  
Tipo: objeto [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md)  
Obrigatório: Não

 ** SupportedCACertificateIdentifiers.member.N **   
Uma lista dos identificadores de certificado CA com suporte.  
Para obter mais informações, consulte [Atualização dos certificados TLS do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) e [criptografia de dados em trânsito](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) no *Guia do desenvolvedor do Amazon DocumentDB.*  
Tipo: matriz de strings  
Obrigatório: Não

 ** SupportsCertificateRotationWithoutRestart **   
Indica se a versão do mecanismo suporta a rotação do certificado do servidor sem reinicializar a instância de banco de dados.  
Tipo: booliano  
Obrigatório: Não

 ** SupportsLogExportsToCloudwatchLogs **   
Um valor que indica se a versão do mecanismo oferece suporte à exportação dos tipos de log especificados pelo `ExportableLogTypes` para CloudWatch Logs.  
Tipo: booliano  
Obrigatório: Não

 ** ValidUpgradeTarget.UpgradeTarget.N **   
Uma lista de versões do mecanismo para as quais essa versão do mecanismo de banco de dados pode ser atualizada.  
Tipo: matriz de objetos [UpgradeTarget](API_UpgradeTarget.md)  
Obrigatório: Não

## Consulte também
<a name="API_DBEngineVersion_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBEngineVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBEngineVersion) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBEngineVersion) 

# DBInstance
<a name="API_DBInstance"></a>

Informações detalhadas sobre uma instância. 

## Conteúdo
<a name="API_DBInstance_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** AutoMinorVersionUpgrade **   
Não se aplica. Esse parâmetro não é aplicável ao Amazon DocumentDB. O Amazon DocumentDB não faz atualizações de versões inferiores, independente do valor definido.  
Tipo: Booliano  
Obrigatório: Não

 ** AvailabilityZone **   
Especifica o nome da Zona de Disponibilidade na qual a instância de banco de dados está localizada.  
Tipo: String  
Obrigatório: Não

 ** BackupRetentionPeriod **   
Especifica o número de dias durante os quais os snapshots automáticos são retidos.  
Tipo: inteiro  
Obrigatório: Não

 ** CACertificateIdentifier **   
O identificador do certificado da CA para essa instância DB.  
Tipo: String  
Obrigatório: Não

 ** CertificateDetails **   
Detalhes do certificado do servidor da instância DB.  
Tipo: objeto [CertificateDetails](API_CertificateDetails.md)  
Obrigatório: Não

 ** CopyTagsToSnapshot **   
Um valor que indica se as tags devem ser copiadas da instância DB nas capturas de tela da mesma. Por padrão, as tags não são copiadas.  
Tipo: Booliano  
Obrigatório: Não

 ** DBClusterIdentifier **   
Contém o nome do cluster do qual a instância de banco de dados faz parte, caso a mesma seja membro.  
Tipo: String  
Obrigatório: Não

 ** DBInstanceArn **   
O nome do recurso da Amazon (ARN) da instância.  
Tipo: String  
Obrigatório: Não

 ** DBInstanceClass **   
Contém o nome da classe de capacidade e memória de computação da instância.  
Tipo: string  
Obrigatório: Não

 ** DBInstanceIdentifier **   
Contém um identificador de banco de dados fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica uma instância.  
Tipo: String  
Obrigatório: Não

 ** DBInstanceStatus **   
Especifica o estado atual desse banco de dados.  
Tipo: String  
Obrigatório: Não

 ** DbiResourceId **   
O identificador exclusivo e imutável Região da AWS para a instância. Esse identificador é encontrado em entradas de log AWS CloudTrail sempre que a chave AWS KMS da instância é acessada.  
Tipo: String  
Obrigatório: Não

 ** DBSubnetGroup **   
Especifica informações sobre o grupo de sub-redes associado à instância, como nome, descrição e sub-redes do grupo de sub-redes.  
Tipo: objeto [DBSubnetGroup](API_DBSubnetGroup.md)  
Obrigatório: Não

 ** EnabledCloudwatchLogsExports.member.N **   
Uma lista de tipos de logs que essa instância está configurada para exportar para o CloudWatch Logs.  
Tipo: matriz de strings  
Obrigatório: Não

 ** Endpoint **   
Especifica o endpoint de conexão.  
Tipo: objeto [Endpoint](API_Endpoint.md)  
Obrigatório: Não

 ** Engine **   
Fornece o nome do mecanismo de banco de dados a ser usado para essa instância.  
Tipo: String  
Obrigatório: Não

 ** EngineVersion **   
Indica a versão do mecanismo do banco de dados.  
Tipo: String  
Obrigatório: Não

 ** InstanceCreateTime **   
Fornece a data e hora em que a instância foi criada.  
Tipo: Timestamp  
Obrigatório: Não

 ** KmsKeyId **   
 Se `StorageEncrypted` for `true`, o identificador da chave AWS KMS para a instância criptografada.   
Tipo: String  
Obrigatório: Não

 ** LatestRestorableTime **   
Especifica a data mais recente até a qual um banco de dados pode ser restaurado com restauração pontual.  
Tipo: carimbo de hora  
Obrigatório: Não

 ** PendingModifiedValues **   
Especifica alterações da instância pendentes. Esse elemento só é incluído quando as alterações estão pendentes. As alterações específicas são identificadas por subelementos.  
Tipo: objeto [PendingModifiedValues](API_PendingModifiedValues.md)  
Obrigatório: Não

 ** PerformanceInsightsEnabled **   
Defina como `true` se a opção Insights de Performance do Amazon RDS estiver ativada para a instância de banco de dados; caso contrário, `false`.  
Tipo: booliano  
Obrigatório: Não

 ** PerformanceInsightsKMSKeyId **   
O identificador de chave do AWS KMS para criptografia de dados de Insights de Performance. O ID da chave do AWS KMS é o nome de recurso da Amazon (ARN), o identificador da chave do AWS KMS ou o alias da chave do AWS KMS para a chave de criptografia do AWS KMS.  
Tipo: String  
Obrigatório: Não

 ** PreferredBackupWindow **   
 Especifica o intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por `BackupRetentionPeriod`.   
Tipo: String  
Obrigatório: Não

 ** PreferredMaintenanceWindow **   
Especifica o período semanal durante o qual pode ocorrer a manutenção do sistema, em Tempo Universal Coordenado (UTC).  
Tipo: String  
Obrigatório: Não

 ** PromotionTier **   
Um valor que especifica a ordem em que uma réplica do Amazon DocumentDB é promovida para a instância primária após uma falha da instância primária existente.  
Tipo: número inteiro  
Obrigatório: Não

 ** PubliclyAccessible **   
Sem compatibilidade. No momento, o Amazon DocumentDB não suporta endpoints públicos. O valor de `PubliclyAccessible` é sempre `false`.   
Tipo: booliano  
Obrigatório: Não

 ** StatusInfos.DBInstanceStatusInfo.N **   
O status da réplica de leitura. Se a instância não for uma réplica de leitura, isso ficará em branco.  
Tipo: matriz de objetos [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md)  
Obrigatório: Não

 ** StorageEncrypted **   
Especifica se a instância é ou não criptografada.  
Tipo: booleano  
Obrigatório: Não

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
Fornece uma lista de elementos do grupo de segurança da VPC a qual a instância pertence.  
Tipo: matriz de objetos [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)  
Obrigatório: Não

## Consulte também
<a name="API_DBInstance_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstance) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstance) 

# DBInstanceStatusInfo
<a name="API_DBInstanceStatusInfo"></a>

Fornece uma lista de informações de status para uma instância.

## Conteúdo
<a name="API_DBInstanceStatusInfo_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** Message **   
Detalhes do erro se houver um erro para a instância. Se a instância não estiver em um estado de erro, esse valor ficará em branco.  
Tipo: String  
Obrigatório: Não

 ** Normal **   
Um valor booliano que será `true` se a instância estiver funcionando normalmente, ou `false` se a instância estiver em um estado de erro.  
Tipo: booliano  
Obrigatório: Não

 ** Status **   
Status da instância. Para uma `StatusType` de réplica de leitura, os valores podem ser `replicating`, error `stopped`, ou`terminated`.  
Tipo: String  
Obrigatório: Não

 ** StatusType **   
Atualmente, esse valor é "`read replication`".  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_DBInstanceStatusInfo_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstanceStatusInfo) 

# DBSubnetGroup
<a name="API_DBSubnetGroup"></a>

Informações detalhadas sobre um grupo de sub-rede. 

## Conteúdo
<a name="API_DBSubnetGroup_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** DBSubnetGroupArn **   
O nome de recurso da Amazon (ARN) do grupo de sub-redes de banco de dados.  
Tipo: String  
Obrigatório: Não

 ** DBSubnetGroupDescription **   
Fornece a descrição do grupo de sub-redes.  
Tipo: String  
Obrigatório: Não

 ** DBSubnetGroupName **   
O nome do grupo de sub-redes.  
Tipo: String  
Obrigatório: Não

 ** SubnetGroupStatus **   
Fornece o status do grupo de sub-redes.  
Tipo: String  
Obrigatório: Não

 ** Subnets.Subnet.N **   
Informações detalhadas sobre uma ou mais sub-redes em um grupo de sub-rede.  
Tipo: matriz de objetos [Subnet](API_Subnet.md)  
Obrigatório: Não

 ** SupportedNetworkTypes.member.N **   
O tipo de rede do grupo de sub-redes do banco de dados.  
Valores válidos: `IPV4` \$1 `DUAL`   
Um `DBSubnetGroup` pode oferecer suporte somente ao protocolo IPv4 ou aos protocolos IPv4 e IPv6 (DUPLO).  
Tipo: matriz de strings  
Obrigatório: Não

 ** VpcId **   
Fornece o ID da nuvem privada virtual (VPC) do grupo de sub-rede.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_DBSubnetGroup_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBSubnetGroup) 

# Endpoint
<a name="API_Endpoint"></a>

Informações de rede para acessar um cluster ou uma instância. Os programas de clientes devem especificar um endpoint válido para acessar esses recursos do Amazon DocumentDB.

## Conteúdo
<a name="API_Endpoint_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros obrigatórios são descritos primeiro.

 ** Address **   
Especifica o endereço DNS da instância.  
Tipo: string  
Obrigatório: Não

 ** HostedZoneId **   
Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.  
Tipo: String  
Obrigatório: Não

 ** Port **   
Especifica a porta onde o mecanismo de banco de dados está realizando a recepção.  
Tipo: inteiro  
Obrigatório: Não

## Consulte também
<a name="API_Endpoint_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Endpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Endpoint) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Endpoint) 

# EngineDefaults
<a name="API_EngineDefaults"></a>

Contém o resultado de uma invocação bem-sucedida da operação `DescribeEngineDefaultClusterParameters`. 

## Conteúdo
<a name="API_EngineDefaults_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros obrigatórios são descritos primeiro.

 ** DBParameterGroupFamily **   
O nome da família de grupos de parâmetros de cluster a qual retornar informações de parâmetros do mecanismo.  
Tipo: string  
Obrigatório: Não

 ** Marker **   
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.  
Tipo: string  
Obrigatório: Não

 ** Parameters.Parameter.N **   
Os parâmetros de uma família específica do grupo de parâmetros do cluster.  
Tipo: matriz de objetos [Parameter](API_Parameter.md)  
Obrigatório: Não

## Consulte também
<a name="API_EngineDefaults_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EngineDefaults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EngineDefaults) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EngineDefaults) 

# Event
<a name="API_Event"></a>

Informações detalhadas sobre um evento.

## Conteúdo
<a name="API_Event_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** Date **   
Especifica a data e a hora do evento.  
Tipo: Timestamp  
Obrigatório: Não

 ** EventCategories.EventCategory.N **   
Especifica a categoria do evento.  
Tipo: matriz de strings  
Obrigatório: Não

 ** Message **   
Fornece o texto desse evento.  
Tipo: String  
Obrigatório: Não

 ** SourceArn **   
O nome de recurso da Amazon (ARN) do evento.  
Tipo: String  
Obrigatório: Não

 ** SourceIdentifier **   
Fornece o identificador para a origem do evento.  
Tipo: String  
Obrigatório: Não

 ** SourceType **   
Especifica o tipo de origem desse evento.  
Tipo: String  
Valores Válidos: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`   
Obrigatório: Não

## Consulte também
<a name="API_Event_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Event) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Event) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Event) 

# EventCategoriesMap
<a name="API_EventCategoriesMap"></a>

Um tipo de origem de evento, acompanhado de um ou mais nomes de categorias de eventos.

## Conteúdo
<a name="API_EventCategoriesMap_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** EventCategories.EventCategory.N **   
As categorias de eventos para o tipo de origem especificado  
Tipo: matriz de strings  
Obrigatório: Não

 ** SourceType **   
O tipo de fonte ao qual pertencem as categorias retornadas.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_EventCategoriesMap_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventCategoriesMap) 

# EventSubscription
<a name="API_EventSubscription"></a>

Informações detalhadas sobre um evento em você se inscreveu.

## Conteúdo
<a name="API_EventSubscription_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** CustomerAwsId **   
A conta de cliente da AWS associada à assinatura de notificações de eventos Amazon DocumentDB.  
Tipo: String  
Obrigatório: Não

 ** CustSubscriptionId **   
O ID da assinatura de notificação de eventos do Amazon DocumentDB.  
Tipo: String  
Obrigatório: Não

 ** Enabled **   
Um valor booliano que indica se a assinatura está ativada. Um valor de `true` indica que a assinatura está ativada.  
Tipo: booliano  
Obrigatório: Não

 ** EventCategoriesList.EventCategory.N **   
Uma lista de categorias de eventos da assinatura de notificações de eventos da Amazon DocumentDB.  
Tipo: matriz de strings  
Obrigatório: Não

 ** EventSubscriptionArn **   
O nome do recurso da Amazon (ARN) da assinatura de eventos.  
Tipo: String  
Obrigatório: Não

 ** SnsTopicArn **   
O ARN do tópico da assinatura de notificações de eventos da Amazon DocumentDB.  
Tipo: String  
Obrigatório: Não

 ** SourceIdsList.SourceId.N **   
Uma lista de IDs de origem da assinatura de notificações de eventos da Amazon DocumentDB.  
Tipo: matriz de strings  
Obrigatório: Não

 ** SourceType **   
O tipo de origem da assinatura de notificações de eventos da Amazon DocumentDB.  
Tipo: String  
Obrigatório: Não

 ** Status **   
O status da assinatura de notificações de eventos da Amazon DocumentDB.  
Restrições:  
Pode ser um dos seguintes: `creating`, `modifying`, `deleting`, `active`, `no-permission`, `topic-not-exist`   
O status `no-permission` indica que o Amazon DocumentDB não tem mais permissão para fazer publicações no tópico do Amazon SNS. O status `topic-not-exist` indica que o tópico foi excluído após a assinatura ser criada.  
Tipo: String  
Obrigatório: Não

 ** SubscriptionCreationTime **   
A hora em que a assinatura de notificações de eventos da Amazon DocumentDB foi criada.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_EventSubscription_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventSubscription) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventSubscription) 

# FailoverState
<a name="API_FailoverState"></a>

Contém o estado das operações programadas ou em andamento em um cluster global do Amazon DocumentDB. Esse tipo de dados está vazio, a menos que uma operação de alternância ou failover esteja programada ou esteja em andamento no cluster global.

## Conteúdo
<a name="API_FailoverState_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** FromDbClusterArn **   
O Amazon Resource Name (ARN) do cluster Amazon DocumentDB que está sendo rebaixado no momento e que está associado a esse estado.  
Tipo: string  
Obrigatório: não

 ** IsDataLossAllowed **   
Indica se a operação é uma transição global ou um failover global. Se a perda de dados for permitida, a operação será um failover global. Caso contrário, é uma transição.  
Tipo: booliano  
Obrigatório: não

 ** Status **   
O status atual do cluster global. Os valores possíveis são:  
+  **pendente** — O serviço recebeu uma solicitação para alternar ou fazer o failover do cluster global. O cluster primário do cluster global e o cluster secundário especificado estão sendo verificados antes do início da operação.
+  **failing-over** — O cluster secundário escolhido está sendo promovido para se tornar o novo cluster primário a realizar failover no cluster global.
+  **cancelamento** — A solicitação para alternar ou fazer o failover do cluster global foi cancelada e o cluster primário e o cluster secundário selecionado estão retornando aos seus estados anteriores.
Tipo: string  
Valores válidos: `pending | failing-over | cancelling`   
Obrigatório: não

 ** ToDbClusterArn **   
O Amazon Resource Name (ARN) do cluster Amazon DocumentDB que está sendo promovido atualmente e que está associado a esse estado.  
Tipo: string  
Obrigatório: não

## Consulte também
<a name="API_FailoverState_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverState) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverState) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverState) 

# Filter
<a name="API_Filter"></a>

Um conjunto nomeado de valores de filtro, usado para retornar uma lista mais específica de resultados. Você pode usar um filtro para combinar um conjunto de recursos por critérios específicos, como IDs.

Curingas não são compatíveis em filtros.

## Conteúdo
<a name="API_Filter_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** Name **   
O nome do filtro. Os nomes dos filtros diferenciam maiúsculas de minúsculas.  
Tipo: string  
Obrigatório: Sim

 ** Values.Value.N **   
Um ou mais valores de filtro. Os valores do filtro diferenciam maiúsculas de minúsculas.  
Tipo: matriz de strings  
Obrigatório: Sim

## Consulte também
<a name="API_Filter_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Filter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Filter) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Filter) 

# GlobalCluster
<a name="API_GlobalCluster"></a>

Um tipo de dado que representa um cluster global do Amazon DocumentDB.

## Conteúdo
<a name="API_GlobalCluster_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** DatabaseName **   
O nome padrão do banco de dados dentro do novo cluster global.  
Tipo: string  
Obrigatório: não

 ** DeletionProtection **   
A configuração de proteção contra exclusão para o novo cluster global.  
Tipo: booliano  
Obrigatório: não

 ** Engine **   
O mecanismo de banco de dados Amazon DocumentDB usado pelo cluster global.   
Tipo: string  
Obrigatório: não

 ** EngineVersion **   
Indica a versão do mecanismo do banco de dados.  
Tipo: string  
Obrigatório: não

 ** FailoverState **   
Um objeto de dados contendo todas as propriedades do estado atual de um processo de alternância ou failover em andamento ou pendente para esse cluster global. Esse objeto está vazio, a menos que a `FailoverGlobalCluster` operação `SwitchoverGlobalCluster` or tenha sido chamada nesse cluster global.  
Tipo: objeto [FailoverState](API_FailoverState.md)  
Obrigatório: não

 ** GlobalClusterArn **   
O nome do recurso da Amazon (ARN) para o cluster global.  
Tipo: string  
Obrigatório: não

 ** GlobalClusterIdentifier **   
Contém um identificador de cluster global fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um cluster global.   
Tipo: string  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.  
Padrão: `[A-Za-z][0-9A-Za-z-:._]*`   
Obrigatório: não

 ** GlobalClusterMembers.GlobalClusterMember.N **   
A lista de clusters IDs para clusters secundários dentro do cluster global. Atualmente limitado a um item.   
Tipo: matriz de objetos [GlobalClusterMember](API_GlobalClusterMember.md)  
Obrigatório: não

 ** GlobalClusterResourceId **   
O identificador Região da AWS exclusivo da região e imutável para o cluster de banco de dados global. Esse identificador é encontrado nas entradas de AWS CloudTrail registro sempre que a chave mestra AWS KMS do cliente (CMK) do cluster é acessada.   
Tipo: string  
Obrigatório: não

 ** Status **   
Especifica o estado atual desse cluster global.  
Tipo: string  
Obrigatório: não

 ** StorageEncrypted **   
A configuração de criptografia de armazenamento para o cluster global.  
Tipo: booliano  
Obrigatório: não

 ** TagList.Tag.N **   
Uma lista de tags globais de cluster.  
Tipo: matriz de objetos [Tag](API_Tag.md)  
Obrigatório: não

## Consulte também
<a name="API_GlobalCluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalCluster) 

# GlobalClusterMember
<a name="API_GlobalClusterMember"></a>

Uma estrutura de dados com informações sobre quaisquer clusters primários e secundários associados a clusters globais do Amazon DocumentDB. 

## Conteúdo
<a name="API_GlobalClusterMember_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** DBClusterArn **   
O nome de recurso da Amazon (ARN) para cada cluster do Amazon DocumentDB.  
Tipo: String  
Obrigatório: Não

 ** IsWriter **   
 Especifica se o cluster Amazon DocumentDB é o cluster primário (ou seja, tem capacidade de leitura e gravação) do cluster global Amazon DocumentDB ao qual está associado.   
Tipo: Booliano  
Obrigatório: não

 ** Readers.member.N **   
O nome do recurso da Amazon (ARN) para cada cluster secundário somente de leitura associado ao cluster global do Amazon DocumentDB.  
Tipo: matriz de strings  
Obrigatório: Não

 ** SynchronizationStatus **   
O status da sincronização de cada cluster Amazon DocumentDB no cluster global.  
Tipo: string  
Valores válidos: `connected | pending-resync`   
Obrigatório: não

## Consulte também
<a name="API_GlobalClusterMember_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalClusterMember) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalClusterMember) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalClusterMember) 

# OrderableDBInstanceOption
<a name="API_OrderableDBInstanceOption"></a>

As opções que estão disponíveis para uma instância.

## Conteúdo
<a name="API_OrderableDBInstanceOption_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** AvailabilityZones.AvailabilityZone.N **   
Uma lista das zonas de disponibilidade para uma instância.  
Tipo: matriz de objetos [AvailabilityZone](API_AvailabilityZone.md)  
Obrigatório: Não

 ** DBInstanceClass **   
A classe da instância para uma instância.  
Tipo: String  
Obrigatório: Não

 ** Engine **   
O tipo de mecanismo de uma instância.  
Tipo: String  
Obrigatório: Não

 ** EngineVersion **   
A versão do mecanismo de uma instância.  
Tipo: String  
Obrigatório: Não

 ** LicenseModel **   
O modelo de licença para uma instância.  
Tipo: String  
Obrigatório: Não

 ** StorageType **   
O tipo de armazenamento a ser associado ao cluster de banco de dados  
Tipo: String  
Obrigatório: Não

 ** Vpc **   
Indica se uma instância é uma nuvem privada virtual (VPC).  
Tipo: booliano  
Obrigatório: Não

## Consulte também
<a name="API_OrderableDBInstanceOption_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/OrderableDBInstanceOption) 

# Parameter
<a name="API_Parameter"></a>

Informações detalhadas sobre um parâmetro individual.

## Conteúdo
<a name="API_Parameter_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** AllowedValues **   
Especifica o intervalo válido de valores para o parâmetro.  
Tipo: String  
Obrigatório: Não

 ** ApplyMethod **   
Indica quando aplicar atualizações de parâmetros.  
Tipo: String  
Valores válidos: `immediate | pending-reboot`   
Obrigatório: Não

 ** ApplyType **   
Especifica o tipo de parâmetros específicos do mecanismo.  
Tipo: String  
Obrigatório: Não

 ** DataType **   
Especifica o tipo de dados válidos para o parâmetro.  
Tipo: String  
Obrigatório: Não

 ** Description **   
Fornece uma descrição do parâmetro.  
Tipo:String  
Obrigatório: Não

 ** IsModifiable **   
 Indica se o parâmetro pode (`true`) ou não (`false`) ser modificado. Alguns parâmetros têm implicações de segurança ou operacionais que os impedem de ser alterados.   
Tipo: Booliano  
Obrigatório: Não

 ** MinimumEngineVersion **   
A versão mais antiga do mecanismo à qual o parâmetro pode ser aplicado.  
Tipo String  
Obrigatório: Não

 ** ParameterName **   
Especifica o nome do parâmetro.  
Tipo: String  
Obrigatório: Não

 ** ParameterValue **   
Especifica o valor do parâmetro. Deve ser um ou mais dos `AllowedValues` dos parâmetros do cluster em formato CSV:  
Os valores válidos são:  
+  `enabled`: o cluster aceita conexões seguras usando o TLS versões de 1.0 a 1.3. 
+  `disabled`: o cluster não aceita conexões seguras usando o TLS. 
+  `fips-140-3`: o cluster só aceita conexões seguras de acordo com os requisitos da publicação 140-3 do Federal Information Processing Standards (FIPS). Só há suporte para isso a partir dos clusters do Amazon DocumentDB 5.0 (versão do mecanismo 3.0.3727) nas regiões a seguir: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.
+  `tls1.2+`: o cluster aceita conexões seguras usando o TLS versões 1.2 e posteriores Só há suporte para isso a partir do Amazon DocumentDB 4.0 (versão de mecanismo 2.0.10980) e Amazon DocumentDB 5.0 (versão de mecanismo 3.0.11051).
+  `tls1.3+`: o cluster aceita conexões seguras usando o TLS versões 1.3 e posteriores Só há suporte para isso a partir do Amazon DocumentDB 4.0 (versão de mecanismo 2.0.10980) e Amazon DocumentDB 5.0 (versão de mecanismo 3.0.11051).
Tipo: String  
Obrigatório: Não

 ** Source **   
Indica a origem do valor do parâmetro.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_Parameter_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Parameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Parameter) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Parameter) 

# PendingCloudwatchLogsExports
<a name="API_PendingCloudwatchLogsExports"></a>

Uma lista dos tipos de log cuja configuração ainda está pendente. Em outras palavras, esses tipos de log estão em processo de ativação ou desativação.

## Conteúdo
<a name="API_PendingCloudwatchLogsExports_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** LogTypesToDisable.member.N **   
Tipos de log que estão em processo de habilitação. Depois de habilitados, esses tipos de log são exportados para o Amazon CloudWatch Logs.  
Tipo: Matriz de strings  
Obrigatório: Não

 ** LogTypesToEnable.member.N **   
Tipos de log que estão em processo de desativação. Depois que são desativados, esses tipos de log não são exportados para o CloudWatch Logs.  
Tipo: Matriz de strings  
Obrigatório: Não

## Consulte também
<a name="API_PendingCloudwatchLogsExports_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingCloudwatchLogsExports) 

# PendingMaintenanceAction
<a name="API_PendingMaintenanceAction"></a>

Fornece informações sobre uma ação de manutenção pendente para um recurso.

## Conteúdo
<a name="API_PendingMaintenanceAction_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** Action **   
O tipo de ação de manutenção pendente que está disponível para o recurso.  
Tipo: String  
Obrigatório: Não

 ** AutoAppliedAfterDate **   
A data da janela de manutenção em que a ação é aplicada. A ação de manutenção é aplicada ao recurso durante a primeira janela de manutenção após essa data. Se essa data for especificada, todas as solicitações de inclusão `next-maintenance` serão ignoradas.  
Tipo: Timestamp  
Obrigatório: Não

 ** CurrentApplyDate **   
A data de início de vigência quando a ação de manutenção pendente é aplicada ao recurso.  
Tipo: Timestamp  
Obrigatório: Não

 ** Description **   
Uma descrição que fornece mais detalhes sobre a ação de manutenção.  
Tipo: String  
Obrigatório: Não

 ** ForcedApplyDate **   
A data em que a ação de manutenção é aplicada automaticamente. A ação de manutenção é aplicada ao recurso nessa data, independentemente da janela de manutenção para o recurso. Se essa data for especificada, todas as solicitações de inclusão `immediate` serão ignoradas.  
Tipo: Timestamp  
Obrigatório: Não

 ** OptInStatus **   
Indica o tipo de solicitação de inclusão que foi recebida para o recurso.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_PendingMaintenanceAction_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingMaintenanceAction) 

# PendingModifiedValues
<a name="API_PendingModifiedValues"></a>

 Uma ou mais configurações modificadas para uma instância. Essas configurações modificadas foram solicitadas, mas ainda não foram aplicadas.

## Conteúdo
<a name="API_PendingModifiedValues_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** AllocatedStorage **   
 Contém o novo tamanho de `AllocatedStorage` para a instância que será aplicado ou está sendo aplicado.   
Tipo: inteiro  
Obrigatório: Não

 ** BackupRetentionPeriod **   
Especifica o número de dias pendentes durante os quais os backups automatizados são retidos.  
Tipo: inteiro  
Obrigatório: Não

 ** CACertificateIdentifier **   
Especifica o identificador da autoridade do certificado (CA) para a instância de banco de dados.  
Tipo: String  
Obrigatório: Não

 ** DBInstanceClass **   
 Contém a nova `DBInstanceClass` para a instância que será aplicada ou está sendo aplicada.   
Tipo: String  
Obrigatório: Não

 ** DBInstanceIdentifier **   
 Contém a nova `DBInstanceIdentifier` para a instância que será aplicada ou está sendo aplicada.   
Tipo: String  
Obrigatório: Não

 ** DBSubnetGroupName **   
O novo grupo de sub-redes de banco de dados para a instância.   
Tipo: String  
Obrigatório: Não

 ** EngineVersion **   
Indica a versão do mecanismo do banco de dados.  
Tipo: String  
Obrigatório: Não

 ** Iops **   
Especifica o novo valor de IOPS provisionadas para a instância que será aplicado ou está sendo aplicado.  
Tipo: inteiro  
Obrigatório: Não

 ** LicenseModel **   
O modelo de licença da instância.  
Valores válidos: `license-included`, `bring-your-own-license`, `general-public-license`   
Tipo: string  
Obrigatório: Não

 ** MasterUserPassword **   
Contém a alteração pendente ou atualmente em andamento das credenciais mestre para a instância.  
Tipo: String  
Obrigatório: Não

 ** MultiAZ **   
Indica que a instância Single-AZ deve ser alterada apara uma implantação Multi-AZ.  
Tipo: booliano  
Obrigatório: Não

 ** PendingCloudwatchLogsExports **   
Uma lista dos tipos de log cuja configuração ainda está pendente. Esses tipos de log estão em processo de ativação ou desativação.  
Tipo: objeto [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md)  
Obrigatório: Não

 ** Port **   
Especifica a porta pendente para a instância.  
Tipo: inteiro  
Obrigatório: Não

 ** StorageType **   
Especifica o tipo de armazenamento a ser associado à instância.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_PendingModifiedValues_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingModifiedValues) 

# ResourcePendingMaintenanceActions
<a name="API_ResourcePendingMaintenanceActions"></a>

Representa o resultado de [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md). 

## Conteúdo
<a name="API_ResourcePendingMaintenanceActions_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** PendingMaintenanceActionDetails.PendingMaintenanceAction.N **   
Uma lista que fornece detalhes sobre as ações de manutenção pendentes para o recurso.  
Tipo: matriz de objetos [PendingMaintenanceAction](API_PendingMaintenanceAction.md)  
Obrigatório: Não

 ** ResourceIdentifier **   
O nome do recurso da Amazon (ARN) do recurso ao qual a ação de manutenção pendente se aplica.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_ResourcePendingMaintenanceActions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResourcePendingMaintenanceActions) 

# ServerlessV2FeaturesSupport
<a name="API_ServerlessV2FeaturesSupport"></a>

Especifica quaisquer propriedades ou limites do Amazon DocumentDB Sem Servidor que sejam diferentes entre as versões do mecanismo do Amazon DocumentDB. É possível testar os valores desse atributo ao decidir qual versão do Amazon DocumentDB usar em um cluster novo ou atualizado. Também é possível recuperar a versão de um cluster existente e verificar se essa versão oferece suporte a determinados recursos do Amazon DocumentDB Sem Servidor antes de tentar usar esses recursos.

## Conteúdo
<a name="API_ServerlessV2FeaturesSupport_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** MaxCapacity **   
O número máximo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 32, 32,5, 33, e assim por diante  
Tipo: duplo  
Obrigatório: Não

 ** MinCapacity **   
O número mínimo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 8, 8,5, 9, e assim por diante  
Tipo: duplo  
Obrigatório: Não

## Consulte também
<a name="API_ServerlessV2FeaturesSupport_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2FeaturesSupport) 

# ServerlessV2ScalingConfiguration
<a name="API_ServerlessV2ScalingConfiguration"></a>

Define a configuração de escalabilidade de um cluster do Amazon DocumentDB Sem Servidor.

## Conteúdo
<a name="API_ServerlessV2ScalingConfiguration_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** MaxCapacity **   
O número máximo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 32, 32,5, 33, e assim por diante  
Tipo: duplo  
Obrigatório: Não

 ** MinCapacity **   
O número mínimo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 8, 8,5, 9, e assim por diante  
Tipo: duplo  
Obrigatório: Não

## Consulte também
<a name="API_ServerlessV2ScalingConfiguration_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 

# ServerlessV2ScalingConfigurationInfo
<a name="API_ServerlessV2ScalingConfigurationInfo"></a>

Recupera a configuração de escalabilidade para um cluster do Amazon DocumentDB Sem Servidor.

## Conteúdo
<a name="API_ServerlessV2ScalingConfigurationInfo_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** MaxCapacity **   
O número máximo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 32, 32,5, 33, e assim por diante   
Tipo: duplo  
Obrigatório: Não

 ** MinCapacity **   
O número mínimo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 8, 8,5, 9, e assim por diante  
Tipo: duplo  
Obrigatório: Não

## Consulte também
<a name="API_ServerlessV2ScalingConfigurationInfo_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 

# Subnet
<a name="API_Subnet"></a>

 Informações detalhadas sobre uma sub-rede. 

## Conteúdo
<a name="API_Subnet_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** SubnetAvailabilityZone **   
Especifica a zona de disponibilidade da sub-rede.  
Tipo: objeto [AvailabilityZone](API_AvailabilityZone.md)  
Obrigatório: Não

 ** SubnetIdentifier **   
Especifica o identificador da sub-rede.  
Tipo: String  
Obrigatório: Não

 ** SubnetStatus **   
Especifica o status da sub-rede.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_Subnet_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Subnet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Subnet) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Subnet) 

# Tag
<a name="API_Tag"></a>

Metadados atribuídos a um recurso do Amazon DocumentDB que consiste em um par de valores-chave.

## Conteúdo
<a name="API_Tag_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** Key **   
Nome obrigatório da tag. O valor da string pode ter de 1 a 128 caracteres Unicode e não pode ter os prefixos "`aws:`" ou "`rds:`". A string pode conter apenas o conjunto de letras em Unicode, dígitos, espaço em branco, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
Tipo: String  
Obrigatório: Não

 ** Value **   
Valor de string opcional da tag. O valor da string pode ter de 1 a 256 caracteres Unicode e não pode ter os prefixos "`aws:`" ou "`rds:`". A string pode conter apenas o conjunto de letras em Unicode, dígitos, espaço em branco, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_Tag_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Tag) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Tag) 

# UpgradeTarget
<a name="API_UpgradeTarget"></a>

A versão do mecanismo de banco de dados para a qual uma instância pode ser atualizada.

## Conteúdo
<a name="API_UpgradeTarget_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** AutoUpgrade **   
Um valor que indica se a versão de destino é aplicada a todas as instâncias de banco de dados de origem que têm `AutoMinorVersionUpgrade` definido como `true`.  
Tipo: booliano  
Obrigatório: Não

 ** Description **   
A versão do mecanismo de banco de dados para a qual uma instância pode ser atualizada.  
Tipo: String  
Obrigatório: Não

 ** Engine **   
O nome do mecanismo de banco de dados de destino de atualização.  
Tipo: String  
Obrigatório: Não

 ** EngineVersion **   
O número da versão do mecanismo de banco de dados de destino de atualização.  
Tipo: String  
Obrigatório: Não

 ** IsMajorVersionUpgrade **   
Um valor que indica se um mecanismo de banco de dados é atualizado para uma versão principal.  
Tipo: booliano  
Obrigatório: Não

## Consulte também
<a name="API_UpgradeTarget_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/UpgradeTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/UpgradeTarget) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/UpgradeTarget) 

# VpcSecurityGroupMembership
<a name="API_VpcSecurityGroupMembership"></a>

Usado como elemento de resposta para consultas sobre membros do grupo de segurança da nuvem privada virtual (VPC).

## Conteúdo
<a name="API_VpcSecurityGroupMembership_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** Status **   
O status do grupo de segurança da VPC.  
Tipo: String  
Obrigatório: Não

 ** VpcSecurityGroupId **   
O nome do grupo de segurança da VPC.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_VpcSecurityGroupMembership_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/VpcSecurityGroupMembership) 

# Amazon DocumentDB Elastic Clusters
<a name="API_Types_Amazon_DocumentDB_Elastic_Clusters"></a>

Os seguintes tipos de dados são definidos pelo Amazon DocumentDB Elastic Clusters:
+  [Cluster](API_elastic_Cluster.md) 
+  [ClusterInList](API_elastic_ClusterInList.md) 
+  [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 
+  [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 
+  [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 
+  [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 
+  [Shard](API_elastic_Shard.md) 
+  [ValidationExceptionField](API_elastic_ValidationExceptionField.md) 

# Cluster
<a name="API_elastic_Cluster"></a>

Retorna informações sobre um cluster elástico específico.

## Conteúdo
<a name="API_elastic_Cluster_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** adminUserName **   <a name="documentdb-Type-elastic_Cluster-adminUserName"></a>
O nome do administrador do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** authType **   <a name="documentdb-Type-elastic_Cluster-authType"></a>
O tipo de autenticação do cluster elástico.  
Tipo: String  
Valores válidos: `PLAIN_TEXT | SECRET_ARN`   
Obrigatório: Sim

 ** clusterArn **   <a name="documentdb-Type-elastic_Cluster-clusterArn"></a>
O identificador ARN do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** clusterEndpoint **   <a name="documentdb-Type-elastic_Cluster-clusterEndpoint"></a>
O URL usado para se conectar ao cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** clusterName **   <a name="documentdb-Type-elastic_Cluster-clusterName"></a>
O nome do cluster elástico.  
Tipo: String  
Obrigatório: Sim

 ** createTime **   <a name="documentdb-Type-elastic_Cluster-createTime"></a>
Especifica a hora em que o cluster elástico foi criado, no Tempo Universal Coordenado (UTC).  
Tipo: string  
Obrigatório: Sim

 ** kmsKeyId **   <a name="documentdb-Type-elastic_Cluster-kmsKeyId"></a>
O identificador de chave do KMS a ser usado para criptografar o cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** preferredMaintenanceWindow **   <a name="documentdb-Type-elastic_Cluster-preferredMaintenanceWindow"></a>
O intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, no Tempo Universal Coordenado (UTC).  
 *Formato*: `ddd:hh24:mi-ddd:hh24:mi`   
Tipo: string  
Obrigatório: Sim

 ** shardCapacity **   <a name="documentdb-Type-elastic_Cluster-shardCapacity"></a>
O número de vCPUs atribuídas a cada fragmento de cluster elástico. O máximo é 64. Os valores permitidos são 2, 4, 8, 16, 32, 64.  
Tipo: Inteiro  
Obrigatório: Sim

 ** shardCount **   <a name="documentdb-Type-elastic_Cluster-shardCount"></a>
O número de fragmentos atribuídos ao cluster elástico. O máximo é 32.  
Tipo: inteiro  
Obrigatório: Sim

 ** status **   <a name="documentdb-Type-elastic_Cluster-status"></a>
O status 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_RECOVERABLE`   
Obrigatório: Sim

 ** subnetIds **   <a name="documentdb-Type-elastic_Cluster-subnetIds"></a>
Os IDs de sub-rede do Amazon EC2 do cluster elástico.  
Tipo: matriz de strings  
Obrigatório: Sim

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_Cluster-vpcSecurityGroupIds"></a>
Uma lista de grupos de segurança da VPC do EC2 associados a esse cluster elástico.  
Tipo: matriz de strings  
Obrigatório: Sim

 ** backupRetentionPeriod **   <a name="documentdb-Type-elastic_Cluster-backupRetentionPeriod"></a>
O número de dias durante os quais os snapshots automáticos são retidos.  
Tipo: inteiro  
Obrigatório: Não

 ** preferredBackupWindow **   <a name="documentdb-Type-elastic_Cluster-preferredBackupWindow"></a>
O intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem ativados, conforme determinado por `backupRetentionPeriod`.  
Tipo: String  
Obrigatório: Não

 ** shardInstanceCount **   <a name="documentdb-Type-elastic_Cluster-shardInstanceCount"></a>
O número de instâncias de réplica que se aplicam a todos os fragmentos no cluster. O valor 1 de `shardInstanceCount` significa que há uma instância gravadora, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade.  
Tipo: inteiro  
Obrigatório: Não

 ** shards **   <a name="documentdb-Type-elastic_Cluster-shards"></a>
O número total de fragmentos no cluster.  
Tipo: matriz de objetos [Shard](API_elastic_Shard.md)  
Obrigatório: Não

## Consulte também
<a name="API_elastic_Cluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster) 

# ClusterInList
<a name="API_elastic_ClusterInList"></a>

Uma lista de clusters elásticos do Amazon DocumentDB.

## Conteúdo
<a name="API_elastic_ClusterInList_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterInList-clusterArn"></a>
O identificador ARN do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** clusterName **   <a name="documentdb-Type-elastic_ClusterInList-clusterName"></a>
O nome do cluster elástico.  
Tipo: String  
Obrigatório: Sim

 ** status **   <a name="documentdb-Type-elastic_ClusterInList-status"></a>
O status 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_RECOVERABLE`   
Exigido: Sim

## Consulte também
<a name="API_elastic_ClusterInList_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterInList) 

# ClusterSnapshot
<a name="API_elastic_ClusterSnapshot"></a>

Retorna informações sobre um snapshot de cluster elástico específico.

## Conteúdo
<a name="API_elastic_ClusterSnapshot_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** adminUserName **   <a name="documentdb-Type-elastic_ClusterSnapshot-adminUserName"></a>
O nome do administrador do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterArn"></a>
O identificador ARN do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** clusterCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterCreationTime"></a>
Especifica a hora em que o cluster elástico foi criado, no Tempo Universal Coordenado (UTC).  
Tipo: string  
Obrigatório: Sim

 ** kmsKeyId **   <a name="documentdb-Type-elastic_ClusterSnapshot-kmsKeyId"></a>
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 **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotArn"></a>
O identificador ARN do snapshot do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** snapshotCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotCreationTime"></a>
A hora em que o snapshot do cluster elástico foi criado, no Tempo Universal Coordenado (UTC).  
Tipo: string  
Obrigatório: Sim

 ** snapshotName **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotName"></a>
O nome do snapshot do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshot-status"></a>
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_RECOVERABLE`   
Obrigatório: Sim

 ** subnetIds **   <a name="documentdb-Type-elastic_ClusterSnapshot-subnetIds"></a>
Os IDs de sub-rede do Amazon EC2 do cluster elástico.  
Tipo: matriz de strings  
Obrigatório: Sim

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_ClusterSnapshot-vpcSecurityGroupIds"></a>
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 **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotType"></a>
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 | AUTOMATED`   
Obrigatório: Não

## Consulte também
<a name="API_elastic_ClusterSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshot) 

# ClusterSnapshotInList
<a name="API_elastic_ClusterSnapshotInList"></a>

Uma lista de snapshots de cluster elástico.

## Conteúdo
<a name="API_elastic_ClusterSnapshotInList_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-clusterArn"></a>
O identificador ARN do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** snapshotArn **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotArn"></a>
O identificador ARN do snapshot do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** snapshotCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotCreationTime"></a>
A hora em que o snapshot do cluster elástico foi criado, no Tempo Universal Coordenado (UTC).  
Tipo: string  
Obrigatório: Sim

 ** snapshotName **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotName"></a>
O nome do snapshot do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-status"></a>
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_RECOVERABLE`   
Exigido: Sim

## Consulte também
<a name="API_elastic_ClusterSnapshotInList_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshotInList) 

# PendingMaintenanceActionDetails
<a name="API_elastic_PendingMaintenanceActionDetails"></a>

Recupera os detalhes das ações de manutenção que estão pendentes.

## Conteúdo
<a name="API_elastic_PendingMaintenanceActionDetails_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** action **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-action"></a>
Exibe a ação específica de uma ação de manutenção pendente.  
Tipo: string  
Obrigatório: Sim

 ** autoAppliedAfterDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-autoAppliedAfterDate"></a>
Exibe a data da janela de manutenção em que a ação é aplicada. A ação de manutenção é aplicada ao recurso durante a primeira janela de manutenção após essa data. Se essa data for especificada, todas as solicitações `NEXT_MAINTENANCE` `optInType` serão ignoradas.  
Tipo: String  
Obrigatório: Não

 ** currentApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-currentApplyDate"></a>
Exibe a data de início de vigência quando a ação de manutenção pendente é aplicada ao recurso.  
Tipo: String  
Obrigatório: Não

 ** description **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-description"></a>
Exibe uma descrição que fornece mais detalhes sobre a ação de manutenção.  
Tipo: String  
Obrigatório: Não

 ** forcedApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-forcedApplyDate"></a>
Exibe a data em que a ação de manutenção é aplicada automaticamente. A ação de manutenção é aplicada ao recurso nessa data, independentemente da janela de manutenção para o recurso. Se essa data for especificada, todas as solicitações `IMMEDIATE` `optInType` serão ignoradas.  
Tipo: String  
Obrigatório: Não

 ** optInStatus **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-optInStatus"></a>
Exibe o tipo de solicitação de `optInType` que foi recebida para o recurso.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_elastic_PendingMaintenanceActionDetails_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 

# ResourcePendingMaintenanceAction
<a name="API_elastic_ResourcePendingMaintenanceAction"></a>

Fornece informações sobre uma ação de manutenção pendente para um recurso.

## Conteúdo
<a name="API_elastic_ResourcePendingMaintenanceAction_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** pendingMaintenanceActionDetails **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-pendingMaintenanceActionDetails"></a>
Fornece informações sobre uma ação de manutenção pendente para um recurso.  
Tipo: matriz de objetos [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md)  
Obrigatório: Não

 ** resourceArn **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-resourceArn"></a>
O nome do recurso da Amazon (ARN) do Amazon DocumentDB do recurso ao qual a ação de manutenção pendente se aplica.  
Tipo: String  
Obrigatório: Não

## Consulte também
<a name="API_elastic_ResourcePendingMaintenanceAction_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 

# Shard
<a name="API_elastic_Shard"></a>

O nome do fragmento.

## Conteúdo
<a name="API_elastic_Shard_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** createTime **   <a name="documentdb-Type-elastic_Shard-createTime"></a>
A hora em que o fragmento foi criado, no Tempo Universal Coordenado (UTC).  
Tipo: string  
Obrigatório: Sim

 ** shardId **   <a name="documentdb-Type-elastic_Shard-shardId"></a>
O ID do fragmento.  
Tipo: string  
Obrigatório: Sim

 ** status **   <a name="documentdb-Type-elastic_Shard-status"></a>
O status atual do fragmento.  
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_RECOVERABLE`   
Exigido: Sim

## Consulte também
<a name="API_elastic_Shard_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Shard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Shard) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Shard) 

# ValidationExceptionField
<a name="API_elastic_ValidationExceptionField"></a>

Um campo específico no qual ocorreu uma determinada exceção de validação.

## Conteúdo
<a name="API_elastic_ValidationExceptionField_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros obrigatórios são descritos primeiro.

 ** message **   <a name="documentdb-Type-elastic_ValidationExceptionField-message"></a>
Uma mensagem de erro descrevendo a exceção de validação nesse campo.  
Tipo: string  
Obrigatório: Sim

 ** name **   <a name="documentdb-Type-elastic_ValidationExceptionField-name"></a>
O nome do campo no qual ocorreu a exceção de validação.  
Tipo: string  
Obrigatório: Sim

## Consulte também
<a name="API_elastic_ValidationExceptionField_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ValidationExceptionField) 

# Erros comuns
<a name="CommonErrors"></a>

Esta seção lista os erros comuns às ações de API de todos os serviços da AWS. Para saber os erros específicos de uma ação de API para esse serviço, consulte o tópico sobre a ação de API em questão.

 **AccessDeniedException**   
Você não tem acesso suficiente para executar essa ação.  
Código de Status HTTP: 400

 **IncompleteSignature**   
A assinatura da solicitação não segue os padrões da AWS.  
Código de Status HTTP: 400

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
O processamento da solicitação falhou por causa de um erro, uma exceção ou uma falha desconhecida.  
Código de Status HTTP: 500

 **InvalidAction**   <a name="CommonErrors-InvalidAction"></a>
A ação ou operação solicitada é inválida. Verifique se a ação foi digitada corretamente.  
Código de Status HTTP: 400

 **InvalidClientTokenId**   <a name="CommonErrors-InvalidClientTokenId"></a>
O certificado X.509 ou o ID de chave de acesso da AWS fornecido não existe em nossos registros.  
Código de status HTTP: 403

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
Você não tem permissão para realizar esta ação.  
Código de Status HTTP: 400

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
O ID da chave de acesso da AWS precisa de uma assinatura do serviço.  
Código de status HTTP: 403

 **RequestExpired**   <a name="CommonErrors-RequestExpired"></a>
A solicitação atingiu o serviço mais de 15 minutos após a data na solicitação ou mais de 15 minutos após a data de expiração da solicitação (como para URLs predeterminados), ou a data na solicitação está a mais de 15 minutos no futuro.  
Código de Status HTTP: 400

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
Falha na solicitação devido a um erro temporário do servidor.  
Código de status HTTP: 503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
A solicitação foi negada devido à limitação da solicitação.  
Código de Status HTTP: 400

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
A entrada não atende às restrições especificadas por um serviço da AWS.  
Código de Status HTTP: 400

# Parâmetros gerais
<a name="CommonParameters"></a>

A lista a seguir contém os parâmetros que todas as ações usam para assinar solicitações do Signature versão 4 com uma string de consulta. Todos os parâmetros específicos de uma ação são listados no tópico para a ação. Para obter mais informações sobre o Signature versão 4, consulte [Assinatura de solicitações de API da AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) no *Guia do usuário do IAM*.

 **Action**   <a name="CommonParameters-Action"></a>
A ação a ser executada.  
Tipo: string  
Obrigatório: Sim

 **Version**   <a name="CommonParameters-Version"></a>
A versão da API para a qual a solicitação foi escrita, expressa no formato AAAA-MM-DD.  
Tipo: string  
Obrigatório: Sim

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
O algoritmo de hash que foi usado para criar a assinatura da solicitação.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Valores Válidos: `AWS4-HMAC-SHA256`   
Obrigatório: condicional

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
O valor de escopo da credencial, uma string que inclui a sua chave de acesso, a data, a região visada, o serviço que está sendo solicitado e uma sequência de encerramento ("aws4\$1request"). O valor é expresso no seguinte formato: *chave\$1acesso*/*AAAAMMDD*/*região*/*serviço*/aws4\$1request.  
Para obter mais informações, consulte [Criação de uma solicitação de API da AWS assinada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) no *Guia do usuário do IAM*.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
A data usada para criar a assinatura. O formato deve ser o formato básico ISO 8601 (AAAAMMDD'T'HHMMSS'Z'). Por exemplo, a data/hora a seguir é um valor X-Amz-Date válido: `20120325T120000Z`.  
Condição: X-Amz-Date é opcional para todas as solicitações e pode ser usado para substituir a data usada para assinar solicitações. Se o cabeçalho Date (Data) for especificado no formato básico ISO 8601, o valor X-Amz-Date não será necessário. Quando X-Amz-Date é usado, sempre substitui o valor do cabeçalho Date (Data). Para obter mais informações, consulte [Elementos de uma assinatura de solicitação de API da AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) no *Guia do usuário do IAM*.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
O token de segurança temporário que foi obtido por meio de uma chamada para o AWS Security Token Service (AWS STS). Para obter uma lista de serviços que oferecem suporte a credenciais de segurança temporárias do AWS STS, consulte [Serviços da AWS que funcionam com o IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) no *Guia do usuário do IAM*.  
Condição: se estiver usando credenciais de segurança temporárias do AWS STS, será necessário incluir o token de segurança.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
Especifica a assinatura com codificação hexadecimal que foi calculada com base na string a ser assinada e na chave de assinatura derivada.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
Especifica todos os cabeçalhos HTTP que foram incluídos como parte da solicitação canônica. Para obter mais informações sobre a especificação de cabeçalhos assinados, consulte [Criação de uma solicitação de API da AWS assinada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) no *Guia do usuário do IAM*.  
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.  
Tipo: string  
Obrigatório: Condicional