Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
API de instancias de Neptune
Acciones:
Estructuras:
CreateDBInstance (acción)
El nombre de la AWS CLI para esta API es: create-db-instance.
Crea una nueva instancia de base de datos.
Solicitud
-
AutoMinorVersionUpgrade (en la CLI:
--auto-minor-version-upgrade): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Indica que las actualizaciones de motor secundarias se aplican automáticamente a la instancia de base de datos durante el intervalo de mantenimiento.
Valor predeterminado:
true -
AvailabilityZone (en la CLI:
--availability-zone): una cadena, del tipo:string(una cadena codificada con UTF-8).La zona de disponibilidad de EC2 en la que se crea la instancia de base de datos.
Valor predeterminado: una zona de disponibilidad aleatoria y elegida por el sistema en la región de Amazon del punto de conexión.
Ejemplo:
us-east-1dRestricción: el parámetro AvailabilityZone no puede especificarse si el parámetro Multi-AZ se establece en
true. La zona de disponibilidad especificada debe estar en la misma región de Amazon que el actual punto de conexión. -
BackupRetentionPeriod (en la CLI:
--backup-retention-period): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).El número de días durante los que se retienen las copias de seguridad automatizadas.
No se usa. El clúster de base de datos administra el periodo de retención de copias de seguridad automatizadas. Para obtener más información, consulte CreateDBCluster (acción).
Valor predeterminado: 1
Restricciones:
-
Debe ser un valor entre 0 y 35.
-
No se puede establecerse en 0 si la instancia de base de datos es un origen a las réplicas de lectura
-
-
CopyTagsToSnapshot (en la CLI:
--copy-tags-to-snapshot): un BooleanOptional, del tipo:boolean(un valor booleano [true o false])."True" para copiar todas las etiquetas de la instancia de base de datos a instantáneas de la instancia de base de datos, de lo contrario "false". El valor predeterminado es false.
-
DBClusterIdentifier (en la CLI:
--db-cluster-identifier): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El identificador del clúster de base de datos al que pertenecerá la instancia.
Para obtener más información acerca de la creación de un clúster de bases de datos, consulte CreateDBCluster (acción).
Tipo: cadena
-
DBInstanceClass (en la CLI:
--db-instance-class): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).La capacidad de memoria y de cómputo de la instancia de base de datos, por ejemplo,
db.m4.large. No todas las clases de instancia de base de datos están disponibles en todas las regiones de Amazon. -
DBInstanceIdentifier (en la CLI:
--db-instance-identifier): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El identificador de instancias de base de datos. Este parámetro se almacena como una cadena en minúsculas.
Restricciones:
-
Deben contener de 1 a 63 caracteres (letras, números o guiones).
-
El primer carácter debe ser una letra.
-
No puede terminar por un guion ni contener dos guiones consecutivos.
Ejemplo:
mydbinstance -
-
DBName (en la CLI:
--db-name): una cadena, del tipo:string(una cadena codificada con UTF-8).No admitido.
-
DBParameterGroupName (en la CLI:
--db-parameter-group-name): una cadena, del tipo:string(una cadena codificada con UTF-8).Nombre del grupo de parámetros de base de datos que desea asociar a esta instancia de base de datos. Si se omite este argumento, se utiliza el DBParameterGroup predeterminado para el motor especificado.
Restricciones:
-
Debe tener de 1 a 255 letras, números o guiones.
-
El primer carácter debe ser una letra
-
No puede terminar por un guion ni contener dos guiones consecutivos
-
-
DBSecurityGroups (en la CLI:
--db-security-groups): una cadena, del tipo:string(una cadena codificada con UTF-8).Lista de grupos de seguridad de base de datos que se van a asociar a esta instancia de base de datos.
Valor predeterminado: el grupo de seguridad de base de datos predeterminado para el motor de base de datos.
-
DBSubnetGroupName (en la CLI:
--db-subnet-group-name): una cadena, del tipo:string(una cadena codificada con UTF-8).Un grupo de subred de base de datos con el que asociar esta instancia de base de datos.
Si no hay un grupo de subred de base de datos, entonces se trata de una instancia de base de datos no VPC.
-
DeletionProtection (en la CLI:
--deletion-protection): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Es un valor que indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación. La protección contra eliminación está deshabilitada de forma predeterminada. Consulte Eliminación de una instancia de base de datos.
Las instancias de base de datos en un clúster de bases de datos se pueden eliminar incluso cuando la protección contra eliminación esté habilitada su clúster de bases de datos principal.
-
Domain (en la CLI:
--domain): una cadena, del tipo:string(una cadena codificada con UTF-8).Especifique el dominio de Active Directory en el que crear la instancia.
-
DomainIAMRoleName (en la CLI:
--domain-iam-role-name): una cadena, del tipo:string(una cadena codificada con UTF-8).Especifique el nombre del rol de IAM que se utilizará al realizar llamadas a la API al servicio de directorio.
-
EnableCloudwatchLogsExports (en la CLI:
--enable-cloudwatch-logs-exports): una cadena, del tipo:string(una cadena codificada con UTF-8).La lista de tipos de registro que deben habilitarse para exportar a CloudWatch Logs.
-
EnableIAMDatabaseAuthentication (en la CLI:
--enable-iam-database-authentication): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).No es compatible con Neptune (se pasa por alto).
-
Engine (en la CLI:
--engine): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).Nombre del motor de base de datos que se va a usar para esta instancia.
Valores válidos:
neptune -
EngineVersion (en la CLI:
--engine-version): una cadena, del tipo:string(una cadena codificada con UTF-8).El número de versión del motor de base de datos que se debe usar. En la actualidad, no tiene ningún efecto establecer este parámetro.
-
Iops (en la CLI:
--iops): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).La cantidad de IOPS provisionadas (operaciones de entrada/salida por segundo) asignada inicialmente para la instancia de base de datos.
-
KmsKeyId (en la CLI:
--kms-key-id): una cadena, del tipo:string(una cadena codificada con UTF-8).El identificador de la clave de Amazon KMS de una instancia de base de datos cifrada.
El identificador de la clave de KMS es el Nombre de recurso de Amazon (ARN) de la clave de cifrado de KMS. Si está creando una instancia de base de datos con la misma cuenta de Amazon a la que pertenece la clave de cifrado de KMS utilizada para cifrar la nueva instancia de base de datos, puede utilizar el alias de la clave de KMS en lugar del ARN de la clave de cifrado de KMS.
No se usa. El clúster de base de datos administra el identificador de claves de KMS. Para obtener más información, consulte CreateDBCluster (acción).
Si el parámetro
StorageEncryptedes "true", y no especifica un valor para el parámetroKmsKeyId, Amazon Neptune utilizará su clave de cifrado predeterminada. Amazon KMS crea la clave de cifrado predeterminada para su cuenta de Amazon. Su cuenta de Amazon dispone de una clave de cifrado predeterminada diferente para cada región de Amazon. -
LicenseModel (en la CLI:
--license-model): una cadena, del tipo:string(una cadena codificada con UTF-8).Información del modelo de licencias de esta instancia de base de datos.
Valores válidos:
license-included|bring-your-own-license|general-public-license -
MonitoringInterval (en la CLI:
--monitoring-interval): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos. Para deshabilitar la recopilación de métricas de monitorización mejorada, especifique 0. El valor predeterminado es 0.
Si se especifica
MonitoringRoleArn, también debe establecerMonitoringIntervalen un valor distinto de 0.Valores válidos:
0, 1, 5, 10, 15, 30, 60 -
MonitoringRoleArn (en la CLI:
--monitoring-role-arn): una cadena, del tipo:string(una cadena codificada con UTF-8).El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs. Por ejemplo,
arn:aws:iam:123456789012:role/emaccess.Si se establece
MonitoringIntervalen un valor distinto de 0, debe suministrar un valor paraMonitoringRoleArn. -
MultiAZ (en la CLI:
--multi-az): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Especifica si la instancia de base de datos es una implementación Multi-AZ. No puede establecer el parámetro AvailabilityZone si el parámetro MultiAZ está establecido en "true".
-
Port (en la CLI:
--port): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).El número de puerto en el que la base de datos acepta conexiones.
No se usa. El clúster de base de datos administra el puerto. Para obtener más información, consulte CreateDBCluster (acción).
Valor predeterminado:
8182Tipo: número entero
-
PreferredBackupWindow (en la CLI:
--preferred-backup-window): una cadena, del tipo:string(una cadena codificada con UTF-8).El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas.
No se usa. El clúster de base de datos administra el intervalo de tiempo diario para la creación de copias de seguridad automatizadas. Para obtener más información, consulte CreateDBCluster (acción).
-
PreferredMaintenanceWindow (en la CLI:
--preferred-maintenance-window): una cadena, del tipo:string(una cadena codificada con UTF-8).El intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en tiempo universal coordinado (UTC).
Formato:
ddd:hh24:mi-ddd:hh24:miEl valor predeterminado es un periodo de 30 minutos seleccionado al azar de un bloque de 8 horas de tiempo para cada región de Amazon, que tiene lugar un día de la semana de forma aleatoria.
Días válidos: lunes, martes, miércoles, jueves, viernes, sábado, domingo.
Restricciones: plazo mínimo de 30 minutos.
-
PromotionTier (en la CLI:
--promotion-tier): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).Un valor que especifica el orden en que se promueven las réplicas de lectura a instancia principal tras un error de la instancia principal existente.
Valor predeterminado: 1
Valores válidos: 0 - 15
-
PubliclyAccessible (en la CLI:
--publicly-accessible): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Hay que dejar de utilizar este marcador.
-
StorageEncrypted (en la CLI:
--storage-encrypted): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Especifica si la instancia de base de datos está cifrada.
No se usa. El cifrado para las instancias de base de datos es gestionado por el clúster de base de datos. Para obtener más información, consulte CreateDBCluster (acción).
Valor predeterminado: false
-
StorageType (en la CLI:
--storage-type): una cadena, del tipo:string(una cadena codificada con UTF-8).No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
-
Tags (en la CLI:
--tags): una matriz de objetos Tag.Las etiquetas que se van a asignar a la nueva instancia.
-
TdeCredentialArn (en la CLI:
--tde-credential-arn): una cadena, del tipo:string(una cadena codificada con UTF-8).El ARN del almacén de claves con el que asociar la instancia para el cifrado de TDE.
-
TdeCredentialPassword (en la CLI:
--tde-credential-password): una SensitiveString, del tipo:string(una cadena codificada con UTF-8).La contraseña del ARN dado del almacén de claves para poder obtener acceso al dispositivo.
-
Timezone (en la CLI:
--timezone): una cadena, del tipo:string(una cadena codificada con UTF-8).La zona horaria de la instancia de base de datos.
-
VpcSecurityGroupIds (en la CLI:
--vpc-security-group-ids): una cadena, del tipo:string(una cadena codificada con UTF-8).Lista de grupos de seguridad de VPC de EC2 que se van a asociar a esta instancia de base de datos.
No se usa. La lista asociada de grupos de seguridad de VPC de EC2 administrada por este clúster de base de datos. Para obtener más información, consulte CreateDBCluster (acción).
Valor predeterminado: el grupo de seguridad de VPC de EC2 predeterminado para la VPC del grupo de la subred de base de datos.
Respuesta
Contiene los detalles de una instancia de base de datos de Amazon Neptune.
Este tipo de datos se utiliza como un elemento de respuesta en la acción DescribeDBInstances (acción).
-
AutoMinorVersionUpgrade: un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica que hay parches de versión secundaria que se aplican automáticamente.
-
AvailabilityZone: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el nombre de la zona de disponibilidad en la que se encuentra la instancia de base de datos.
-
BackupRetentionPeriod: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
-
CACertificateIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).El identificador del certificado de CA para esta instancia de base de datos.
-
CopyTagsToSnapshot: un booleano, del tipo:
boolean(un valor booleano [true o false]).Especifica si las etiquetas se copian de la instancia de base de datos a instantáneas de la instancia de base de datos.
-
DBClusterIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Si la instancia de base de datos es miembro de un clúster de base de datos, contiene el nombre del clúster de base de datos del que la instancia de base de datos es miembro.
-
DBInstanceArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El Nombre de recurso de Amazon (ARN) de la instancia de base de datos.
-
DBInstanceClass: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia de base de datos.
-
DBInstanceIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene un identificador de bases de datos facilitado por el usuario. Este identificador es la clave única que identifica una instancia de base de datos.
-
DbInstancePort: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el puerto que escucha la instancia de base de datos. Si la instancia de base de datos forma parte de un clúster de base de datos, este puede ser un puerto distinto del puerto del clúster de base de datos.
-
DBInstanceStatus: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el estado actual de esta base de datos.
-
DbiResourceId: una cadena, del tipo:
string(una cadena codificada con UTF-8).El identificador inmutable único de la región de Amazon para la instancia de base de datos. Este identificador se encuentra en entradas de registro de Amazon CloudTrail cuando se accede a la clave de Amazon KMS para la instancia de base de datos.
-
DBName: una cadena, del tipo:
string(una cadena codificada con UTF-8).El nombre de la base de datos.
-
DBParameterGroups: matriz de objetos DBParameterGroupStatus.
Proporciona la lista de grupos de parámetros de base de datos que se aplica a esta instancia de base de datos.
-
DBSecurityGroups: matriz de objetos DBSecurityGroupMembership.
Proporciona la lista de elementos de grupo de seguridad de base de datos que contiene solo los subelementos
DBSecurityGroup.NameyDBSecurityGroup.Status. -
DBSubnetGroup: objeto DBSubnetGroup.
Especifica información sobre el grupo de subred asociado a la instancia de base de datos, incluido el nombre, la descripción y subredes en el grupo de subred.
-
DeletionProtection: un BooleanOptional, del tipo:
boolean(un valor booleano [true o false]).Indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La instancia no se puede eliminar cuando está habilitada la protección contra eliminación. Consulte Eliminación de una instancia de base de datos.
-
DomainMemberships: matriz de objetos DomainMembership.
No compatible
-
EnabledCloudwatchLogsExports: una cadena, del tipo:
string(una cadena codificada con UTF-8).Una lista de tipos de registro para los que esta instancia de base de datos está configurada para exportar a CloudWatch Logs.
-
Endpoint: objeto Punto de conexión.
Especifica el punto de conexión de conexión.
-
Engine: una cadena, del tipo:
string(una cadena codificada con UTF-8).Proporciona el nombre del motor de base de datos que se va a usar para esta instancia de base de datos.
-
EngineVersion: una cadena, del tipo:
string(una cadena codificada con UTF-8).Indica la versión del motor de base de datos.
-
EnhancedMonitoringResourceArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El Nombre de recurso de Amazon (ARN) del flujo de registros de Amazon CloudWatch Logs que recibe los datos de métricas de monitorización mejorada para la instancia de base de datos.
-
IAMDatabaseAuthenticationEnabled: un booleano, del tipo:
boolean(un valor booleano [true o false]).True si la autenticación de Amazon Identity and Access Management (IAM) está habilitada; de lo contrario, el valor es False.
-
InstanceCreateTime: un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).Proporciona la fecha y hora en que se creó la instancia de base de datos.
-
Iops: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el valor de las IOPS provisionadas (las operaciones de E/S por segundo).
-
KmsKeyId: una cadena, del tipo:
string(una cadena codificada con UTF-8).No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
-
LatestRestorableTime: un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
-
LicenseModel: una cadena, del tipo:
string(una cadena codificada con UTF-8).Información del modelo de licencias de esta instancia de base de datos.
-
MonitoringInterval: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos.
-
MonitoringRoleArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs.
-
MultiAZ: un booleano, del tipo:
boolean(un valor booleano [true o false]).Especifica si la instancia de base de datos es una implementación Multi-AZ.
-
PendingModifiedValues: objeto PendingModifiedValues.
Especifica que los cambios a la instancia de base de datos están pendientes. Este elemento sólo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.
-
PreferredBackupWindow: una cadena, del tipo:
string(una cadena codificada con UTF-8).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. -
PreferredMaintenanceWindow: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
-
PromotionTier: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente.
-
PubliclyAccessible: un booleano, del tipo:
boolean(un valor booleano [true o false]).Hay que dejar de utilizar este marcador.
-
ReadReplicaDBClusterIdentifiers: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene uno o varios identificadores de los clústeres de base de datos que son réplicas de lectura de esta instancia de base de datos.
-
ReadReplicaDBInstanceIdentifiers: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene uno o varios identificadores de las réplicas de lectura asociados con esta instancia de base de datos.
-
ReadReplicaSourceDBInstanceIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene el identificador de la instancia de base de datos de origen si esta instancia de base de datos es una réplica de lectura.
-
SecondaryAvailabilityZone: una cadena, del tipo:
string(una cadena codificada con UTF-8).Si está presente, especifica el nombre de la zona de disponibilidad secundaria para una instancia de base de datos compatible con Multi-AZ.
-
StatusInfos: matriz de objetos DBInstanceStatusInfo.
El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.
-
StorageEncrypted: un booleano, del tipo:
boolean(un valor booleano [true o false]).No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
-
StorageType: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el tipo de almacenamiento asociado con la instancia de base de datos.
-
TdeCredentialArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del almacén de claves con el que se asocia la instancia para el cifrado de TDE.
-
Timezone: una cadena, del tipo:
string(una cadena codificada con UTF-8).No admitido.
-
VpcSecurityGroups: matriz de objetos VpcSecurityGroupMembership.
Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia de base de datos.
Errores
DeleteDBInstance (acción)
El nombre de la AWS CLI para esta API es: delete-db-instance.
La acción DeleteDBInstance elimina una instancia de base de datos aprovisionada anteriormente. Al eliminar una instancia de base de datos, se eliminan todas las copias de seguridad automatizadas para esa instancia y no se pueden recuperar. Las instantáneas de base de datos manuales de la instancia de base de datos que va a eliminar DeleteDBInstance no se eliminan.
Si solicita a una instantánea de base de datos final el estado de la instancia de base de datos de Amazon Neptune es deleting hasta que se crea la instantánea de base de datos. La acción de la API DescribeDBInstance se utiliza para monitorizar el estado de esta operación. La acción no se puede cancelar o revertir una vez enviada.
Tenga en cuenta que cuando una instancia de base de datos se encuentra en un estado de error y tiene un estado de failed, incompatible-restore o incompatible-network, solo puede eliminarlo cuando el parámetro SkipFinalSnapshot se establece en true.
No puede eliminar una instancia de base de datos si es la única instancia en el clúster de base de datos o si tiene habilitada la protección contra eliminación.
Solicitud
-
DBInstanceIdentifier (en la CLI:
--db-instance-identifier): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El identificador de instancias de bases de datos para la instancia de base de datos que se va a eliminar. Este parámetro no distingue entre mayúsculas y minúsculas.
Restricciones:
-
Debe coincidir con el nombre de una instancia de base de datos existente.
-
-
FinalDBSnapshotIdentifier (en la CLI:
--final-db-snapshot-identifier): una cadena, del tipo:string(una cadena codificada con UTF-8).El DBSnapshotIdentifier del nuevo DBSnapshot se crea cuando SkipFinalSnapshot se establece en
false.nota
Si se especifica este parámetro y también se establece el parámetro SkipFinalShapshot en "true", se producirá un error.
Restricciones:
-
Debe tener de 1 a 255 letras o números.
-
El primer carácter debe ser una letra
-
No puede terminar por un guion ni contener dos guiones consecutivos
-
No puede especificarse al eliminar una réplica de lectura.
-
-
SkipFinalSnapshot (en la CLI:
--skip-final-snapshot): un booleano, del tipo:boolean(un valor booleano [true o false]).Determina si se crea una instantánea de base de datos antes de que se elimine la instancia de base de datos. Si se especifica
true, no se crea DBSnapshot. Si se especificafalse, se crea una instantánea de base de datos antes de que se elimine la instancia de base de datos.Tenga en cuenta que cuando una instancia de base de datos se encuentra en los estados "failed", "incompatible-restore" o "incompatible-network", solo puede eliminarla cuando el parámetro SkipFinalSnapshot se establece en "true".
Especifique
trueal eliminar una réplica de lectura.nota
Deberá especificarse el parámetro FinalDBSnapshotIdentifier si SkipFinalSnapshot es
false.Valor predeterminado:
false
Respuesta
Contiene los detalles de una instancia de base de datos de Amazon Neptune.
Este tipo de datos se utiliza como un elemento de respuesta en la acción DescribeDBInstances (acción).
-
AutoMinorVersionUpgrade: un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica que hay parches de versión secundaria que se aplican automáticamente.
-
AvailabilityZone: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el nombre de la zona de disponibilidad en la que se encuentra la instancia de base de datos.
-
BackupRetentionPeriod: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
-
CACertificateIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).El identificador del certificado de CA para esta instancia de base de datos.
-
CopyTagsToSnapshot: un booleano, del tipo:
boolean(un valor booleano [true o false]).Especifica si las etiquetas se copian de la instancia de base de datos a instantáneas de la instancia de base de datos.
-
DBClusterIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Si la instancia de base de datos es miembro de un clúster de base de datos, contiene el nombre del clúster de base de datos del que la instancia de base de datos es miembro.
-
DBInstanceArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El Nombre de recurso de Amazon (ARN) de la instancia de base de datos.
-
DBInstanceClass: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia de base de datos.
-
DBInstanceIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene un identificador de bases de datos facilitado por el usuario. Este identificador es la clave única que identifica una instancia de base de datos.
-
DbInstancePort: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el puerto que escucha la instancia de base de datos. Si la instancia de base de datos forma parte de un clúster de base de datos, este puede ser un puerto distinto del puerto del clúster de base de datos.
-
DBInstanceStatus: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el estado actual de esta base de datos.
-
DbiResourceId: una cadena, del tipo:
string(una cadena codificada con UTF-8).El identificador inmutable único de la región de Amazon para la instancia de base de datos. Este identificador se encuentra en entradas de registro de Amazon CloudTrail cuando se accede a la clave de Amazon KMS para la instancia de base de datos.
-
DBName: una cadena, del tipo:
string(una cadena codificada con UTF-8).El nombre de la base de datos.
-
DBParameterGroups: matriz de objetos DBParameterGroupStatus.
Proporciona la lista de grupos de parámetros de base de datos que se aplica a esta instancia de base de datos.
-
DBSecurityGroups: matriz de objetos DBSecurityGroupMembership.
Proporciona la lista de elementos de grupo de seguridad de base de datos que contiene solo los subelementos
DBSecurityGroup.NameyDBSecurityGroup.Status. -
DBSubnetGroup: objeto DBSubnetGroup.
Especifica información sobre el grupo de subred asociado a la instancia de base de datos, incluido el nombre, la descripción y subredes en el grupo de subred.
-
DeletionProtection: un BooleanOptional, del tipo:
boolean(un valor booleano [true o false]).Indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La instancia no se puede eliminar cuando está habilitada la protección contra eliminación. Consulte Eliminación de una instancia de base de datos.
-
DomainMemberships: matriz de objetos DomainMembership.
No compatible
-
EnabledCloudwatchLogsExports: una cadena, del tipo:
string(una cadena codificada con UTF-8).Una lista de tipos de registro para los que esta instancia de base de datos está configurada para exportar a CloudWatch Logs.
-
Endpoint: objeto Punto de conexión.
Especifica el punto de conexión de conexión.
-
Engine: una cadena, del tipo:
string(una cadena codificada con UTF-8).Proporciona el nombre del motor de base de datos que se va a usar para esta instancia de base de datos.
-
EngineVersion: una cadena, del tipo:
string(una cadena codificada con UTF-8).Indica la versión del motor de base de datos.
-
EnhancedMonitoringResourceArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El Nombre de recurso de Amazon (ARN) del flujo de registros de Amazon CloudWatch Logs que recibe los datos de métricas de monitorización mejorada para la instancia de base de datos.
-
IAMDatabaseAuthenticationEnabled: un booleano, del tipo:
boolean(un valor booleano [true o false]).True si la autenticación de Amazon Identity and Access Management (IAM) está habilitada; de lo contrario, el valor es False.
-
InstanceCreateTime: un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).Proporciona la fecha y hora en que se creó la instancia de base de datos.
-
Iops: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el valor de las IOPS provisionadas (las operaciones de E/S por segundo).
-
KmsKeyId: una cadena, del tipo:
string(una cadena codificada con UTF-8).No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
-
LatestRestorableTime: un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
-
LicenseModel: una cadena, del tipo:
string(una cadena codificada con UTF-8).Información del modelo de licencias de esta instancia de base de datos.
-
MonitoringInterval: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos.
-
MonitoringRoleArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs.
-
MultiAZ: un booleano, del tipo:
boolean(un valor booleano [true o false]).Especifica si la instancia de base de datos es una implementación Multi-AZ.
-
PendingModifiedValues: objeto PendingModifiedValues.
Especifica que los cambios a la instancia de base de datos están pendientes. Este elemento sólo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.
-
PreferredBackupWindow: una cadena, del tipo:
string(una cadena codificada con UTF-8).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. -
PreferredMaintenanceWindow: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
-
PromotionTier: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente.
-
PubliclyAccessible: un booleano, del tipo:
boolean(un valor booleano [true o false]).Hay que dejar de utilizar este marcador.
-
ReadReplicaDBClusterIdentifiers: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene uno o varios identificadores de los clústeres de base de datos que son réplicas de lectura de esta instancia de base de datos.
-
ReadReplicaDBInstanceIdentifiers: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene uno o varios identificadores de las réplicas de lectura asociados con esta instancia de base de datos.
-
ReadReplicaSourceDBInstanceIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene el identificador de la instancia de base de datos de origen si esta instancia de base de datos es una réplica de lectura.
-
SecondaryAvailabilityZone: una cadena, del tipo:
string(una cadena codificada con UTF-8).Si está presente, especifica el nombre de la zona de disponibilidad secundaria para una instancia de base de datos compatible con Multi-AZ.
-
StatusInfos: matriz de objetos DBInstanceStatusInfo.
El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.
-
StorageEncrypted: un booleano, del tipo:
boolean(un valor booleano [true o false]).No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
-
StorageType: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el tipo de almacenamiento asociado con la instancia de base de datos.
-
TdeCredentialArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del almacén de claves con el que se asocia la instancia para el cifrado de TDE.
-
Timezone: una cadena, del tipo:
string(una cadena codificada con UTF-8).No admitido.
-
VpcSecurityGroups: matriz de objetos VpcSecurityGroupMembership.
Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia de base de datos.
Errores
ModifyDBInstance (acción)
El nombre de la AWS CLI para esta API es: modify-db-instance.
Modifica la configuración de una instancia de base de datos. Puede cambiar uno o varios parámetros de configuración de la base de datos mediante la especificación de estos parámetros y los nuevos valores en la solicitud. Para obtener información sobre qué modificaciones puede realizar a su instancia de base de datos, llame a DescribeValidDBInstanceModifications (acción) antes de llamar a ModifyDBInstance (acción).
Solicitud
-
AllowMajorVersionUpgrade (en la CLI:
--allow-major-version-upgrade): un booleano, del tipo:boolean(un valor booleano [true o false]).Indica que se permiten actualizaciones de la versión principal. El cambio de este parámetro no produce una interrupción y el cambio se aplica de forma asíncrona tan pronto como sea posible.
-
ApplyImmediately (en la CLI:
--apply-immediately): un booleano, del tipo:boolean(un valor booleano [true o false]).Especifica si las modificaciones de esta solicitud y todas las modificaciones pendientes se aplican de manera asíncrona en cuanto es posible, independientemente de la configuración de
PreferredMaintenanceWindowde esta instancia de base de datos.Si este parámetro se establece en
false, los cambios realizados en la instancia de base de datos se aplican durante la siguiente ventana de mantenimiento. Algunos cambios de los parámetros puede causar una interrupción y se aplican en la siguiente llamada a RebootDBInstance (acción), o el siguiente reinicio por error.Valor predeterminado:
false -
AutoMinorVersionUpgrade (en la CLI:
--auto-minor-version-upgrade): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Indica que las actualizaciones de versión secundarias se aplican automáticamente a la instancia de base de datos durante el periodo de mantenimiento. El cambio de este parámetro no produce una interrupción, salvo en el siguiente caso, y el cambio se aplica de forma asíncrona tan pronto como sea posible. Se producirá una interrupción si este parámetro se establece en
truedurante el periodo de mantenimiento, y hay una versión secundaria más nueva disponible y Neptune ha permitido la aplicación de parches automática para esa versión del motor. -
BackupRetentionPeriod (en la CLI:
--backup-retention-period): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).No se usa. El clúster de base de datos administra el periodo de retención de copias de seguridad automatizadas. Para obtener más información, consulte ModifyDBCluster (acción).
Valor predeterminado: Utiliza la configuración existente
-
CACertificateIdentifier (en la CLI:
--ca-certificate-identifier): una cadena, del tipo:string(una cadena codificada con UTF-8).Indica el certificado que debe asociarse a la instancia.
-
CloudwatchLogsExportConfiguration (en la CLI:
--cloudwatch-logs-export-configuration): un objeto CloudwatchLogsExportConfiguration.La opción de configuración para los tipos de registro que se debe habilitar para la exportación a CloudWatch Logs para una instancia de base de datos específica o un clúster de base de datos.
-
CopyTagsToSnapshot (en la CLI:
--copy-tags-to-snapshot): un BooleanOptional, del tipo:boolean(un valor booleano [true o false])."True" para copiar todas las etiquetas de la instancia de base de datos a instantáneas de la instancia de base de datos, de lo contrario "false". El valor predeterminado es false.
-
DBInstanceClass (en la CLI:
--db-instance-class): una cadena, del tipo:string(una cadena codificada con UTF-8).La capacidad nueva de memoria y de cómputo de la instancia de base de datos, por ejemplo,
db.m4.large. No todas las clases de instancia de base de datos están disponibles en todas las regiones de Amazon.Si modifica la clase de la instancia de base de datos se produce una interrupción durante el cambio. El cambio se aplica durante la siguiente ventana de mantenimiento, a menos que
ApplyImmediatelyse especifique comotruepara esta solicitud.Valor predeterminado: Utiliza la configuración existente
-
DBInstanceIdentifier (en la CLI:
--db-instance-identifier): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El identificador de instancias de base de datos. Este valor se almacena como una cadena en minúsculas.
Restricciones:
-
Debe coincidir con el identificador de una DBInstance existente.
-
-
DBParameterGroupName (en la CLI:
--db-parameter-group-name): una cadena, del tipo:string(una cadena codificada con UTF-8).Nombre del grupo de parámetros de base de datos que se va a aplicar a esta instancia de base de datos. Cambiar este ajuste no produce una interrupción. El nombre del grupo de parámetros se modifica inmediatamente, pero los cambios del parámetro no se aplican hasta que se reinicia la instancia sin conmutación por error. La instancia de base de datos NO se reiniciará automáticamente y los cambios de los parámetros NO se aplicarán durante la siguiente ventana de mantenimiento.
Valor predeterminado: Utiliza la configuración existente
Restricciones: el grupo de parámetros de base de datos debe estar en la misma familia de grupos de parámetros de base de datos que esta instancia de base de datos.
-
DBPortNumber (en la CLI:
--db-port-number): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).El número de puerto en el que la base de datos acepta conexiones.
El valor del parámetro
DBPortNumberno debe coincidir con ninguno de los valores de puertos especificados para el grupo de opciones para la instancia de base de datos.La base de datos se reiniciará si se cambia el valor
DBPortNumberindependientemente del valor del parámetroApplyImmediately.Valor predeterminado:
8182 -
DBSecurityGroups (en la CLI:
--db-security-groups): una cadena, del tipo:string(una cadena codificada con UTF-8).Lista de grupos de seguridad de base de datos que se van a autorizar en esta instancia de base de datos. El cambio de esta configuración no produce una interrupción y el cambio se aplica de forma asíncrona tan pronto como sea posible.
Restricciones:
-
Si se suministra, debe coincidir con DBSecurityGroups existentes.
-
-
DBSubnetGroupName (en la CLI:
--db-subnet-group-name): una cadena, del tipo:string(una cadena codificada con UTF-8).El grupo de subredes de base de datos nuevo de la instancia de base de datos. Puede utilizar este parámetro para mover la instancia de base de datos a otra VPC.
Cambiar el grupo de subredes provoca una interrupción durante el cambio. El cambio se aplica durante la siguiente ventana de mantenimiento, a menos que especifique
truepara el parámetroApplyImmediately.Restricciones: si se proporciona, debe coincidir con el nombre de un DBSubnetGroup existente.
Ejemplo:
mySubnetGroup -
DeletionProtection (en la CLI:
--deletion-protection): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Es un valor que indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación. La protección contra eliminación está deshabilitada de forma predeterminada. Consulte Eliminación de una instancia de base de datos.
-
Domain (en la CLI:
--domain): una cadena, del tipo:string(una cadena codificada con UTF-8).No admitido.
-
DomainIAMRoleName (en la CLI:
--domain-iam-role-name): una cadena, del tipo:string(una cadena codificada con UTF-8).No compatible
-
EnableIAMDatabaseAuthentication (en la CLI:
--enable-iam-database-authentication): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).True para habilitar el mapeo de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos; de lo contrario, el valor es False.
Puede utilizar la autenticación de bases de datos de IAM para los siguientes motores de bases de datos
No se usa. El clúster de base de datos administra el mapeo de cuentas de Amazon IAM a cuentas de base de datos. Para obtener más información, consulte ModifyDBCluster (acción).
Valor predeterminado:
false -
EngineVersion (en la CLI:
--engine-version): una cadena, del tipo:string(una cadena codificada con UTF-8).Número de versión del motor de base de datos al que se va a actualizar. En la actualidad, no tiene ningún efecto establecer este parámetro. Para actualizar el motor de la base de datos a la versión más reciente, utilice la API ApplyPendingMaintenanceAction (acción).
-
Iops (en la CLI:
--iops): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).El valor nuevo de la IOPS provisionada (operaciones de E/S por segundo) para la instancia.
El cambio de esta configuración no produce una interrupción y el cambio se aplica durante la siguiente ventana de mantenimiento a menos que el parámetro
ApplyImmediatelyse haya establecido entruepara esta solicitud.Valor predeterminado: Utiliza la configuración existente
-
MonitoringInterval (en la CLI:
--monitoring-interval): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos. Para deshabilitar la recopilación de métricas de monitorización mejorada, especifique 0. El valor predeterminado es 0.
Si se especifica
MonitoringRoleArn, también debe establecerMonitoringIntervalen un valor distinto de 0.Valores válidos:
0, 1, 5, 10, 15, 30, 60 -
MonitoringRoleArn (en la CLI:
--monitoring-role-arn): una cadena, del tipo:string(una cadena codificada con UTF-8).El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs. Por ejemplo,
arn:aws:iam:123456789012:role/emaccess.Si se establece
MonitoringIntervalen un valor distinto de 0, debe suministrar un valor paraMonitoringRoleArn. -
MultiAZ (en la CLI:
--multi-az): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Especifica si la instancia de base de datos es una implementación Multi-AZ. El cambio de este parámetro no produce una interrupción y el cambio se aplica durante la siguiente ventana de mantenimiento a menos que el parámetro
ApplyImmediatelyse haya establecido entruepara esta solicitud. -
NewDBInstanceIdentifier (en la CLI:
--new-db-instance-identifier): una cadena, del tipo:string(una cadena codificada con UTF-8).El nuevo identificador de instancia de base de datos para la instancia de base de datos cuando se cambia el nombre de una instancia de base de datos. Cuando cambie el identificador de instancia de base de datos, la instancia se reiniciará inmediatamente si establece
Apply Immediatelyen "true", o durante la siguiente ventana de mantenimiento si estableceApply Immediatelyen "false". Este valor se almacena como una cadena en minúsculas.Restricciones:
-
Deben contener de 1 a 63 caracteres (letras, números o guiones).
-
El primer carácter debe ser una letra.
-
No puede terminar por un guion ni contener dos guiones consecutivos.
Ejemplo:
mydbinstance -
-
PreferredBackupWindow (en la CLI:
--preferred-backup-window): una cadena, del tipo:string(una cadena codificada con UTF-8).El intervalo de tiempo diario durante el cual se crean copias de seguridad automatizadas si están habilitadas.
No se usa. El clúster de base de datos administra el intervalo de tiempo diario para la creación de copias de seguridad automatizadas. Para obtener más información, consulte ModifyDBCluster (acción).
Restricciones:
-
Tiene que tener el formato hh24:mi-hh24:mi
-
Debe estar en tiempo universal coordinado (UTC)
-
No debe entrar en conflicto con la ventana de mantenimiento preferida.
-
Debe durar al menos 30 minutos.
-
-
PreferredMaintenanceWindow (en la CLI:
--preferred-maintenance-window): una cadena, del tipo:string(una cadena codificada con UTF-8).El intervalo de tiempo semanal (en UTC) durante el cual puede llevarse a cabo el mantenimiento del sistema, que puede producir una interrupción. El cambio de este parámetro no produce una interrupción, salvo en la siguiente situación, y el cambio se aplica de forma asíncrona tan pronto como sea posible. Si hay acciones pendientes que provocan un reinicio, y el periodo de mantenimiento se cambia para incluir la hora actual, cambiar este parámetro provocará un reinicio de la instancia de base de datos. Si cambiar este periodo a la hora actual, debe haber al menos 30 minutos entre la hora actual y el final del periodo, para asegurarse de que se apliquen los cambios pendientes.
Valor predeterminado: Utiliza la configuración existente
Formato: ddd:hh24:mi-ddd:hh24:mi
Días válidos: lunes | martes | miércoles | jueves | viernes | sábado | domingo
Restricciones: debe durar al menos 30 minutos.
-
PromotionTier (en la CLI:
--promotion-tier): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente.
Valor predeterminado: 1
Valores válidos: 0 - 15
-
PubliclyAccessible (en la CLI:
--publicly-accessible): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Hay que dejar de utilizar este marcador.
-
StorageType (en la CLI:
--storage-type): una cadena, del tipo:string(una cadena codificada con UTF-8).No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
-
TdeCredentialArn (en la CLI:
--tde-credential-arn): una cadena, del tipo:string(una cadena codificada con UTF-8).El ARN del almacén de claves con el que asociar la instancia para el cifrado de TDE.
-
TdeCredentialPassword (en la CLI:
--tde-credential-password): una SensitiveString, del tipo:string(una cadena codificada con UTF-8).La contraseña del ARN dado del almacén de claves para poder obtener acceso al dispositivo.
-
VpcSecurityGroupIds (en la CLI:
--vpc-security-group-ids): una cadena, del tipo:string(una cadena codificada con UTF-8).Lista de grupos de seguridad de VPC de EC2 que se van a autorizar en esta instancia de base de datos. Este cambio se aplica de forma asíncrona, tan pronto como sea posible.
No se usa. La lista asociada de grupos de seguridad de VPC de EC2 administrada por este clúster de base de datos. Para obtener más información, consulte ModifyDBCluster (acción).
Restricciones:
-
Si se suministra, debe coincidir con VpcSecurityGroupIds existentes.
-
Respuesta
Contiene los detalles de una instancia de base de datos de Amazon Neptune.
Este tipo de datos se utiliza como un elemento de respuesta en la acción DescribeDBInstances (acción).
-
AutoMinorVersionUpgrade: un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica que hay parches de versión secundaria que se aplican automáticamente.
-
AvailabilityZone: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el nombre de la zona de disponibilidad en la que se encuentra la instancia de base de datos.
-
BackupRetentionPeriod: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
-
CACertificateIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).El identificador del certificado de CA para esta instancia de base de datos.
-
CopyTagsToSnapshot: un booleano, del tipo:
boolean(un valor booleano [true o false]).Especifica si las etiquetas se copian de la instancia de base de datos a instantáneas de la instancia de base de datos.
-
DBClusterIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Si la instancia de base de datos es miembro de un clúster de base de datos, contiene el nombre del clúster de base de datos del que la instancia de base de datos es miembro.
-
DBInstanceArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El Nombre de recurso de Amazon (ARN) de la instancia de base de datos.
-
DBInstanceClass: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia de base de datos.
-
DBInstanceIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene un identificador de bases de datos facilitado por el usuario. Este identificador es la clave única que identifica una instancia de base de datos.
-
DbInstancePort: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el puerto que escucha la instancia de base de datos. Si la instancia de base de datos forma parte de un clúster de base de datos, este puede ser un puerto distinto del puerto del clúster de base de datos.
-
DBInstanceStatus: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el estado actual de esta base de datos.
-
DbiResourceId: una cadena, del tipo:
string(una cadena codificada con UTF-8).El identificador inmutable único de la región de Amazon para la instancia de base de datos. Este identificador se encuentra en entradas de registro de Amazon CloudTrail cuando se accede a la clave de Amazon KMS para la instancia de base de datos.
-
DBName: una cadena, del tipo:
string(una cadena codificada con UTF-8).El nombre de la base de datos.
-
DBParameterGroups: matriz de objetos DBParameterGroupStatus.
Proporciona la lista de grupos de parámetros de base de datos que se aplica a esta instancia de base de datos.
-
DBSecurityGroups: matriz de objetos DBSecurityGroupMembership.
Proporciona la lista de elementos de grupo de seguridad de base de datos que contiene solo los subelementos
DBSecurityGroup.NameyDBSecurityGroup.Status. -
DBSubnetGroup: objeto DBSubnetGroup.
Especifica información sobre el grupo de subred asociado a la instancia de base de datos, incluido el nombre, la descripción y subredes en el grupo de subred.
-
DeletionProtection: un BooleanOptional, del tipo:
boolean(un valor booleano [true o false]).Indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La instancia no se puede eliminar cuando está habilitada la protección contra eliminación. Consulte Eliminación de una instancia de base de datos.
-
DomainMemberships: matriz de objetos DomainMembership.
No compatible
-
EnabledCloudwatchLogsExports: una cadena, del tipo:
string(una cadena codificada con UTF-8).Una lista de tipos de registro para los que esta instancia de base de datos está configurada para exportar a CloudWatch Logs.
-
Endpoint: objeto Punto de conexión.
Especifica el punto de conexión de conexión.
-
Engine: una cadena, del tipo:
string(una cadena codificada con UTF-8).Proporciona el nombre del motor de base de datos que se va a usar para esta instancia de base de datos.
-
EngineVersion: una cadena, del tipo:
string(una cadena codificada con UTF-8).Indica la versión del motor de base de datos.
-
EnhancedMonitoringResourceArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El Nombre de recurso de Amazon (ARN) del flujo de registros de Amazon CloudWatch Logs que recibe los datos de métricas de monitorización mejorada para la instancia de base de datos.
-
IAMDatabaseAuthenticationEnabled: un booleano, del tipo:
boolean(un valor booleano [true o false]).True si la autenticación de Amazon Identity and Access Management (IAM) está habilitada; de lo contrario, el valor es False.
-
InstanceCreateTime: un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).Proporciona la fecha y hora en que se creó la instancia de base de datos.
-
Iops: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el valor de las IOPS provisionadas (las operaciones de E/S por segundo).
-
KmsKeyId: una cadena, del tipo:
string(una cadena codificada con UTF-8).No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
-
LatestRestorableTime: un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
-
LicenseModel: una cadena, del tipo:
string(una cadena codificada con UTF-8).Información del modelo de licencias de esta instancia de base de datos.
-
MonitoringInterval: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos.
-
MonitoringRoleArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs.
-
MultiAZ: un booleano, del tipo:
boolean(un valor booleano [true o false]).Especifica si la instancia de base de datos es una implementación Multi-AZ.
-
PendingModifiedValues: objeto PendingModifiedValues.
Especifica que los cambios a la instancia de base de datos están pendientes. Este elemento sólo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.
-
PreferredBackupWindow: una cadena, del tipo:
string(una cadena codificada con UTF-8).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. -
PreferredMaintenanceWindow: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
-
PromotionTier: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente.
-
PubliclyAccessible: un booleano, del tipo:
boolean(un valor booleano [true o false]).Hay que dejar de utilizar este marcador.
-
ReadReplicaDBClusterIdentifiers: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene uno o varios identificadores de los clústeres de base de datos que son réplicas de lectura de esta instancia de base de datos.
-
ReadReplicaDBInstanceIdentifiers: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene uno o varios identificadores de las réplicas de lectura asociados con esta instancia de base de datos.
-
ReadReplicaSourceDBInstanceIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene el identificador de la instancia de base de datos de origen si esta instancia de base de datos es una réplica de lectura.
-
SecondaryAvailabilityZone: una cadena, del tipo:
string(una cadena codificada con UTF-8).Si está presente, especifica el nombre de la zona de disponibilidad secundaria para una instancia de base de datos compatible con Multi-AZ.
-
StatusInfos: matriz de objetos DBInstanceStatusInfo.
El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.
-
StorageEncrypted: un booleano, del tipo:
boolean(un valor booleano [true o false]).No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
-
StorageType: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el tipo de almacenamiento asociado con la instancia de base de datos.
-
TdeCredentialArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del almacén de claves con el que se asocia la instancia para el cifrado de TDE.
-
Timezone: una cadena, del tipo:
string(una cadena codificada con UTF-8).No admitido.
-
VpcSecurityGroups: matriz de objetos VpcSecurityGroupMembership.
Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia de base de datos.
Errores
RebootDBInstance (acción)
El nombre de la AWS CLI para esta API es: reboot-db-instance.
Es posible que necesite reiniciar su instancia de base de datos, normalmente por razones de mantenimiento. Por ejemplo, si realiza determinadas modificaciones o si cambia el grupo de parámetros de base de datos asociado a la instancia de base de datos, debe reiniciar la instancia para que los cambios surtan efecto.
Cuando se reinicia una instancia de base de datos, se reinicia el servicio del motor de base de datos. Al reiniciar una instancia de base de datos, se produce una interrupción momentánea, durante la cual su estado se establece en rebooting.
Solicitud
-
DBInstanceIdentifier (en la CLI:
--db-instance-identifier): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El identificador de instancias de base de datos. Este parámetro se almacena como una cadena en minúsculas.
Restricciones:
-
Debe coincidir con el identificador de una DBInstance existente.
-
-
ForceFailover (en la CLI:
--force-failover): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).Cuando
true, el reinicio se realiza a través de una conmutación por error Multi-AZ.Restricción no se puede especificar
truesi la instancia no se ha configurado para Multi-AZ.
Respuesta
Contiene los detalles de una instancia de base de datos de Amazon Neptune.
Este tipo de datos se utiliza como un elemento de respuesta en la acción DescribeDBInstances (acción).
-
AutoMinorVersionUpgrade: un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica que hay parches de versión secundaria que se aplican automáticamente.
-
AvailabilityZone: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el nombre de la zona de disponibilidad en la que se encuentra la instancia de base de datos.
-
BackupRetentionPeriod: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
-
CACertificateIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).El identificador del certificado de CA para esta instancia de base de datos.
-
CopyTagsToSnapshot: un booleano, del tipo:
boolean(un valor booleano [true o false]).Especifica si las etiquetas se copian de la instancia de base de datos a instantáneas de la instancia de base de datos.
-
DBClusterIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Si la instancia de base de datos es miembro de un clúster de base de datos, contiene el nombre del clúster de base de datos del que la instancia de base de datos es miembro.
-
DBInstanceArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El Nombre de recurso de Amazon (ARN) de la instancia de base de datos.
-
DBInstanceClass: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia de base de datos.
-
DBInstanceIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene un identificador de bases de datos facilitado por el usuario. Este identificador es la clave única que identifica una instancia de base de datos.
-
DbInstancePort: un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el puerto que escucha la instancia de base de datos. Si la instancia de base de datos forma parte de un clúster de base de datos, este puede ser un puerto distinto del puerto del clúster de base de datos.
-
DBInstanceStatus: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el estado actual de esta base de datos.
-
DbiResourceId: una cadena, del tipo:
string(una cadena codificada con UTF-8).El identificador inmutable único de la región de Amazon para la instancia de base de datos. Este identificador se encuentra en entradas de registro de Amazon CloudTrail cuando se accede a la clave de Amazon KMS para la instancia de base de datos.
-
DBName: una cadena, del tipo:
string(una cadena codificada con UTF-8).El nombre de la base de datos.
-
DBParameterGroups: matriz de objetos DBParameterGroupStatus.
Proporciona la lista de grupos de parámetros de base de datos que se aplica a esta instancia de base de datos.
-
DBSecurityGroups: matriz de objetos DBSecurityGroupMembership.
Proporciona la lista de elementos de grupo de seguridad de base de datos que contiene solo los subelementos
DBSecurityGroup.NameyDBSecurityGroup.Status. -
DBSubnetGroup: objeto DBSubnetGroup.
Especifica información sobre el grupo de subred asociado a la instancia de base de datos, incluido el nombre, la descripción y subredes en el grupo de subred.
-
DeletionProtection: un BooleanOptional, del tipo:
boolean(un valor booleano [true o false]).Indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La instancia no se puede eliminar cuando está habilitada la protección contra eliminación. Consulte Eliminación de una instancia de base de datos.
-
DomainMemberships: matriz de objetos DomainMembership.
No compatible
-
EnabledCloudwatchLogsExports: una cadena, del tipo:
string(una cadena codificada con UTF-8).Una lista de tipos de registro para los que esta instancia de base de datos está configurada para exportar a CloudWatch Logs.
-
Endpoint: objeto Punto de conexión.
Especifica el punto de conexión de conexión.
-
Engine: una cadena, del tipo:
string(una cadena codificada con UTF-8).Proporciona el nombre del motor de base de datos que se va a usar para esta instancia de base de datos.
-
EngineVersion: una cadena, del tipo:
string(una cadena codificada con UTF-8).Indica la versión del motor de base de datos.
-
EnhancedMonitoringResourceArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El Nombre de recurso de Amazon (ARN) del flujo de registros de Amazon CloudWatch Logs que recibe los datos de métricas de monitorización mejorada para la instancia de base de datos.
-
IAMDatabaseAuthenticationEnabled: un booleano, del tipo:
boolean(un valor booleano [true o false]).True si la autenticación de Amazon Identity and Access Management (IAM) está habilitada; de lo contrario, el valor es False.
-
InstanceCreateTime: un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).Proporciona la fecha y hora en que se creó la instancia de base de datos.
-
Iops: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el valor de las IOPS provisionadas (las operaciones de E/S por segundo).
-
KmsKeyId: una cadena, del tipo:
string(una cadena codificada con UTF-8).No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
-
LatestRestorableTime: un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
-
LicenseModel: una cadena, del tipo:
string(una cadena codificada con UTF-8).Información del modelo de licencias de esta instancia de base de datos.
-
MonitoringInterval: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos.
-
MonitoringRoleArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs.
-
MultiAZ: un booleano, del tipo:
boolean(un valor booleano [true o false]).Especifica si la instancia de base de datos es una implementación Multi-AZ.
-
PendingModifiedValues: objeto PendingModifiedValues.
Especifica que los cambios a la instancia de base de datos están pendientes. Este elemento sólo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.
-
PreferredBackupWindow: una cadena, del tipo:
string(una cadena codificada con UTF-8).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. -
PreferredMaintenanceWindow: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
-
PromotionTier: un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente.
-
PubliclyAccessible: un booleano, del tipo:
boolean(un valor booleano [true o false]).Hay que dejar de utilizar este marcador.
-
ReadReplicaDBClusterIdentifiers: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene uno o varios identificadores de los clústeres de base de datos que son réplicas de lectura de esta instancia de base de datos.
-
ReadReplicaDBInstanceIdentifiers: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene uno o varios identificadores de las réplicas de lectura asociados con esta instancia de base de datos.
-
ReadReplicaSourceDBInstanceIdentifier: una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene el identificador de la instancia de base de datos de origen si esta instancia de base de datos es una réplica de lectura.
-
SecondaryAvailabilityZone: una cadena, del tipo:
string(una cadena codificada con UTF-8).Si está presente, especifica el nombre de la zona de disponibilidad secundaria para una instancia de base de datos compatible con Multi-AZ.
-
StatusInfos: matriz de objetos DBInstanceStatusInfo.
El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.
-
StorageEncrypted: un booleano, del tipo:
boolean(un valor booleano [true o false]).No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
-
StorageType: una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el tipo de almacenamiento asociado con la instancia de base de datos.
-
TdeCredentialArn: una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del almacén de claves con el que se asocia la instancia para el cifrado de TDE.
-
Timezone: una cadena, del tipo:
string(una cadena codificada con UTF-8).No admitido.
-
VpcSecurityGroups: matriz de objetos VpcSecurityGroupMembership.
Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia de base de datos.
DescribeDBInstances (acción)
El nombre de la AWS CLI para esta API es: describe-db-instances.
Devuelve información sobre las instancias aprovisionadas y admite la paginación.
nota
Esta operación también puede devolver información para las instancias de Amazon RDS y las instancias de Amazon DocDB.
Solicitud
-
DBInstanceIdentifier (en la CLI:
--db-instance-identifier): una cadena, del tipo:string(una cadena codificada con UTF-8).Identificador de la instancia proporcionado por el usuario. Si se especifica este parámetro, solo se devuelve información de la instancia de base de datos específica. Este parámetro no distingue entre mayúsculas y minúsculas.
Restricciones:
-
Si se proporciona, debe coincidir con el identificador de una DBInstance existente.
-
-
Filters (en la CLI:
--filters): una matriz de objetos Filtro.Un filtro que especifica una o varias instancias de bases de datos para describir.
Filtros compatibles:
-
db-cluster-id: acepta identificadores de clúster de base de datos y Nombres de recursos de Amazon (ARN). La lista de resultados solo incluirá información sobre las instancias de bases de datos asociadas con los clústeres de base de datos identificados por estos ARN. -
engine- Acepta un nombre de motor (comoneptune) y restringe la lista de resultados a instancias de base de datos creadas por ese motor.
Por ejemplo, para invocar esta API desde la CLI de Amazon y filtrar de modo que sólo se devuelvan las instancias de base de datos de Neptune, puede utilizar el siguiente comando:
aws neptune describe-db-instances \ --filters Name=engine,Values=neptune -
-
Marker (en la CLI:
--marker): una cadena, del tipo:string(una cadena codificada con UTF-8).Un token de paginación opcional proporcionado por una solicitud
DescribeDBInstancesanterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado porMaxRecords. -
MaxRecords (en la CLI:
--max-records): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor
MaxRecordsespecificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.Predeterminado: 100
Restricciones: Mínimo 20, máximo 100.
Respuesta
-
DBInstances: matriz de objetos DBInstance.
Una lista de instancias DBInstance (estructura).
-
Marker: una cadena, del tipo:
string(una cadena codificada con UTF-8).Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por
MaxRecords.
Errores
DescribeOrderableDBInstanceOptions (acción)
El nombre de la AWS CLI para esta API es: describe-orderable-db-instance-options.
Devuelve una lista de opciones de instancia de base de datos ordenable para el motor especificado.
Solicitud
-
DBInstanceClass (en la CLI:
--db-instance-class): una cadena, del tipo:string(una cadena codificada con UTF-8).El valor del filtro de la clase de instancia de base de datos. Especifique este parámetro para mostrar solo las ofertas disponibles que coinciden con la clase de instancia de base de datos especificada.
-
Engine (en la CLI:
--engine): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).Nombre del motor para el que recuperar opciones de la instancia de base de datos.
-
EngineVersion (en la CLI:
--engine-version): una cadena, del tipo:string(una cadena codificada con UTF-8).Valor del filtro de la versión del motor. Especifique este parámetro para mostrar solo las ofertas disponibles que coinciden con la versión del motor especificado.
-
Filters (en la CLI:
--filters): una matriz de objetos Filtro.Este parámetro es incompatible en estos momentos.
-
LicenseModel (en la CLI:
--license-model): una cadena, del tipo:string(una cadena codificada con UTF-8).El valor del filtro del modelo de licencia. Especifique este parámetro para mostrar solo las ofertas disponibles que coinciden con el modelo de licencia especificado.
-
Marker (en la CLI:
--marker): una cadena, del tipo:string(una cadena codificada con UTF-8).Un token de paginación opcional proporcionado por una solicitud DescribeOrderableDBInstanceOptions anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por
MaxRecords. -
MaxRecords (en la CLI:
--max-records): un IntegerOptional, del tipo:integer(un valor entero firmado de 32 bits).El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor
MaxRecordsespecificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.Predeterminado: 100
Restricciones: Mínimo 20, máximo 100.
-
Vpc (en la CLI:
--vpc): un BooleanOptional, del tipo:boolean(un valor booleano [true o false]).El valor de filtro de VPC. Especifique este parámetro para mostrar solo la disponibilidad de ofertas VPC o no VPC.
Respuesta
-
Marker: una cadena, del tipo:
string(una cadena codificada con UTF-8).Un token de paginación opcional proporcionado por una solicitud OrderableDBInstanceOptions anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por
MaxRecords. -
OrderableDBInstanceOptions: matriz de objetos OrderableDBInstanceOption.
Una estructura OrderableDBInstanceOption (estructura) que contiene información acerca de opciones ordenables para la instancia de base de datos.
DescribeValidDBInstanceModifications (acción)
El nombre de la AWS CLI para esta API es: describe-valid-db-instance-modifications.
Puede llamar a DescribeValidDBInstanceModifications (acción) para obtener información sobre qué modificaciones puede realizar a su instancia de base de datos. Puede utilizar esta información cuando llama a ModifyDBInstance (acción).
Solicitud
-
DBInstanceIdentifier (en la CLI:
--db-instance-identifier): obligatorio: una cadena, del tipo:string(una cadena codificada con UTF-8).El identificador de cliente o el ARN de la instancia de base de datos.
Respuesta
Información sobre las modificaciones válidas que puede realizar a la instancia de base de datos. Contiene el resultado de una llamada correcta a la acción DescribeValidDBInstanceModifications (acción). Puede utilizar esta información cuando llama a ModifyDBInstance (acción).
-
Storage: matriz de objetos ValidStorageOptions.
Opciones de almacenamiento válidas para su instancia de base de datos.
Estructuras:
DBInstance (estructura)
Contiene los detalles de una instancia de base de datos de Amazon Neptune.
Este tipo de datos se utiliza como un elemento de respuesta en la acción DescribeDBInstances (acción).
Campos
-
AutoMinorVersionUpgrade: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica que hay parches de versión secundaria que se aplican automáticamente.
-
AvailabilityZone: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el nombre de la zona de disponibilidad en la que se encuentra la instancia de base de datos.
-
BackupRetentionPeriod: se trata de un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
-
CACertificateIdentifier: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El identificador del certificado de CA para esta instancia de base de datos.
-
CopyTagsToSnapshot: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Especifica si las etiquetas se copian de la instancia de base de datos a instantáneas de la instancia de base de datos.
-
DBClusterIdentifier: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Si la instancia de base de datos es miembro de un clúster de base de datos, contiene el nombre del clúster de base de datos del que la instancia de base de datos es miembro.
-
DBInstanceArn: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El Nombre de recurso de Amazon (ARN) de la instancia de base de datos.
-
DBInstanceClass: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia de base de datos.
-
DBInstanceIdentifier: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene un identificador de bases de datos facilitado por el usuario. Este identificador es la clave única que identifica una instancia de base de datos.
-
DbInstancePort: se trata de un valor entero, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el puerto que escucha la instancia de base de datos. Si la instancia de base de datos forma parte de un clúster de base de datos, este puede ser un puerto distinto del puerto del clúster de base de datos.
-
DBInstanceStatus: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el estado actual de esta base de datos.
-
DbiResourceId: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El identificador inmutable único de la región de Amazon para la instancia de base de datos. Este identificador se encuentra en entradas de registro de Amazon CloudTrail cuando se accede a la clave de Amazon KMS para la instancia de base de datos.
-
DBName: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El nombre de la base de datos.
-
DBParameterGroups: se trata de una matriz de objetos DBParameterGroupStatus.
Proporciona la lista de grupos de parámetros de base de datos que se aplica a esta instancia de base de datos.
-
DBSecurityGroups: se trata de una matriz de objetos DBSecurityGroupMembership.
Proporciona la lista de elementos de grupo de seguridad de base de datos que contiene solo los subelementos
DBSecurityGroup.NameyDBSecurityGroup.Status. -
DBSubnetGroup: se trata de un objeto DBSubnetGroup.
Especifica información sobre el grupo de subred asociado a la instancia de base de datos, incluido el nombre, la descripción y subredes en el grupo de subred.
-
DeletionProtection: se trata de un BooleanOptional, del tipo:
boolean(un valor booleano [true o false]).Indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La instancia no se puede eliminar cuando está habilitada la protección contra eliminación. Consulte Eliminación de una instancia de base de datos.
-
DomainMemberships: se trata de una matriz de objetos DomainMembership.
No compatible
-
EnabledCloudwatchLogsExports: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Una lista de tipos de registro para los que esta instancia de base de datos está configurada para exportar a CloudWatch Logs.
-
Endpoint: se trata de un objeto Punto de conexión.
Especifica el punto de conexión de conexión.
-
Engine: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Proporciona el nombre del motor de base de datos que se va a usar para esta instancia de base de datos.
-
EngineVersion: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Indica la versión del motor de base de datos.
-
EnhancedMonitoringResourceArn: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El Nombre de recurso de Amazon (ARN) del flujo de registros de Amazon CloudWatch Logs que recibe los datos de métricas de monitorización mejorada para la instancia de base de datos.
-
IAMDatabaseAuthenticationEnabled: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).True si la autenticación de Amazon Identity and Access Management (IAM) está habilitada; de lo contrario, el valor es False.
-
InstanceCreateTime: se trata de un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).Proporciona la fecha y hora en que se creó la instancia de base de datos.
-
Iops: se trata de un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el valor de las IOPS provisionadas (las operaciones de E/S por segundo).
-
KmsKeyId: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
-
LatestRestorableTime: se trata de un TStamp, del tipo:
timestamp(un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
-
LicenseModel: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Información del modelo de licencias de esta instancia de base de datos.
-
MonitoringInterval: se trata de un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos.
-
MonitoringRoleArn: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs.
-
MultiAZ: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Especifica si la instancia de base de datos es una implementación Multi-AZ.
-
PendingModifiedValues: se trata de un objeto PendingModifiedValues.
Especifica que los cambios a la instancia de base de datos están pendientes. Este elemento sólo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.
-
PreferredBackupWindow: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).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. -
PreferredMaintenanceWindow: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
-
PromotionTier: se trata de un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente.
-
PubliclyAccessible: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Hay que dejar de utilizar este marcador.
-
ReadReplicaDBClusterIdentifiers: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene uno o varios identificadores de los clústeres de base de datos que son réplicas de lectura de esta instancia de base de datos.
-
ReadReplicaDBInstanceIdentifiers: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene uno o varios identificadores de las réplicas de lectura asociados con esta instancia de base de datos.
-
ReadReplicaSourceDBInstanceIdentifier: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene el identificador de la instancia de base de datos de origen si esta instancia de base de datos es una réplica de lectura.
-
SecondaryAvailabilityZone: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Si está presente, especifica el nombre de la zona de disponibilidad secundaria para una instancia de base de datos compatible con Multi-AZ.
-
StatusInfos: se trata de una matriz de objetos DBInstanceStatusInfo.
El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.
-
StorageEncrypted: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
-
StorageType: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el tipo de almacenamiento asociado con la instancia de base de datos.
-
TdeCredentialArn: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El ARN del almacén de claves con el que se asocia la instancia para el cifrado de TDE.
-
Timezone: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).No admitido.
-
VpcSecurityGroups: se trata de una matriz de objetos VpcSecurityGroupMembership.
Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia de base de datos.
DBInstance se utiliza como el elemento de respuesta para:
DBInstanceStatusInfo (estructura)
Proporciona una lista de información de estado para una instancia de base de datos.
Campos
-
Message: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Detalles del error si hay un error para la instancia. Si la instancia no se encuentra en un estado de error, este valor aparece en blanco.
-
Normal: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Valor booleano que es "true" si la instancia funciona con normalidad o "false" si la instancia se encuentra en un estado de error.
-
Status: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Estado de la instancia de base de datos. Para obtener un StatusType de réplica de lectura, los valores pueden ser replicando, error, detenido o terminado.
-
StatusType: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Este valor es actualmente una "replicación de lectura".
OrderableDBInstanceOption (estructura)
Contiene una lista de las opciones disponibles para una instancia de base de datos.
Este tipo de datos se utiliza como un elemento de respuesta en la acción DescribeOrderableDBInstanceOptions (acción).
Campos
-
AvailabilityZones: se trata de una matriz de objetos AvailabilityZone.
Una lista de zonas de disponibilidad para una instancia de base de datos.
-
DBInstanceClass: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).La clase de instancia de base de datos de la instancia de base de datos.
-
Engine: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El tipo de motor de una instancia de base de datos.
-
EngineVersion: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).La versión de motor de una instancia de base de datos.
-
LicenseModel: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El modelo de licencia de la instancia de base de datos.
-
MaxIopsPerDbInstance: se trata de un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Máximo total de IOPS provisionadas para una instancia de base de datos.
-
MaxIopsPerGib: se trata de un DoubleOptional, del tipo:
double(un número en coma flotante IEEE 754 de precisión doble).Máximo de IOPS provisionadas por GiB para una instancia de base de datos.
-
MaxStorageSize: se trata de un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Tamaño máximo de almacenamiento para una instancia de base de datos
-
MinIopsPerDbInstance: se trata de un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Mínimo total de IOPS provisionadas para una instancia de base de datos.
-
MinIopsPerGib: se trata de un DoubleOptional, del tipo:
double(un número en coma flotante IEEE 754 de precisión doble).Mínimo de IOPS provisionadas por GiB para una instancia de base de datos.
-
MinStorageSize: se trata de un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Tamaño mínimo de almacenamiento para una instancia de base de datos
-
MultiAZCapable: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica si una instancia de base de datos admite Multi-AZ.
-
ReadReplicaCapable: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica si una instancia de base de datos puede tener una réplica de lectura.
-
StorageType: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
-
SupportsEnhancedMonitoring: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica si una instancia de base de datos admite la monitorización mejorada a intervalos de 1 a 60 segundos.
-
SupportsGlobalDatabases: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Un valor que indica si puede utilizar las bases de datos globales de Neptune con una combinación específica de otros atributos del motor de base de datos.
-
SupportsIAMDatabaseAuthentication: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica si una instancia de base de datos admite autenticación de base de datos de IAM.
-
SupportsIops: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica si una instancia de base de datos admite IOPS provisionadas.
-
SupportsStorageEncryption: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica si una instancia de base de datos admite almacenamiento cifrado.
-
Vpc: se trata de un booleano, del tipo:
boolean(un valor booleano [true o false]).Indica si una instancia de base de datos se encuentra en una VPC.
PendingModifiedValues (estructura)
Este tipo de datos se utiliza como un elemento de respuesta en la acción ModifyDBInstance (acción).
Campos
-
AllocatedStorage: se trata de un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Contiene el tamaño nuevo de
AllocatedStoragecorrespondiente a la instancia de base de datos que se aplicará o que se está aplicando. -
BackupRetentionPeriod: se trata de un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el número de días pendientes durante los que se conservan las copias de seguridad automatizadas.
-
CACertificateIdentifier: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Especifica el identificador del certificado de CA para la instancia de base de datos.
-
DBInstanceClass: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene la nueva
DBInstanceClasscorrespondiente a la instancia de base de datos que se aplicará o que se está aplicando. -
DBInstanceIdentifier: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Contiene la nueva
DBInstanceIdentifiercorrespondiente a la instancia de base de datos que se aplicará o que se está aplicando. -
DBSubnetGroupName: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).El grupo de subredes de base de datos nuevo de la instancia de base de datos.
-
EngineVersion: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).Indica la versión del motor de base de datos.
-
Iops: se trata de un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el valor nuevo de IOPS provisionadas correspondiente a la instancia de base de datos que se aplicará o que se está aplicando.
-
MultiAZ: se trata de un BooleanOptional, del tipo:
boolean(un valor booleano [true o false]).Indica que la instancia de base de datos Single-AZ va a cambiar a una implementación Multi-AZ.
-
PendingCloudwatchLogsExports: se trata de un objeto PendingCloudwatchLogsExports.
Esta estructura
PendingCloudwatchLogsExportsespecifica los cambios pendientes en los que los registros de CloudWatch están habilitados y cuáles están deshabilitados. -
Port: se trata de un IntegerOptional, del tipo:
integer(un valor entero firmado de 32 bits).Especifica el puerto pendiente para la instancia de base de datos.
-
StorageType: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
ValidStorageOptions (estructura)
No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
Campos
-
IopsToStorageRatio: se trata de una matriz de objetos DoubleRange.
No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
-
ProvisionedIops: se trata de una matriz de objetos Rango.
No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
-
StorageSize: se trata de una matriz de objetos Rango.
No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
-
StorageType: se trata de una cadena, del tipo:
string(una cadena codificada con UTF-8).No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
ValidDBInstanceModificationsMessage (estructura)
Información sobre las modificaciones válidas que puede realizar a la instancia de base de datos. Contiene el resultado de una llamada correcta a la acción DescribeValidDBInstanceModifications (acción). Puede utilizar esta información cuando llama a ModifyDBInstance (acción).
Campos
-
Storage: se trata de una matriz de objetos ValidStorageOptions.
Opciones de almacenamiento válidas para su instancia de base de datos.
ValidDBInstanceModificationsMessage se utiliza como el elemento de respuesta para:
