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: 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
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
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
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: carimbo de hora
Obrigatório: Não
- KmsKeyId
-
Se
StorageEncryptedfortrue, 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
Obrigatório: Não
- PerformanceInsightsEnabled
-
Defina como
truese 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 suporte. No momento, o Amazon DocumentDB não suporta endpoints públicos. O valor de
PubliclyAccessibleé semprefalse.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 SDKs específicos de linguagem AWS, consulte:
