DBInstance - Amazon DocumentDB

DBInstance

Información detallada sobre una instancia.

Contenido

nota

Los parámetros obligatorios se describen primero en la siguiente tabla.

AutoMinorVersionUpgrade

No se aplica. Este parámetro no se aplica a Amazon DocumentDB. Amazon DocumentDB no actualiza versiones secundarias, independientemente del valor establecido.

Tipo: Booleano

Requerido: no

AvailabilityZone

Especifica el nombre de la Zona de Disponibilidad en la que se encuentra la instancia.

Tipo: cadena

Requerido: no

BackupRetentionPeriod

Especifica el número de días durante los que se retienen las instantáneas automáticas.

Tipo: entero

Requerido: no

CACertificateIdentifier

El identificador del certificado de CA para esta instancia de base de datos.

Tipo: cadena

Requerido: no

CertificateDetails

Los detalles del certificado de servidor de la instancia de base de datos.

Tipo: objeto CertificateDetails

Requerido: no

CopyTagsToSnapshot

Es un valor que indica si se deben copiar las etiquetas de la instancia de base de datos en instantáneas de la instancia de base de datos. Las etiquetas no se copian de forma predeterminada.

Tipo: Booleano

Requerido: no

DBClusterIdentifier

Contiene el nombre del clúster al que pertenece la instancia si ésta es miembro de un clúster.

Tipo: cadena

Requerido: no

DBInstanceArn

El nombre de recurso de Amazon (ARN) de la instancia.

Tipo: cadena

Requerido: no

DBInstanceClass

Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia.

Tipo: cadena

Requerido: no

DBInstanceIdentifier

Contiene un identificador de base de datos proporcionado por el usuario. Este identificador es la clave única que identifica una instancia.

Tipo: cadena

Requerido: no

DBInstanceStatus

Especifica el estado actual de esta base de datos.

Tipo: cadena

Requerido: no

DbiResourceId

El identificador inmutable único de la Región de AWS para la instancia. Este identificador se encuentra en las entradas de registro de AWS CloudTrail cada vez que se accede a la clave de AWS KMS para la instancia.

Tipo: cadena

Requerido: no

DBSubnetGroup

Especifica información sobre el grupo de subred asociado a la instancia, incluido el nombre, la descripción y subredes en el grupo de subred.

Tipo: objeto DBSubnetGroup

Requerido: no

EnabledCloudwatchLogsExports.member.N

Una lista de tipos de registro para los que esta instancia está configurada para exportar a CloudWatch Logs.

Tipo: matriz de cadenas

Requerido: no

Endpoint

Especifica el punto de conexión.

Tipo: objeto Endpoint

Requerido: no

Engine

Proporciona el nombre del motor de base de datos que se va a usar para esta instancia.

Tipo: cadena

Requerido: no

EngineVersion

Indica la versión del motor de base de datos.

Tipo: cadena

Requerido: no

InstanceCreateTime

Proporciona la fecha y hora en que se creó la instancia.

Tipo: marca temporal

Requerido: no

KmsKeyId

Si StorageEncrypted es true, el identificador de clave AWS KMS para la instancia encriptada.

Tipo: cadena

Requerido: no

LatestRestorableTime

Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.

Tipo: marca temporal

Requerido: no

PendingModifiedValues

Especifica que los cambios a la instancia están pendientes. Este elemento solo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.

Tipo: objeto PendingModifiedValues

Requerido: no

PerformanceInsightsEnabled

Establézcalo en true si la Información de rendimiento de Amazon RDS está habilitada para la instancia de base de datos; de lo contrario, el valor es false.

Tipo: Booleano

Requerido: no

PerformanceInsightsKMSKeyId

El identificador de la clave de AWS KMS para el cifrado de datos de Performance Insights. El ID de clave de AWS KMS es el nombre de recurso de Amazon (ARN), el identificador de clave de AWS KMS o el alias de clave de AWS KMS de la clave de cifrado de AWS KMS.

Tipo: cadena

Requerido: no

PreferredBackupWindow

Especifica el intervalo de tiempo diario durante el cual se crean copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas, de acuerdo con la propiedad BackupRetentionPeriod.

Tipo: cadena

Requerido: no

PreferredMaintenanceWindow

Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).

Tipo: cadena

Requerido: no

PromotionTier

Valor que especifica el orden en el que se promueve una réplica de Amazon DocumentDB a la instancia primaria tras un fallo de la instancia primaria existente.

Tipo: entero

Requerido: no

PubliclyAccessible

No admitido. Actualmente, Amazon DocumentDB no admite puntos de conexión públicos. El valor de PubliclyAccessible es siempre false.

Tipo: Booleano

Requerido: no

StatusInfos.DBInstanceStatusInfo.N

El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.

Tipo: matriz de objetos DBInstanceStatusInfo

Requerido: no

StorageEncrypted

Especifica si la instancia está encriptada o no.

Tipo: Booleano

Requerido: no

VpcSecurityGroups.VpcSecurityGroupMembership.N

Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia.

Tipo: matriz de objetos VpcSecurityGroupMembership

Requerido: no

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte: