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á.
# CreateDBCluster
Cria um novo cluster do Amazon DocumentDB.
## Parâmetros da solicitação
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
O elemento a seguir é retornado pelo serviço.
** DBCluster **
Informações detalhadas sobre um cluster.
Tipo: objeto [DBCluster](API_DBCluster.md)
## Erros
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
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)