API de clusters de banco de dados do Neptune

• CreateDBCluster (ação)

• DeleteDBCluster (ação)

• ModifyDBCluster (ação)

• StartDBCluster (ação)

• StopDBCluster (ação)

• AddRoleToDBCluster (ação)

• RemoveRoleFromDBCluster (ação)

• FailoverDBCluster (ação)

• PromoteReadReplicaDBCluster (ação)

• DescribeDBClusters (ação)

• DBCluster (estrutura)

• DBClusterMember (estrutura)

• DBClusterRole (estrutura)

• CloudwatchLogsExportConfiguration (estrutura)

• PendingCloudwatchLogsExports (estrutura)

• ClusterPendingModifiedValues (estrutura)

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

  Uma lista de zonas de disponibilidade do EC2 nas quais as instâncias no cluster de banco de dados podem ser criadas.

• 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. Você deve especificar o valor mínimo de 1.

  Padrão: 1

  Restrições:

  • Deve ser um valor de 1 a 35

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

  Se definido como true, as tags serão copiadas em qualquer snapshot do cluster de banco de dados criado.

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

  O nome para o seu banco de dados, com até 64 caracteres alfanuméricos. Se um nome não for fornecido, o Amazon Neptune não criará um banco de dados no cluster de banco de dados que você está criando.

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

  O identificador de cluster de banco de dados. 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: my-cluster1

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

  O nome do grupo de parâmetros de cluster de banco de dados para associar a este cluster de banco de dados. Se esse argumento for omitido, o padrão será usado.

  Restrições:

  • Se for fornecido, deverá corresponder ao nome de um DBClusterParameterGroup existente.

• 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 esse cluster de banco de dados.

  Restrições: deve corresponder ao nome de um DBSubnetGroup existente. Não deve ser padrão.

  Exemplo: mySubnetgroup

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

  Um valor que indica se o cluster 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 habilitada.

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

  Uma lista dos tipos de logs que esse cluster de banco de dados deve exportar para o CloudWatch Logs. Os tipos de log válidos são: audit (para publicar logs de auditoria) e slowquery (para publicar logs de consulta lenta). Consulte Publicar logs do Neptune no Amazon CloudWatch Logs.

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

  Se for definido como true, habilitará a autenticação do Amazon Identity and Access Management (IAM) para todo o cluster de banco de dados (isso não pode ser definido na instância).

  Padrão: false.

• 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 esse cluster de banco de dados.

  Valores Válidos: neptune

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

  O número de versão do mecanismo de banco de dados a ser usado para o novo cluster de banco de dados.

  Exemplo: 1.2.1.0

• GlobalClusterIdentifier( na CLI:--global-cluster-identifier): um GlobalClusterIdentifier, do tipo: string (uma string codificada em UTF-8), no mínimo 1 e no máximo 255 ?st?s, correspondendo a esta expressão regular: [A-Za-z][0-9A-Za-z-:._]*.

  O ID do banco de dados global do Neptune ao qual esse novo cluster de banco de dados deve ser adicionado.

• 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 um cluster de banco de dados criptografado.

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

  Se uma chave de criptografia não for especificada em KmsKeyId:

  • Se ReplicationSourceIdentifier identificar uma origem criptografada, o Amazon Neptune usará a chave de criptografia utilizada para criptografar a origem. Caso contrário, o Amazon Neptune usará a chave de criptografia padrão.

  • Se o parâmetro StorageEncrypted for true e ReplicationSourceIdentifier não for especificado, 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.

  Se você criar uma réplica de leitura de um cluster de banco de dados criptografado em outra região da Amazon, é necessário definir KmsKeyId como um ID de chave do KMS que seja válido na região da Amazon de destino. Essa chave é usada para criptografar a réplica de leitura nessa região da Amazon.

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

  O número de porta em que as instâncias no cluster de banco de dados aceitam conexões.

  Padrão: 8182

• 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 serão criados se eles forem habilitados com o parâmetro BackupRetentionPeriod.

  O padrão é uma janela de trinta minutos selecionada aleatoriamente em um bloco de tempo de oito horas para cada região da Amazon. Para ver os blocos de tempo disponíveis, consulte Neptune Maintenance Window no Guia do usuário do Amazon Neptune.

  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 intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, 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. Para ver os blocos de tempo disponíveis, consulte Neptune Maintenance Window no Guia do usuário do Amazon Neptune.

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

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

• PreSignedUrl (na CLI: --pre-signed-url): uma string, do tipo: string (uma string codificada em UTF-8).

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

• ReplicationSourceIdentifier (na CLI: --replication-source-identifier): uma string, do tipo: string (uma string codificada em UTF-8).

  O nome de recurso da Amazon (ARN) da instância ou do cluster de banco de dados de origem, se esse cluster de banco de dados for criado como uma réplica de leitura.

• ServerlessV2ScalingConfiguration (na CLI: --serverless-v2-scaling-configuration): um objeto ServerlessV2ScalingConfiguration.

  Contém a configuração de escalabilidade de um cluster de banco de dados do Neptune Serverless.

  Para obter mais informações, consulte Using Amazon Neptune Serverless no Guia do usuário do Amazon Neptune.

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

  Especifica se o cluster de banco de dados é criptografado.

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

  O tipo de armazenamento do novo cluster de banco de dados.

  Valores válidos:

  • standard: ( o padrão ). Configura o armazenamento econômico do banco de dados para aplicações com uso moderado a pequeno de E/S. Quando definido como standard, o tipo de armazenamento não é retornado na resposta.

  • iopt1: habilita o armazenamento otimizado para E/S desenvolvido para atender às necessidades de workloads de grafos de uso intenso de E/S que exigem preços previsíveis com baixa latência de E/S e throughput de E/S consistente.

    O armazenamento otimizado para E/S do Neptune só está disponível a partir da versão 1.3.0.0 do mecanismo.

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

  As tags a serem atribuídas ao novo cluster 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 serem associados a esse cluster de banco de dados.

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

  AllocatedStorage sempre retorna 1, pois o tamanho de armazenamento de cluster de banco de dados do Neptune não é fixo, mas se ajusta automaticamente conforme necessário.

• AssociatedRoles – Uma matriz de objetos DBClusterRole.

  Fornece uma lista dos perfis do Amazon Identity and Access Management (IAM) que estão associadas ao cluster de banco de dados. Os perfis do IAM associados a uma permissão de concessão do cluster de banco de dados para o cluster de banco de dados para acessar outros serviços da Amazon em seu nome.

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

  Hora em que o cluster de banco de dados será reiniciado automaticamente.

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

  Fornece a lista de zonas de disponibilidade do EC2 nas quais as instâncias no cluster de banco de dados podem ser criadas.

• BacktrackConsumedChangeRecords: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BacktrackWindow: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BackupRetentionPeriod: um IntegerOptional, 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.

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

  Não compatível com o Neptune.

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

  Identifica o grupo de clones ao qual o cluster do banco de dados está associado.

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

  Especifica a hora em que o cluster de banco de dados foi criado, no Tempo Universal Coordenado (UTC).

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

  Se definido como true, as tags serão copiadas em qualquer snapshot do cluster de banco de dados criado.

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

  Se definido como true, o cluster de banco de dados poderá ser clonado em várias contas.

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

  Contém o nome do banco de dados inicial desse cluster de banco de dados que foi fornecido no momento da criação, caso tenha sido especificado quando o cluster de banco de dados foi criado. Esse mesmo nome é retornado durante toda a duração do cluster de banco de dados.

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

  O nome de recurso da Amazon (ARN) do cluster de banco de dados.

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

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

• DBClusterMembers – Uma matriz de objetos DBClusterMember.

  Fornece a lista de instâncias que compõem o cluster de banco de dados.

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

  Especifica o nome do grupo de parâmetros de cluster de banco de dados para o cluster de banco de dados.

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

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

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

  Especifica informações sobre o grupo de sub-redes associado ao cluster 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 o cluster de banco de dados tem a proteção contra exclusão ativada ou não. O banco de dados não pode ser excluído quando a proteção contra exclusão está habilitada.

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

  Não compatível com o Neptune.

• EarliestRestorableTime: 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 antiga para a qual um banco de dados pode ser restaurado com restauração point-in-time.

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

  Uma lista de tipos de logs que esse cluster de banco de dados está configurado para exportar para o CloudWatch Logs. Os tipos de log válidos são: audit (para publicar logs de auditoria no CloudWatch) e slowquery (para publicar logs de consulta lenta no CloudWatch). Consulte Publicar logs do Neptune no Amazon CloudWatch Logs.

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

  Especifica o endpoint de conexão para a instância principal do cluster de banco de dados.

• 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 esse cluster 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.

• GlobalClusterIdentifier: um GlobalClusterIdentifier, do tipo: string (uma string codificada em UTF-8), no mínimo 1 e no máximo 255 ?st?s, correspondendo a esta expressão regular: [A-Za-z][0-9A-Za-z-:._]*.

  Contém um identificador de cluster de banco de dados global fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um banco de dados global.

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

  Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.

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

  True se o mapeamento de contas do Amazon Identity and Access Management (IAM) para contas de banco de dados estiver habilitado. Caso contrário, false.

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

  Na próxima vez que for possível modificar o cluster de banco de dados para usar o tipo de armazenamento iopt1.

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

  Se StorageEncrypted for true, o identificador da chave Amazon KMS para o cluster de banco de dados criptografado.

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

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

  Especifica se o cluster de banco de dados tem instâncias em várias zonas de disponibilidade.

• PendingModifiedValues: um objeto ClusterPendingModifiedValues.

  Esse tipo de dados é usado como um elemento de resposta na operação ModifyDBCluster e contém alterações que serão aplicadas durante a próxima janela de manutenção.

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

  Especifica o andamento da operação como uma porcentagem.

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

  Especifica a porta onde o mecanismo de banco de dados está realizando a recepção.

• 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).

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

  O endpoint do leitor do cluster de banco de dados. O endpoint do leitor para uma carga do cluster de banco de dados equilibra as conexões entre as réplicas de leitura que estão disponíveis em um cluster de banco de dados. À medida que os clientes solicitam novas conexões ao endpoint do leitor, o Neptune distribui as solicitações de conexão entre as réplicas de leitura no cluster de banco de dados. Essa funcionalidade pode ajudar a equilibrar sua carga de trabalho de leitura entre várias réplicas de leitura em seu cluster de banco de dados.

  Se ocorrer um failover e a réplica de leitura à qual você estiver conectado for promovida à instância principal, sua conexão será interrompida. Para continuar a enviar sua carga de trabalho de leitura a outras réplicas de leitura no cluster, reconecte-se ao endpoint do leitor.

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

  Contém um ou mais identificadores das réplicas de leitura associadas a esse cluster de banco de dados.

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

  Não compatível com o Neptune.

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

  Não compatível com o Neptune.

• ServerlessV2ScalingConfiguration: um objeto ServerlessV2ScalingConfigurationInfo.

  Mostra a configuração de escalabilidade de um cluster de banco de dados do Neptune Serverless.

  Para obter mais informações, consulte Using Amazon Neptune Serverless no Guia do usuário do Amazon Neptune.

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

  Especifica o estado atual desse cluster de banco de dados.

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

  Especifica se o cluster de banco de dados é criptografado.

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

  O tipo de armazenamento usado pelo cluster de banco de dados.

  Valores válidos:

  • standard: ( o padrão ). Fornece armazenamento econômico do banco de dados para aplicações com uso moderado a pequeno de E/S.

  • iopt1: habilita o armazenamento otimizado para E/S desenvolvido para atender às necessidades de workloads de grafos de uso intenso de E/S que exigem preços previsíveis com baixa latência de E/S e throughput de E/S consistente.

    O armazenamento otimizado para E/S do Neptune só está disponível a partir da versão 1.3.0.0 do mecanismo.

• VpcSecurityGroups – Uma matriz de objetos VpcSecurityGroupMembership.

  Fornece uma lista de grupos de segurança da VPC à qual o cluster de banco de dados pertence.

Erros

• DBClusterAlreadyExistsFault

• InsufficientStorageClusterCapacityFault

• DBClusterQuotaExceededFault

• StorageQuotaExceededFault

• DBSubnetGroupNotFoundFault

• InvalidVPCNetworkStateFault

• InvalidDBClusterStateFault

• InvalidDBSubnetGroupStateFault

• InvalidSubnet

• InvalidDBInstanceStateFault

• DBClusterParameterGroupNotFoundFault

• KMSKeyNotAccessibleFault

• DBClusterNotFoundFault

• DBInstanceNotFoundFault

• DBSubnetGroupDoesNotCoverEnoughAZs

• GlobalClusterNotFoundFault

• InvalidGlobalClusterStateFault

• 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 a ser excluído. Este parâmetro não diferencia maiúsculas de minúsculas.

  Restrições:

  • Deve ser um DBClusterIdentifier existente.

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

  O identificador do novo snapshot de cluster de banco de dados criado quando SkipFinalSnapshot é definido como false.

  nota

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

  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

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

  Determina se um snapshot de cluster de banco de dados foi criado antes de o cluster de banco de dados ser excluído. Se true for especificado, nenhum snapshot de cluster de banco de dados será criado. Se false for especificado, um snapshot de cluster de banco de dados será criado antes de o cluster de banco de dados ser excluído.

  nota

  Você deverá especificar um parâmetro FinalDBSnapshotIdentifier se SkipFinalSnapshot for false.

  Padrão: false

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

  AllocatedStorage sempre retorna 1, pois o tamanho de armazenamento de cluster de banco de dados do Neptune não é fixo, mas se ajusta automaticamente conforme necessário.

• AssociatedRoles – Uma matriz de objetos DBClusterRole.

  Fornece uma lista dos perfis do Amazon Identity and Access Management (IAM) que estão associadas ao cluster de banco de dados. Os perfis do IAM associados a uma permissão de concessão do cluster de banco de dados para o cluster de banco de dados para acessar outros serviços da Amazon em seu nome.

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

  Hora em que o cluster de banco de dados será reiniciado automaticamente.

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

  Fornece a lista de zonas de disponibilidade do EC2 nas quais as instâncias no cluster de banco de dados podem ser criadas.

• BacktrackConsumedChangeRecords: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BacktrackWindow: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BackupRetentionPeriod: um IntegerOptional, 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.

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

  Não compatível com o Neptune.

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

  Identifica o grupo de clones ao qual o cluster do banco de dados está associado.

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

  Especifica a hora em que o cluster de banco de dados foi criado, no Tempo Universal Coordenado (UTC).

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

  Se definido como true, as tags serão copiadas em qualquer snapshot do cluster de banco de dados criado.

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

  Se definido como true, o cluster de banco de dados poderá ser clonado em várias contas.

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

  Contém o nome do banco de dados inicial desse cluster de banco de dados que foi fornecido no momento da criação, caso tenha sido especificado quando o cluster de banco de dados foi criado. Esse mesmo nome é retornado durante toda a duração do cluster de banco de dados.

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

  O nome de recurso da Amazon (ARN) do cluster de banco de dados.

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

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

• DBClusterMembers – Uma matriz de objetos DBClusterMember.

  Fornece a lista de instâncias que compõem o cluster de banco de dados.

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

  Especifica o nome do grupo de parâmetros de cluster de banco de dados para o cluster de banco de dados.

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

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

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

  Especifica informações sobre o grupo de sub-redes associado ao cluster 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 o cluster de banco de dados tem a proteção contra exclusão ativada ou não. O banco de dados não pode ser excluído quando a proteção contra exclusão está habilitada.

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

  Não compatível com o Neptune.

• EarliestRestorableTime: 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 antiga para a qual um banco de dados pode ser restaurado com restauração point-in-time.

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

  Uma lista de tipos de logs que esse cluster de banco de dados está configurado para exportar para o CloudWatch Logs. Os tipos de log válidos são: audit (para publicar logs de auditoria no CloudWatch) e slowquery (para publicar logs de consulta lenta no CloudWatch). Consulte Publicar logs do Neptune no Amazon CloudWatch Logs.

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

  Especifica o endpoint de conexão para a instância principal do cluster de banco de dados.

• 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 esse cluster 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.

• GlobalClusterIdentifier: um GlobalClusterIdentifier, do tipo: string (uma string codificada em UTF-8), no mínimo 1 e no máximo 255 ?st?s, correspondendo a esta expressão regular: [A-Za-z][0-9A-Za-z-:._]*.

  Contém um identificador de cluster de banco de dados global fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um banco de dados global.

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

  Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.

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

  True se o mapeamento de contas do Amazon Identity and Access Management (IAM) para contas de banco de dados estiver habilitado. Caso contrário, false.

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

  Na próxima vez que for possível modificar o cluster de banco de dados para usar o tipo de armazenamento iopt1.

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

  Se StorageEncrypted for true, o identificador da chave Amazon KMS para o cluster de banco de dados criptografado.

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

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

  Especifica se o cluster de banco de dados tem instâncias em várias zonas de disponibilidade.

• PendingModifiedValues: um objeto ClusterPendingModifiedValues.

  Esse tipo de dados é usado como um elemento de resposta na operação ModifyDBCluster e contém alterações que serão aplicadas durante a próxima janela de manutenção.

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

  Especifica o andamento da operação como uma porcentagem.

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

  Especifica a porta onde o mecanismo de banco de dados está realizando a recepção.

• 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).

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

  O endpoint do leitor do cluster de banco de dados. O endpoint do leitor para uma carga do cluster de banco de dados equilibra as conexões entre as réplicas de leitura que estão disponíveis em um cluster de banco de dados. À medida que os clientes solicitam novas conexões ao endpoint do leitor, o Neptune distribui as solicitações de conexão entre as réplicas de leitura no cluster de banco de dados. Essa funcionalidade pode ajudar a equilibrar sua carga de trabalho de leitura entre várias réplicas de leitura em seu cluster de banco de dados.

  Se ocorrer um failover e a réplica de leitura à qual você estiver conectado for promovida à instância principal, sua conexão será interrompida. Para continuar a enviar sua carga de trabalho de leitura a outras réplicas de leitura no cluster, reconecte-se ao endpoint do leitor.

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

  Contém um ou mais identificadores das réplicas de leitura associadas a esse cluster de banco de dados.

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

  Não compatível com o Neptune.

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

  Não compatível com o Neptune.

• ServerlessV2ScalingConfiguration: um objeto ServerlessV2ScalingConfigurationInfo.

  Mostra a configuração de escalabilidade de um cluster de banco de dados do Neptune Serverless.

  Para obter mais informações, consulte Using Amazon Neptune Serverless no Guia do usuário do Amazon Neptune.

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

  Especifica o estado atual desse cluster de banco de dados.

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

  Especifica se o cluster de banco de dados é criptografado.

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

  O tipo de armazenamento usado pelo cluster de banco de dados.

  Valores válidos:

  • standard: ( o padrão ). Fornece armazenamento econômico do banco de dados para aplicações com uso moderado a pequeno de E/S.

  • iopt1: habilita o armazenamento otimizado para E/S desenvolvido para atender às necessidades de workloads de grafos de uso intenso de E/S que exigem preços previsíveis com baixa latência de E/S e throughput de E/S consistente.

    O armazenamento otimizado para E/S do Neptune só está disponível a partir da versão 1.3.0.0 do mecanismo.

• VpcSecurityGroups – Uma matriz de objetos VpcSecurityGroupMembership.

  Fornece uma lista de grupos de segurança da VPC à qual o cluster de banco de dados pertence.

Erros

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

• DBClusterSnapshotAlreadyExistsFault

• SnapshotQuotaExceededFault

• InvalidDBClusterSnapshotStateFault

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

  Um valor que indica se as atualizações de outras versões principais são permitidas.

  Restrições: é necessário definir o sinalizador allow-major-version-upgrade ao fornecer um parâmetro EngineVersion que use uma versão principal diferente da versão atual do cluster de banco de dados.

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

  Um valor que especifica se as modificações feitas nesta solicitação e todas as modificações pendentes serão aplicadas de maneira assíncrona assim que possível, independentemente da configuração PreferredMaintenanceWindow do cluster de banco de dados. Caso esse parâmetro seja definido como false, as alterações feitas no cluster de banco de dados serão aplicadas durante a próxima janela de manutenção.

  O parâmetro ApplyImmediately afeta apenas os valores NewDBClusterIdentifier. Se você definir o valor do parâmetro ApplyImmediately como falso e, depois, alterar para NewDBClusterIdentifier, os valores serão aplicados durante a próxima janela de manutenção. Todas as demais alterações serão aplicadas de imediato, independentemente do valor do parâmetro ApplyImmediately.

  Padrão: false

• 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. Você deve especificar o valor mínimo de 1.

  Padrão: 1

  Restrições:

  • Deve ser um valor de 1 a 35

• 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 de banco de dados. Consulte Usar a CLI para publicar logs de auditoria do Neptune no CloudWatch Logs.

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

  Se definido como true, as tags serão copiadas em qualquer snapshot do cluster de banco de dados criado.

• 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 que está sendo modificado. Esse parâmetro não diferencia maiúsculas de minúsculas.

  Restrições:

  • Deve ser o identificador de um DBCluster existente.

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

  O nome do grupo de parâmetros do cluster de banco de dados a ser usado no cluster de banco de dados.

• DBInstanceParameterGroupName (na CLI: --db-instance-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 a todas as instâncias do cluster de banco de dados.

  nota

  Quando você aplica um grupo de parâmetros usando DBInstanceParameterGroupName, as alterações de parâmetros são aplicadas imediatamente, não durante a próxima janela de manutenção.

  Padrão: a configuração de nome existente

  Restrições:

  • O grupo de parâmetros de banco de dados deve estar na mesma família de grupos de parâmetros de banco de dados que a versão de cluster de banco de dados de destino.

  • O parâmetro DBInstanceParameterGroupName só é válido em combinação com o parâmetro AllowMajorVersionUpgrade.

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

  Um valor que indica se o cluster 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.

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

  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 o qual você deseja atualizar. Alterar esse parâmetro resulta em uma interrupção. A alteração será aplicada durante a próxima janela de manutenção, a menos que o parâmetro ApplyImmediately seja definido como true.

  Para obter uma lista de versões válidas do mecanismo, consulte Versões do mecanismo do Amazon Neptune ou chame DescribeDBEngineVersions (ação).

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

  O novo identificador do cluster de banco de dados durante a renomeação de um cluster de banco de dados. 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: my-cluster2

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

  O número da porta na qual o cluster do DB aceita conexões.

  Restrições: o valor deve ser 1150-65535

  Padrão: a mesma porta que a do cluster de banco de dados original.

• 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 serão criados se eles forem habilitados com o parâmetro BackupRetentionPeriod.

  O padrão é uma janela de trinta minutos selecionada aleatoriamente em um bloco de tempo de oito horas para cada região da Amazon.

  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 intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, 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.

• ServerlessV2ScalingConfiguration (na CLI: --serverless-v2-scaling-configuration): um objeto ServerlessV2ScalingConfiguration.

  Contém a configuração de escalabilidade de um cluster de banco de dados do Neptune Serverless.

  Para obter mais informações, consulte Using Amazon Neptune Serverless no Guia do usuário do Amazon Neptune.

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

  O tipo de armazenamento a ser associado ao cluster de banco de dados.

  Valores válidos:

  • standard: ( o padrão ). Configura o armazenamento econômico do banco de dados para aplicações com uso moderado a pequeno de E/S.

  • iopt1: habilita o armazenamento otimizado para E/S desenvolvido para atender às necessidades de workloads de grafos de uso intenso de E/S que exigem preços previsíveis com baixa latência de E/S e throughput de E/S consistente.

    O armazenamento otimizado para E/S do Neptune só está disponível a partir da versão 1.3.0.0 do mecanismo.

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

  A lista de grupos de segurança da VPC a que o cluster de banco de dados pertencerá.

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

  AllocatedStorage sempre retorna 1, pois o tamanho de armazenamento de cluster de banco de dados do Neptune não é fixo, mas se ajusta automaticamente conforme necessário.

• AssociatedRoles – Uma matriz de objetos DBClusterRole.

  Fornece uma lista dos perfis do Amazon Identity and Access Management (IAM) que estão associadas ao cluster de banco de dados. Os perfis do IAM associados a uma permissão de concessão do cluster de banco de dados para o cluster de banco de dados para acessar outros serviços da Amazon em seu nome.

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

  Hora em que o cluster de banco de dados será reiniciado automaticamente.

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

  Fornece a lista de zonas de disponibilidade do EC2 nas quais as instâncias no cluster de banco de dados podem ser criadas.

• BacktrackConsumedChangeRecords: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BacktrackWindow: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BackupRetentionPeriod: um IntegerOptional, 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.

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

  Não compatível com o Neptune.

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

  Identifica o grupo de clones ao qual o cluster do banco de dados está associado.

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

  Especifica a hora em que o cluster de banco de dados foi criado, no Tempo Universal Coordenado (UTC).

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

  Se definido como true, as tags serão copiadas em qualquer snapshot do cluster de banco de dados criado.

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

  Se definido como true, o cluster de banco de dados poderá ser clonado em várias contas.

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

  Contém o nome do banco de dados inicial desse cluster de banco de dados que foi fornecido no momento da criação, caso tenha sido especificado quando o cluster de banco de dados foi criado. Esse mesmo nome é retornado durante toda a duração do cluster de banco de dados.

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

  O nome de recurso da Amazon (ARN) do cluster de banco de dados.

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

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

• DBClusterMembers – Uma matriz de objetos DBClusterMember.

  Fornece a lista de instâncias que compõem o cluster de banco de dados.

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

  Especifica o nome do grupo de parâmetros de cluster de banco de dados para o cluster de banco de dados.

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

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

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

  Especifica informações sobre o grupo de sub-redes associado ao cluster 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 o cluster de banco de dados tem a proteção contra exclusão ativada ou não. O banco de dados não pode ser excluído quando a proteção contra exclusão está habilitada.

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

  Não compatível com o Neptune.

• EarliestRestorableTime: 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 antiga para a qual um banco de dados pode ser restaurado com restauração point-in-time.

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

  Uma lista de tipos de logs que esse cluster de banco de dados está configurado para exportar para o CloudWatch Logs. Os tipos de log válidos são: audit (para publicar logs de auditoria no CloudWatch) e slowquery (para publicar logs de consulta lenta no CloudWatch). Consulte Publicar logs do Neptune no Amazon CloudWatch Logs.

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

  Especifica o endpoint de conexão para a instância principal do cluster de banco de dados.

• 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 esse cluster 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.

• GlobalClusterIdentifier: um GlobalClusterIdentifier, do tipo: string (uma string codificada em UTF-8), no mínimo 1 e no máximo 255 ?st?s, correspondendo a esta expressão regular: [A-Za-z][0-9A-Za-z-:._]*.

  Contém um identificador de cluster de banco de dados global fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um banco de dados global.

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

  Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.

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

  True se o mapeamento de contas do Amazon Identity and Access Management (IAM) para contas de banco de dados estiver habilitado. Caso contrário, false.

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

  Na próxima vez que for possível modificar o cluster de banco de dados para usar o tipo de armazenamento iopt1.

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

  Se StorageEncrypted for true, o identificador da chave Amazon KMS para o cluster de banco de dados criptografado.

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

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

  Especifica se o cluster de banco de dados tem instâncias em várias zonas de disponibilidade.

• PendingModifiedValues: um objeto ClusterPendingModifiedValues.

  Esse tipo de dados é usado como um elemento de resposta na operação ModifyDBCluster e contém alterações que serão aplicadas durante a próxima janela de manutenção.

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

  Especifica o andamento da operação como uma porcentagem.

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

  Especifica a porta onde o mecanismo de banco de dados está realizando a recepção.

• 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).

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

  O endpoint do leitor do cluster de banco de dados. O endpoint do leitor para uma carga do cluster de banco de dados equilibra as conexões entre as réplicas de leitura que estão disponíveis em um cluster de banco de dados. À medida que os clientes solicitam novas conexões ao endpoint do leitor, o Neptune distribui as solicitações de conexão entre as réplicas de leitura no cluster de banco de dados. Essa funcionalidade pode ajudar a equilibrar sua carga de trabalho de leitura entre várias réplicas de leitura em seu cluster de banco de dados.

  Se ocorrer um failover e a réplica de leitura à qual você estiver conectado for promovida à instância principal, sua conexão será interrompida. Para continuar a enviar sua carga de trabalho de leitura a outras réplicas de leitura no cluster, reconecte-se ao endpoint do leitor.

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

  Contém um ou mais identificadores das réplicas de leitura associadas a esse cluster de banco de dados.

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

  Não compatível com o Neptune.

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

  Não compatível com o Neptune.

• ServerlessV2ScalingConfiguration: um objeto ServerlessV2ScalingConfigurationInfo.

  Mostra a configuração de escalabilidade de um cluster de banco de dados do Neptune Serverless.

  Para obter mais informações, consulte Using Amazon Neptune Serverless no Guia do usuário do Amazon Neptune.

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

  Especifica o estado atual desse cluster de banco de dados.

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

  Especifica se o cluster de banco de dados é criptografado.

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

  O tipo de armazenamento usado pelo cluster de banco de dados.

  Valores válidos:

  • standard: ( o padrão ). Fornece armazenamento econômico do banco de dados para aplicações com uso moderado a pequeno de E/S.

  • iopt1: habilita o armazenamento otimizado para E/S desenvolvido para atender às necessidades de workloads de grafos de uso intenso de E/S que exigem preços previsíveis com baixa latência de E/S e throughput de E/S consistente.

    O armazenamento otimizado para E/S do Neptune só está disponível a partir da versão 1.3.0.0 do mecanismo.

• VpcSecurityGroups – Uma matriz de objetos VpcSecurityGroupMembership.

  Fornece uma lista de grupos de segurança da VPC à qual o cluster de banco de dados pertence.

Erros

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

• StorageQuotaExceededFault

• DBSubnetGroupNotFoundFault

• InvalidVPCNetworkStateFault

• InvalidDBSubnetGroupStateFault

• InvalidSubnet

• DBClusterParameterGroupNotFoundFault

• InvalidDBSecurityGroupStateFault

• InvalidDBInstanceStateFault

• DBClusterAlreadyExistsFault

• StorageTypeNotSupportedFault

• 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 Neptune a ser iniciado. Este parâmetro é armazenado como uma string com letras minúsculas.

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

  AllocatedStorage sempre retorna 1, pois o tamanho de armazenamento de cluster de banco de dados do Neptune não é fixo, mas se ajusta automaticamente conforme necessário.

• AssociatedRoles – Uma matriz de objetos DBClusterRole.

  Fornece uma lista dos perfis do Amazon Identity and Access Management (IAM) que estão associadas ao cluster de banco de dados. Os perfis do IAM associados a uma permissão de concessão do cluster de banco de dados para o cluster de banco de dados para acessar outros serviços da Amazon em seu nome.

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

  Hora em que o cluster de banco de dados será reiniciado automaticamente.

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

  Fornece a lista de zonas de disponibilidade do EC2 nas quais as instâncias no cluster de banco de dados podem ser criadas.

• BacktrackConsumedChangeRecords: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BacktrackWindow: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BackupRetentionPeriod: um IntegerOptional, 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.

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

  Não compatível com o Neptune.

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

  Identifica o grupo de clones ao qual o cluster do banco de dados está associado.

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

  Especifica a hora em que o cluster de banco de dados foi criado, no Tempo Universal Coordenado (UTC).

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

  Se definido como true, as tags serão copiadas em qualquer snapshot do cluster de banco de dados criado.

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

  Se definido como true, o cluster de banco de dados poderá ser clonado em várias contas.

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

  Contém o nome do banco de dados inicial desse cluster de banco de dados que foi fornecido no momento da criação, caso tenha sido especificado quando o cluster de banco de dados foi criado. Esse mesmo nome é retornado durante toda a duração do cluster de banco de dados.

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

  O nome de recurso da Amazon (ARN) do cluster de banco de dados.

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

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

• DBClusterMembers – Uma matriz de objetos DBClusterMember.

  Fornece a lista de instâncias que compõem o cluster de banco de dados.

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

  Especifica o nome do grupo de parâmetros de cluster de banco de dados para o cluster de banco de dados.

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

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

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

  Especifica informações sobre o grupo de sub-redes associado ao cluster 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 o cluster de banco de dados tem a proteção contra exclusão ativada ou não. O banco de dados não pode ser excluído quando a proteção contra exclusão está habilitada.

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

  Não compatível com o Neptune.

• EarliestRestorableTime: 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 antiga para a qual um banco de dados pode ser restaurado com restauração point-in-time.

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

  Uma lista de tipos de logs que esse cluster de banco de dados está configurado para exportar para o CloudWatch Logs. Os tipos de log válidos são: audit (para publicar logs de auditoria no CloudWatch) e slowquery (para publicar logs de consulta lenta no CloudWatch). Consulte Publicar logs do Neptune no Amazon CloudWatch Logs.

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

  Especifica o endpoint de conexão para a instância principal do cluster de banco de dados.

• 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 esse cluster 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.

• GlobalClusterIdentifier: um GlobalClusterIdentifier, do tipo: string (uma string codificada em UTF-8), no mínimo 1 e no máximo 255 ?st?s, correspondendo a esta expressão regular: [A-Za-z][0-9A-Za-z-:._]*.

  Contém um identificador de cluster de banco de dados global fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um banco de dados global.

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

  Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.

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

  True se o mapeamento de contas do Amazon Identity and Access Management (IAM) para contas de banco de dados estiver habilitado. Caso contrário, false.

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

  Na próxima vez que for possível modificar o cluster de banco de dados para usar o tipo de armazenamento iopt1.

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

  Se StorageEncrypted for true, o identificador da chave Amazon KMS para o cluster de banco de dados criptografado.

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

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

  Especifica se o cluster de banco de dados tem instâncias em várias zonas de disponibilidade.

• PendingModifiedValues: um objeto ClusterPendingModifiedValues.

  Esse tipo de dados é usado como um elemento de resposta na operação ModifyDBCluster e contém alterações que serão aplicadas durante a próxima janela de manutenção.

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

  Especifica o andamento da operação como uma porcentagem.

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

  Especifica a porta onde o mecanismo de banco de dados está realizando a recepção.

• 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).

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

  O endpoint do leitor do cluster de banco de dados. O endpoint do leitor para uma carga do cluster de banco de dados equilibra as conexões entre as réplicas de leitura que estão disponíveis em um cluster de banco de dados. À medida que os clientes solicitam novas conexões ao endpoint do leitor, o Neptune distribui as solicitações de conexão entre as réplicas de leitura no cluster de banco de dados. Essa funcionalidade pode ajudar a equilibrar sua carga de trabalho de leitura entre várias réplicas de leitura em seu cluster de banco de dados.

  Se ocorrer um failover e a réplica de leitura à qual você estiver conectado for promovida à instância principal, sua conexão será interrompida. Para continuar a enviar sua carga de trabalho de leitura a outras réplicas de leitura no cluster, reconecte-se ao endpoint do leitor.

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

  Contém um ou mais identificadores das réplicas de leitura associadas a esse cluster de banco de dados.

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

  Não compatível com o Neptune.

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

  Não compatível com o Neptune.

• ServerlessV2ScalingConfiguration: um objeto ServerlessV2ScalingConfigurationInfo.

  Mostra a configuração de escalabilidade de um cluster de banco de dados do Neptune Serverless.

  Para obter mais informações, consulte Using Amazon Neptune Serverless no Guia do usuário do Amazon Neptune.

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

  Especifica o estado atual desse cluster de banco de dados.

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

  Especifica se o cluster de banco de dados é criptografado.

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

  O tipo de armazenamento usado pelo cluster de banco de dados.

  Valores válidos:

  • standard: ( o padrão ). Fornece armazenamento econômico do banco de dados para aplicações com uso moderado a pequeno de E/S.

  • iopt1: habilita o armazenamento otimizado para E/S desenvolvido para atender às necessidades de workloads de grafos de uso intenso de E/S que exigem preços previsíveis com baixa latência de E/S e throughput de E/S consistente.

    O armazenamento otimizado para E/S do Neptune só está disponível a partir da versão 1.3.0.0 do mecanismo.

• VpcSecurityGroups – Uma matriz de objetos VpcSecurityGroupMembership.

  Fornece uma lista de grupos de segurança da VPC à qual o cluster de banco de dados pertence.

Erros

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

• InvalidDBInstanceStateFault

• 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 Neptune a ser interrompido. Este parâmetro é armazenado como uma string com letras minúsculas.

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

  AllocatedStorage sempre retorna 1, pois o tamanho de armazenamento de cluster de banco de dados do Neptune não é fixo, mas se ajusta automaticamente conforme necessário.

• AssociatedRoles – Uma matriz de objetos DBClusterRole.

  Fornece uma lista dos perfis do Amazon Identity and Access Management (IAM) que estão associadas ao cluster de banco de dados. Os perfis do IAM associados a uma permissão de concessão do cluster de banco de dados para o cluster de banco de dados para acessar outros serviços da Amazon em seu nome.

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

  Hora em que o cluster de banco de dados será reiniciado automaticamente.

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

  Fornece a lista de zonas de disponibilidade do EC2 nas quais as instâncias no cluster de banco de dados podem ser criadas.

• BacktrackConsumedChangeRecords: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BacktrackWindow: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BackupRetentionPeriod: um IntegerOptional, 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.

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

  Não compatível com o Neptune.

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

  Identifica o grupo de clones ao qual o cluster do banco de dados está associado.

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

  Especifica a hora em que o cluster de banco de dados foi criado, no Tempo Universal Coordenado (UTC).

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

  Se definido como true, as tags serão copiadas em qualquer snapshot do cluster de banco de dados criado.

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

  Se definido como true, o cluster de banco de dados poderá ser clonado em várias contas.

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

  Contém o nome do banco de dados inicial desse cluster de banco de dados que foi fornecido no momento da criação, caso tenha sido especificado quando o cluster de banco de dados foi criado. Esse mesmo nome é retornado durante toda a duração do cluster de banco de dados.

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

  O nome de recurso da Amazon (ARN) do cluster de banco de dados.

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

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

• DBClusterMembers – Uma matriz de objetos DBClusterMember.

  Fornece a lista de instâncias que compõem o cluster de banco de dados.

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

  Especifica o nome do grupo de parâmetros de cluster de banco de dados para o cluster de banco de dados.

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

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

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

  Especifica informações sobre o grupo de sub-redes associado ao cluster 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 o cluster de banco de dados tem a proteção contra exclusão ativada ou não. O banco de dados não pode ser excluído quando a proteção contra exclusão está habilitada.

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

  Não compatível com o Neptune.

• EarliestRestorableTime: 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 antiga para a qual um banco de dados pode ser restaurado com restauração point-in-time.

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

  Uma lista de tipos de logs que esse cluster de banco de dados está configurado para exportar para o CloudWatch Logs. Os tipos de log válidos são: audit (para publicar logs de auditoria no CloudWatch) e slowquery (para publicar logs de consulta lenta no CloudWatch). Consulte Publicar logs do Neptune no Amazon CloudWatch Logs.

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

  Especifica o endpoint de conexão para a instância principal do cluster de banco de dados.

• 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 esse cluster 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.

• GlobalClusterIdentifier: um GlobalClusterIdentifier, do tipo: string (uma string codificada em UTF-8), no mínimo 1 e no máximo 255 ?st?s, correspondendo a esta expressão regular: [A-Za-z][0-9A-Za-z-:._]*.

  Contém um identificador de cluster de banco de dados global fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um banco de dados global.

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

  Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.

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

  True se o mapeamento de contas do Amazon Identity and Access Management (IAM) para contas de banco de dados estiver habilitado. Caso contrário, false.

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

  Na próxima vez que for possível modificar o cluster de banco de dados para usar o tipo de armazenamento iopt1.

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

  Se StorageEncrypted for true, o identificador da chave Amazon KMS para o cluster de banco de dados criptografado.

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

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

  Especifica se o cluster de banco de dados tem instâncias em várias zonas de disponibilidade.

• PendingModifiedValues: um objeto ClusterPendingModifiedValues.

  Esse tipo de dados é usado como um elemento de resposta na operação ModifyDBCluster e contém alterações que serão aplicadas durante a próxima janela de manutenção.

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

  Especifica o andamento da operação como uma porcentagem.

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

  Especifica a porta onde o mecanismo de banco de dados está realizando a recepção.

• 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).

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

  O endpoint do leitor do cluster de banco de dados. O endpoint do leitor para uma carga do cluster de banco de dados equilibra as conexões entre as réplicas de leitura que estão disponíveis em um cluster de banco de dados. À medida que os clientes solicitam novas conexões ao endpoint do leitor, o Neptune distribui as solicitações de conexão entre as réplicas de leitura no cluster de banco de dados. Essa funcionalidade pode ajudar a equilibrar sua carga de trabalho de leitura entre várias réplicas de leitura em seu cluster de banco de dados.

  Se ocorrer um failover e a réplica de leitura à qual você estiver conectado for promovida à instância principal, sua conexão será interrompida. Para continuar a enviar sua carga de trabalho de leitura a outras réplicas de leitura no cluster, reconecte-se ao endpoint do leitor.

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

  Contém um ou mais identificadores das réplicas de leitura associadas a esse cluster de banco de dados.

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

  Não compatível com o Neptune.

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

  Não compatível com o Neptune.

• ServerlessV2ScalingConfiguration: um objeto ServerlessV2ScalingConfigurationInfo.

  Mostra a configuração de escalabilidade de um cluster de banco de dados do Neptune Serverless.

  Para obter mais informações, consulte Using Amazon Neptune Serverless no Guia do usuário do Amazon Neptune.

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

  Especifica o estado atual desse cluster de banco de dados.

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

  Especifica se o cluster de banco de dados é criptografado.

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

  O tipo de armazenamento usado pelo cluster de banco de dados.

  Valores válidos:

  • standard: ( o padrão ). Fornece armazenamento econômico do banco de dados para aplicações com uso moderado a pequeno de E/S.

  • iopt1: habilita o armazenamento otimizado para E/S desenvolvido para atender às necessidades de workloads de grafos de uso intenso de E/S que exigem preços previsíveis com baixa latência de E/S e throughput de E/S consistente.

    O armazenamento otimizado para E/S do Neptune só está disponível a partir da versão 1.3.0.0 do mecanismo.

• VpcSecurityGroups – Uma matriz de objetos VpcSecurityGroupMembership.

  Fornece uma lista de grupos de segurança da VPC à qual o cluster de banco de dados pertence.

Erros

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

• InvalidDBInstanceStateFault

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

  O nome do cluster de banco de dados a ser associado à função do IAM.

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

  O nome do atributo do cluster de banco de dados do Neptune ao qual o perfil do IAM deve ser associado. Para obter a lista de nomes de recursos compatíveis, consulte DBEngineVersion (estrutura).

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

  O nome de recurso da Amazon (ARN) da função do IAM a ser associada ao cluster de banco de dados do Neptune, por exemplo, arn:aws:iam::123456789012:role/NeptuneAccessRole.

Resposta

• Nenhum parâmetro de resposta.

Erros

• DBClusterNotFoundFault

• DBClusterRoleAlreadyExistsFault

• InvalidDBClusterStateFault

• DBClusterRoleQuotaExceededFault

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

  O nome do cluster de banco de dados a ser desassociado da função do IAM.

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

  O nome do atributo do cluster de banco de dados do qual o perfil do IAM deve ser dissociado. Para obter a lista de nomes de recursos compatíveis, consulte DescribeDBEngineVersions (ação).

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

  O nome de recurso da Amazon (ARN) da função do IAM a ser desassociada do cluster de banco de dados, por exemplo, arn:aws:iam::123456789012:role/NeptuneAccessRole.

Resposta

• Nenhum parâmetro de resposta.

Erros

• DBClusterNotFoundFault

• DBClusterRoleNotFoundFault

• InvalidDBClusterStateFault

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

  Um identificador de cluster de banco de dados para o qual forçar um failover. Esse parâmetro não diferencia maiúsculas de minúsculas.

  Restrições:

  • Deve ser o identificador de um DBCluster existente.

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

  O nome da instância a ser promovida a instância principal.

  Você deve especificar o identificador da instância para uma réplica de leitura no cluster de banco de dados. Por exemplo, mydbcluster-replica1.

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

  AllocatedStorage sempre retorna 1, pois o tamanho de armazenamento de cluster de banco de dados do Neptune não é fixo, mas se ajusta automaticamente conforme necessário.

• AssociatedRoles – Uma matriz de objetos DBClusterRole.

  Fornece uma lista dos perfis do Amazon Identity and Access Management (IAM) que estão associadas ao cluster de banco de dados. Os perfis do IAM associados a uma permissão de concessão do cluster de banco de dados para o cluster de banco de dados para acessar outros serviços da Amazon em seu nome.

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

  Hora em que o cluster de banco de dados será reiniciado automaticamente.

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

  Fornece a lista de zonas de disponibilidade do EC2 nas quais as instâncias no cluster de banco de dados podem ser criadas.

• BacktrackConsumedChangeRecords: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BacktrackWindow: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BackupRetentionPeriod: um IntegerOptional, 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.

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

  Não compatível com o Neptune.

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

  Identifica o grupo de clones ao qual o cluster do banco de dados está associado.

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

  Especifica a hora em que o cluster de banco de dados foi criado, no Tempo Universal Coordenado (UTC).

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

  Se definido como true, as tags serão copiadas em qualquer snapshot do cluster de banco de dados criado.

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

  Se definido como true, o cluster de banco de dados poderá ser clonado em várias contas.

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

  Contém o nome do banco de dados inicial desse cluster de banco de dados que foi fornecido no momento da criação, caso tenha sido especificado quando o cluster de banco de dados foi criado. Esse mesmo nome é retornado durante toda a duração do cluster de banco de dados.

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

  O nome de recurso da Amazon (ARN) do cluster de banco de dados.

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

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

• DBClusterMembers – Uma matriz de objetos DBClusterMember.

  Fornece a lista de instâncias que compõem o cluster de banco de dados.

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

  Especifica o nome do grupo de parâmetros de cluster de banco de dados para o cluster de banco de dados.

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

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

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

  Especifica informações sobre o grupo de sub-redes associado ao cluster 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 o cluster de banco de dados tem a proteção contra exclusão ativada ou não. O banco de dados não pode ser excluído quando a proteção contra exclusão está habilitada.

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

  Não compatível com o Neptune.

• EarliestRestorableTime: 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 antiga para a qual um banco de dados pode ser restaurado com restauração point-in-time.

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

  Uma lista de tipos de logs que esse cluster de banco de dados está configurado para exportar para o CloudWatch Logs. Os tipos de log válidos são: audit (para publicar logs de auditoria no CloudWatch) e slowquery (para publicar logs de consulta lenta no CloudWatch). Consulte Publicar logs do Neptune no Amazon CloudWatch Logs.

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

  Especifica o endpoint de conexão para a instância principal do cluster de banco de dados.

• 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 esse cluster 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.

• GlobalClusterIdentifier: um GlobalClusterIdentifier, do tipo: string (uma string codificada em UTF-8), no mínimo 1 e no máximo 255 ?st?s, correspondendo a esta expressão regular: [A-Za-z][0-9A-Za-z-:._]*.

  Contém um identificador de cluster de banco de dados global fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um banco de dados global.

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

  Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.

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

  True se o mapeamento de contas do Amazon Identity and Access Management (IAM) para contas de banco de dados estiver habilitado. Caso contrário, false.

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

  Na próxima vez que for possível modificar o cluster de banco de dados para usar o tipo de armazenamento iopt1.

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

  Se StorageEncrypted for true, o identificador da chave Amazon KMS para o cluster de banco de dados criptografado.

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

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

  Especifica se o cluster de banco de dados tem instâncias em várias zonas de disponibilidade.

• PendingModifiedValues: um objeto ClusterPendingModifiedValues.

  Esse tipo de dados é usado como um elemento de resposta na operação ModifyDBCluster e contém alterações que serão aplicadas durante a próxima janela de manutenção.

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

  Especifica o andamento da operação como uma porcentagem.

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

  Especifica a porta onde o mecanismo de banco de dados está realizando a recepção.

• 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).

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

  O endpoint do leitor do cluster de banco de dados. O endpoint do leitor para uma carga do cluster de banco de dados equilibra as conexões entre as réplicas de leitura que estão disponíveis em um cluster de banco de dados. À medida que os clientes solicitam novas conexões ao endpoint do leitor, o Neptune distribui as solicitações de conexão entre as réplicas de leitura no cluster de banco de dados. Essa funcionalidade pode ajudar a equilibrar sua carga de trabalho de leitura entre várias réplicas de leitura em seu cluster de banco de dados.

  Se ocorrer um failover e a réplica de leitura à qual você estiver conectado for promovida à instância principal, sua conexão será interrompida. Para continuar a enviar sua carga de trabalho de leitura a outras réplicas de leitura no cluster, reconecte-se ao endpoint do leitor.

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

  Contém um ou mais identificadores das réplicas de leitura associadas a esse cluster de banco de dados.

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

  Não compatível com o Neptune.

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

  Não compatível com o Neptune.

• ServerlessV2ScalingConfiguration: um objeto ServerlessV2ScalingConfigurationInfo.

  Mostra a configuração de escalabilidade de um cluster de banco de dados do Neptune Serverless.

  Para obter mais informações, consulte Using Amazon Neptune Serverless no Guia do usuário do Amazon Neptune.

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

  Especifica o estado atual desse cluster de banco de dados.

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

  Especifica se o cluster de banco de dados é criptografado.

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

  O tipo de armazenamento usado pelo cluster de banco de dados.

  Valores válidos:

  • standard: ( o padrão ). Fornece armazenamento econômico do banco de dados para aplicações com uso moderado a pequeno de E/S.

  • iopt1: habilita o armazenamento otimizado para E/S desenvolvido para atender às necessidades de workloads de grafos de uso intenso de E/S que exigem preços previsíveis com baixa latência de E/S e throughput de E/S consistente.

    O armazenamento otimizado para E/S do Neptune só está disponível a partir da versão 1.3.0.0 do mecanismo.

• VpcSecurityGroups – Uma matriz de objetos VpcSecurityGroupMembership.

  Fornece uma lista de grupos de segurança da VPC à qual o cluster de banco de dados pertence.

Erros

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

• InvalidDBInstanceStateFault

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

  Sem suporte.

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

  AllocatedStorage sempre retorna 1, pois o tamanho de armazenamento de cluster de banco de dados do Neptune não é fixo, mas se ajusta automaticamente conforme necessário.

• AssociatedRoles – Uma matriz de objetos DBClusterRole.

  Fornece uma lista dos perfis do Amazon Identity and Access Management (IAM) que estão associadas ao cluster de banco de dados. Os perfis do IAM associados a uma permissão de concessão do cluster de banco de dados para o cluster de banco de dados para acessar outros serviços da Amazon em seu nome.

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

  Hora em que o cluster de banco de dados será reiniciado automaticamente.

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

  Fornece a lista de zonas de disponibilidade do EC2 nas quais as instâncias no cluster de banco de dados podem ser criadas.

• BacktrackConsumedChangeRecords: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BacktrackWindow: um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BackupRetentionPeriod: um IntegerOptional, 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.

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

  Não compatível com o Neptune.

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

  Identifica o grupo de clones ao qual o cluster do banco de dados está associado.

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

  Especifica a hora em que o cluster de banco de dados foi criado, no Tempo Universal Coordenado (UTC).

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

  Se definido como true, as tags serão copiadas em qualquer snapshot do cluster de banco de dados criado.

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

  Se definido como true, o cluster de banco de dados poderá ser clonado em várias contas.

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

  Contém o nome do banco de dados inicial desse cluster de banco de dados que foi fornecido no momento da criação, caso tenha sido especificado quando o cluster de banco de dados foi criado. Esse mesmo nome é retornado durante toda a duração do cluster de banco de dados.

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

  O nome de recurso da Amazon (ARN) do cluster de banco de dados.

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

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

• DBClusterMembers – Uma matriz de objetos DBClusterMember.

  Fornece a lista de instâncias que compõem o cluster de banco de dados.

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

  Especifica o nome do grupo de parâmetros de cluster de banco de dados para o cluster de banco de dados.

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

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

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

  Especifica informações sobre o grupo de sub-redes associado ao cluster 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 o cluster de banco de dados tem a proteção contra exclusão ativada ou não. O banco de dados não pode ser excluído quando a proteção contra exclusão está habilitada.

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

  Não compatível com o Neptune.

• EarliestRestorableTime: 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 antiga para a qual um banco de dados pode ser restaurado com restauração point-in-time.

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

  Uma lista de tipos de logs que esse cluster de banco de dados está configurado para exportar para o CloudWatch Logs. Os tipos de log válidos são: audit (para publicar logs de auditoria no CloudWatch) e slowquery (para publicar logs de consulta lenta no CloudWatch). Consulte Publicar logs do Neptune no Amazon CloudWatch Logs.

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

  Especifica o endpoint de conexão para a instância principal do cluster de banco de dados.

• 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 esse cluster 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.

• GlobalClusterIdentifier: um GlobalClusterIdentifier, do tipo: string (uma string codificada em UTF-8), no mínimo 1 e no máximo 255 ?st?s, correspondendo a esta expressão regular: [A-Za-z][0-9A-Za-z-:._]*.

  Contém um identificador de cluster de banco de dados global fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um banco de dados global.

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

  Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.

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

  True se o mapeamento de contas do Amazon Identity and Access Management (IAM) para contas de banco de dados estiver habilitado. Caso contrário, false.

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

  Na próxima vez que for possível modificar o cluster de banco de dados para usar o tipo de armazenamento iopt1.

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

  Se StorageEncrypted for true, o identificador da chave Amazon KMS para o cluster de banco de dados criptografado.

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

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

  Especifica se o cluster de banco de dados tem instâncias em várias zonas de disponibilidade.

• PendingModifiedValues: um objeto ClusterPendingModifiedValues.

  Esse tipo de dados é usado como um elemento de resposta na operação ModifyDBCluster e contém alterações que serão aplicadas durante a próxima janela de manutenção.

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

  Especifica o andamento da operação como uma porcentagem.

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

  Especifica a porta onde o mecanismo de banco de dados está realizando a recepção.

• 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).

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

  O endpoint do leitor do cluster de banco de dados. O endpoint do leitor para uma carga do cluster de banco de dados equilibra as conexões entre as réplicas de leitura que estão disponíveis em um cluster de banco de dados. À medida que os clientes solicitam novas conexões ao endpoint do leitor, o Neptune distribui as solicitações de conexão entre as réplicas de leitura no cluster de banco de dados. Essa funcionalidade pode ajudar a equilibrar sua carga de trabalho de leitura entre várias réplicas de leitura em seu cluster de banco de dados.

  Se ocorrer um failover e a réplica de leitura à qual você estiver conectado for promovida à instância principal, sua conexão será interrompida. Para continuar a enviar sua carga de trabalho de leitura a outras réplicas de leitura no cluster, reconecte-se ao endpoint do leitor.

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

  Contém um ou mais identificadores das réplicas de leitura associadas a esse cluster de banco de dados.

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

  Não compatível com o Neptune.

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

  Não compatível com o Neptune.

• ServerlessV2ScalingConfiguration: um objeto ServerlessV2ScalingConfigurationInfo.

  Mostra a configuração de escalabilidade de um cluster de banco de dados do Neptune Serverless.

  Para obter mais informações, consulte Using Amazon Neptune Serverless no Guia do usuário do Amazon Neptune.

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

  Especifica o estado atual desse cluster de banco de dados.

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

  Especifica se o cluster de banco de dados é criptografado.

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

  O tipo de armazenamento usado pelo cluster de banco de dados.

  Valores válidos:

  • standard: ( o padrão ). Fornece armazenamento econômico do banco de dados para aplicações com uso moderado a pequeno de E/S.

  • iopt1: habilita o armazenamento otimizado para E/S desenvolvido para atender às necessidades de workloads de grafos de uso intenso de E/S que exigem preços previsíveis com baixa latência de E/S e throughput de E/S consistente.

    O armazenamento otimizado para E/S do Neptune só está disponível a partir da versão 1.3.0.0 do mecanismo.

• VpcSecurityGroups – Uma matriz de objetos VpcSecurityGroupMembership.

  Fornece uma lista de grupos de segurança da VPC à qual o cluster de banco de dados pertence.

Erros

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

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

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

  Restrições:

  • Se fornecido, deverá ser um DBClusterIdentifier existente.

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

  Um filtro que especifica um ou mais clusters de banco de dados a serem descritos.

  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 os clusters de banco de dados identificado por esses ARNs.

  • engine - aceita um nome de mecanismo (como neptune) e restringe a lista de resultados aos clusters de banco de dados criados por esse mecanismo.

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

  aws neptune describe-db-clusters \
              --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 DescribeDBClusters (ação) 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.

• DBClusters – Uma matriz de objetos DBCluster.

  Contém uma lista de clusters de banco de dados para o usuário.

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

  Um token de paginação que pode ser usado em uma solicitação DescribeDBClusters subsequente.

Erros

• DBClusterNotFoundFault

Campos

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

  AllocatedStorage sempre retorna 1, pois o tamanho de armazenamento de cluster de banco de dados do Neptune não é fixo, mas se ajusta automaticamente conforme necessário.

• AssociatedRoles: é uma matriz de objetos DBClusterRole.

  Fornece uma lista dos perfis do Amazon Identity and Access Management (IAM) que estão associadas ao cluster de banco de dados. Os perfis do IAM associados a uma permissão de concessão do cluster de banco de dados para o cluster de banco de dados para acessar outros serviços da Amazon em seu nome.

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

  Hora em que o cluster de banco de dados será reiniciado automaticamente.

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

  Fornece a lista de zonas de disponibilidade do EC2 nas quais as instâncias no cluster de banco de dados podem ser criadas.

• BacktrackConsumedChangeRecords: é um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BacktrackWindow: é um LongOptional, do tipo: long (um valor inteiro assinado de 64 bits).

  Não compatível com o Neptune.

• BackupRetentionPeriod: é um IntegerOptional, 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.

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

  Não compatível com o Neptune.

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

  Identifica o grupo de clones ao qual o cluster do banco de dados está associado.

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

  Especifica a hora em que o cluster de banco de dados foi criado, no Tempo Universal Coordenado (UTC).

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

  Se definido como true, as tags serão copiadas em qualquer snapshot do cluster de banco de dados criado.

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

  Se definido como true, o cluster de banco de dados poderá ser clonado em várias contas.

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

  Contém o nome do banco de dados inicial desse cluster de banco de dados que foi fornecido no momento da criação, caso tenha sido especificado quando o cluster de banco de dados foi criado. Esse mesmo nome é retornado durante toda a duração do cluster de banco de dados.

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

  O nome de recurso da Amazon (ARN) do cluster de banco de dados.

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

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

• DBClusterMembers: é uma matriz de objetos DBClusterMember.

  Fornece a lista de instâncias que compõem o cluster de banco de dados.

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

  Especifica o nome do grupo de parâmetros de cluster de banco de dados para o cluster de banco de dados.

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

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

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

  Especifica informações sobre o grupo de sub-redes associado ao cluster 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 o cluster de banco de dados tem a proteção contra exclusão ativada ou não. O banco de dados não pode ser excluído quando a proteção contra exclusão está habilitada.

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

  Não compatível com o Neptune.

• EarliestRestorableTime: é 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 antiga para a qual um banco de dados pode ser restaurado com restauração point-in-time.

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

  Uma lista de tipos de logs que esse cluster de banco de dados está configurado para exportar para o CloudWatch Logs. Os tipos de log válidos são: audit (para publicar logs de auditoria no CloudWatch) e slowquery (para publicar logs de consulta lenta no CloudWatch). Consulte Publicar logs do Neptune no Amazon CloudWatch Logs.

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

  Especifica o endpoint de conexão para a instância principal do cluster de banco de dados.

• 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 esse cluster 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.

• GlobalClusterIdentifier: é um GlobalClusterIdentifier, do tipo: string (uma string codificada em UTF-8), no mínimo 1 e no máximo 255 ?st?s, correspondendo a esta expressão regular: [A-Za-z][0-9A-Za-z-:._]*.

  Contém um identificador de cluster de banco de dados global fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um banco de dados global.

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

  Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.

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

  True se o mapeamento de contas do Amazon Identity and Access Management (IAM) para contas de banco de dados estiver habilitado. Caso contrário, false.

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

  Na próxima vez que for possível modificar o cluster de banco de dados para usar o tipo de armazenamento iopt1.

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

  Se StorageEncrypted for true, o identificador da chave Amazon KMS para o cluster de banco de dados criptografado.

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

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

  Especifica se o cluster de banco de dados tem instâncias em várias zonas de disponibilidade.

• PendingModifiedValues: é um objeto ClusterPendingModifiedValues.

  Esse tipo de dados é usado como um elemento de resposta na operação ModifyDBCluster e contém alterações que serão aplicadas durante a próxima janela de manutenção.

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

  Especifica o andamento da operação como uma porcentagem.

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

  Especifica a porta onde o mecanismo de banco de dados está realizando a recepção.

• 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).

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

  O endpoint do leitor do cluster de banco de dados. O endpoint do leitor para uma carga do cluster de banco de dados equilibra as conexões entre as réplicas de leitura que estão disponíveis em um cluster de banco de dados. À medida que os clientes solicitam novas conexões ao endpoint do leitor, o Neptune distribui as solicitações de conexão entre as réplicas de leitura no cluster de banco de dados. Essa funcionalidade pode ajudar a equilibrar sua carga de trabalho de leitura entre várias réplicas de leitura em seu cluster de banco de dados.

  Se ocorrer um failover e a réplica de leitura à qual você estiver conectado for promovida à instância principal, sua conexão será interrompida. Para continuar a enviar sua carga de trabalho de leitura a outras réplicas de leitura no cluster, reconecte-se ao endpoint do leitor.

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

  Contém um ou mais identificadores das réplicas de leitura associadas a esse cluster de banco de dados.

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

  Não compatível com o Neptune.

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

  Não compatível com o Neptune.

• ServerlessV2ScalingConfiguration: é um objeto ServerlessV2ScalingConfigurationInfo.

  Mostra a configuração de escalabilidade de um cluster de banco de dados do Neptune Serverless.

  Para obter mais informações, consulte Using Amazon Neptune Serverless no Guia do usuário do Amazon Neptune.

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

  Especifica o estado atual desse cluster de banco de dados.

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

  Especifica se o cluster de banco de dados é criptografado.

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

  O tipo de armazenamento usado pelo cluster de banco de dados.

  Valores válidos:

  • standard: ( o padrão ). Fornece armazenamento econômico do banco de dados para aplicações com uso moderado a pequeno de E/S.

  • iopt1: habilita o armazenamento otimizado para E/S desenvolvido para atender às necessidades de workloads de grafos de uso intenso de E/S que exigem preços previsíveis com baixa latência de E/S e throughput de E/S consistente.

    O armazenamento otimizado para E/S do Neptune só está disponível a partir da versão 1.3.0.0 do mecanismo.

• VpcSecurityGroups: é uma matriz de objetos VpcSecurityGroupMembership.

  Fornece uma lista de grupos de segurança da VPC à qual o cluster de banco de dados pertence.

• CreateDBCluster

• DeleteDBCluster

• FailoverDBCluster

• ModifyDBCluster

• PromoteReadReplicaDBCluster

• RestoreDBClusterFromSnapshot

• RestoreDBClusterToPointInTime

• StartDBCluster

• StopDBCluster

Campos

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

  Especifica o status do grupo de parâmetros de cluster de banco de dados para esse membro do cluster de banco de dados.

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

  Especifica o identificador da instância para esse membro do cluster de banco de dados.

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

  Valor que será true se o membro do cluster for a instância principal do cluster de banco de dados. Caso contrário, será false.

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

Campos

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

  O nome do recurso associado ao perfil do Amazon Identity and Access Management (IAM). Para obter a lista de nomes de recursos compatíveis, consulte DescribeDBEngineVersions (ação).

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

  O Nome de recurso da Amazon (ARN) da função do IAM associada ao cluster de banco de dados.

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

  Descreve o estado da associação entre a função do IAM e o cluster de banco de dados. A propriedade Status retorna um dos valores a seguir:

  • ACTIVE: o ARN do perfil do IAM é associado ao cluster de banco de dados e pode ser usado para acessar outros serviços da Amazon em seu nome.

  • PENDING – o ARN da função do IAM está sendo associado ao cluster de banco de dados.

  • INVALID: o ARN do perfil do IAM está associado ao cluster de banco de dados, mas o cluster de banco de dados não consegue assumir o perfil do IAM para acessar outros serviços da Amazon em seu nome.

Campos

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

  A lista de tipos de logs a serem desabilitados.

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

  A lista de tipos de logs a serem habilitados.

Campos

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

  Tipos de log que estão em processo de habilitação. Depois de habilitados, esses tipos de log são exportados para o CloudWatch Logs.

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

  Tipos de log que estão em processo de desativação. Depois que são desativados, esses tipos de log não são exportados para o CloudWatch Logs.

Campos

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

  O tamanho de armazenamento alocado em gibibytes (GiB) para mecanismos de banco de dados. Para o Neptune, AllocatedStorage sempre exibe 1, pois o tamanho de armazenamento do cluster de banco de dados do Neptune não é fixo, mas se ajusta automaticamente conforme necessário.

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

  O número de dias durante os quais os snapshots automáticos do banco de dados são retidos.

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

  O valor DBClusterIdentifier para o cluster de banco de dados.

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

  Versão do mecanismo de banco de dados.

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

  Um valor que indica se o mapeamento de contas do AWS Identity and Access Management (IAM) para contas do banco de dados está habilitado.

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

  O valor das IOPS (operações de entrada/saída por segundo) provisionadas. Essa configuração é somente para clusters de banco de dados 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.

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

  A alteração pendente no tipo de armazenamento do cluster de banco de dados.   Valores válidos:

  • standard: ( o padrão ). Configura o armazenamento econômico do banco de dados para aplicações com uso moderado a pequeno de E/S.

  • iopt1: habilita o armazenamento otimizado para E/S desenvolvido para atender às necessidades de workloads de grafos de uso intenso de E/S que exigem preços previsíveis com baixa latência de E/S e throughput de E/S consistente.

    O armazenamento otimizado para E/S do Neptune só está disponível a partir da versão 1.3.0.0 do mecanismo.