API de instâncias do Neptune - Amazon Neptune
CreateDBInstanceDeleteDBInstanceModifyDBInstanceRebootDBInstanceDescribeDBInstancesDescribeOrderableDBInstanceOptionsDescribeValidDBInstanceModifications________________________DBInstanceDBInstanceStatusInfoOrderableDBInstanceOptionPendingModifiedValuesValidStorageOptionsValidDBInstanceModificationsMessage

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

API de instâncias do Neptune

Ações:

Estruturas:

CreateDBInstance (ação)

        O nome da CLI da AWS para essa API é: create-db-instance.

Cria uma nova instância de banco de dados.

Solicitação

  • AutoMinorVersionUpgrade (na CLI: --auto-minor-version-upgrade): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica que as atualizações de mecanismos menores são aplicadas automaticamente à instância de banco de dados durante a janela de manutenção.

    Padrão: true

  • AvailabilityZone (na CLI: --availability-zone): uma string, do tipo: string (uma string codificada em UTF-8).

    A zona de disponibilidade do EC2 na qual a instância de banco de dados é criada.

    Padrão: uma zona de disponibilidade aleatória e escolhida pelo sistema na região da Amazon do endpoint.

    Exemplo: us-east-1d

    Restrição: o parâmetro AvailabilityZone não poderá ser especificado se o parâmetro MultiAZ estiver definido como true. A zona de disponibilidade especificada deve estar na mesma região da Amazon que o endpoint atual.

  • BackupRetentionPeriod (na CLI: --backup-retention-period): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O número de dias durante os quais os backups automatizados são retidos.

    Não aplicável. O período de retenção de backups automatizados é gerenciado pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).

    Padrão: 1

    Restrições:

    • Deve ser um valor de 0 a 35

    • Não poderá ser definido como 0 se a instância de banco de dados for uma origem para réplicas de leitura

  • CopyTagsToSnapshot (na CLI: --copy-tags-to-snapshot): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    True para copiar todas as tags da instância de banco de dados para os snapshots da instância de banco de dados. Caso contrário, false. O padrão é falso.

  • DBClusterIdentifier (na CLI: --db-cluster-identifier): obrigatório: uma string, do tipo: string (uma string codificada em UTF-8).

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

    Para obter informações sobre como criar com um cluster de banco de dados, consulte CreateDBCluster (ação).

    Tipo: string

  • DBInstanceClass (na CLI: --db-instance-class): obrigatório: uma string, do tipo: string (uma string codificada em UTF-8).

    A capacidade de computação e memória da instância de banco de dados, por exemplo, db.m4.large. Nem todas as classes de instâncias de banco de dados estão disponíveis em todas as regiões da Amazon.

  • DBInstanceIdentifier (na CLI: --db-instance-identifier): obrigatório: uma string, do tipo: string (uma string codificada em UTF-8).

    O DB instance identifier. Este parâmetro é armazenado como uma string com letras minúsculas.

    Restrições:

    • Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.

    • O primeiro caractere deve ser uma letra.

    • Não podem terminar com um hífen ou conter dois hífens consecutivos.

    Exemplo: mydbinstance

  • DBName (na CLI: --db-name): uma string, do tipo: string (uma string codificada em UTF-8).

    Sem suporte.

  • DBParameterGroupName (na CLI: --db-parameter-group-name): uma string, do tipo: string (uma string codificada em UTF-8).

    O nome do grupo de parâmetros de banco de dados a ser associado a essa instância de banco de dados. Se este argumento for omitido, o DBParameterGroup padrão para o mecanismo especificado será usado.

    Restrições:

    • Deve ter de 1 a 255 letras, números ou hifens.

    • O primeiro caractere deve ser uma letra

    • Não podem terminar com um hífen ou conter dois hífens consecutivos

  • DBSecurityGroups (na CLI: --db-security-groups): uma string, do tipo: string (uma string codificada em UTF-8).

    Uma lista de grupos de segurança de banco de dados a ser associada a essa instância de banco de dados.

    Padrão: o grupo de segurança de banco de dados padrão para o mecanismo de banco de dados.

  • DBSubnetGroupName (na CLI: --db-subnet-group-name): uma string, do tipo: string (uma string codificada em UTF-8).

    Um grupo de sub-redes de banco de dados a ser associado a essa instância de banco de dados.

    Se não houver um grupo de sub-redes de banco de dados, será uma instância de banco de dados que não seja da VPC.

  • DeletionProtection (na CLI: --deletion-protection): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Um valor que indica se a instância de banco de dados tem a proteção contra exclusão habilitada. O banco de dados não pode ser excluído quando a proteção contra exclusão está habilitada. Por padrão, a proteção contra exclusão fica desabilitada. Consulte Excluir uma instância de banco de dados.

    As instâncias de banco de dados em um cluster de banco de dados poderão ser excluídas mesmo quando a proteção contra exclusão estiver ativada no cluster de banco de dados pai.

  • Domain (na CLI: --domain): uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o domínio do Active Directory no qual criar a instância.

  • DomainIAMRoleName (na CLI: --domain-iam-role-name): uma string, do tipo: string (uma string codificada em UTF-8).

    Especifique o nome da função do IAM a ser usado ao fazer chamadas de API para o Directory Service.

  • EnableCloudwatchLogsExports (na CLI: --enable-cloudwatch-logs-exports): uma string, do tipo: string (uma string codificada em UTF-8).

    A lista de tipos de log que precisam estar habilitados para exportação para o CloudWatch Logs.

  • EnableIAMDatabaseAuthentication (na CLI: --enable-iam-database-authentication): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Não compatível com o Neptune (ignorado).

  • Engine (na CLI: --engine): obrigatório: uma string, do tipo: string (uma string codificada em UTF-8).

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

    Valores Válidos: neptune

  • EngineVersion (na CLI: --engine-version): uma string, do tipo: string (uma string codificada em UTF-8).

    O número da versão do mecanismo de banco de dados a ser usado. Atualmente, a definição desse parâmetro não tem efeito.

  • Iops (na CLI: --iops): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    A quantidade de IOPS (operações de entrada/saída por segundo) provisionadas a serem inicialmente alocadas para a instância de banco de dados.

  • KmsKeyId (na CLI: --kms-key-id): uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador da chave do Amazon KMS para uma instância de banco de dados criptografada.

    O identificador de chave KMS é o Amazon Resource Name (ARN) da chave de criptografia KMS. Se você estiver criando uma instância de banco de dados com a mesma conta da Amazon que tem a chave de criptografia do KMS usada para criptografar a nova instância de banco de dados, use o alias da chave do KMS em vez do ARN para a chave de criptografia do KM.

    Não aplicável. O identificador de chave do KMS é gerenciado pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).

    Se o parâmetro StorageEncrypted for true e você não especificar o valor para o parâmetro KmsKeyId, o Amazon Neptune usará a chave de criptografia padrão. O Amazon KMS cria a chave de criptografia padrão para a conta da Amazon. A conta da Amazon tem uma chave de criptografia padrão diferente para cada região da Amazon.

  • LicenseModel (na CLI: --license-model): uma string, do tipo: string (uma string codificada em UTF-8).

    Informações do modelo de licença dessa instância de banco de dados.

    Valores válidos: license-included | bring-your-own-license | general-public-license

  • MonitoringInterval (na CLI: --monitoring-interval): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O intervalo, em segundos, entre pontos quando as métricas de monitoramento avançado são coletadas para a instância de banco de dados. Para desabilitar a coleta de métricas de monitoramento avançado, especifique 0. O padrão é 0.

    Se MonitoringRoleArn for especificado, você também deverá definir MonitoringInterval como um valor diferente de 0.

    Valores Válidos: 0, 1, 5, 10, 15, 30, 60

  • MonitoringRoleArn (na CLI: --monitoring-role-arn): uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN da função do IAM que permite que o Neptune envie métricas de monitoramento avançado para o Amazon CloudWatch Logs. Por exemplo, arn:aws:iam:123456789012:role/emaccess.

    Se MonitoringInterval estiver definido com um valor diferente de 0, você deverá fornecer um valor de MonitoringRoleArn.

  • MultiAZ (na CLI: --multi-az): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se a instância de banco de dados é uma implantação Multi-AZ. Não será possível definir o parâmetro AvailabilityZone se o parâmetro MultiAZ estiver definido como true.

  • Port (na CLI: --port): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O número da porta na qual o banco de dados aceita conexões.

    Não aplicável. A porta é gerenciada pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).

    Padrão: 8182

    Tipo: inteiro

  • PreferredBackupWindow (na CLI: --preferred-backup-window): uma string, do tipo: string (uma string codificada em UTF-8).

    O intervalo de tempo diário durante o qual os backups automatizados são criados.

    Não aplicável. O intervalo de tempo diário para a criação de backups automatizados é gerenciado pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).

  • PreferredMaintenanceWindow (na CLI: --preferred-maintenance-window): uma string, do tipo: string (uma string codificada em UTF-8).

    O intervalo de tempo em cada semana durante o qual ocorre a manutenção do sistema, no Tempo Universal Coordenado (UTC).

    Formato: ddd:hh24:mi-ddd:hh24:mi

    O padrão é uma janela de trinta minutos selecionada aleatoriamente em um bloco de tempo de oito horas para cada região da Amazon, ocorrendo em um dia aleatório da semana.

    Dias válidos: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Restrições: janela mínima de 30 minutos.

  • PromotionTier (na CLI: --promotion-tier): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Um valor que especifica a ordem na qual uma réplica de leitura é promovida à instância principal após uma falha da instância principal existente.

    Padrão: 1

    Valores válidos: 0 a 15

  • PubliclyAccessible (na CLI: --publicly-accessible): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Este sinalizador não deve mais ser usado.

  • StorageEncrypted (na CLI: --storage-encrypted): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se a instância de banco de dados é criptografada.

    Não aplicável. A criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).

    Padrão: False

  • StorageType (na CLI: --storage-type): uma string, do tipo: string (uma string codificada em UTF-8).

    Não aplicável. No Neptune, o tipo de armazenamento é gerenciado no nível do cluster de banco de dados.

  • Tags (na CLI: --tags): uma matriz de objetos Tag.

    As tags a serem atribuídas à nova instância.

  • TdeCredentialArn (na CLI: --tde-credential-arn): uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN do armazenamento de chaves ao qual associar a instância para a criptografia TDE.

  • TdeCredentialPassword (na CLI: --tde-credential-password): uma SensitiveString, do tipo: string (uma string codificada em UTF-8).

    A senha para o determinado ARN do armazenamento de chaves para acessar o dispositivo.

  • Timezone (na CLI: --timezone): uma string, do tipo: string (uma string codificada em UTF-8).

    O fuso horário da instância de banco de dados.

  • VpcSecurityGroupIds (na CLI: --vpc-security-group-ids): uma string, do tipo: string (uma string codificada em UTF-8).

    Uma lista de grupos de segurança da VPC do EC2 a ser associada a essa instância de banco de dados.

    Não aplicável. A lista de grupos de segurança da VPC do EC2 associada é gerenciada pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).

    Padrão: o grupo de segurança da VPC do EC2 padrão para a VPC do grupo de sub-redes de banco de dados.

Resposta

Contém os detalhes de uma instância de banco de dados do Amazon Neptune.

Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBInstances (ação).

  • AutoMinorVersionUpgrade: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica que os patches de versões secundárias são aplicados automaticamente.

  • AvailabilityZone: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o nome da zona de disponibilidade na qual a instância de banco de dados está localizada.

  • BackupRetentionPeriod: um valor inteiro, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o número de dias durante os quais os DB snapshots automáticos são retidos.

  • CACertificateIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador do certificado da CA para essa instância DB.

  • CopyTagsToSnapshot: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se as tags atribuídas são copiadas da instância de banco de dados nos snapshots da instância de banco de dados.

  • DBClusterIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Se a instância de banco de dados for membro de um cluster de banco de dados, conterá o nome do cluster de banco de dados do qual a instância de banco de dados é membro.

  • DBInstanceArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome de recurso da Amazon (ARN) da instância de banco de dados.

  • DBInstanceClass: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém o nome da classe de capacidade de computação e memória da instância de banco de dados.

  • DBInstanceIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um identificador de banco de dados fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica uma instância de banco de dados.

  • DbInstancePort: um valor inteiro, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica a porta na qual a instância de banco de dados escuta. Se a instância de banco de dados fizer parte de um cluster de banco de dados, isso poderá ser uma porta diferente da porta do cluster de banco de dados.

  • DBInstanceStatus: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o estado atual desse banco de dados.

  • DbiResourceId: uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador exclusivo e imutável da região da Amazon da instância de banco de dados. Esse identificador é encontrado nas entradas de log do Amazon CloudTrail sempre que a chave do Amazon KMS da instância de banco de dados é acessada.

  • DBName: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome do banco de dados.

  • DBParameterGroups – Uma matriz de objetos DBParameterGroupStatus.

    Fornece a lista de grupo de parâmetros de banco de dados aplicados a essa instância de banco de dados.

  • DBSecurityGroups – Uma matriz de objetos DBSecurityGroupMembership.

    Fornece a lista de elementos do grupo de segurança de banco de dados que contém somente os subelementos DBSecurityGroup.Name e DBSecurityGroup.Status.

  • DBSubnetGroup: um objeto DBSubnetGroup.

    Especifica informações sobre o grupo de sub-redes associado à instância de banco de dados, incluindo o nome, a descrição e as sub-redes no grupo de sub-redes.

  • DeletionProtection: um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se a instância de banco de dados tem a proteção contra exclusão ativada. A instância não poderá ser excluída quando a proteção contra exclusão estiver ativada. Consulte Excluir uma instância de banco de dados.

  • DomainMemberships – Uma matriz de objetos DomainMembership.

    Não suportado

  • EnabledCloudwatchLogsExports: uma string, do tipo: string (uma string codificada em UTF-8).

    Uma lista de tipos de logs que essa instância de banco de dados está configurada para exportar para o CloudWatch Logs.

  • Endpoint – Um objeto Endpoint.

    Especifica o endpoint de conexão.

  • Engine: uma string, do tipo: string (uma string codificada em UTF-8).

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

  • EngineVersion: uma string, do tipo: string (uma string codificada em UTF-8).

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

  • EnhancedMonitoringResourceArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome de recurso da Amazon (ARN) do fluxo de logs do Amazon CloudWatch Logs que recebe os dados de métricas de monitoramento avançado para a instância de banco de dados.

  • IAMDatabaseAuthenticationEnabled: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Verdadeiro se a autenticação do Amazon Identity and Access Management (IAM) estiver habilitada. Caso contrário, falso.

  • InstanceCreateTime: um TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

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

  • Iops: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o valor das IOPS (operações de entrada/saída por segundo) provisionadas.

  • KmsKeyId: uma string, do tipo: string (uma string codificada em UTF-8).

    Não compatível: a criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados.

  • LatestRestorableTime: um TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

    Especifica a data mais recente até a qual um banco de dados pode ser restaurado com restauração pontual.

  • LicenseModel: uma string, do tipo: string (uma string codificada em UTF-8).

    Informações do modelo de licença dessa instância de banco de dados.

  • MonitoringInterval: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O intervalo, em segundos, entre pontos quando as métricas de monitoramento avançado são coletadas para a instância de banco de dados.

  • MonitoringRoleArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN da função do IAM que permite que o Neptune envie métricas de monitoramento avançado para o Amazon CloudWatch Logs.

  • MultiAZ: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se a instância de banco de dados é uma implantação Multi-AZ.

  • PendingModifiedValues: um objeto PendingModifiedValues.

    Especifica que alterações à instância de banco de dados estão pendentes. Esse elemento só é incluído quando as alterações estão pendentes. As alterações específicas são identificadas por subelementos.

  • PreferredBackupWindow: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por BackupRetentionPeriod.

  • PreferredMaintenanceWindow: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o período semanal durante o qual pode ocorrer a manutenção do sistema, em Tempo Universal Coordenado (UTC).

  • PromotionTier: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Um valor que especifica a ordem em que uma réplica de leitura é promovida à instância principal após uma falha da instância principal existente.

  • PubliclyAccessible: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Este sinalizador não deve mais ser usado.

  • ReadReplicaDBClusterIdentifiers: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um ou mais identificadores de clusters de banco de dados que são réplicas de leitura dessa instância de banco de dados.

  • ReadReplicaDBInstanceIdentifiers: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um ou mais identificadores das réplicas de leitura associadas a essa instância de banco de dados.

  • ReadReplicaSourceDBInstanceIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém o identificador da instância de banco de dados de origem se essa instância de banco de dados for uma réplica de leitura.

  • SecondaryAvailabilityZone: uma string, do tipo: string (uma string codificada em UTF-8).

    Se houver, especificará o nome da zona de disponibilidade secundária para uma instância de banco de dados com suporte a Multi-AZ

  • StatusInfos – Uma matriz de objetos DBInstanceStatusInfo.

    O status da réplica de leitura. Se a instância não for uma réplica de leitura, isso ficará em branco.

  • StorageEncrypted: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Não compatível: a criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados.

  • StorageType: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o tipo de armazenamento associado à instância de banco de dados.

  • TdeCredentialArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN do armazenamento de chaves ao qual a instância está associada para criptografia TDE.

  • Timezone: uma string, do tipo: string (uma string codificada em UTF-8).

    Sem suporte.

  • VpcSecurityGroups – Uma matriz de objetos VpcSecurityGroupMembership.

    Fornece uma lista de elementos do grupo de segurança da VPC à qual a instância de banco de dados pertence.

Erros

DeleteDBInstance (ação)

        O nome da CLI da AWS para essa API é: delete-db-instance.

A ação DeleteDBInstance exclui uma instância de banco de dados provisionada anteriormente. Quando você exclui uma instância de banco de dados, todos os backups automatizados dessa instância são excluídos e não podem ser recuperados. Os DB snapshots manuais da instância de banco de dados a ser excluída por DeleteDBInstance não serão excluídos.

Se você solicitar um DB snapshot final, o status da instância de banco de dados do Amazon Neptune será deleting até que o DB snapshot seja criado. A ação de API DescribeDBInstance é usada para monitorar o status dessa operação. A ação não poderá ser cancelada nem revertida após ser enviada.

Observe que, quando uma instância de banco de dados estiver em um estado de falha e tiver um status failed, incompatible-restore ou incompatible-network, ela só poderá ser excluída quando o parâmetro SkipFinalSnapshot for definido como true.

Não será possível excluir uma instância de banco de dados se ela for a única instância no cluster de banco de dados ou se ela tiver proteção contra exclusão ativada.

Solicitação

  • DBInstanceIdentifier (na CLI: --db-instance-identifier): obrigatório: uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador da instância de banco de dados a ser excluída. Este parâmetro não diferencia maiúsculas de minúsculas.

    Restrições:

    • Deve corresponder ao nome de uma instância de banco de dados existente.

  • FinalDBSnapshotIdentifier (na CLI: --final-db-snapshot-identifier): uma string, do tipo: string (uma string codificada em UTF-8).

    O DBSnapshotIdentifier do novo DBSnapshot criado quando SkipFinalSnapshot está definido como false.

    nota

    Especificar esse parâmetro e também definir o parâmetro SkipFinalShapshot como true resultará em erro.

    Restrições:

    • Deve ter de 1 a 255 letras ou números.

    • O primeiro caractere deve ser uma letra

    • Não podem terminar com um hífen ou conter dois hífens consecutivos

    • Não pode ser especificado ao excluir uma réplica de leitura.

  • SkipFinalSnapshot (na CLI: --skip-final-snapshot): um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Determina se um DB snapshot final foi criado antes de a instância de banco de dados ser excluída. Se true for especificado, nenhum DBSnapshot será criado. Se false for especificado, um DB snapshot será criado antes de a instância de banco de dados ser excluída.

    Observe que, quando uma instância de banco de dados estiver em um estado de falha e tiver um status "failed", "incompatible-restore" ou "incompatible-network", ela só poderá ser excluída quando o parâmetro SkipFinalSnapshot for definido como "true".

    Especifique true ao excluir uma réplica de leitura.

    nota

    O parâmetro FinalDBSnapshotIdentifier deverá ser especificado se SkipFinalSnapshot for false.

    Padrão: false

Resposta

Contém os detalhes de uma instância de banco de dados do Amazon Neptune.

Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBInstances (ação).

  • AutoMinorVersionUpgrade: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica que os patches de versões secundárias são aplicados automaticamente.

  • AvailabilityZone: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o nome da zona de disponibilidade na qual a instância de banco de dados está localizada.

  • BackupRetentionPeriod: um valor inteiro, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o número de dias durante os quais os DB snapshots automáticos são retidos.

  • CACertificateIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador do certificado da CA para essa instância DB.

  • CopyTagsToSnapshot: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se as tags atribuídas são copiadas da instância de banco de dados nos snapshots da instância de banco de dados.

  • DBClusterIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Se a instância de banco de dados for membro de um cluster de banco de dados, conterá o nome do cluster de banco de dados do qual a instância de banco de dados é membro.

  • DBInstanceArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome de recurso da Amazon (ARN) da instância de banco de dados.

  • DBInstanceClass: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém o nome da classe de capacidade de computação e memória da instância de banco de dados.

  • DBInstanceIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um identificador de banco de dados fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica uma instância de banco de dados.

  • DbInstancePort: um valor inteiro, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica a porta na qual a instância de banco de dados escuta. Se a instância de banco de dados fizer parte de um cluster de banco de dados, isso poderá ser uma porta diferente da porta do cluster de banco de dados.

  • DBInstanceStatus: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o estado atual desse banco de dados.

  • DbiResourceId: uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador exclusivo e imutável da região da Amazon da instância de banco de dados. Esse identificador é encontrado nas entradas de log do Amazon CloudTrail sempre que a chave do Amazon KMS da instância de banco de dados é acessada.

  • DBName: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome do banco de dados.

  • DBParameterGroups – Uma matriz de objetos DBParameterGroupStatus.

    Fornece a lista de grupo de parâmetros de banco de dados aplicados a essa instância de banco de dados.

  • DBSecurityGroups – Uma matriz de objetos DBSecurityGroupMembership.

    Fornece a lista de elementos do grupo de segurança de banco de dados que contém somente os subelementos DBSecurityGroup.Name e DBSecurityGroup.Status.

  • DBSubnetGroup: um objeto DBSubnetGroup.

    Especifica informações sobre o grupo de sub-redes associado à instância de banco de dados, incluindo o nome, a descrição e as sub-redes no grupo de sub-redes.

  • DeletionProtection: um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se a instância de banco de dados tem a proteção contra exclusão ativada. A instância não poderá ser excluída quando a proteção contra exclusão estiver ativada. Consulte Excluir uma instância de banco de dados.

  • DomainMemberships – Uma matriz de objetos DomainMembership.

    Não suportado

  • EnabledCloudwatchLogsExports: uma string, do tipo: string (uma string codificada em UTF-8).

    Uma lista de tipos de logs que essa instância de banco de dados está configurada para exportar para o CloudWatch Logs.

  • Endpoint – Um objeto Endpoint.

    Especifica o endpoint de conexão.

  • Engine: uma string, do tipo: string (uma string codificada em UTF-8).

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

  • EngineVersion: uma string, do tipo: string (uma string codificada em UTF-8).

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

  • EnhancedMonitoringResourceArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome de recurso da Amazon (ARN) do fluxo de logs do Amazon CloudWatch Logs que recebe os dados de métricas de monitoramento avançado para a instância de banco de dados.

  • IAMDatabaseAuthenticationEnabled: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Verdadeiro se a autenticação do Amazon Identity and Access Management (IAM) estiver habilitada. Caso contrário, falso.

  • InstanceCreateTime: um TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

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

  • Iops: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o valor das IOPS (operações de entrada/saída por segundo) provisionadas.

  • KmsKeyId: uma string, do tipo: string (uma string codificada em UTF-8).

    Não compatível: a criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados.

  • LatestRestorableTime: um TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

    Especifica a data mais recente até a qual um banco de dados pode ser restaurado com restauração pontual.

  • LicenseModel: uma string, do tipo: string (uma string codificada em UTF-8).

    Informações do modelo de licença dessa instância de banco de dados.

  • MonitoringInterval: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O intervalo, em segundos, entre pontos quando as métricas de monitoramento avançado são coletadas para a instância de banco de dados.

  • MonitoringRoleArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN da função do IAM que permite que o Neptune envie métricas de monitoramento avançado para o Amazon CloudWatch Logs.

  • MultiAZ: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se a instância de banco de dados é uma implantação Multi-AZ.

  • PendingModifiedValues: um objeto PendingModifiedValues.

    Especifica que alterações à instância de banco de dados estão pendentes. Esse elemento só é incluído quando as alterações estão pendentes. As alterações específicas são identificadas por subelementos.

  • PreferredBackupWindow: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por BackupRetentionPeriod.

  • PreferredMaintenanceWindow: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o período semanal durante o qual pode ocorrer a manutenção do sistema, em Tempo Universal Coordenado (UTC).

  • PromotionTier: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Um valor que especifica a ordem em que uma réplica de leitura é promovida à instância principal após uma falha da instância principal existente.

  • PubliclyAccessible: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Este sinalizador não deve mais ser usado.

  • ReadReplicaDBClusterIdentifiers: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um ou mais identificadores de clusters de banco de dados que são réplicas de leitura dessa instância de banco de dados.

  • ReadReplicaDBInstanceIdentifiers: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um ou mais identificadores das réplicas de leitura associadas a essa instância de banco de dados.

  • ReadReplicaSourceDBInstanceIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém o identificador da instância de banco de dados de origem se essa instância de banco de dados for uma réplica de leitura.

  • SecondaryAvailabilityZone: uma string, do tipo: string (uma string codificada em UTF-8).

    Se houver, especificará o nome da zona de disponibilidade secundária para uma instância de banco de dados com suporte a Multi-AZ

  • StatusInfos – Uma matriz de objetos DBInstanceStatusInfo.

    O status da réplica de leitura. Se a instância não for uma réplica de leitura, isso ficará em branco.

  • StorageEncrypted: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Não compatível: a criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados.

  • StorageType: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o tipo de armazenamento associado à instância de banco de dados.

  • TdeCredentialArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN do armazenamento de chaves ao qual a instância está associada para criptografia TDE.

  • Timezone: uma string, do tipo: string (uma string codificada em UTF-8).

    Sem suporte.

  • VpcSecurityGroups – Uma matriz de objetos VpcSecurityGroupMembership.

    Fornece uma lista de elementos do grupo de segurança da VPC à qual a instância de banco de dados pertence.

Erros

ModifyDBInstance (ação)

        O nome da CLI da AWS para essa API é: modify-db-instance.

Modifica as configurações de uma instância de banco de dados. Você pode alterar um ou mais parâmetros de configuração do banco de dados especificando esses parâmetros e os novos valores na solicitação. Para saber quais modificações que você pode fazer em sua instância de banco de dados, chame DescribeValidDBInstanceModifications (ação) antes de chamar ModifyDBInstance (ação).

Solicitação

  • AllowMajorVersionUpgrade (na CLI: --allow-major-version-upgrade): um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica as atualizações principais de versões que são permitidas. Alterar esse parâmetro não resultará em uma interrupção e a alteração será aplicada de maneira assíncrona logo que possível.

  • ApplyImmediately (na CLI: --apply-immediately): um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se as modificações feitas nessa solicitação e todas as modificações pendentes serão aplicadas de maneira assíncrona logo que possível, independentemente da configuração PreferredMaintenanceWindow da instância de banco de dados.

    Caso esse parâmetro seja definido como false, as alterações feitas na instância de banco de dados serão aplicadas durante a próxima janela de manutenção. Algumas alterações de parâmetro podem causar uma interrupção e serão aplicadas na próxima chamada para RebootDBInstance (ação) ou na próxima reinicialização por falha.

    Padrão: false

  • AutoMinorVersionUpgrade (na CLI: --auto-minor-version-upgrade): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica que as atualizações secundárias do mecanismos serão aplicadas automaticamente à instância de banco de dados durante a janela de manutenção. Alterar esse parâmetro não resultará em uma interrupção, exceto no caso a seguir, e a alteração será aplicada de maneira assíncrona logo que possível. Ocorrerá uma interrupção se esse parâmetro estiver definido como true durante a janela de manutenção, e uma versão secundária mais nova estará disponível. O Neptune habilitou a aplicação automática de patches para essa versão do mecanismo.

  • BackupRetentionPeriod (na CLI: --backup-retention-period): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Não aplicável. O período de retenção de backups automatizados é gerenciado pelo cluster de banco de dados. Para obter mais informações, consulte ModifyDBCluster (ação).

    Padrão: usa a configuração existente

  • CACertificateIdentifier (na CLI: --ca-certificate-identifier): uma string, do tipo: string (uma string codificada em UTF-8).

    Indica o certificado que deve ser associado à instância.

  • CloudwatchLogsExportConfiguration (na CLI: --cloudwatch-logs-export-configuration): um objeto CloudwatchLogsExportConfiguration.

    A configuração para os tipos de log a serem habilitados para exportação para o CloudWatch Logs para um determinado cluster ou instância de banco de dados.

  • CopyTagsToSnapshot (na CLI: --copy-tags-to-snapshot): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    True para copiar todas as tags da instância de banco de dados para os snapshots da instância de banco de dados. Caso contrário, false. O padrão é falso.

  • DBInstanceClass (na CLI: --db-instance-class): uma string, do tipo: string (uma string codificada em UTF-8).

    A nova capacidade de computação e memória da instância de banco de dados, por exemplo, db.m4.large. Nem todas as classes de instâncias de banco de dados estão disponíveis em todas as regiões da Amazon.

    Se você modificar a classe da instância de banco de dados, ocorrerá uma interrupção durante a alteração. A alteração será aplicada durante a próxima janela de manutenção, a menos que ApplyImmediately seja especificado como true para essa solicitação.

    Padrão: usa a configuração existente

  • DBInstanceIdentifier (na CLI: --db-instance-identifier): obrigatório: uma string, do tipo: string (uma string codificada em UTF-8).

    O DB instance identifier. Esse valor é armazenado como uma string em minúsculas.

    Restrições:

    • Deve corresponder ao identificador de uma DBInstance existente.

  • DBParameterGroupName (na CLI: --db-parameter-group-name): uma string, do tipo: string (uma string codificada em UTF-8).

    O nome do grupo de parâmetros de banco de dados a ser aplicado à instância de banco de dados. Alterar essa configuração não resultará em uma interrupção. O nome do parameter group propriamente dito é alterado imediatamente, mas as alterações de parâmetros reais não serão aplicadas até que você reinicialize a instância sem failover. A instância de banco de dados NÃO será reinicializada automaticamente, e as alterações de parâmetro NÃO serão aplicadas durante a próxima janela de manutenção.

    Padrão: usa a configuração existente

    Restrições: o grupo de parâmetros de banco de dados deve estar na mesma família do grupo de parâmetros de banco de dados como essa instância de banco de dados.

  • DBPortNumber (na CLI: --db-port-number): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O número da porta na qual o banco de dados aceita conexões.

    O valor do parâmetro DBPortNumber não deve corresponder a nenhum dos valores de porta especificados para as opções no grupo de opções da instância de banco de dados.

    Seu banco de dados será reiniciado quando você alterar o valor de DBPortNumber independentemente do valor do parâmetro ApplyImmediately.

    Padrão: 8182

  • DBSecurityGroups (na CLI: --db-security-groups): uma string, do tipo: string (uma string codificada em UTF-8).

    Uma lista de grupos de segurança de banco de dados a serem autorizados nessa instância de banco de dados. A alteração dessa configuração não resultará em uma interrupção e a alteração será aplicada de maneira assíncrona logo que possível.

    Restrições:

    • Se fornecido, deve corresponder a DBSecurityGroups existentes.

  • DBSubnetGroupName (na CLI: --db-subnet-group-name): uma string, do tipo: string (uma string codificada em UTF-8).

    O novo grupo de sub-redes de banco de dados para a instância de banco de dados. Você pode usar esse parâmetro para mover sua instância de banco de dados para uma VPC diferente.

    Alterar o grupo de sub-redes faz com que ocorra uma interrupção durante a alteração. A alteração será aplicada durante a próxima janela de manutenção, a menos que você especifique true para o parâmetro ApplyImmediately.

    Restrições: se fornecido, deve corresponder ao nome de um DBSubnetGroup existente.

    Exemplo: mySubnetGroup

  • DeletionProtection (na CLI: --deletion-protection): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Um valor que indica se a instância de banco de dados tem a proteção contra exclusão habilitada. O banco de dados não pode ser excluído quando a proteção contra exclusão está habilitada. Por padrão, a proteção contra exclusão fica desabilitada. Consulte Excluir uma instância de banco de dados.

  • Domain (na CLI: --domain): uma string, do tipo: string (uma string codificada em UTF-8).

    Sem suporte.

  • DomainIAMRoleName (na CLI: --domain-iam-role-name): uma string, do tipo: string (uma string codificada em UTF-8).

    Não suportado

  • EnableIAMDatabaseAuthentication (na CLI: --enable-iam-database-authentication): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Verdadeiro para habilitar o mapeamento de contas do Amazon Identity and Access Management (IAM) para contas de banco de dados. Caso contrário, falso.

    Você pode habilitar a autenticação do banco de dados do IAM para os mecanismos de banco de dados a seguir

    Não aplicável. O mapeamento de contas do Amazon IAM para contas de banco de dados é gerenciado pelo cluster de banco de dados. Para obter mais informações, consulte ModifyDBCluster (ação).

    Padrão: false

  • EngineVersion (na CLI: --engine-version): uma string, do tipo: string (uma string codificada em UTF-8).

    O número da versão do mecanismo de banco de dados para a qual será feita a atualização. Atualmente, a definição desse parâmetro não tem efeito. Para atualizar seu mecanismo de banco de dados para a versão mais recente, use a API ApplyPendingMaintenanceAction (ação).

  • Iops (na CLI: --iops): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O novo valor de IOPS (operações de E/S por segundo) provisionadas para a instância.

    Alterar essa configuração parâmetro não resultará em uma interrupção e a alteração será aplicada durante a próxima janela de manutenção, a menos que o parâmetro ApplyImmediately esteja definido como true para essa solicitação.

    Padrão: usa a configuração existente

  • MonitoringInterval (na CLI: --monitoring-interval): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O intervalo, em segundos, entre pontos quando as métricas de monitoramento avançado são coletadas para a instância de banco de dados. Para desabilitar a coleta de métricas de monitoramento avançado, especifique 0. O padrão é 0.

    Se MonitoringRoleArn for especificado, você também deverá definir MonitoringInterval como um valor diferente de 0.

    Valores Válidos: 0, 1, 5, 10, 15, 30, 60

  • MonitoringRoleArn (na CLI: --monitoring-role-arn): uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN da função do IAM que permite que o Neptune envie métricas de monitoramento avançado para o Amazon CloudWatch Logs. Por exemplo, arn:aws:iam:123456789012:role/emaccess.

    Se MonitoringInterval estiver definido com um valor diferente de 0, você deverá fornecer um valor de MonitoringRoleArn.

  • MultiAZ (na CLI: --multi-az): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se a instância de banco de dados é uma implantação Multi-AZ. Alterar esse parâmetro não resultará em uma interrupção e a alteração será aplicada durante a próxima janela de manutenção, a menos que o parâmetro ApplyImmediately esteja definido como true para essa solicitação.

  • NewDBInstanceIdentifier (na CLI: --new-db-instance-identifier): uma string, do tipo: string (uma string codificada em UTF-8).

    O novo identificador da instância de banco de dados durante a renomeação de uma instância de banco de dados. Quando você altera o identificador da instância de banco de dados, uma reinicialização de instância ocorrerá imediatamente se você definir Apply Immediately como true ou ocorrerá durante a próxima janela de manutenção se você definir Apply Immediately como false. Esse valor é armazenado como uma string em minúsculas.

    Restrições:

    • Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.

    • O primeiro caractere deve ser uma letra.

    • Não podem terminar com um hífen ou conter dois hífens consecutivos.

    Exemplo: mydbinstance

  • PreferredBackupWindow (na CLI: --preferred-backup-window): uma string, do tipo: string (uma string codificada em UTF-8).

    O período diário durante o qual os backups automatizados serão criados se eles estiverem habilitados.

    Não aplicável. O intervalo de tempo diário para a criação de backups automatizados é gerenciado pelo cluster de banco de dados. Para obter mais informações, consulte ModifyDBCluster (ação).

    Restrições:

    • Deve estar no formato hh24:mi-hh24:mi

    • Deve estar expresso no Tempo Universal Coordenado (UTC)

    • Não pode entrar em conflito com a janela de manutenção preferencial

    • Deve ser, pelo menos, 30 minutos

  • PreferredMaintenanceWindow (na CLI: --preferred-maintenance-window): uma string, do tipo: string (uma string codificada em UTF-8).

    O período semanal (em UTC) durante o qual pode ocorrer a manutenção do sistema, o que pode resultar em uma interrupção. A alteração desse parâmetro não resultará em uma interrupção, exceto na situação a seguir, e a alteração será aplicada de maneira assíncrona logo que possível. Se houver ações pendentes que causem uma reinicialização e a janela de manutenção for alterada para incluir a hora atual, a alteração desse parâmetro causará uma reinicialização da instância de banco de dados. Se essa janela for mudada para a hora atual, deverá haver pelo menos 30 minutos entre a hora atual e o final da janela para garantir que as alterações pendentes sejam aplicadas.

    Padrão: usa a configuração existente

    Formato: ddd:hh24:mi-ddd:hh24:mi

    Dias válidos: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Restrições: deve ser, pelo menos, 30 minutos

  • PromotionTier (na CLI: --promotion-tier): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Um valor que especifica a ordem em que uma réplica de leitura é promovida à instância principal após uma falha da instância principal existente.

    Padrão: 1

    Valores válidos: 0 a 15

  • PubliclyAccessible (na CLI: --publicly-accessible): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Este sinalizador não deve mais ser usado.

  • StorageType (na CLI: --storage-type): uma string, do tipo: string (uma string codificada em UTF-8).

    Não aplicável. No Neptune, o tipo de armazenamento é gerenciado no nível do cluster de banco de dados.

  • TdeCredentialArn (na CLI: --tde-credential-arn): uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN do armazenamento de chaves ao qual associar a instância para a criptografia TDE.

  • TdeCredentialPassword (na CLI: --tde-credential-password): uma SensitiveString, do tipo: string (uma string codificada em UTF-8).

    A senha para o determinado ARN do armazenamento de chaves para acessar o dispositivo.

  • VpcSecurityGroupIds (na CLI: --vpc-security-group-ids): uma string, do tipo: string (uma string codificada em UTF-8).

    Uma lista de grupos de segurança da VPC do EC2 a serem autorizados nessa instância de banco de dados. Essa alteração será aplicada de forma assíncrona logo que possível.

    Não aplicável. A lista de grupos de segurança da VPC do EC2 associada é gerenciada pelo cluster de banco de dados. Para obter mais informações, consulte ModifyDBCluster (ação).

    Restrições:

    • Se fornecido, deve corresponder a VpcSecurityGroupIds existentes.

Resposta

Contém os detalhes de uma instância de banco de dados do Amazon Neptune.

Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBInstances (ação).

  • AutoMinorVersionUpgrade: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica que os patches de versões secundárias são aplicados automaticamente.

  • AvailabilityZone: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o nome da zona de disponibilidade na qual a instância de banco de dados está localizada.

  • BackupRetentionPeriod: um valor inteiro, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o número de dias durante os quais os DB snapshots automáticos são retidos.

  • CACertificateIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador do certificado da CA para essa instância DB.

  • CopyTagsToSnapshot: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se as tags atribuídas são copiadas da instância de banco de dados nos snapshots da instância de banco de dados.

  • DBClusterIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Se a instância de banco de dados for membro de um cluster de banco de dados, conterá o nome do cluster de banco de dados do qual a instância de banco de dados é membro.

  • DBInstanceArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome de recurso da Amazon (ARN) da instância de banco de dados.

  • DBInstanceClass: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém o nome da classe de capacidade de computação e memória da instância de banco de dados.

  • DBInstanceIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um identificador de banco de dados fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica uma instância de banco de dados.

  • DbInstancePort: um valor inteiro, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica a porta na qual a instância de banco de dados escuta. Se a instância de banco de dados fizer parte de um cluster de banco de dados, isso poderá ser uma porta diferente da porta do cluster de banco de dados.

  • DBInstanceStatus: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o estado atual desse banco de dados.

  • DbiResourceId: uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador exclusivo e imutável da região da Amazon da instância de banco de dados. Esse identificador é encontrado nas entradas de log do Amazon CloudTrail sempre que a chave do Amazon KMS da instância de banco de dados é acessada.

  • DBName: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome do banco de dados.

  • DBParameterGroups – Uma matriz de objetos DBParameterGroupStatus.

    Fornece a lista de grupo de parâmetros de banco de dados aplicados a essa instância de banco de dados.

  • DBSecurityGroups – Uma matriz de objetos DBSecurityGroupMembership.

    Fornece a lista de elementos do grupo de segurança de banco de dados que contém somente os subelementos DBSecurityGroup.Name e DBSecurityGroup.Status.

  • DBSubnetGroup: um objeto DBSubnetGroup.

    Especifica informações sobre o grupo de sub-redes associado à instância de banco de dados, incluindo o nome, a descrição e as sub-redes no grupo de sub-redes.

  • DeletionProtection: um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se a instância de banco de dados tem a proteção contra exclusão ativada. A instância não poderá ser excluída quando a proteção contra exclusão estiver ativada. Consulte Excluir uma instância de banco de dados.

  • DomainMemberships – Uma matriz de objetos DomainMembership.

    Não suportado

  • EnabledCloudwatchLogsExports: uma string, do tipo: string (uma string codificada em UTF-8).

    Uma lista de tipos de logs que essa instância de banco de dados está configurada para exportar para o CloudWatch Logs.

  • Endpoint – Um objeto Endpoint.

    Especifica o endpoint de conexão.

  • Engine: uma string, do tipo: string (uma string codificada em UTF-8).

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

  • EngineVersion: uma string, do tipo: string (uma string codificada em UTF-8).

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

  • EnhancedMonitoringResourceArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome de recurso da Amazon (ARN) do fluxo de logs do Amazon CloudWatch Logs que recebe os dados de métricas de monitoramento avançado para a instância de banco de dados.

  • IAMDatabaseAuthenticationEnabled: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Verdadeiro se a autenticação do Amazon Identity and Access Management (IAM) estiver habilitada. Caso contrário, falso.

  • InstanceCreateTime: um TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

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

  • Iops: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o valor das IOPS (operações de entrada/saída por segundo) provisionadas.

  • KmsKeyId: uma string, do tipo: string (uma string codificada em UTF-8).

    Não compatível: a criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados.

  • LatestRestorableTime: um TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

    Especifica a data mais recente até a qual um banco de dados pode ser restaurado com restauração pontual.

  • LicenseModel: uma string, do tipo: string (uma string codificada em UTF-8).

    Informações do modelo de licença dessa instância de banco de dados.

  • MonitoringInterval: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O intervalo, em segundos, entre pontos quando as métricas de monitoramento avançado são coletadas para a instância de banco de dados.

  • MonitoringRoleArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN da função do IAM que permite que o Neptune envie métricas de monitoramento avançado para o Amazon CloudWatch Logs.

  • MultiAZ: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se a instância de banco de dados é uma implantação Multi-AZ.

  • PendingModifiedValues: um objeto PendingModifiedValues.

    Especifica que alterações à instância de banco de dados estão pendentes. Esse elemento só é incluído quando as alterações estão pendentes. As alterações específicas são identificadas por subelementos.

  • PreferredBackupWindow: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por BackupRetentionPeriod.

  • PreferredMaintenanceWindow: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o período semanal durante o qual pode ocorrer a manutenção do sistema, em Tempo Universal Coordenado (UTC).

  • PromotionTier: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Um valor que especifica a ordem em que uma réplica de leitura é promovida à instância principal após uma falha da instância principal existente.

  • PubliclyAccessible: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Este sinalizador não deve mais ser usado.

  • ReadReplicaDBClusterIdentifiers: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um ou mais identificadores de clusters de banco de dados que são réplicas de leitura dessa instância de banco de dados.

  • ReadReplicaDBInstanceIdentifiers: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um ou mais identificadores das réplicas de leitura associadas a essa instância de banco de dados.

  • ReadReplicaSourceDBInstanceIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém o identificador da instância de banco de dados de origem se essa instância de banco de dados for uma réplica de leitura.

  • SecondaryAvailabilityZone: uma string, do tipo: string (uma string codificada em UTF-8).

    Se houver, especificará o nome da zona de disponibilidade secundária para uma instância de banco de dados com suporte a Multi-AZ

  • StatusInfos – Uma matriz de objetos DBInstanceStatusInfo.

    O status da réplica de leitura. Se a instância não for uma réplica de leitura, isso ficará em branco.

  • StorageEncrypted: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Não compatível: a criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados.

  • StorageType: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o tipo de armazenamento associado à instância de banco de dados.

  • TdeCredentialArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN do armazenamento de chaves ao qual a instância está associada para criptografia TDE.

  • Timezone: uma string, do tipo: string (uma string codificada em UTF-8).

    Sem suporte.

  • VpcSecurityGroups – Uma matriz de objetos VpcSecurityGroupMembership.

    Fornece uma lista de elementos do grupo de segurança da VPC à qual a instância de banco de dados pertence.

Erros

RebootDBInstance (ação)

        O nome da CLI da AWS para essa API é: reboot-db-instance.

Você pode precisar reinicializar sua instância de banco de dados, geralmente, por motivos de manutenção. Por exemplo, se você fizer determinadas modificações ou alterar o grupo de parâmetros de banco de dados associado à instância de banco de dados, deverá reiniciar a instância para que as alterações sejam implementadas.

Reiniciar uma instância de banco de dados reinicia o serviço de mecanismo de banco de dados. Reinicializar uma instância de banco de dados resulta em uma interrupção momentânea, durante a qual o status da instância de banco de dados é definido como rebooting (reinicialização).

Solicitação

  • DBInstanceIdentifier (na CLI: --db-instance-identifier): obrigatório: uma string, do tipo: string (uma string codificada em UTF-8).

    O DB instance identifier. Este parâmetro é armazenado como uma string com letras minúsculas.

    Restrições:

    • Deve corresponder ao identificador de uma DBInstance existente.

  • ForceFailover (na CLI: --force-failover): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Quando true, a reinicialização é feita por meio de um failover de Multi-AZ.

    Restrição: não será possível especificar true se a instância não estiver configurada para Multi-AZ.

Resposta

Contém os detalhes de uma instância de banco de dados do Amazon Neptune.

Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBInstances (ação).

  • AutoMinorVersionUpgrade: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica que os patches de versões secundárias são aplicados automaticamente.

  • AvailabilityZone: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o nome da zona de disponibilidade na qual a instância de banco de dados está localizada.

  • BackupRetentionPeriod: um valor inteiro, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o número de dias durante os quais os DB snapshots automáticos são retidos.

  • CACertificateIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador do certificado da CA para essa instância DB.

  • CopyTagsToSnapshot: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se as tags atribuídas são copiadas da instância de banco de dados nos snapshots da instância de banco de dados.

  • DBClusterIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Se a instância de banco de dados for membro de um cluster de banco de dados, conterá o nome do cluster de banco de dados do qual a instância de banco de dados é membro.

  • DBInstanceArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome de recurso da Amazon (ARN) da instância de banco de dados.

  • DBInstanceClass: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém o nome da classe de capacidade de computação e memória da instância de banco de dados.

  • DBInstanceIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um identificador de banco de dados fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica uma instância de banco de dados.

  • DbInstancePort: um valor inteiro, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica a porta na qual a instância de banco de dados escuta. Se a instância de banco de dados fizer parte de um cluster de banco de dados, isso poderá ser uma porta diferente da porta do cluster de banco de dados.

  • DBInstanceStatus: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o estado atual desse banco de dados.

  • DbiResourceId: uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador exclusivo e imutável da região da Amazon da instância de banco de dados. Esse identificador é encontrado nas entradas de log do Amazon CloudTrail sempre que a chave do Amazon KMS da instância de banco de dados é acessada.

  • DBName: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome do banco de dados.

  • DBParameterGroups – Uma matriz de objetos DBParameterGroupStatus.

    Fornece a lista de grupo de parâmetros de banco de dados aplicados a essa instância de banco de dados.

  • DBSecurityGroups – Uma matriz de objetos DBSecurityGroupMembership.

    Fornece a lista de elementos do grupo de segurança de banco de dados que contém somente os subelementos DBSecurityGroup.Name e DBSecurityGroup.Status.

  • DBSubnetGroup: um objeto DBSubnetGroup.

    Especifica informações sobre o grupo de sub-redes associado à instância de banco de dados, incluindo o nome, a descrição e as sub-redes no grupo de sub-redes.

  • DeletionProtection: um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se a instância de banco de dados tem a proteção contra exclusão ativada. A instância não poderá ser excluída quando a proteção contra exclusão estiver ativada. Consulte Excluir uma instância de banco de dados.

  • DomainMemberships – Uma matriz de objetos DomainMembership.

    Não suportado

  • EnabledCloudwatchLogsExports: uma string, do tipo: string (uma string codificada em UTF-8).

    Uma lista de tipos de logs que essa instância de banco de dados está configurada para exportar para o CloudWatch Logs.

  • Endpoint – Um objeto Endpoint.

    Especifica o endpoint de conexão.

  • Engine: uma string, do tipo: string (uma string codificada em UTF-8).

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

  • EngineVersion: uma string, do tipo: string (uma string codificada em UTF-8).

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

  • EnhancedMonitoringResourceArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome de recurso da Amazon (ARN) do fluxo de logs do Amazon CloudWatch Logs que recebe os dados de métricas de monitoramento avançado para a instância de banco de dados.

  • IAMDatabaseAuthenticationEnabled: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Verdadeiro se a autenticação do Amazon Identity and Access Management (IAM) estiver habilitada. Caso contrário, falso.

  • InstanceCreateTime: um TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

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

  • Iops: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o valor das IOPS (operações de entrada/saída por segundo) provisionadas.

  • KmsKeyId: uma string, do tipo: string (uma string codificada em UTF-8).

    Não compatível: a criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados.

  • LatestRestorableTime: um TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

    Especifica a data mais recente até a qual um banco de dados pode ser restaurado com restauração pontual.

  • LicenseModel: uma string, do tipo: string (uma string codificada em UTF-8).

    Informações do modelo de licença dessa instância de banco de dados.

  • MonitoringInterval: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O intervalo, em segundos, entre pontos quando as métricas de monitoramento avançado são coletadas para a instância de banco de dados.

  • MonitoringRoleArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN da função do IAM que permite que o Neptune envie métricas de monitoramento avançado para o Amazon CloudWatch Logs.

  • MultiAZ: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se a instância de banco de dados é uma implantação Multi-AZ.

  • PendingModifiedValues: um objeto PendingModifiedValues.

    Especifica que alterações à instância de banco de dados estão pendentes. Esse elemento só é incluído quando as alterações estão pendentes. As alterações específicas são identificadas por subelementos.

  • PreferredBackupWindow: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por BackupRetentionPeriod.

  • PreferredMaintenanceWindow: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o período semanal durante o qual pode ocorrer a manutenção do sistema, em Tempo Universal Coordenado (UTC).

  • PromotionTier: um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Um valor que especifica a ordem em que uma réplica de leitura é promovida à instância principal após uma falha da instância principal existente.

  • PubliclyAccessible: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Este sinalizador não deve mais ser usado.

  • ReadReplicaDBClusterIdentifiers: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um ou mais identificadores de clusters de banco de dados que são réplicas de leitura dessa instância de banco de dados.

  • ReadReplicaDBInstanceIdentifiers: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um ou mais identificadores das réplicas de leitura associadas a essa instância de banco de dados.

  • ReadReplicaSourceDBInstanceIdentifier: uma string, do tipo: string (uma string codificada em UTF-8).

    Contém o identificador da instância de banco de dados de origem se essa instância de banco de dados for uma réplica de leitura.

  • SecondaryAvailabilityZone: uma string, do tipo: string (uma string codificada em UTF-8).

    Se houver, especificará o nome da zona de disponibilidade secundária para uma instância de banco de dados com suporte a Multi-AZ

  • StatusInfos – Uma matriz de objetos DBInstanceStatusInfo.

    O status da réplica de leitura. Se a instância não for uma réplica de leitura, isso ficará em branco.

  • StorageEncrypted: um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Não compatível: a criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados.

  • StorageType: uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o tipo de armazenamento associado à instância de banco de dados.

  • TdeCredentialArn: uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN do armazenamento de chaves ao qual a instância está associada para criptografia TDE.

  • Timezone: uma string, do tipo: string (uma string codificada em UTF-8).

    Sem suporte.

  • VpcSecurityGroups – Uma matriz de objetos VpcSecurityGroupMembership.

    Fornece uma lista de elementos do grupo de segurança da VPC à qual a instância de banco de dados pertence.

Erros

DescribeDBInstances (ação)

        O nome da CLI da AWS para essa API é: describe-db-instances.

Retorna informações sobre instâncias provisionadas e oferece suporte à paginação.

nota

Essa operação também pode retornar informações para instâncias do Amazon RDS e instâncias do Amazon DocDB.

Solicitação

  • DBInstanceIdentifier (na CLI: --db-instance-identifier): uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador da instância fornecido pelo usuário. Se esse parâmetro for especificado, somente as informações da instância de banco de dados específica serão retornadas. Este parâmetro não diferencia maiúsculas de minúsculas.

    Restrições:

    • Se fornecido, deve corresponder ao identificador de uma DBInstance existente.

  • Filters (na CLI: --filters): uma matriz de objetos Filtro.

    Um filtro que especifica uma ou mais instâncias de banco de dados a serem descritas.

    Filtros suportados:

    • db-cluster-id – aceita identificadores de cluster de banco de dados e os Nomes de recursos da Amazon (ARNs) do cluster de banco de dados. A lista de resultados incluirá somente informações sobre as instâncias de banco de dados associadas aos clusters de banco de dados identificados por esses ARNs.

    • engine – aceita um nome de mecanismo (como neptune) e restringe a lista de resultados a instâncias de banco de dados criadas por esse mecanismo.

    Por exemplo, para invocar essa API na CLI da Amazon e filtrar para que somente instâncias de banco de dados do Neptune sejam exibidas, é possível usar o seguinte comando:

    aws neptune describe-db-instances \
            --filters  Name=engine,Values=neptune

  • Marker (na CLI: --marker): uma string, do tipo: string (uma string codificada em UTF-8).

    Um token de paginação opcional fornecido por uma solicitação DescribeDBInstances anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por MaxRecords.

  • MaxRecords (na CLI: --max-records): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o valor MaxRecords especificado, um token de paginação chamado de marcador será incluído na resposta para que os resultados restantes possam ser recuperados.

    Padrão: 100

    Restrições: Mínimo 20, máximo 100.

Resposta

  • DBInstances – Uma matriz de objetos DBInstance.

    Uma lista de instâncias DBInstance (estrutura).

  • Marker: uma string, do tipo: string (uma string codificada em UTF-8).

    Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por MaxRecords.

Erros

DescribeOrderableDBInstanceOptions (ação)

        O nome da CLI da AWS para essa API é: describe-orderable-db-instance-options.

Retorna uma lista de opções de instância de banco de dados que podem ser solicitadas para o mecanismo especificado.

Solicitação

  • DBInstanceClass (na CLI: --db-instance-class): uma string, do tipo: string (uma string codificada em UTF-8).

    O valor do filtro da classe da instância de banco de dados. Especifique esse parâmetro para mostrar somente as ofertas disponíveis correspondentes à classe da instância de banco de dados especificada.

  • Engine (na CLI: --engine): obrigatório: uma string, do tipo: string (uma string codificada em UTF-8).

    O nome do mecanismo para o qual recuperar opções de instância de banco de dados.

  • EngineVersion (na CLI: --engine-version): uma string, do tipo: string (uma string codificada em UTF-8).

    O valor do filtro da versão do mecanismo. Especifique esse parâmetro para mostrar somente as ofertas disponíveis correspondentes à versão do mecanismo especificado.

  • Filters (na CLI: --filters): uma matriz de objetos Filtro.

    Não há suporte para esse parâmetro atualmente.

  • LicenseModel (na CLI: --license-model): uma string, do tipo: string (uma string codificada em UTF-8).

    O valor do filtro do modelo de licença. Especifique esse parâmetro para mostrar somente as ofertas disponíveis correspondentes ao modelo de licença especificado.

  • Marker (na CLI: --marker): uma string, do tipo: string (uma string codificada em UTF-8).

    Um token de paginação opcional fornecido por uma solicitação DescribeOrderableDBInstanceOptions anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por MaxRecords.

  • MaxRecords (na CLI: --max-records): um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o valor MaxRecords especificado, um token de paginação chamado de marcador será incluído na resposta para que os resultados restantes possam ser recuperados.

    Padrão: 100

    Restrições: Mínimo 20, máximo 100.

  • Vpc (na CLI: --vpc): um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    O valor do filtro da VPC. Especifique esse parâmetro para mostrar somente a VPC disponível ou ofertas que não sejam de VPC.

Resposta

  • Marker: uma string, do tipo: string (uma string codificada em UTF-8).

    Um token de paginação opcional fornecido por uma solicitação OrderableDBInstanceOptions anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por MaxRecords.

  • OrderableDBInstanceOptions – Uma matriz de objetos OrderableDBInstanceOption.

    Uma estrutura OrderableDBInstanceOption (estrutura) que contém informações sobre as opções que podem ser solicitadas para a instância de banco de dados.

DescribeValidDBInstanceModifications (ação)

        O nome da CLI da AWS para essa API é: describe-valid-db-instance-modifications.

É possível chamar DescribeValidDBInstanceModifications (ação) para saber quais modificações que você pode fazer em sua instância de banco de dados. Você pode usar essas informações quando chamar ModifyDBInstance (ação).

Solicitação

  • DBInstanceIdentifier (na CLI: --db-instance-identifier): obrigatório: uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador do cliente ou o ARN de sua instância de banco de dados.

Resposta

Informações sobre modificações válidas que você pode fazer à sua instância de banco de dados. Contém o resultado de uma chamada bem-sucedida para a ação DescribeValidDBInstanceModifications (ação). Você pode usar essas informações quando chamar ModifyDBInstance (ação).

  • Storage – Uma matriz de objetos ValidStorageOptions.

    Opções de armazenamento válidas para sua instância de banco de dados.

Erros

Estruturas:

DBInstance (estrutura)

Contém os detalhes de uma instância de banco de dados do Amazon Neptune.

Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBInstances (ação).

Campos

  • AutoMinorVersionUpgrade: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica que os patches de versões secundárias são aplicados automaticamente.

  • AvailabilityZone: é uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o nome da zona de disponibilidade na qual a instância de banco de dados está localizada.

  • BackupRetentionPeriod: é um valor inteiro, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o número de dias durante os quais os DB snapshots automáticos são retidos.

  • CACertificateIdentifier: é uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador do certificado da CA para essa instância DB.

  • CopyTagsToSnapshot: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se as tags atribuídas são copiadas da instância de banco de dados nos snapshots da instância de banco de dados.

  • DBClusterIdentifier: é uma string, do tipo: string (uma string codificada em UTF-8).

    Se a instância de banco de dados for membro de um cluster de banco de dados, conterá o nome do cluster de banco de dados do qual a instância de banco de dados é membro.

  • DBInstanceArn: é uma string, do tipo: string (uma string codificada em UTF-8).

    O nome de recurso da Amazon (ARN) da instância de banco de dados.

  • DBInstanceClass: é uma string, do tipo: string (uma string codificada em UTF-8).

    Contém o nome da classe de capacidade de computação e memória da instância de banco de dados.

  • DBInstanceIdentifier: é uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um identificador de banco de dados fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica uma instância de banco de dados.

  • DbInstancePort: é um valor inteiro, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica a porta na qual a instância de banco de dados escuta. Se a instância de banco de dados fizer parte de um cluster de banco de dados, isso poderá ser uma porta diferente da porta do cluster de banco de dados.

  • DBInstanceStatus: é uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o estado atual desse banco de dados.

  • DbiResourceId: é uma string, do tipo: string (uma string codificada em UTF-8).

    O identificador exclusivo e imutável da região da Amazon da instância de banco de dados. Esse identificador é encontrado nas entradas de log do Amazon CloudTrail sempre que a chave do Amazon KMS da instância de banco de dados é acessada.

  • DBName: é uma string, do tipo: string (uma string codificada em UTF-8).

    O nome do banco de dados.

  • DBParameterGroups: é uma matriz de objetos DBParameterGroupStatus.

    Fornece a lista de grupo de parâmetros de banco de dados aplicados a essa instância de banco de dados.

  • DBSecurityGroups: é uma matriz de objetos DBSecurityGroupMembership.

    Fornece a lista de elementos do grupo de segurança de banco de dados que contém somente os subelementos DBSecurityGroup.Name e DBSecurityGroup.Status.

  • DBSubnetGroup: é um objeto DBSubnetGroup.

    Especifica informações sobre o grupo de sub-redes associado à instância de banco de dados, incluindo o nome, a descrição e as sub-redes no grupo de sub-redes.

  • DeletionProtection: é um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se a instância de banco de dados tem a proteção contra exclusão ativada. A instância não poderá ser excluída quando a proteção contra exclusão estiver ativada. Consulte Excluir uma instância de banco de dados.

  • DomainMemberships: é uma matriz de objetos DomainMembership.

    Não suportado

  • EnabledCloudwatchLogsExports: é uma string, do tipo: string (uma string codificada em UTF-8).

    Uma lista de tipos de logs que essa instância de banco de dados está configurada para exportar para o CloudWatch Logs.

  • Endpoint: é um objeto Endpoint.

    Especifica o endpoint de conexão.

  • Engine: é uma string, do tipo: string (uma string codificada em UTF-8).

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

  • EngineVersion: é uma string, do tipo: string (uma string codificada em UTF-8).

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

  • EnhancedMonitoringResourceArn: é uma string, do tipo: string (uma string codificada em UTF-8).

    O nome de recurso da Amazon (ARN) do fluxo de logs do Amazon CloudWatch Logs que recebe os dados de métricas de monitoramento avançado para a instância de banco de dados.

  • IAMDatabaseAuthenticationEnabled: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Verdadeiro se a autenticação do Amazon Identity and Access Management (IAM) estiver habilitada. Caso contrário, falso.

  • InstanceCreateTime: é um TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

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

  • Iops: é um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o valor das IOPS (operações de entrada/saída por segundo) provisionadas.

  • KmsKeyId: é uma string, do tipo: string (uma string codificada em UTF-8).

    Não compatível: a criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados.

  • LatestRestorableTime: é um TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

    Especifica a data mais recente até a qual um banco de dados pode ser restaurado com restauração pontual.

  • LicenseModel: é uma string, do tipo: string (uma string codificada em UTF-8).

    Informações do modelo de licença dessa instância de banco de dados.

  • MonitoringInterval: é um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    O intervalo, em segundos, entre pontos quando as métricas de monitoramento avançado são coletadas para a instância de banco de dados.

  • MonitoringRoleArn: é uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN da função do IAM que permite que o Neptune envie métricas de monitoramento avançado para o Amazon CloudWatch Logs.

  • MultiAZ: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Especifica se a instância de banco de dados é uma implantação Multi-AZ.

  • PendingModifiedValues: é um objeto PendingModifiedValues.

    Especifica que alterações à instância de banco de dados estão pendentes. Esse elemento só é incluído quando as alterações estão pendentes. As alterações específicas são identificadas por subelementos.

  • PreferredBackupWindow: é uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por BackupRetentionPeriod.

  • PreferredMaintenanceWindow: é uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o período semanal durante o qual pode ocorrer a manutenção do sistema, em Tempo Universal Coordenado (UTC).

  • PromotionTier: é um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Um valor que especifica a ordem em que uma réplica de leitura é promovida à instância principal após uma falha da instância principal existente.

  • PubliclyAccessible: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Este sinalizador não deve mais ser usado.

  • ReadReplicaDBClusterIdentifiers: é uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um ou mais identificadores de clusters de banco de dados que são réplicas de leitura dessa instância de banco de dados.

  • ReadReplicaDBInstanceIdentifiers: é uma string, do tipo: string (uma string codificada em UTF-8).

    Contém um ou mais identificadores das réplicas de leitura associadas a essa instância de banco de dados.

  • ReadReplicaSourceDBInstanceIdentifier: é uma string, do tipo: string (uma string codificada em UTF-8).

    Contém o identificador da instância de banco de dados de origem se essa instância de banco de dados for uma réplica de leitura.

  • SecondaryAvailabilityZone: é uma string, do tipo: string (uma string codificada em UTF-8).

    Se houver, especificará o nome da zona de disponibilidade secundária para uma instância de banco de dados com suporte a Multi-AZ

  • StatusInfos: é uma matriz de objetos DBInstanceStatusInfo.

    O status da réplica de leitura. Se a instância não for uma réplica de leitura, isso ficará em branco.

  • StorageEncrypted: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Não compatível: a criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados.

  • StorageType: é uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o tipo de armazenamento associado à instância de banco de dados.

  • TdeCredentialArn: é uma string, do tipo: string (uma string codificada em UTF-8).

    O ARN do armazenamento de chaves ao qual a instância está associada para criptografia TDE.

  • Timezone: é uma string, do tipo: string (uma string codificada em UTF-8).

    Sem suporte.

  • VpcSecurityGroups: é uma matriz de objetos VpcSecurityGroupMembership.

    Fornece uma lista de elementos do grupo de segurança da VPC à qual a instância de banco de dados pertence.

