API de snapshots do Neptune

• Criar DBCluster instantâneo (ação)

• Excluir DBCluster instantâneo (ação)

• Copiar DBCluster instantâneo (ação)

• Modificar DBCluster SnapshotAttribute (ação)

• Restaurar DBCluster FromSnapshot (ação)

• Restaurar DBCluster ToPointInTime (ação)

• Descreva DBCluster os instantâneos (ação)

• Descreva DBCluster SnapshotAttributes (ação)

• DBClusterInstantâneo (estrutura)

• DBClusterSnapshotAttribute (estrutura)

• DBClusterSnapshotAttributesResult (estrutura)

• 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 para o qual criar um snapshot. Esse parâmetro não diferencia maiúsculas de minúsculas.

  Restrições:

  • Deve corresponder ao identificador de um existente DBCluster.

  Example: my-cluster1

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

  O identificador do snapshot do 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.

  Example: my-cluster1-snapshot1

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

  As tags a serem atribuídas ao snapshot do cluster de banco de dados.

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

  Especifica o tamanho de armazenamento alocado em gibibytes (GiB).

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

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

• ClusterCreateTime— a 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).

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

  Especifica o identificador do cluster de banco de dados do qual esse snapshot de cluster de banco de dados foi criado.

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

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

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

  Especifica o identificador de um snapshot de cluster de banco de dados. Deve corresponder ao identificador de um snapshot existente.

  Depois de restaurar um cluster de banco de dados usando um DBClusterSnapshotIdentifier, é necessário especificar o mesmo DBClusterSnapshotIdentifier para qualquer atualização futura para o cluster de banco de dados. Quando você especifica essa propriedade para uma atualização, o cluster de banco de dados não é restaurado do snapshot novamente, e os dados no banco de dados não são alterados.

  No entanto, se você não especificar o DBClusterSnapshotIdentifier, será criado um cluster de banco de dados vazio e o cluster de banco de dados original será excluído. Se você especificar uma propriedade diferente da propriedade de restauração de snapshot anterior, o cluster de banco de dados será restaurado do snapshot especificado pelo DBClusterSnapshotIdentifier e o cluster de banco de dados original será excluído.

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

  Especifica o nome do mecanismo de banco de dados.

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

  Fornece a versão do mecanismo de banco de dados para esse snapshot do cluster de banco de dados.

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

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

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

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

  Fornece as informações do modelo de licença para esse snapshot do cluster de banco de dados.

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

  Especifica a porcentagem dos dados estimados transferidos.

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

  Especifica a porta na qual o cluster de banco de dados estava realizando a escuta no momento do snapshot.

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

  Fornece a hora em que o snapshot foi criado, no Tempo Universal Coordenado (UTC).

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

  Fornece o tipo do snapshot do cluster de banco de dados.

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

  Se o snapshot do cluster de banco de dados foi copiado de um snapshot do cluster de banco de dados de origem, o nome de recurso da Amazon (ARN) do snapshot do cluster de banco de dados de origem, caso contrário, um valor nulo.

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

  Especifica o status desse snapshot de cluster de banco de dados.

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

  Especifica se o snapshot do cluster de banco de dados está criptografado.

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

  O tipo de armazenamento associado ao snapshot de cluster de banco de dados.

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

  Fornece o ID da VPC associada ao snapshot de cluster de banco de dados.

Erros

• DBClusterSnapshotAlreadyExistsFault

• Inválido DBCluster StateFault

• DBClusterNotFoundFault

• SnapshotQuotaExceededFault

• Inválido DBCluster SnapshotStateFault

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

  O identificador do snapshot do cluster de banco de dados a ser excluído.

  Restrições: deve ser o nome de um snapshot do cluster de banco de dados existente no estado available.

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

  Especifica o tamanho de armazenamento alocado em gibibytes (GiB).

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

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

• ClusterCreateTime— a 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).

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

  Especifica o identificador do cluster de banco de dados do qual esse snapshot de cluster de banco de dados foi criado.

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

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

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

  Especifica o identificador de um snapshot de cluster de banco de dados. Deve corresponder ao identificador de um snapshot existente.

  Depois de restaurar um cluster de banco de dados usando um DBClusterSnapshotIdentifier, é necessário especificar o mesmo DBClusterSnapshotIdentifier para qualquer atualização futura para o cluster de banco de dados. Quando você especifica essa propriedade para uma atualização, o cluster de banco de dados não é restaurado do snapshot novamente, e os dados no banco de dados não são alterados.

  No entanto, se você não especificar o DBClusterSnapshotIdentifier, será criado um cluster de banco de dados vazio e o cluster de banco de dados original será excluído. Se você especificar uma propriedade diferente da propriedade de restauração de snapshot anterior, o cluster de banco de dados será restaurado do snapshot especificado pelo DBClusterSnapshotIdentifier e o cluster de banco de dados original será excluído.

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

  Especifica o nome do mecanismo de banco de dados.

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

  Fornece a versão do mecanismo de banco de dados para esse snapshot do cluster de banco de dados.

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

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

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

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

  Fornece as informações do modelo de licença para esse snapshot do cluster de banco de dados.

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

  Especifica a porcentagem dos dados estimados transferidos.

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

  Especifica a porta na qual o cluster de banco de dados estava realizando a escuta no momento do snapshot.

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

  Fornece a hora em que o snapshot foi criado, no Tempo Universal Coordenado (UTC).

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

  Fornece o tipo do snapshot do cluster de banco de dados.

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

  Se o snapshot do cluster de banco de dados foi copiado de um snapshot do cluster de banco de dados de origem, o nome de recurso da Amazon (ARN) do snapshot do cluster de banco de dados de origem, caso contrário, um valor nulo.

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

  Especifica o status desse snapshot de cluster de banco de dados.

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

  Especifica se o snapshot do cluster de banco de dados está criptografado.

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

  O tipo de armazenamento associado ao snapshot de cluster de banco de dados.

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

  Fornece o ID da VPC associada ao snapshot de cluster de banco de dados.

Erros

• Inválido DBCluster SnapshotStateFault

• DBClusterSnapshotNotFoundFault

• CopyTags(na CLI:--copy-tags) — a BooleanOptional, do tipo: boolean (um valor booleano (verdadeiro ou falso)).

  True para copiar todas as tags do snapshot do cluster de banco de dados de origem no snapshot do cluster de banco de dados de destino. Caso contrário, false. O padrão é falso.

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

  O ID da chave do Amazon KMS para um snapshot do cluster de banco de dados criptografado. O ID da chave do KMS é o nome do recurso da Amazon (ARN), o identificador da chave do KMS ou o alias da chave do KMS para a chave de criptografia do KMS.

  Se você copiar um snapshot do cluster de banco de dados criptografado da conta da Amazon, poderá especificar um valor para KmsKeyId a fim de criptografar a cópia com uma nova chave de criptografia do KMS. Se você não especificar um valor para KmsKeyId, a cópia do snapshot do cluster de banco de dados será criptografada com a mesma chave do KMS que o snapshot do cluster de banco de dados de origem.

  Se você copiar um snapshot de cluster de banco de dados criptografado compartilhado de outra conta da Amazon, deverá especificar um valor para KmsKeyId.

  As chaves de criptografia do KMS são específicas das regiões da Amazon em que são criadas. Não é possível usar chaves de criptografia de uma região da Amazon em outra região da Amazon.

  Você não pode criptografar um snapshot de cluster de banco de dados não criptografado ao copiá-lo. Se você tentar copiar um snapshot de cluster de banco de dados não criptografado e especificar um valor para o KmsKeyId parâmetro, um erro será retornado.

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

  Sem suporte no momento.

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

  O identificador do snapshot do cluster de banco de dados a ser copiado. Esse parâmetro não diferencia maiúsculas de minúsculas.

  Restrições:

  • É necessário especificar um snapshot de sistema válido no estado "disponível".

  • Especifique um identificador de DB snapshot.

  Example: my-cluster-snapshot1

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

  As tags a serem atribuídas à nova cópia do snapshot do cluster de banco de dados.

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

  O identificador do novo snapshot do cluster de banco de dados a ser criado a partir do snapshot do cluster de banco de dados de origem. Esse parâmetro não diferencia maiúsculas de 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.

  Example: my-cluster-snapshot2

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

  Especifica o tamanho de armazenamento alocado em gibibytes (GiB).

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

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

• ClusterCreateTime— a 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).

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

  Especifica o identificador do cluster de banco de dados do qual esse snapshot de cluster de banco de dados foi criado.

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

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

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

  Especifica o identificador de um snapshot de cluster de banco de dados. Deve corresponder ao identificador de um snapshot existente.

  Depois de restaurar um cluster de banco de dados usando um DBClusterSnapshotIdentifier, é necessário especificar o mesmo DBClusterSnapshotIdentifier para qualquer atualização futura para o cluster de banco de dados. Quando você especifica essa propriedade para uma atualização, o cluster de banco de dados não é restaurado do snapshot novamente, e os dados no banco de dados não são alterados.

  No entanto, se você não especificar o DBClusterSnapshotIdentifier, será criado um cluster de banco de dados vazio e o cluster de banco de dados original será excluído. Se você especificar uma propriedade diferente da propriedade de restauração de snapshot anterior, o cluster de banco de dados será restaurado do snapshot especificado pelo DBClusterSnapshotIdentifier e o cluster de banco de dados original será excluído.

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

  Especifica o nome do mecanismo de banco de dados.

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

  Fornece a versão do mecanismo de banco de dados para esse snapshot do cluster de banco de dados.

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

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

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

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

  Fornece as informações do modelo de licença para esse snapshot do cluster de banco de dados.

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

  Especifica a porcentagem dos dados estimados transferidos.

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

  Especifica a porta na qual o cluster de banco de dados estava realizando a escuta no momento do snapshot.

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

  Fornece a hora em que o snapshot foi criado, no Tempo Universal Coordenado (UTC).

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

  Fornece o tipo do snapshot do cluster de banco de dados.

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

  Se o snapshot do cluster de banco de dados foi copiado de um snapshot do cluster de banco de dados de origem, o nome de recurso da Amazon (ARN) do snapshot do cluster de banco de dados de origem, caso contrário, um valor nulo.

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

  Especifica o status desse snapshot de cluster de banco de dados.

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

  Especifica se o snapshot do cluster de banco de dados está criptografado.

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

  O tipo de armazenamento associado ao snapshot de cluster de banco de dados.

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

  Fornece o ID da VPC associada ao snapshot de cluster de banco de dados.

Erros

• DBClusterSnapshotAlreadyExistsFault

• DBClusterSnapshotNotFoundFault

• Inválido DBCluster StateFault

• Inválido DBCluster SnapshotStateFault

• SnapshotQuotaExceededFault

• KMSKeyNotAccessibleFault

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

  O nome do atributo do snapshot do cluster de banco de dados a ser modificado.

  Para gerenciar a autorização de outras contas da Amazon para copiar ou restaurar um snapshot manual do cluster do banco de dados, defina esse valor como restore.

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

  O identificador do snapshot do cluster de banco de dados cujos atributos serão modificados.

• ValuesToAdd (na CLI: --values-to-add): uma string, do tipo: string (uma string codificada em UTF-8).

  Uma lista de atributos de snapshot do cluster de banco de dados a serem adicionados ao atributo especificado por AttributeName.

  Para autorizar outras contas da Amazon a copiar ou restaurar um snapshot manual do cluster de banco de dados, defina essa lista para incluir uma ou mais contas da Amazon ou all para tornar o snapshot manual do cluster de banco de dados restaurável por qualquer conta IDs da Amazon. Não adicione o valor all a nenhum snapshot manual do cluster de banco de dados que contenha informações privadas que você não deseja disponibilizar para todas as contas da Amazon.

• ValuesToRemove (na CLI: --values-to-remove): uma string, do tipo: string (uma string codificada em UTF-8).

  Uma lista de atributos de snapshot do cluster de banco de dados a serem removidos do atributo especificado por AttributeName.

  Para remover a autorização de outras contas da Amazon para copiar ou restaurar um snapshot manual do cluster de banco de dados, defina essa lista para incluir um ou mais identificadores de conta da Amazon, ou all para remover a autorização de uma conta da Amazon para copiar ou restaurar o snapshot do cluster de banco de dados. Se você especificar all, uma conta da Amazon cujo ID for explicitamente adicionado ao atributo restore ainda poderá copiar ou restaurar um snapshot manual do cluster de banco de dados.

• DBClusterSnapshotAttributes: um array de objetos DBClusterSnapshotAttribute.

  A lista de atributos e valores do snapshot manual do cluster de banco de dados.

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

  O identificador do snapshot manual do cluster de banco de dados ao qual os atributos se aplicam.

Erros

• DBClusterSnapshotNotFoundFault

• Inválido DBCluster SnapshotStateFault

• SharedSnapshotQuotaExceededFault

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

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

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

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

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

  Sem compatibilidade.

• 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 criado a partir do DB snapshot ou do snapshot do cluster de banco de dados. Este parâmetro não diferencia maiúsculas de 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

  Example: my-snapshot-id

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

  Restrições:

  • Se fornecido, deve corresponder ao nome de um existente DBClusterParameterGroup.

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

  O nome do grupo de sub-redes de banco de dados a ser usado no novo cluster de banco de dados.

  Restrições: se fornecidas, devem corresponder ao nome de um grupo existente DBSubnet.

  Example: mySubnetgroup

• DeletionProtection(na CLI:--deletion-protection) — a BooleanOptional, do tipo: boolean (um valor booleano (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.

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

  A lista de registros que o cluster de banco de dados restaurado deve exportar para o Amazon CloudWatch Logs.

• EnableIAMDatabaseAuthentication(na CLI:--enable-iam-database-authentication) — a BooleanOptional, do tipo: boolean (um valor booleano (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

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

  O mecanismo de banco de dados a utilizar para o novo cluster de banco de dados.

  Padrão: o mesmo que a origem

  Restrição: deve ser compatível com o mecanismo da origem

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

  A versão do mecanismo de banco de dados a ser usada para o novo cluster de banco de dados.

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

  O identificador da chave do Amazon KMS a ser usada ao restaurar um cluster de banco de dados criptografado a partir de um snapshot de banco de dados ou um snapshot do cluster de banco de dados.

  O identificador de chave KMS é o Amazon Resource Name (ARN) da chave de criptografia KMS. Se você estiver restaurando 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 para a chave de criptografia do KMS.

  Se você não especificar um valor para o parâmetro KmsKeyId, ocorrerá o seguinte:

  • Se o DB snapshot ou o snapshot do cluster de banco de dados em SnapshotIdentifier for criptografado, o cluster de banco de dados restaurado será criptografado usando a chave do KMS que foi utilizada para criptografar o DB snapshot ou o snapshot do cluster de banco de dados.

  • Se o DB snapshot ou do cluster de banco de dados em SnapshotIdentifier não estiver criptografado, o cluster de banco de dados restaurado não será criptografado.

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

  O número da porta na qual o novo cluster de banco de dados 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.

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

  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.

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

  O identificador do qual restaurar o DB snapshot ou o snapshot do cluster de banco de dados.

  Você pode usar o nome ou o nome de recurso da Amazon (ARN) para especificar um snapshot do cluster de banco de dados. No entanto, é possível usar apenas o ARN para especificar um DB snapshot.

  Restrições:

  • Deve corresponder ao identificador de um snapshot existente.

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

  Especifica o tipo de armazenamento a ser associado ao cluster de banco de dados.

  Valores válidos: standard, iopt1

  Padrão: standard

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

  As tags a serem atribuídas ao cluster de banco de dados restaurado.

• 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 novo cluster de banco de dados pertencerá.

• AllocatedStorage— an IntegerOptional, do tipo: integer (um 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: um array de objetos DBClusterFunção.

  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— a 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 EC2 disponibilidade nas quais as instâncias no cluster de banco de dados podem ser criadas.

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

  Não compatível com o Neptune.

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

  Não compatível com o Neptune.

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

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

• Capacity— an IntegerOptional, do tipo: integer (um 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— a 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— a BooleanOptional, do tipo: boolean (um valor booleano (verdadeiro ou falso)).

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

• CrossAccountClone— a BooleanOptional, do tipo: boolean (um valor booleano (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: um array de objetos DBClusterMembro.

  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 CloudTrail log da Amazon 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— a BooleanOptional, do tipo: boolean (um valor booleano (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— a 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— a TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

  Especifica a primeira vez em que um banco de dados pode ser restaurado com a point-in-time restauração.

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

  Uma lista dos tipos de log que esse cluster de banco de dados está configurado para exportar para CloudWatch Logs. Os tipos de registro válidos são: audit (para publicar registros de auditoria CloudWatch) e slowquery (para publicar registros de consulta lenta). CloudWatch Consulte Publicação de registros do Neptune nos registros da Amazon. CloudWatch

• 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— a GlobalClusterIdentifier, do tipo: string (uma string codificada em UTF-8), não inferior a 1 ou superior a 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— a 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— a TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

  Especifica a última hora na qual um banco de dados pode ser restaurado com a point-in-time restauração.

• 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— an IntegerOptional, do tipo: integer (um 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 Sem servidor v2 ScalingConfigurationInfo.

  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: um array de objetos VpcSecurityGroupMembership.

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

Erros

• DBClusterAlreadyExistsFault

• DBClusterQuotaExceededFault

• StorageQuotaExceededFault

• DBSubnetGroupNotFoundFault

• DBSnapshotNotFoundFault

• DBClusterSnapshotNotFoundFault

• Insuficiente DBCluster CapacityFault

• InsufficientStorageClusterCapacityFault

• Inválido DBSnapshot StateFault

• Inválido DBCluster SnapshotStateFault

• StorageQuotaExceededFault

• Inválido VPCNetwork StateFault

• InvalidRestoreFault

• DBSubnetGroupNotFoundFault

• InvalidSubnet

• OptionGroupNotFoundFault

• KMSKeyNotAccessibleFault

• DBClusterParameterGroupNotFoundFault

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

  O nome do novo cluster de banco de dados a ser criado.

  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

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

  Restrições:

  • Se fornecido, deve corresponder ao nome de um existente DBClusterParameterGroup.

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

  O nome do grupo de sub-redes de banco de dados a ser usado para o novo cluster de banco de dados.

  Restrições: se fornecidas, devem corresponder ao nome de um grupo existente DBSubnet.

  Example: mySubnetgroup

• DeletionProtection(na CLI:--deletion-protection) — a BooleanOptional, do tipo: boolean (um valor booleano (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.

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

  A lista de registros que o cluster de banco de dados restaurado deve exportar para o CloudWatch Logs.

• EnableIAMDatabaseAuthentication(na CLI:--enable-iam-database-authentication) — a BooleanOptional, do tipo: boolean (um valor booleano (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

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

  O identificador da chave do Amazon KMS a ser usada ao restaurar um cluster de banco de dados criptografado a partir de 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 restaurando 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 para a chave de criptografia do KMS.

  Você pode restaurar para um novo cluster de banco de dados e criptografar o novo cluster com uma chave do KMS que é diferente da chave do KMS usada para criptografar o cluster de banco de dados de origem. O novo cluster de banco de dados é criptografado com a chave do KMS identificada pelo parâmetro KmsKeyId.

  Se você não especificar um valor para o parâmetro KmsKeyId, ocorrerá o seguinte:

  • Se o cluster de banco de dados for criptografado, o cluster de banco de dados restaurado será criptografado usando a chave do KMS que foi utilizada para criptografar o cluster de banco de dados de origem.

  • Se o cluster de banco de dados não estiver criptografado, o cluster de banco de dados restaurado não será criptografado.

  Se DBClusterIdentifier referir-se a um cluster de banco de dados não criptografado, a solicitação de restauração será rejeitada.

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

  O número da porta na qual o novo cluster de banco de dados 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.

• RestoreToTime(na CLI:--restore-to-time) — a TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um deslocamento da meia-noite de 01/01/1970).

  A data e a hora para às quais restaurar o cluster de banco de dados.

  Valores válidos: o valor deve ser expresso no formato do Tempo Universal Coordenado (UTC)

  Restrições:

  • Devem ser anteriores ao último momento restaurável da instância de banco de dados

  • Devem ser especificadas se o parâmetro UseLatestRestorableTime não for especificado

  • Não podem ser especificadas se o parâmetro UseLatestRestorableTime for true

  • Não podem ser especificadas se o parâmetro RestoreType for copy-on-write.

  Example: 2015-03-07T23:45:00Z

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

  O tipo de restauração a ser realizada. É possível especificar um dos seguintes valores:

  • full-copy - o novo cluster de banco de dados é restaurado como uma cópia completa do cluster de banco de dados de origem.

  • copy-on-write - o novo cluster de banco de dados é restaurado como um clone do cluster de banco de dados de origem.

  Se você não especificar um valor RestoreType, o novo cluster de banco de dados será restaurado como uma cópia completa do cluster de banco de dados de origem.

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

  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.

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

  O identificador do cluster de banco de dados de origem do qual restaurar.

  Restrições:

  • Deve corresponder ao identificador de um existente DBCluster.

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

  Especifica o tipo de armazenamento a ser associado ao cluster de banco de dados.

  Valores válidos: standard, iopt1

  Padrão: standard

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

  As tags a serem aplicadas ao cluster de banco de dados restaurado.

• UseLatestRestorableTime (na CLI: --use-latest-restorable-time): um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

  Um valor que é definido como true para restaurar o cluster de banco de dados para o horário mais recente de backup restaurável. Caso contrário, false.

  Padrão: false

  Restrições: não poderão ser especificadas se o parâmetro RestoreToTime for especificado.

• 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 à qual o novo cluster de banco de dados pertence.

• AllocatedStorage— an IntegerOptional, do tipo: integer (um 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: um array de objetos DBClusterFunção.

  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— a 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 EC2 disponibilidade nas quais as instâncias no cluster de banco de dados podem ser criadas.

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

  Não compatível com o Neptune.

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

  Não compatível com o Neptune.

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

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

• Capacity— an IntegerOptional, do tipo: integer (um 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— a 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— a BooleanOptional, do tipo: boolean (um valor booleano (verdadeiro ou falso)).

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

• CrossAccountClone— a BooleanOptional, do tipo: boolean (um valor booleano (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: um array de objetos DBClusterMembro.

  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 CloudTrail log da Amazon 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— a BooleanOptional, do tipo: boolean (um valor booleano (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— a 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— a TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

  Especifica a primeira vez em que um banco de dados pode ser restaurado com a point-in-time restauração.

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

  Uma lista dos tipos de log que esse cluster de banco de dados está configurado para exportar para CloudWatch Logs. Os tipos de registro válidos são: audit (para publicar registros de auditoria CloudWatch) e slowquery (para publicar registros de consulta lenta). CloudWatch Consulte Publicação de registros do Neptune nos registros da Amazon. CloudWatch

• 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— a GlobalClusterIdentifier, do tipo: string (uma string codificada em UTF-8), não inferior a 1 ou superior a 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— a 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— a TStamp, do tipo: timestamp (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970).

  Especifica a última hora na qual um banco de dados pode ser restaurado com a point-in-time restauração.

• 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— an IntegerOptional, do tipo: integer (um 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 Sem servidor v2 ScalingConfigurationInfo.

  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: um array de objetos VpcSecurityGroupMembership.

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

Erros

• DBClusterAlreadyExistsFault

• DBClusterNotFoundFault

• DBClusterQuotaExceededFault

• DBClusterSnapshotNotFoundFault

• DBSubnetGroupNotFoundFault

• Insuficiente DBCluster CapacityFault

• InsufficientStorageClusterCapacityFault

• Inválido DBCluster SnapshotStateFault

• Inválido DBCluster StateFault

• Inválido DBSnapshot StateFault

• InvalidRestoreFault

• InvalidSubnet

• Inválido VPCNetwork StateFault

• KMSKeyNotAccessibleFault

• OptionGroupNotFoundFault

• StorageQuotaExceededFault

• DBClusterParameterGroupNotFoundFault

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

  O ID do cluster de banco de dados para o qual recuperar a lista de snapshots de cluster de banco de dados. Esse parâmetro não pode ser usado em conjunto com o parâmetro DBClusterSnapshotIdentifier. Esse parâmetro não diferencia maiúsculas de minúsculas.

  Restrições:

  • Se fornecido, deve corresponder ao identificador de um existente DBCluster.

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

  Um identificador de snapshot de cluster de banco de dados específico a ser descrito. Esse parâmetro não pode ser usado em conjunto com o parâmetro DBClusterIdentifier. Esse valor é armazenado como uma string em minúsculas.

  Restrições:

  • Se fornecido, deve corresponder ao identificador de um DBCluster Snapshot existente.

  • Se esse identificador for uma captura de tela automatizada, o parâmetro SnapshotType também deverá ser especificado.

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

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

• IncludePublic (na CLI: --include-public): um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

  Verdadeiro para incluir snapshots manuais do cluster de banco de dados que são públicos e podem ser copiados ou restaurados por qualquer conta da Amazon. Caso contrário, falso. O padrão é false. O padrão é falso.

  Você pode compartilhar um snapshot manual do cluster de banco de dados como público usando a ação de API Modificar DBCluster SnapshotAttribute (ação).

• IncludeShared (na CLI: --include-shared): um valor booliano, do tipo: boolean (um valor booliano (verdadeiro ou falso)).

  Verdadeiro para incluir snapshots manuais do cluster de banco de dados compartilhados de outras contas da Amazon que essa conta da Amazon tem permissão para copiar ou restaurar. Caso contrário, falso. O padrão é false.

  É possível fornecer a uma conta da Amazon permissão para restaurar um snapshot manual do cluster de banco de dados de outra conta da Amazon com a ação da API Modificar DBCluster SnapshotAttribute (ação).

• 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 DescribeDBClusterSnapshots 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) — an IntegerOptional, do tipo: integer (um 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 de 20, máximo de 100.

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

  O tipo de snapshots de cluster de banco de dados a ser retornado. É possível especificar um dos seguintes valores:

  • automated: exibe todos os snapshots do cluster de banco de dados que foram criados pelo Amazon Neptune automaticamente para minha conta da Amazon.

  • manual: exibe todos os snapshots do cluster de banco de dados que foram criados por minha conta da Amazon.

  • shared: gera todos os snapshots manuais do cluster de banco de dados que foram compartilhados para a minha conta da Amazon.

  • public – retorna todos os snapshots do cluster de banco de dados que foram marcados como públicos.

  Se você não especificar um valor SnapshotType, os snapshots de cluster de banco de dados automatizados e manuais serão retornados. Você pode incluir snapshots do cluster de banco de dados compartilhados com esses resultados configurando o parâmetro IncludeShared como true. Você pode incluir snapshots do cluster de banco de dados públicos com esses resultados configurando o parâmetro IncludePublic como true.

  Os parâmetros IncludeShared e IncludePublic não se aplicam aos valores SnapshotType de manual ou automated. O parâmetro IncludePublic não se aplica quando SnapshotType está definido como shared. O parâmetro IncludeShared não se aplica quando SnapshotType está definido como public.

• DBClusterSnapshots: um array de objetos DBClusterInstantâneo.

  Fornece uma lista de snapshots do cluster 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 opcional fornecido por uma solicitação Descreva DBCluster os instantâneos (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.

Erros

• DBClusterSnapshotNotFoundFault

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

  O identificador do snapshot do cluster de banco de dados cujos atributos serão descritos.

• DBClusterSnapshotAttributes: um array de objetos DBClusterSnapshotAttribute.

  A lista de atributos e valores do snapshot manual do cluster de banco de dados.

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

  O identificador do snapshot manual do cluster de banco de dados ao qual os atributos se aplicam.

Erros

• DBClusterSnapshotNotFoundFault

Campos

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

  Especifica o tamanho de armazenamento alocado em gibibytes (GiB).

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

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

• ClusterCreateTime— Este é 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).

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

  Especifica o identificador do cluster de banco de dados do qual esse snapshot de cluster de banco de dados foi criado.

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

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

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

  Especifica o identificador de um snapshot de cluster de banco de dados. Deve corresponder ao identificador de um snapshot existente.

  Depois de restaurar um cluster de banco de dados usando um DBClusterSnapshotIdentifier, é necessário especificar o mesmo DBClusterSnapshotIdentifier para qualquer atualização futura para o cluster de banco de dados. Quando você especifica essa propriedade para uma atualização, o cluster de banco de dados não é restaurado do snapshot novamente, e os dados no banco de dados não são alterados.

  No entanto, se você não especificar o DBClusterSnapshotIdentifier, será criado um cluster de banco de dados vazio e o cluster de banco de dados original será excluído. Se você especificar uma propriedade diferente da propriedade de restauração de snapshot anterior, o cluster de banco de dados será restaurado do snapshot especificado pelo DBClusterSnapshotIdentifier e o cluster de banco de dados original será excluído.

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

  Especifica o nome do mecanismo de banco de dados.

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

  Fornece a versão do mecanismo de banco de dados para esse snapshot do cluster de banco de dados.

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

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

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

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

  Fornece as informações do modelo de licença para esse snapshot do cluster de banco de dados.

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

  Especifica a porcentagem dos dados estimados transferidos.

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

  Especifica a porta na qual o cluster de banco de dados estava realizando a escuta no momento do snapshot.

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

  Fornece a hora em que o snapshot foi criado, no Tempo Universal Coordenado (UTC).

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

  Fornece o tipo do snapshot do cluster de banco de dados.

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

  Se o snapshot do cluster de banco de dados foi copiado de um snapshot do cluster de banco de dados de origem, o nome de recurso da Amazon (ARN) do snapshot do cluster de banco de dados de origem, caso contrário, um valor nulo.

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

  Especifica o status desse snapshot de cluster de banco de dados.

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

  Especifica se o snapshot do cluster de banco de dados está criptografado.

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

  O tipo de armazenamento associado ao snapshot de cluster de banco de dados.

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

  Fornece o ID da VPC associada ao snapshot de cluster de banco de dados.

• Criar DBCluster instantâneo

• Copiar DBCluster instantâneo

• Excluir DBCluster instantâneo

Campos

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

  O nome do atributo do snapshot manual do cluster de banco de dados.

  O atributo chamado restore refere-se à lista de contas da Amazon que têm permissão para copiar ou restaurar o snapshot manual do cluster de banco de dados. Para obter mais informações, consulte Ação da API Modificar DBCluster SnapshotAttribute (ação).

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

  Os valores do atributo do snapshot manual do cluster de banco de dados.

  Se o AttributeName campo estiver definido comorestore, esse elemento retornará uma lista das contas IDs da Amazon que estão autorizadas a copiar ou restaurar o snapshot manual do cluster de banco de dados. Se um valor de all estiver na lista, o snapshot manual do cluster de banco de dados será público e estará disponível para qualquer conta da Amazon copiar ou restaurar.

Campos

• DBClusterSnapshotAttributes: é uma matriz de objetos DBClusterSnapshotAttribute.

  A lista de atributos e valores do snapshot manual do cluster de banco de dados.

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

  O identificador do snapshot manual do cluster de banco de dados ao qual os atributos se aplicam.

• Descreva DBCluster SnapshotAttributes

• Modificar DBCluster SnapshotAttribute