CreateDBInstance - Amazon DocumentDB

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

CreateDBInstance

Cria uma nova instância de banco de dados.

Parâmetros de Solicitação

Para obter informações sobre os parâmetros comuns que todas as ações utilizam, consulte Parâmetros comuns.

DBClusterIdentifier

O identificador do cluster ao qual a instância pertencerá.

Tipo: String

Exigido: Sim

DBInstanceClass

A capacidade de computação e memória da instância. Por exemplo, db.r5.large.

Tipo: String

Exigido: 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 podem terminar com um hífen ou conter dois hífens consecutivos.

Exemplo: mydbinstance

Tipo: String

Exigido: Sim

Engine

O nome do mecanismo de banco de dados a ser usado para essa instância.

Valor válido: docdb

Tipo: String

Exigido: 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 e escolhida pelo sistema na Região da AWS do endpoint.

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 e Criptografia de dados em trânsito 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.

Tipo: Booliano

Obrigatório: Não

PerformanceInsightsKMSKeyId

O identificador de chave do AWS KMS para criptografia de dados de Insights de Performance.

O identificador de chave AWS KMS do KMS é o ARN da chave, o ID da chave, o ARN do apelido ou o nome do apelido da chave do KMS.

Se você não especificar um valor para PerformanceInsightsKMSKeyId, 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 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

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. Você pode atribuir até 10 tags a uma instância.

Tipo: matriz de objetos Tag

Obrigatório: Não

Elementos de Resposta

O elemento a seguir é retornado pelo serviço.

DBInstance

Informações detalhadas sobre uma instância.

Tipo: objeto DBInstance

Erros

Para obter informações sobre os erros comuns que todas as ações retornam, consulte Erros comuns.

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

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

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: