As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
API de parâmetros do Neptune
Ações:
Estruturas:
CopyDBParameterGroup (ação)
O nome da CLI da AWS para essa API é: copy-db-parameter-group.
Copia o grupo de parâmetros de banco de dados especificado.
Solicitação
-
SourceDBParameterGroupIdentifier (na CLI:
--source-db-parameter-group-identifier): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O identificador ou o ARN do grupo de parâmetros de banco de dados de origem. Para obter informações sobre a criação de um ARN, consulte Criação de um nome de recurso da Amazon (ARN) do Amazon ARN.
Restrições:
-
É necessário especificar um grupo de parâmetros de banco de dados válido.
-
É necessário especificar um identificador válido de grupo de parâmetros de banco de dados, por exemplo
my-db-param-groupou um ARN válido.
-
-
Tags (na CLI:
--tags): uma matriz de objetos Tag.As tags a serem atribuídas ao grupo de parâmetros de banco de dados copiado.
-
TargetDBParameterGroupDescription (na CLI:
--target-db-parameter-group-description): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).Uma descrição do grupo de parâmetros de banco de dados copiado.
-
TargetDBParameterGroupIdentifier (na CLI:
--target-db-parameter-group-identifier): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O identificador do grupo de parâmetros de banco de dados copiado.
Restrições:
-
Não pode ser nulo, estar vazio ou em branco.
-
Deve conter de 1 a 255 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-db-parameter-group -
Resposta
Contém os detalhes de um grupo de parâmetros de banco de dados do Amazon Neptune.
Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBParameterGroups (ação).
-
DBParameterGroupArn: uma string, do tipo:
string(uma string codificada em UTF-8).O nome de recurso da Amazon (ARN) do grupo de parâmetros de banco de dados.
-
DBParameterGroupFamily: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome da família de grupos de parâmetros de banco de dados com a qual esse grupo de parâmetros de banco de dados é compatível.
-
DBParameterGroupName: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome do grupo de parâmetros de banco de dados.
-
Description: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece a descrição especificada pelo cliente para esse grupo de parâmetros de banco de dados.
Erros
CopyDBClusterParameterGroup (ação)
O nome da CLI da AWS para essa API é: copy-db-cluster-parameter-group.
Copia o grupo de parâmetros de cluster de banco de dados especificado.
Solicitação
-
SourceDBClusterParameterGroupIdentifier (na CLI:
--source-db-cluster-parameter-group-identifier): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O identificador ou o nome de recurso da Amazon (ARN) do grupo de parâmetros de cluster de banco de dados de origem. Para obter informações sobre a criação de um ARN, consulte Criação de um nome de recurso da Amazon (ARN) do Amazon ARN.
Restrições:
-
É necessário especificar um grupo de parâmetros de cluster de banco de dados válido.
-
Se o grupo de parâmetros de cluster de banco de dados de origem estiver na mesma região da Amazon que a cópia, especifique um identificador de grupo de parâmetros de banco de dados válido, por exemplo,
my-db-cluster-param-groupou um ARN válido. -
Se o grupo de parâmetros de banco de dados de origem estiver em uma região da Amazon diferente da cópia, especifique um ARN do grupo de parâmetros de cluster de banco de dados válido, por exemplo,
arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
-
-
Tags (na CLI:
--tags): uma matriz de objetos Tag.As tags a serem atribuídas ao grupo de parâmetros de cluster de banco de dados copiado.
-
TargetDBClusterParameterGroupDescription (na CLI:
--target-db-cluster-parameter-group-description): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).Uma descrição do grupo de parâmetros de cluster de banco de dados copiado.
-
TargetDBClusterParameterGroupIdentifier (na CLI:
--target-db-cluster-parameter-group-identifier): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O identificador do grupo de parâmetros de cluster de banco de dados copiado.
Restrições:
-
Não pode ser nulo, estar vazio nem estar em branco
-
Deve conter de 1 a 255 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-cluster-param-group1 -
Resposta
Contém os detalhes de um grupo de parâmetros de cluster de banco de dados do Amazon Neptune.
Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBClusterParameterGroups (ação).
-
DBClusterParameterGroupArn: uma string, do tipo:
string(uma string codificada em UTF-8).O nome de recurso da Amazon (ARN) do grupo de parâmetros de cluster de banco de dados.
-
DBClusterParameterGroupName: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome do parameter group do cluster de banco de dados.
-
DBParameterGroupFamily: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome da família do parameter group de banco de dados com a qual esse parameter group de cluster de banco de dados é compatível.
-
Description: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece a descrição especificada pelo cliente para este parameter group do cluster de banco de dados.
Erros
CreateDBParameterGroup (ação)
O nome da CLI da AWS para essa API é: create-db-parameter-group.
Cria um novo grupo de parâmetros de banco de dados.
Um grupo de parâmetros de banco de dados é inicialmente criado com os parâmetros padrão para o mecanismo de banco de dados usado pela instância de banco de dados. Para fornecer valores personalizados para qualquer um dos parâmetros, modifique o grupo depois de criá-lo usando ModifyDBParameterGroup. Assim que você criar um grupo de parâmetros de banco de dados, você precisa associá-lo à sua instância de banco de dados usando ModifyDBInstance. Ao associar um novo grupo de parâmetros de banco de dados a uma instância de banco de dados em execução, você precisa reinicializar a instância de banco de dados sem failover para que o novo grupo de parâmetros de banco de dados e as configurações associados entrem em vigor.
Importante
Depois de criar um grupo de parâmetros de banco de dados, espere pelo menos 5 minutos para criar sua primeira instância de banco de dados que usa esse grupo de parâmetros como o padrão. Isso permite que o Amazon Neptune complete totalmente a ação de criação antes que o grupo de parâmetros seja usado como padrão para uma nova instância de banco de dados. Isso é especialmente importante para parâmetros que são críticos ao criar o banco de dados padrão para uma instância de banco de dados, como o conjunto de caracteres para o banco de dados padrão definido pelo parâmetro character_set_database. Você pode usar a opção Parameter Groups (Grupos de parâmetros) do console do Amazon Neptune ou o comando DescribeDBParameters para verificar se o seu grupo de parâmetros de banco de dados foi criado ou modificado.
Solicitação
-
DBParameterGroupFamily (na CLI:
--db-parameter-group-family): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome da família de grupos de parâmetros de banco de dados. Um grupo de parâmetros de banco de dados pode ser associado a uma única família de grupos de parâmetros de banco de dados e pode ser aplicado somente a uma instância de banco de dados que execute um mecanismo de banco de dados e uma versão do mecanismo compatível com essa família de grupos de parâmetros de banco de dados.
-
DBParameterGroupName (na CLI:
--db-parameter-group-name): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome do grupo de parâmetros de banco de dados.
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
nota
Esse valor é armazenado como uma string em minúsculas.
-
-
Description (na CLI:
--description): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).A descrição do grupo de parâmetros de banco de dados.
-
Tags (na CLI:
--tags): uma matriz de objetos Tag.As tags a serem atribuídas ao novo grupo de parâmetros de banco de dados.
Resposta
Contém os detalhes de um grupo de parâmetros de banco de dados do Amazon Neptune.
Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBParameterGroups (ação).
-
DBParameterGroupArn: uma string, do tipo:
string(uma string codificada em UTF-8).O nome de recurso da Amazon (ARN) do grupo de parâmetros de banco de dados.
-
DBParameterGroupFamily: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome da família de grupos de parâmetros de banco de dados com a qual esse grupo de parâmetros de banco de dados é compatível.
-
DBParameterGroupName: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome do grupo de parâmetros de banco de dados.
-
Description: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece a descrição especificada pelo cliente para esse grupo de parâmetros de banco de dados.
CreateDBClusterParameterGroup (ação)
O nome da CLI da AWS para essa API é: create-db-cluster-parameter-group.
Cria um novo grupo de parâmetros de cluster de banco de dados.
Os parâmetros em um grupo de parâmetros de cluster de banco de dados aplicam-se a todas as instâncias em um cluster de banco de dados.
Um grupo de parâmetros de cluster de banco de dados é inicialmente criado com os parâmetros padrão para o mecanismo de banco de dados usado pelas instâncias do cluster de banco de dados. Para fornecer valores personalizados para qualquer um dos parâmetros, modifique o grupo depois de criá-lo usando ModifyDBClusterParameterGroup (ação). Assim que você criar um grupo de parâmetros de cluster de banco de dados, você precisa associá-lo ao seu cluster de banco de dados usando ModifyDBCluster (ação). Ao associar um novo grupo de parâmetros de cluster de banco de dados a um cluster de banco de dados em execução, você precisa reinicializar as instâncias de banco de dados no cluster de banco de dados sem failover para que o novo grupo de parâmetros de cluster de banco de dados e as configurações associados entrem em vigor.
Importante
Depois de criar um grupo de parâmetros de cluster de banco de dados, espere pelo menos 5 minutos para criar seu primeiro cluster de banco de dados usando esse grupo de parâmetros de banco de dados como o padrão. Isso permite que o Amazon Neptune complete totalmente a ação de criação antes que o grupo de parâmetros de cluster de banco de dados seja usado como padrão para um novo cluster de banco de dados. Isso é especialmente importante para parâmetros que são críticos ao criar o banco de dados padrão para um cluster de banco de dados, como o conjunto de caracteres para o banco de dados padrão definido pelo parâmetro character_set_database. Você pode usar a opção Parameter Groups (Grupos de parâmetros) do console do Amazon Neptune
Solicitação
-
DBClusterParameterGroupName (na CLI:
--db-cluster-parameter-group-name): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome do grupo de parâmetros de cluster de banco de dados.
Restrições:
-
Deve ser correspondente ao nome de um DBClusterParameterGroup existente.
nota
Esse valor é armazenado como uma string em minúsculas.
-
-
DBParameterGroupFamily (na CLI:
--db-parameter-group-family): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome da família de grupos de parâmetros de cluster de banco de dados. Um grupo de parâmetros de cluster de banco de dados pode ser associado a uma única família de grupos de parâmetros de cluster de banco de dados e pode ser aplicado somente a um cluster de banco de dados que execute um mecanismo de banco de dados e uma versão do mecanismo compatível com essa família de grupos de parâmetros de cluster de banco de dados.
-
Description (na CLI:
--description): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).A descrição do grupo de parâmetros de cluster de banco de dados.
-
Tags (na CLI:
--tags): uma matriz de objetos Tag.As tags a serem atribuídas ao novo grupo de parâmetros de cluster de banco de dados.
Resposta
Contém os detalhes de um grupo de parâmetros de cluster de banco de dados do Amazon Neptune.
Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBClusterParameterGroups (ação).
-
DBClusterParameterGroupArn: uma string, do tipo:
string(uma string codificada em UTF-8).O nome de recurso da Amazon (ARN) do grupo de parâmetros de cluster de banco de dados.
-
DBClusterParameterGroupName: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome do parameter group do cluster de banco de dados.
-
DBParameterGroupFamily: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome da família do parameter group de banco de dados com a qual esse parameter group de cluster de banco de dados é compatível.
-
Description: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece a descrição especificada pelo cliente para este parameter group do cluster de banco de dados.
DeleteDBParameterGroup (ação)
O nome da CLI da AWS para essa API é: delete-db-parameter-group.
Exclui um DBParameterGroup especificado. O DBParameterGroup a ser excluído não pode ser associado a todas as instâncias de banco de dados.
Solicitação
-
DBParameterGroupName (na CLI:
--db-parameter-group-name): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome do grupo de parâmetros de banco de dados.
Restrições:
-
Deve ser o nome de um grupo de parâmetros de banco de dados existente.
-
Não é possível excluir um grupo de parâmetros de banco de dados padrão
-
Não pode ser associado a nenhuma instância de banco de dados
-
Resposta
Nenhum parâmetro de resposta.
DeleteDBClusterParameterGroup (ação)
O nome da CLI da AWS para essa API é: delete-db-cluster-parameter-group.
Exclui um grupo de parâmetros de cluster de banco de dados especificado. O grupo de parâmetros de cluster de banco de dados a ser excluído não pode ser associado a nenhum cluster de banco de dados.
Solicitação
-
DBClusterParameterGroupName (na CLI:
--db-cluster-parameter-group-name): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome do grupo de parâmetros de cluster de banco de dados.
Restrições:
-
Deve ser o nome de um grupo de parâmetros de cluster de banco de dados existente.
-
Não é possível excluir um grupo de parâmetros de cluster de banco de dados padrão.
-
Não pode ser associado a nenhum cluster de banco de dados.
-
Resposta
Nenhum parâmetro de resposta.
ModifyDBParameterGroup (ação)
O nome da CLI da AWS para essa API é: modify-db-parameter-group.
Modifica os parâmetros de um grupo de parâmetros de banco de dados. Para modificar mais de um parâmetro, envie uma lista do seguinte: ParameterName, ParameterValue e ApplyMethod. No máximo, 20 parâmetros pode ser modificado em uma única solicitação.
nota
As alterações em parâmetros dinâmicos são aplicadas imediatamente. As alterações para parâmetros estáticos exigem uma reinicialização sem failover para a instância de banco de dados associada ao grupo de parâmetros para que a alteração entre em vigor.
Importante
Depois de modificar um grupo de parâmetros de banco de dados, espere pelo menos 5 minutos para criar sua primeira instância de banco de dados que use esse grupo de parâmetros de banco de dados como o padrão. Isso permite que o Amazon Neptune complete totalmente a ação de modificação antes que o grupo de parâmetros seja usado como padrão para uma nova instância de banco de dados. Isso é especialmente importante para parâmetros que são críticos ao criar o banco de dados padrão para uma instância de banco de dados, como o conjunto de caracteres para o banco de dados padrão definido pelo parâmetro character_set_database. Você pode usar a opção Parameter Groups (Grupos de parâmetros) do console do Amazon Neptune ou o comando DescribeDBParameters para verificar se o seu grupo de parâmetros de banco de dados foi criado ou modificado.
Solicitação
-
DBParameterGroupName (na CLI:
--db-parameter-group-name): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome do grupo de parâmetros de banco de dados.
Restrições:
-
Se fornecido, deve ser correspondente ao nome de um DBParameterGroup existente.
-
-
Parameters (na CLI:
--parameters): obrigatório: uma matriz de objetos Parâmetro.Uma matriz de nomes de parâmetros, valores e o método de aplicação da atualização de parâmetros. Pelo menos um nome de parâmetro, valor e método de aplicação devem ser fornecidos; argumentos subsequentes são opcionais. No máximo, 20 parâmetros pode ser modificado em uma única solicitação.
Valores válidos (para o método de aplicação):
immediate | pending-rebootnota
Você pode usar o valor imediato somente com parâmetros dinâmicos. Você pode usar o valor de reinicialização pendente para parâmetros estáticos e dinâmicos, e as alterações serão aplicadas quando você reiniciar a instância de banco de dados sem failover.
Resposta
-
DBParameterGroupName: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome do grupo de parâmetros de banco de dados.
ModifyDBClusterParameterGroup (ação)
O nome da CLI da AWS para essa API é: modify-db-cluster-parameter-group.
Modifica os parâmetros de um grupo de parâmetros de cluster de banco de dados. Para modificar mais de um parâmetro, envie uma lista do seguinte: ParameterName, ParameterValue e ApplyMethod. No máximo, 20 parâmetros pode ser modificado em uma única solicitação.
nota
As alterações em parâmetros dinâmicos são aplicadas imediatamente. As alterações em parâmetros estáticos exigem uma reinicialização sem failover para o cluster de banco de dados associado ao grupo de parâmetros para que a alteração entre em vigor.
Importante
Depois de criar um grupo de parâmetros de cluster de banco de dados, espere pelo menos 5 minutos para criar seu primeiro cluster de banco de dados usando esse grupo de parâmetros de banco de dados como o padrão. Isso permite que o Amazon Neptune complete totalmente a ação de criação antes que o grupo de parâmetros seja usado como padrão para um novo cluster de banco de dados. Isso é especialmente importante para parâmetros que são críticos ao criar o banco de dados padrão para um cluster de banco de dados, como o conjunto de caracteres para o banco de dados padrão definido pelo parâmetro character_set_database. Você pode usar a opção Parameter Groups (Grupos de parâmetros) do console do Amazon Neptune ou o comando DescribeDBClusterParameters (ação) para verificar se o seu grupo de parâmetros de cluster de banco de dados foi criado ou modificado.
Solicitação
-
DBClusterParameterGroupName (na CLI:
--db-cluster-parameter-group-name): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome do grupo de parâmetros de cluster de banco de dados a ser modificado.
-
Parameters (na CLI:
--parameters): obrigatório: uma matriz de objetos Parâmetro.Uma lista de parâmetros no grupo de parâmetros de cluster de banco de dados a ser modificado.
Resposta
-
DBClusterParameterGroupName: uma string, do tipo:
string(uma string codificada em UTF-8).O nome do grupo de parâmetros de cluster de banco de dados.
Restrições:
-
Deve ter de 1 a 255 letras ou números.
-
O primeiro caractere deve ser uma letra
-
Não podem terminar com um hífen ou conter dois hífens consecutivos
nota
Esse valor é armazenado como uma string em minúsculas.
-
ResetDBParameterGroup (ação)
O nome da CLI da AWS para essa API é: reset-db-parameter-group.
Modifica os parâmetros de um grupo de parâmetros de banco de dados para o valor padrão do mecanismo/sistema. Para redefinir parâmetros específicos, forneça uma lista do seguinte: ParameterName e ApplyMethod. Para redefinir todo o grupo de parâmetros de banco de dados, especifique o nome DBParameterGroup e os parâmetros ResetAllParameters. Quando você redefine todo o grupo, os parâmetros dinâmicos são atualizados imediatamente, e os parâmetros estáticos são definidos como pending-reboot para entrar em vigor na próxima reinicialização da instância de banco de dados ou na solicitação RebootDBInstance.
Solicitação
-
DBParameterGroupName (na CLI:
--db-parameter-group-name): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome do grupo de parâmetros de banco de dados.
Restrições:
-
Deve ser correspondente ao nome de um DBParameterGroup existente.
-
-
Parameters (na CLI:
--parameters): uma matriz de objetos Parâmetro.Para redefinir todo o grupo de parâmetros de banco de dados, especifique o nome
DBParameterGroupe os parâmetrosResetAllParameters. Para redefinir parâmetros específicos, forneça uma lista do seguinte:ParameterNameeApplyMethod. No máximo, 20 parâmetros pode ser modificado em uma única solicitação.Valores válidos (para o método de aplicação):
pending-reboot -
ResetAllParameters (na CLI:
--reset-all-parameters): um valor booliano, do tipo:boolean(um valor booliano (verdadeiro ou falso)).Especifica se é necessário redefinir todos os parâmetros do grupo de parâmetros de banco de dados como valores padrão (
true) ou não (false).Padrão:
true
Resposta
-
DBParameterGroupName: uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome do grupo de parâmetros de banco de dados.
ResetDBClusterParameterGroup (ação)
O nome da CLI da AWS para essa API é: reset-db-cluster-parameter-group.
Modifica os parâmetros de um grupo de parâmetros de cluster de banco de dados para o valor padrão. Para redefinir parâmetros específicos, envie uma lista do seguinte: ParameterName e ApplyMethod. Para redefinir todo o grupo de parâmetros de cluster de banco de dados, especifique o DBClusterParameterGroupName e os parâmetros ResetAllParameters.
Quando você redefine todo o grupo, os parâmetros dinâmicos são atualizados imediatamente, e os parâmetros estáticos são definidos como pending-reboot para entrar em vigor na próxima reinicialização da instância de banco de dados ou na solicitação RebootDBInstance (ação). Você deve chamar RebootDBInstance (ação) para cada instância de banco de dados no cluster de banco de dados à qual deseja aplicar o parâmetro estático atualizado.
Solicitação
-
DBClusterParameterGroupName (na CLI:
--db-cluster-parameter-group-name): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome do grupo de parâmetros de cluster de banco de dados a ser redefinido.
-
Parameters (na CLI:
--parameters): uma matriz de objetos Parâmetro.Uma lista de nomes de parâmetros no grupo de parâmetros de cluster de banco de dados a serem redefinidos como valores padrão. Você não poderá usar esse parâmetro se o parâmetro
ResetAllParametersestiver definido comotrue. -
ResetAllParameters (na CLI:
--reset-all-parameters): um valor booliano, do tipo:boolean(um valor booliano (verdadeiro ou falso)).Um valor definido como
truepara redefinir todos os parâmetros do grupo de parâmetros de cluster de banco de dados como seus valores padrão, efalsecaso contrário. Você não poderá usar esse parâmetro se houver uma lista de nomes de parâmetros especificados para o parâmetroParameters.
Resposta
-
DBClusterParameterGroupName: uma string, do tipo:
string(uma string codificada em UTF-8).O nome do grupo de parâmetros de cluster de banco de dados.
Restrições:
-
Deve ter de 1 a 255 letras ou números.
-
O primeiro caractere deve ser uma letra
-
Não podem terminar com um hífen ou conter dois hífens consecutivos
nota
Esse valor é armazenado como uma string em minúsculas.
-
DescribeDBParameters (ação)
O nome da CLI da AWS para essa API é: describe-db-parameters.
Retorna a lista de parâmetros detalhada de um grupo de parâmetros de banco de dados.
Solicitação
-
DBParameterGroupName (na CLI:
--db-parameter-group-name): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome de um grupo de parâmetros de banco de dados específico do qual retornar detalhes.
Restrições:
-
Se fornecido, deve ser correspondente ao nome de um DBParameterGroup existente.
-
-
Filters (na CLI:
--filters): uma matriz de objetos Filtro.Não há suporte atualmente para esse parâmetro.
-
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
DescribeDBParametersanterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado porMaxRecords. -
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
MaxRecordsespecificado, 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.
-
Source (na CLI:
--source): uma string, do tipo:string(uma string codificada em UTF-8).Os tipos de parâmetros a serem retornados.
Padrão: todos os tipos de parâmetros são retornados
Valores válidos:
user | system | engine-default
Resposta
-
Marker: uma string, do tipo:
string(uma string codificada em UTF-8).Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por
MaxRecords. -
Parameters – Uma matriz de objetos Parâmetro.
Uma lista de valores Parâmetro (estrutura).
DescribeDBParameterGroups (ação)
O nome da CLI da AWS para essa API é: describe-db-parameter-groups.
Retorna uma lista de descrições de DBParameterGroup. Se um DBParameterGroupName for especificado, a lista conterá apenas a descrição do grupo de parâmetros de banco de dados especificado.
Solicitação
-
DBParameterGroupName (na CLI:
--db-parameter-group-name): uma string, do tipo:string(uma string codificada em UTF-8).O nome de um grupo de parâmetros de banco de dados específico do qual retornar detalhes.
Restrições:
-
Se for fornecido, deverá corresponder ao nome de um DBClusterParameterGroup existente.
-
-
Filters (na CLI:
--filters): uma matriz de objetos Filtro.Não há suporte atualmente para esse parâmetro.
-
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
DescribeDBParameterGroupsanterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado porMaxRecords. -
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
MaxRecordsespecificado, um token de paginação chamado de marcador será incluído na resposta para que os resultados restantes possam ser recuperados.Padrão: 100
Restrições: mínimo 20, máximo 100.
Resposta
-
DBParameterGroups – Uma matriz de objetos DBParameterGroup.
Uma lista de instâncias DBParameterGroup (estrutura).
-
Marker: uma string, do tipo:
string(uma string codificada em UTF-8).Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por
MaxRecords.
DescribeDBClusterParameters (ação)
O nome da CLI da AWS para essa API é: describe-db-cluster-parameters.
Retorna a lista de parâmetros detalhada de um grupo de parâmetros de cluster de banco de dados.
Solicitação
-
DBClusterParameterGroupName (na CLI:
--db-cluster-parameter-group-name): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome de um grupo de parâmetros de cluster de banco de dados específico do qual retornar detalhes de parâmetros.
Restrições:
-
Se for fornecido, deverá corresponder ao nome de um DBClusterParameterGroup existente.
-
-
Filters (na CLI:
--filters): uma matriz de objetos Filtro.Não há suporte atualmente para esse parâmetro.
-
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
DescribeDBClusterParametersanterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado porMaxRecords. -
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
MaxRecordsespecificado, 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.
-
Source (na CLI:
--source): uma string, do tipo:string(uma string codificada em UTF-8).Um valor que indica para retornar apenas parâmetros para uma origem específica. As origens de parâmetros podem ser
engine,serviceoucustomer.
Resposta
-
Marker: uma string, do tipo:
string(uma string codificada em UTF-8).Um token de paginação opcional fornecido por uma solicitação DescribeDBClusterParameters anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por
MaxRecords. -
Parameters – Uma matriz de objetos Parâmetro.
Fornece uma lista de parâmetros para o grupo de parâmetros de cluster de banco de dados.
DescribeDBClusterParameterGroups (ação)
O nome da CLI da AWS para essa API é: describe-db-cluster-parameter-groups.
Retorna uma lista de descrições de DBClusterParameterGroup. Se um parâmetro DBClusterParameterGroupName for especificado, a lista conterá apenas a descrição do grupo de parâmetros de cluster de banco de dados especificado.
Solicitação
-
DBClusterParameterGroupName (na CLI:
--db-cluster-parameter-group-name): uma string, do tipo:string(uma string codificada em UTF-8).O nome de um grupo de parâmetros de cluster de banco de dados específico do qual retornar detalhes.
Restrições:
-
Se for fornecido, deverá corresponder ao nome de um DBClusterParameterGroup existente.
-
-
Filters (na CLI:
--filters): uma matriz de objetos Filtro.Não há suporte atualmente para esse parâmetro.
-
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
DescribeDBClusterParameterGroupsanterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado porMaxRecords. -
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
MaxRecordsespecificado, um token de paginação chamado de marcador será incluído na resposta para que os resultados restantes possam ser recuperados.Padrão: 100
Restrições: mínimo 20, máximo 100.
Resposta
-
DBClusterParameterGroups – Uma matriz de objetos DBClusterParameterGroup.
Uma lista de grupos de parâmetros de cluster de banco de dados.
-
Marker: uma string, do tipo:
string(uma string codificada em UTF-8).Um token de paginação opcional fornecido por uma solicitação
DescribeDBClusterParameterGroupsanterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado porMaxRecords.
DescribeEngineDefaultParameters (ação)
O nome da CLI da AWS para essa API é: describe-engine-default-parameters.
Retorna as informações sobre o mecanismo padrão e parâmetros do sistema do mecanismo de banco de dados especificado.
Solicitação
-
DBParameterGroupFamily (na CLI:
--db-parameter-group-family): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome da família de grupos de parâmetros de banco de dados.
-
Filters (na CLI:
--filters): uma matriz de objetos Filtro.Sem suporte no momento.
-
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
DescribeEngineDefaultParametersanterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado porMaxRecords. -
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
MaxRecordsespecificado, um token de paginação chamado de marcador será incluído na resposta para que os resultados restantes possam ser recuperados.Padrão: 100
Restrições: mínimo 20, máximo 100.
Resposta
Contém o resultado de uma invocação bem-sucedida da ação DescribeEngineDefaultParameters (ação).
-
DBParameterGroupFamily: uma string, do tipo:
string(uma string codificada em UTF-8).Especifica o nome da família de grupos de parâmetros de banco de dados à qual os parâmetros padrão do mecanismo se aplicam.
-
Marker: uma string, do tipo:
string(uma string codificada em UTF-8).Um token de paginação opcional fornecido por uma solicitação EngineDefaults anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por
MaxRecords. -
Parameters – Uma matriz de objetos Parâmetro.
Contém uma lista de parâmetros padrão do mecanismo.
DescribeEngineDefaultClusterParameters (ação)
O nome da CLI da AWS para essa API é: describe-engine-default-cluster-parameters.
Retorna as informações sobre o mecanismo padrão e os parâmetros do sistema do mecanismo de banco de dados do cluster.
Solicitação
-
DBParameterGroupFamily (na CLI:
--db-parameter-group-family): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome da família de grupos de parâmetros de cluster de banco de dados da qual retornar informações de parâmetros do mecanismo.
-
Filters (na CLI:
--filters): uma matriz de objetos Filtro.Não há suporte atualmente para esse parâmetro.
-
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
DescribeEngineDefaultClusterParametersanterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado porMaxRecords. -
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
MaxRecordsespecificado, um token de paginação chamado de marcador será incluído na resposta para que os resultados restantes possam ser recuperados.Padrão: 100
Restrições: mínimo 20, máximo 100.
Resposta
Contém o resultado de uma invocação bem-sucedida da ação DescribeEngineDefaultParameters (ação).
-
DBParameterGroupFamily: uma string, do tipo:
string(uma string codificada em UTF-8).Especifica o nome da família de grupos de parâmetros de banco de dados à qual os parâmetros padrão do mecanismo se aplicam.
-
Marker: uma string, do tipo:
string(uma string codificada em UTF-8).Um token de paginação opcional fornecido por uma solicitação EngineDefaults anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por
MaxRecords. -
Parameters – Uma matriz de objetos Parâmetro.
Contém uma lista de parâmetros padrão do mecanismo.
Estruturas:
Parâmetro (estrutura)
Especifica um parâmetro.
Campos
-
AllowedValues: é uma string, do tipo:
string(uma string codificada em UTF-8).Especifica o intervalo válido de valores para o parâmetro.
-
ApplyMethod: é um ApplyMethod, do tipo
string: (uma string codificada em UTF-8).Indica quando aplicar atualizações de parâmetros.
-
ApplyType: é uma string, do tipo:
string(uma string codificada em UTF-8).Especifica o tipo de parâmetros específicos do mecanismo.
-
DataType: é uma string, do tipo:
string(uma string codificada em UTF-8).Especifica o tipo de dados válidos para o parâmetro.
-
Description: é uma string, do tipo:
string(uma string codificada em UTF-8).Fornece uma descrição do parâmetro.
-
IsModifiable: é um valor booliano, do tipo:
boolean(um valor booliano (verdadeiro ou falso)).Indica se o parâmetro pode (
true) ou não (false) ser modificado. Alguns parâmetros têm implicações de segurança ou operacionais que os impedem de ser alterados. -
MinimumEngineVersion: é uma string, do tipo:
string(uma string codificada em UTF-8).A versão mais antiga do mecanismo à qual o parâmetro pode ser aplicado.
-
ParameterName: é uma string, do tipo:
string(uma string codificada em UTF-8).Especifica o nome do parâmetro.
-
ParameterValue: é uma string, do tipo:
string(uma string codificada em UTF-8).Especifica o valor do parâmetro.
-
Source: é uma string, do tipo:
string(uma string codificada em UTF-8).Indica a origem do valor do parâmetro.
DBParameterGroup (estrutura)
Contém os detalhes de um grupo de parâmetros de banco de dados do Amazon Neptune.
Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBParameterGroups (ação).
Campos
-
DBParameterGroupArn: é uma string, do tipo:
string(uma string codificada em UTF-8).O nome de recurso da Amazon (ARN) do grupo de parâmetros de banco de dados.
-
DBParameterGroupFamily: é uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome da família de grupos de parâmetros de banco de dados com a qual esse grupo de parâmetros de banco de dados é compatível.
-
DBParameterGroupName: é uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome do grupo de parâmetros de banco de dados.
-
Description: é uma string, do tipo:
string(uma string codificada em UTF-8).Fornece a descrição especificada pelo cliente para esse grupo de parâmetros de banco de dados.
DBParameterGroup é usado como o elemento de resposta para:
DBClusterParameterGroup (estrutura)
Contém os detalhes de um grupo de parâmetros de cluster de banco de dados do Amazon Neptune.
Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBClusterParameterGroups (ação).
Campos
-
DBClusterParameterGroupArn: é uma string, do tipo:
string(uma string codificada em UTF-8).O nome de recurso da Amazon (ARN) do grupo de parâmetros de cluster de banco de dados.
-
DBClusterParameterGroupName: é uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome do parameter group do cluster de banco de dados.
-
DBParameterGroupFamily: é uma string, do tipo:
string(uma string codificada em UTF-8).Fornece o nome da família do parameter group de banco de dados com a qual esse parameter group de cluster de banco de dados é compatível.
-
Description: é uma string, do tipo:
string(uma string codificada em UTF-8).Fornece a descrição especificada pelo cliente para este parameter group do cluster de banco de dados.
DBClusterParameterGroup é usado como o elemento de resposta para:
DBParameterGroupStatus (estrutura)
O status do grupo de parâmetros de banco de dados.
Esse tipo de dados é usado como um elemento de resposta nas seguintes ações:
Campos
-
DBParameterGroupName: é uma string, do tipo:
string(uma string codificada em UTF-8).O nome do grupo de parâmetros de banco de dados.
-
ParameterApplyStatus: é uma string, do tipo:
string(uma string codificada em UTF-8).O status de atualizações de parâmetros.