DBInstance é usado como o elemento de resposta para:

DBInstanceStatusInfo (estrutura)

Fornece uma lista de informações de status para uma instância de banco de dados.

Campos

  • Message: é uma string, do tipo: string (uma string codificada em UTF-8).

    Detalhes do erro se houver um erro para a instância. Se a instância não estiver em um estado de erro, esse valor ficará em branco.

  • Normal: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Valor booliano que será true se a instância estiver funcionando normalmente, ou false se a instância estiver em um estado de erro.

  • Status: é uma string, do tipo: string (uma string codificada em UTF-8).

    Status da instância de banco de dados. Para um StatusType de réplica de leitura, os valores podem ser replicação, erro, interrompida ou encerrada.

  • StatusType: é uma string, do tipo: string (uma string codificada em UTF-8).

    No momento, esse valor é "read replication".

OrderableDBInstanceOption (estrutura)

Contém uma lista de opções disponíveis para uma instância de banco de dados.

Esse tipo de dados é usado como um elemento de resposta na ação DescribeOrderableDBInstanceOptions (ação).

Campos

  • AvailabilityZones: é uma matriz de objetos AvailabilityZone.

    Uma lista das zonas de disponibilidade para uma instância de banco de dados.

  • DBInstanceClass: é uma string, do tipo: string (uma string codificada em UTF-8).

    A classe da instância de banco de dados para uma instância de banco de dados.

  • Engine: é uma string, do tipo: string (uma string codificada em UTF-8).

    O tipo de mecanismo de uma instância de banco de dados.

  • EngineVersion: é uma string, do tipo: string (uma string codificada em UTF-8).

    A versão do mecanismo de uma instância de banco de dados.

  • LicenseModel: é uma string, do tipo: string (uma string codificada em UTF-8).

    O modelo de licença para uma instância de banco de dados.

  • MaxIopsPerDbInstance: é um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Total máximo de IOPS provisionadas para uma instância de banco de dados

  • MaxIopsPerGib: é um DoubleOptional, do tipo: double (um número de ponto flutuante IEEE 754 de dupla precisão).

    Máximo de IOPS provisionadas por GiB para uma instância de banco de dados

  • MaxStorageSize: é um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Tamanho máximo de armazenamento de uma instância de banco de dados.

  • MinIopsPerDbInstance: é um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Total mínimo de IOPS provisionadas para uma instância de banco de dados

  • MinIopsPerGib: é um DoubleOptional, do tipo: double (um número de ponto flutuante IEEE 754 de dupla precisão).

    Mínimo de IOPS provisionadas por GiB para uma instância de banco de dados

  • MinStorageSize: é um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Tamanho mínimo de armazenamento de uma instância de banco de dados.

  • MultiAZCapable: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se uma instância de banco de dados tem capacidade para Multi-AZ.

  • ReadReplicaCapable: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se uma instância de banco de dados pode ter uma réplica de leitura.

  • StorageType: é uma string, do tipo: string (uma string codificada em UTF-8).

    Não aplicável. No Neptune, o tipo de armazenamento é gerenciado no nível do cluster de banco de dados.

  • SupportsEnhancedMonitoring: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se uma instância de banco de dados oferece suporte ao monitoramento avançado em intervalos de 1 a 60 segundos.

  • SupportsGlobalDatabases: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Um valor que indica se você pode usar os bancos de dados globais do Neptune com uma combinação específica de outros atributos do mecanismo de banco de dados.

  • SupportsIAMDatabaseAuthentication: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se uma instância de banco de dados oferece suporte à autenticação de banco de dados do IAM.

  • SupportsIops: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se uma instância de banco de dados oferece suporte a IOPS provisionadas.

  • SupportsStorageEncryption: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se uma instância de banco de dados oferece suporte ao armazenamento criptografado.

  • Vpc: é um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica se uma instância de banco de dados está em uma VPC.

PendingModifiedValues (estrutura)

Esse tipo de dados é usado como um elemento de resposta na ação ModifyDBInstance (ação).

Campos

  • AllocatedStorage: é um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Contém o novo tamanho de AllocatedStorage para a instância de banco de dados que será aplicado ou está sendo aplicado.

  • BackupRetentionPeriod: é um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o número de dias pendentes durante os quais os backups automatizados são retidos.

  • CACertificateIdentifier: é uma string, do tipo: string (uma string codificada em UTF-8).

    Especifica o identificador do certificado da CA para a instância de banco de dados.

  • DBInstanceClass: é uma string, do tipo: string (uma string codificada em UTF-8).

    Contém a nova DBInstanceClass para a instância de banco de dados que será aplicada ou está sendo aplicada.

  • DBInstanceIdentifier: é uma string, do tipo: string (uma string codificada em UTF-8).

    Contém a nova DBInstanceIdentifier para a instância de banco de dados que será aplicada ou está sendo aplicada.

  • DBSubnetGroupName: é uma string, do tipo: string (uma string codificada em UTF-8).

    O novo grupo de sub-redes de banco de dados para a instância de banco de dados.

  • EngineVersion: é uma string, do tipo: string (uma string codificada em UTF-8).

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

  • Iops: é um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica o novo valor de IOPS provisionadas para a instância de banco de dados que será aplicado ou está sendo aplicado.

  • MultiAZ: é um BooleanOptional, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

    Indica que a instância de banco de dados Single-AZ deve ser alterada apara uma implantação Multi-AZ.

  • PendingCloudwatchLogsExports: é um objeto PendingCloudwatchLogsExports.

    Essa estrutura PendingCloudwatchLogsExports especifica alterações pendentes em quais logs do CloudWatch estão habilitados e quais estão desabilitados.

  • Port: é um IntegerOptional, do tipo: integer (um valor inteiro assinado de 32 bits).

    Especifica a porta pendente para a instância de banco de dados.

  • StorageType: é uma string, do tipo: string (uma string codificada em UTF-8).

    Não aplicável. No Neptune, o tipo de armazenamento é gerenciado no nível do cluster de banco de dados.

ValidStorageOptions (estrutura)

Não aplicável. No Neptune, o tipo de armazenamento é gerenciado no nível do cluster de banco de dados.

Campos

  • IopsToStorageRatio: é uma matriz de objetos DoubleRange.

    Não aplicável. No Neptune, o tipo de armazenamento é gerenciado no nível do cluster de banco de dados.

  • ProvisionedIops: é uma matriz de objetos Intervalo.

    Não aplicável. No Neptune, o tipo de armazenamento é gerenciado no nível do cluster de banco de dados.

  • StorageSize: é uma matriz de objetos Intervalo.

    Não aplicável. No Neptune, o tipo de armazenamento é gerenciado no nível do cluster de banco de dados.

  • StorageType: é uma string, do tipo: string (uma string codificada em UTF-8).

    Não aplicável. No Neptune, o tipo de armazenamento é gerenciado no nível do cluster de banco de dados.

ValidDBInstanceModificationsMessage (estrutura)

Informações sobre modificações válidas que você pode fazer à sua instância de banco de dados. Contém o resultado de uma chamada bem-sucedida para a ação DescribeValidDBInstanceModifications (ação). Você pode usar essas informações quando chamar ModifyDBInstance (ação).

Campos

  • Storage: é uma matriz de objetos ValidStorageOptions.

    Opções de armazenamento válidas para sua instância de banco de dados.

ValidDBInstanceModificationsMessage é usado como o elemento de resposta para: