As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
API de instâncias do Neptune
Ações do:
Estruturas:
CreateDBInstance (ação)
O nome da CLI da AWS para essa API é: create-db-instance.
Cria uma nova instância de banco de dados.
Solicitação
-
AutoMinorVersionUpgrade (na CLI:
--auto-minor-version-upgrade): um BooleanOptional, do tipo:boolean(um valor booliano (verdadeiro ou falso)).Indica que as atualizações de mecanismos menores são aplicadas automaticamente à instância de banco de dados durante a janela de manutenção.
Padrão:
true -
AvailabilityZone (na CLI:
--availability-zone): uma string, do tipo:string(uma string codificada em UTF-8).A zona de disponibilidade do EC2 na qual a instância de banco de dados é criada.
Padrão: uma zona de disponibilidade aleatória e escolhida pelo sistema na região da Amazon do endpoint.
Exemplo:
us-east-1dRestrição: o parâmetro AvailabilityZone não poderá ser especificado se o parâmetro MultiAZ estiver definido como
true. A zona de disponibilidade especificada deve estar na mesma região da Amazon que o endpoint atual. -
BackupRetentionPeriod (na CLI:
--backup-retention-period): um IntegerOptional, do tipo:integer(um valor inteiro assinado de 32 bits).O número de dias durante os quais os backups automatizados são retidos.
Não aplicável. O período de retenção de backups automatizados é gerenciado pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).
Padrão: 1
Restrições:
-
Deve ser um valor de 0 a 35
-
Não poderá ser definido como 0 se a instância de banco de dados for uma origem para réplicas de leitura
-
-
CopyTagsToSnapshot (na CLI:
--copy-tags-to-snapshot): um BooleanOptional, do tipo:boolean(um valor booliano (verdadeiro ou falso)).True para copiar todas as tags da instância de banco de dados para os snapshots da instância de banco de dados. Caso contrário, false. O padrão é falso.
-
DBClusterIdentifier (na CLI:
--db-cluster-identifier): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O identificador do cluster de banco de dados ao qual a instância pertencerá.
Para obter informações sobre como criar com um cluster de banco de dados, consulte CreateDBCluster (ação).
Tipo: String
-
DBInstanceClass (na CLI:
--db-instance-class): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).A capacidade de computação e memória da instância de banco de dados, por exemplo,
db.m4.large. Nem todas as classes de instâncias de banco de dados estão disponíveis em todas as regiões da Amazon. -
DBInstanceIdentifier (na CLI:
--db-instance-identifier): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O DB instance identifier. Este parâmetro é armazenado como uma string com letras minúsculas.
Restrições:
-
Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.
-
O primeiro caractere deve ser uma letra.
-
Não podem terminar com um hífen ou conter dois hífens consecutivos.
Exemplo:
mydbinstance -
-
DBName (na CLI:
--db-name): uma string, do tipo:string(uma string codificada em UTF-8).Sem compatibilidade.
-
DBParameterGroupName (na CLI:
--db-parameter-group-name): uma string, do tipo:string(uma string codificada em UTF-8).O nome do grupo de parâmetros de banco de dados a ser associado a essa instância de banco de dados. Se este argumento for omitido, o DBParameterGroup padrão para o mecanismo especificado será usado.
Restrições:
-
Deve ter de 1 a 255 letras, números ou hifens.
-
O primeiro caractere deve ser uma letra
-
Não podem terminar com um hífen ou conter dois hífens consecutivos
-
-
DBSecurityGroups (na CLI:
--db-security-groups): uma string, do tipo:string(uma string codificada em UTF-8).Uma lista de grupos de segurança de banco de dados a ser associada a essa instância de banco de dados.
Padrão: o grupo de segurança de banco de dados padrão para o mecanismo de banco de dados.
-
DBSubnetGroupName (na CLI:
--db-subnet-group-name): uma string, do tipo:string(uma string codificada em UTF-8).Um grupo de sub-redes de banco de dados a ser associado a essa instância de banco de dados.
Se não houver um grupo de sub-redes de banco de dados, será uma instância de banco de dados que não seja da VPC.
-
DeletionProtection (na CLI:
--deletion-protection): um BooleanOptional, do tipo:boolean(um valor booliano (verdadeiro ou falso)).Um valor que indica se a instância de banco de dados tem a proteção contra exclusão habilitada. O banco de dados não pode ser excluído quando a proteção contra exclusão está habilitada. Por padrão, a proteção contra exclusão fica desabilitada. Consulte Excluir uma instância de banco de dados.
As instâncias de banco de dados em um cluster de banco de dados poderão ser excluídas mesmo quando a proteção contra exclusão estiver ativada no cluster de banco de dados pai.
-
Domain (na CLI:
--domain): uma string, do tipo:string(uma string codificada em UTF-8).Especifica o domínio do Active Directory no qual criar a instância.
-
DomainIAMRoleName (na CLI:
--domain-iam-role-name): uma string, do tipo:string(uma string codificada em UTF-8).Especifique o nome da função do IAM a ser usado ao fazer chamadas de API para o Directory Service.
-
EnableCloudwatchLogsExports (na CLI:
--enable-cloudwatch-logs-exports): uma string, do tipo:string(uma string codificada em UTF-8).A lista de tipos de log que precisam estar habilitados para exportação para o CloudWatch Logs.
-
EnableIAMDatabaseAuthentication (na CLI:
--enable-iam-database-authentication): um BooleanOptional, do tipo:boolean(um valor booliano (verdadeiro ou falso)).Não compatível com o Neptune (ignorado).
-
Engine (na CLI:
--engine): obrigatório: uma string, do tipo:string(uma string codificada em UTF-8).O nome do mecanismo de banco de dados a ser usado para essa instância.
Valores Válidos:
neptune -
EngineVersion (na CLI:
--engine-version): uma string, do tipo:string(uma string codificada em UTF-8).O número da versão do mecanismo de banco de dados a ser usado. Atualmente, a definição desse parâmetro não tem efeito.
-
Iops (na CLI:
--iops): um IntegerOptional, do tipo:integer(um valor inteiro assinado de 32 bits).A quantidade de IOPS (operações de entrada/saída por segundo) provisionadas a serem inicialmente alocadas para a instância de banco de dados.
-
KmsKeyId (na CLI:
--kms-key-id): uma string, do tipo:string(uma string codificada em UTF-8).O identificador da chave do Amazon KMS para uma instância de banco de dados criptografada.
O identificador de chave KMS é o Amazon Resource Name (ARN) da chave de criptografia KMS. Se você estiver criando uma instância de banco de dados com a mesma conta da Amazon que tem a chave de criptografia do KMS usada para criptografar a nova instância de banco de dados, use o alias da chave do KMS em vez do ARN para a chave de criptografia do KM.
Não aplicável. O identificador de chave do KMS é gerenciado pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).
Se o parâmetro
StorageEncryptedfor true e você não especificar o valor para o parâmetroKmsKeyId, o Amazon Neptune usará a chave de criptografia padrão. O Amazon KMS cria a chave de criptografia padrão para a conta da Amazon. A conta da Amazon tem uma chave de criptografia padrão diferente para cada região da Amazon. -
LicenseModel (na CLI:
--license-model): uma string, do tipo:string(uma string codificada em UTF-8).Informações do modelo de licença dessa instância de banco de dados.
Valores válidos:
license-included|bring-your-own-license|general-public-license -
MonitoringInterval (na CLI:
--monitoring-interval): um IntegerOptional, do tipo:integer(um valor inteiro assinado de 32 bits).O intervalo, em segundos, entre pontos quando as métricas de monitoramento avançado são coletadas para a instância de banco de dados. Para desabilitar a coleta de métricas de monitoramento avançado, especifique 0. O padrão é 0.
Se
MonitoringRoleArnfor especificado, você também deverá definirMonitoringIntervalcomo um valor diferente de 0.Valores Válidos:
0, 1, 5, 10, 15, 30, 60 -
MonitoringRoleArn (na CLI:
--monitoring-role-arn): uma string, do tipo:string(uma string codificada em UTF-8).O ARN da função do IAM que permite que o Neptune envie métricas de monitoramento avançado para o Amazon CloudWatch Logs. Por exemplo,
arn:aws:iam:123456789012:role/emaccess.Se
MonitoringIntervalestiver definido com um valor diferente de 0, você deverá fornecer um valor deMonitoringRoleArn. -
MultiAZ (na CLI:
--multi-az): um BooleanOptional, do tipo:boolean(um valor booliano (verdadeiro ou falso)).Especifica se a instância de banco de dados é uma implantação Multi-AZ. Não será possível definir o parâmetro AvailabilityZone se o parâmetro MultiAZ estiver definido como true.
-
Port (na CLI:
--port): um IntegerOptional, do tipo:integer(um valor inteiro assinado de 32 bits).O número da porta na qual o banco de dados aceita conexões.
Não aplicável. A porta é gerenciada pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).
Padrão:
8182Tipo: inteiro
-
PreferredBackupWindow (na CLI:
--preferred-backup-window): uma string, do tipo:string(uma string codificada em UTF-8).O intervalo de tempo diário durante o qual os backups automatizados são criados.
Não aplicável. O intervalo de tempo diário para a criação de backups automatizados é gerenciado pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).
-
PreferredMaintenanceWindow (na CLI:
--preferred-maintenance-window): uma string, do tipo:string(uma string codificada em UTF-8).O intervalo de tempo em cada semana durante o qual ocorre a manutenção do sistema, no Tempo Universal Coordenado (UTC).
Formato:
ddd:hh24:mi-ddd:hh24:miO padrão é uma janela de trinta minutos selecionada aleatoriamente em um bloco de tempo de oito horas para cada região da Amazon, ocorrendo em um dia aleatório da semana.
Dias válidos: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Restrições: janela mínima de 30 minutos.
-
PromotionTier (na CLI:
--promotion-tier): um IntegerOptional, do tipo:integer(um valor inteiro assinado de 32 bits).Um valor que especifica a ordem na qual uma réplica de leitura é promovida à instância principal após uma falha da instância principal existente.
Padrão: 1
Valores válidos: 0 a 15
-
PubliclyAccessible (na CLI:
--publicly-accessible): um BooleanOptional, do tipo:boolean(um valor booliano (verdadeiro ou falso)).Este sinalizador não deve mais ser usado.
-
StorageEncrypted (na CLI:
--storage-encrypted): um BooleanOptional, do tipo:boolean(um valor booliano (verdadeiro ou falso)).Especifica se a instância de banco de dados é criptografada.
Não aplicável. A criptografia para instâncias de banco de dados é gerenciada pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).
Padrão: False
-
StorageType (na CLI:
--storage-type): uma string, do tipo:string(uma string codificada em UTF-8).Não aplicável. No Neptune, o tipo de armazenamento é gerenciado no nível do cluster de banco de dados.
-
Tags (na CLI:
--tags): uma matriz de objetos Tag.As tags a serem atribuídas à nova instância.
-
TdeCredentialArn (na CLI:
--tde-credential-arn): uma string, do tipo:string(uma string codificada em UTF-8).O ARN do armazenamento de chaves ao qual associar a instância para a criptografia TDE.
-
TdeCredentialPassword (na CLI:
--tde-credential-password): uma SensitiveString, do tipo:string(uma string codificada em UTF-8).A senha para o determinado ARN do armazenamento de chaves para acessar o dispositivo.
-
Timezone (na CLI:
--timezone): uma string, do tipo:string(uma string codificada em UTF-8).O fuso horário da instância de banco de dados.
-
VpcSecurityGroupIds (na CLI:
--vpc-security-group-ids): uma string, do tipo:string(uma string codificada em UTF-8).Uma lista de grupos de segurança da VPC do EC2 a ser associada a essa instância de banco de dados.
Não aplicável. A lista de grupos de segurança da VPC do EC2 associada é gerenciada pelo cluster de banco de dados. Para obter mais informações, consulte CreateDBCluster (ação).
Padrão: o grupo de segurança da VPC do EC2 padrão para a VPC do grupo de sub-redes de banco de dados.
Resposta
Contém os detalhes de uma instância de banco de dados do Amazon Neptune.
Esse tipo de dados é usado como um elemento de resposta na ação DescribeDBInstances (ação).
-
AutoMinorVersionUpgrade: um valor booliano, do tipo:
boolean(um valor booliano (verdadeiro ou falso)).Indica que os patches de versões secundárias são aplicados automaticamente.
-
AvailabilityZone: uma string, do tipo:
string(uma string codificada em UTF-8).Especifica o nome da zona de disponibilidade na qual a instância de banco de dados está localizada.
-
BackupRetentionPeriod: um valor inteiro, do tipo:
integer(um valor inteiro assinado de 32 bits).Especifica o número de dias durante os quais os DB snapshots automáticos são retidos.
-
CACertificateIdentifier: uma string, do tipo:
string(uma string codificada em UTF-8).O identificador do certificado da CA para essa instância DB.
-
CopyTagsToSnapshot: um valor booliano, do tipo:
boolean(um valor booliano (verdadeiro ou falso)).Especifica se as tags atribuídas são copiadas da instância de banco de dados nos snapshots da instância de banco de dados.
-
DBClusterIdentifier: uma string, do tipo:
string(uma string codificada em UTF-8).Se a instância de banco de dados for membro de um cluster de banco de dados, conterá o nome do cluster de banco de dados do qual a instância de banco de dados é membro.
-
DBInstanceArn: uma string, do tipo:
string(uma string codificada em UTF-8).O nome de recurso da Amazon (ARN) da instância de banco de dados.
-
DBInstanceClass: uma string, do tipo:
string(uma string codificada em UTF-8).Contém o nome da classe de capacidade de computação e memória da instância de banco de dados.
-
DBInstanceIdentifier: uma string, do tipo:
string(uma string codificada em UTF-8).Contém um identificador de banco de dados fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica uma instância de banco de dados.
-
DbInstancePort: um valor inteiro, do tipo:
integer(um valor inteiro assinado de 32 bits).Especifica a porta na qual a instância de banco de dados escuta. Se a instância de banco de dados fizer parte de um cluster de banco de dados, isso poderá ser uma porta diferente da porta do cluster de banco de dados.
-
DBInstanceStatus: uma string, do tipo:
string(uma string codificada em UTF-8).Especifica o estado atual desse banco de dados.
-
DbiResourceId: uma string, do tipo:
string(uma string codificada em UTF-8).O identificador exclusivo e imutável da região da Amazon da instância de banco de dados. Esse identificador é encontrado nas entradas de log do Amazon CloudTrail sempre que a chave do Amazon KMS da instância de banco de dados é acessada.
-
DBName: uma string, do tipo:
string(uma string codificada em UTF-8).O nome do banco de dados.
-
DBParameterGroups: um array de objetos DBParameterGroupStatus.
Fornece a lista de grupo de parâmetros de banco de dados aplicados a essa instância de banco de dados.
-
DBSecurityGroups: um array de objetos DBSecurityGroupMembership.
Fornece a lista de elementos do grupo de segurança de banco de dados que contém somente os subelementos
DBSecurityGroup.NameeDBSecurityGroup.Status. -
DBSubnetGroup: um objeto DBSubnetGroup.
Especifica informações sobre o grupo de sub-redes associado à instância de banco de dados, incluindo o nome, a descrição e as sub-redes no grupo de sub-redes.
-
DeletionProtection: um BooleanOptional, do tipo:
boolean(um valor booliano (verdadeiro ou falso)).Indica se a instância de banco de dados tem a proteção contra exclusão ativada. A instância não poderá ser excluída quando a proteção contra exclusão estiver ativada. Consulte Excluir uma instância de banco de dados.
-