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 de Solicitação
Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte Parâmetros comuns.
- 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 podem terminar com um hífen ou conter dois hífens consecutivos.
Exemplo:
my-clusterTipo: String
Exigido: Sim
-
- Engine
-
O nome do mecanismo de banco de dados a ser usado para esse cluster.
Valores válidos:
docdbTipo: String
Exigido: Sim
- AvailabilityZones.AvailabilityZone.N
-
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. Você deve 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
DBSubnetGroupexistente. Não deve ser padrão.Exemplo:
mySubnetgroupTipo: string
Obrigatório: Não
- DeletionProtection
-
Especifica se esse cluster pode ser excluído. Se
DeletionProtectionestiver ativado, o cluster não pode ser excluído, a menos que seja modificado eDeletionProtectionesteja desabilitado.DeletionProtectionprotege clusters contra exclusão acidental.Tipo: booleano
Obrigatório: Não
- EnableCloudwatchLogsExports.member.N
-
A lista de tipos de log que precisam estar habilitados para exportação para o Amazon CloudWatch Logs. Você pode habilitar logs de auditoria ou logs de profiler. Para obter mais informações, consulte Realização de auditoria nos eventos do Amazon DocumentDB e Criação de perfil das operações do Amazon DocumentDB.
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-versionassumirá 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 da chave do AWS KMS para um cluster criptografado.
O identificador da chave do AWS KMS é o nome do recurso da Amazon (ARN) para a chave de criptografia do AWS KMS. Se você estiver criando um cluster com a mesma Conta da AWS que tem a chave de criptografia do AWS KMS usada para criptografar o novo cluster, use o alias da chave do AWS KMS em vez de o ARN da chave de criptografia do AWS KMS.
Se uma chave de criptografia não for especificada em
KmsKeyId:-
Se o parâmetro
StorageEncryptedfortrue, o Amazon DocumentDB usará a chave de criptografia padrão.
O AWS KMS cria a chave de criptografia padrão para a sua Conta da AWS. Sua Conta da AWS tem uma chave de criptografia padrão diferente para cada Regiões da AWS.
Tipo: string
Obrigatório: Não
-
- MasterUsername
-
O nome do usuário mestre 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
- 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 tempo de 8 horas para cada 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:miO padrão é uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de tempo de 8 horas para cada Região da AWS, ocorrendo em um dia da semana aleatório.
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
- StorageEncrypted
-
Especifica se o cluster é criptografado.
Tipo: booleano
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 | iopt1O valor padrão é
standard.nota
Quando você cria um cluster de banco de dados do 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 comostandard.Tipo: String
Obrigatório: Não
- Tags.Tag.N
-
As tags a serem atribuídas ao cluster.
Tipo: matriz de objetos Tag
Obrigatório: Não
- VpcSecurityGroupIds.VpcSecurityGroupId.N
-
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
Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte Erros comuns.
- DBClusterAlreadyExistsFault
-
Você já tem um cluster com o identificador determinado.
Código de status HTTP: 400
- DBClusterNotFoundFault
-
DBClusterIdentifiernão se refere a um cluster existente.Código de Status HTTP: 404
- DBClusterParameterGroupNotFound
-
DBClusterParameterGroupNamenã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
-
DBInstanceIdentifiernã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
-
DBSubnetGroupNamenão se refere a um grupo de sub-redes existente.Código de Status HTTP: 404
- GlobalClusterNotFoundFault
-
GlobalClusterIdentifiernã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. Você pode 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 chave do AWS KMS.
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 um dos SDKs específicos de linguagem AWS, consulte:
