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

DBInstance

Informações detalhadas sobre uma instância.

Conteúdo

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: sequência

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: sequência

Obrigatório: não

CertificateDetails

Detalhes do certificado do servidor da instância DB.

Tipo: objeto CertificateDetails

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: sequência

Obrigatório: não

DBInstanceArn

O nome do recurso da Amazon (ARN) da instância.

Tipo: sequência

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: sequência

Obrigatório: não

DBInstanceStatus

Especifica o estado atual desse banco de dados.

Tipo: sequência

Obrigatório: não

DbiResourceId

O identificador Região da AWS-exclusivo e imutável da instância. Esse identificador é encontrado nas entradas de AWS CloudTrail registro sempre que a AWS KMS chave da instância é acessada.

Tipo: sequência

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

Obrigatório: Não

EnabledCloudwatchLogsExports.member.N

Uma lista dos tipos de registro 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

Obrigatório: Não

Engine

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

Tipo: sequência

Obrigatório: não

EngineVersion

Indica a versão do mecanismo do banco de dados.

Tipo: sequência

Obrigatório: não

InstanceCreateTime

Fornece a data e hora em que a instância foi criada.

Tipo: carimbo de data/hora

Obrigatório: não

KmsKeyId

Se StorageEncrypted fortrue, o identificador da AWS KMS chave para a instância criptografada.

Tipo: sequência

Obrigatório: não

LatestRestorableTime

Especifica a última hora na qual um banco de dados pode ser restaurado com a point-in-time restauração.

Tipo: carimbo de data/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

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: sequência

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: sequência

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

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

Obrigatório: não

Consulte também

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