RDS Instance

5 min

Resumo

Crie, modifique e exclua instâncias do AWS RDS.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
allocated_storage	integer		A quantidade de armazenamento (em gibibytes) a ser alocada para a instância de banco de dados.
allow_major_version_upgrade	boolean	Escolhas: - false (default) - true	Se deve permitir atualizações de versão principal.
apply_immediately	boolean	Escolhas: - false (default) - true	Um valor que especifica se a modificação de um cluster com new_db_instance_identifier e master_user_password deve ser aplicada o mais rápido possível, independentemente da configuração do parâmetro preferred_maintenance_window. Se false, as alterações serão aplicadas durante a próxima janela de manutenção.
auto_minor_version_upgrade	boolean	Escolhas: - false (default) - true	Se as atualizações de versão secundária são aplicadas automaticamente à instância de banco de dados durante a janela de manutenção.
availability_zone aliases: [az, zone]	string		Uma lista de zonas de disponibilidade do EC2 nas quais as instâncias no cluster de banco de dados podem ser criadas. Pode ser usada ao criar um cluster ou ao restaurar do S3 ou de um snapshot. Mutuamente exclusivo com multi_az.
backup_retention_period	integer		Número de dias em que os backups automatizados são retidos. Quando definido como 0, os backups automatizados serão desativados. (Não aplicável se a instância de banco de dados for uma fonte para ler réplicas) Pode ser usado ao criar um novo cluster, ao restaurar do S3 ou ao modificar um cluster.
ca_certificate_identifier	string		Identificador do certificado de CA para a instância de banco de dados.
character_set_name	string		Conjunto de caracteres a ser associado ao cluster de banco de dados.
copy_tags_to_snapshot	boolean	Escolhas: - false (default) - true	Se deve ou não copiar todas as tags da instância de banco de dados para snapshots da instância. Ao criar inicialmente uma instância de banco de dados, a API do RDS assume como padrão false se não for especificado.
creation_source	string	Escolhas: - snapshot - s3 - instance	Qual fonte usar ao restaurar de um modelo (uma instância existente, bucket do S3 ou snapshot).
db_cluster_identifier aliases: [cluster_id]	string		O identificador do cluster de banco de dados (em letras minúsculas) ao qual adicionar a instância de banco de dados aurora. O identificador deve conter de 1 a 63 letras, números ou hífens e o primeiro caractere deve ser uma letra e não pode terminar em hífen ou conter hífens consecutivos.
db_instance_class aliases: [class, instance_type]	string		A capacidade de computação e memória da instância de banco de dados, por exemplo db.t2.micro.
db_instance_identifier - required aliases: [instance_id, id]	string		O identificador da instância de banco de dados (minúsculas). O identificador deve conter de 1 a 63 letras, números ou hífens e o primeiro caractere deve ser uma letra e não pode terminar em hífen ou conter hífens consecutivos.
db_name	string		O nome do seu banco de dados. Se um nome não for fornecido, o Amazon RDS não criará um banco de dados.
db_parameter_group_name	string		O nome do grupo de parâmetros de banco de dados a ser associado a esta instância de banco de dados. Ao criar a instância de banco de dados, se esse argumento for omitido, o DBParameterGroup padrão para o mecanismo especificado será usado.
db_security_groups	list / elements=string		(plataforma EC2-Classic) Uma lista de grupos de segurança de banco de dados a serem associados a esta instância de banco de dados.
db_snapshot_identifier	string		O identificador do instantâneo de banco de dados a ser restaurado se estiver usando creatation_source=snapshot.
db_subnet_group_name aliases: [subnet_group]	string		O nome do grupo de sub-rede de banco de dados a ser usado para a instância de banco de dados.
domain	string		O domínio do Active Directory no qual restaurar a instância.
domain_iam_role_name	string		O nome da função do IAM a ser usada ao fazer chamadas de API para o serviço de diretório.
enable_cloudwatch_logs_exports aliases: [cloudwatch_log_exports]	list / elements=string		Uma lista de tipos de log que precisam ser habilitados para exportação para o CloudWatch Logs.
enable_iam_database_authentication	boolean	Escolhas: - false (default) - true	Habilite o mapeamento de contas do AWS Identity and Access Management (IAM) para contas de banco de dados. Se essa opção for omitida ao criar o cluster, o Amazon RDS a definirá como False.
enable_performance_insights	boolean	Escolhas: - false (default) - true	Se deve habilitar o Performance Insights para a instância de banco de dados.
engine	string	Escolhas: - 'aurora' - 'aurora-mysql' - 'aurora-postgresql' - 'mariadb' - 'mysql' - 'oracle-ee' - 'oracle-ee-cdb' - 'oracle-se2' - 'oracle-se2-cdb' - 'postgres' - 'sqlserver-ee' - 'sqlserver-se' - 'sqlserver-ex' - 'sqlserver- web'	Nome do mecanismo de banco de dados a ser usado para esta instância. Isso é necessário para se criar uma instância. As escolhas válidas são aurora \| aurora-mysql \| aurora-postgresql \| mariadb \| mysql \| oracle-ee \| oracle-se \| oracle-se1 \| oracle-se2 \| postgres \| sqlserver-ee \| sqlserver-ex \| sqlserver-se \| sqlserver-web.
engine_version	string		Número da versão do mecanismo de banco de dados a ser usado. Para o Aurora MySQL, pode ser 5.6.10a , 5.7.12. Ou por exemplo o Aurora PostgreSQL, 9.6.3.
final_db_snapshot_identifier aliases: [final_snapshot_identifier]	string		O identificador de snapshot de instância de banco de dados do novo snapshot de instância de banco de dados criado quando skip_final_snapshot é falso.
force_failover	boolean	Escolhas: - false (default) - true	Defina como true para conduzir a reinicialização por meio de um failover do MultiAZ.
force_update_password	boolean	Escolhas: - false (default) - true	Defina como True para atualizar a senha do cluster com master_user_password. Como não é possível comparar senhas para determinar se elas precisam ser atualizadas, isso é definido como False por padrão para permitir idempotência.
iops	integer		O valor de IOPS provisionadas (operações de E/S por segundo). Só é definido quando o tipo de armazenamento é definido como io1.
kms_key_id	string		O ARN do identificador de chave do AWS KMS para uma instância de banco de dados criptografada. Se você estiver criando uma instância de banco de dados com a mesma conta da AWS que possui a chave de criptografia KMS usada para criptografar a nova instância de banco de dados, poderá usar o alias da chave KMS em vez do ARN da chave de criptografia KM. Se storage_encrypted for true ee essa opção não for fornecida, a chave de criptografia padrão será usada.
license_model	string		O modelo de licença para a instância de banco de dados. Várias opções são license-included, bring-your-own-license e general-public-license. Essa opção também pode ser omitida para um valor padrão aceito.
master_user_password aliases: [password]	string		Uma senha de 8 a 41 caracteres para o usuário do banco de dados mestre. A senha pode conter qualquer caractere ASCII imprimível, exceto "/", """ ou "@". Para modificar a senha, use force_password_update. Use apply_immediately para alterar a senha imediatamente, caso contrário, ela será atualizada durante a próxima janela de manutenção.
master_username aliases: [username]	string		O nome do usuário mestre do cluster de banco de dados. Deve ter de 1 a 16 letras ou números e começar com uma letra.
max_allocated_storage	integer		O limite superior para o qual o Amazon RDS pode dimensionar automaticamente o armazenamento da instância de banco de dados.
monitoring_interval	integer		O intervalo, em segundos, quando as métricas do Enhanced Monitoring são coletadas para a instância de banco de dados. Para desabilitar a coleta de métricas, especifique 0. O padrão do Amazon RDS é 0 se omitido ao criar inicialmente uma instância de banco de dados.
monitoring_role_arn	string		O ARN da função do IAM que permite que o RDS envie métricas de monitoramento aprimoradas ao Amazon CloudWatch Logs.
multi_az	boolean	Escolhas: - false (default) - true	Especifica se a instância de banco de dados é uma implantação Multi-AZ. Mutuamente exclusivo com availability_zone.
new_db_instance_identifier aliases: [new_instance_id, new_id]	string		O novo identificador de cluster de banco de dados (em letras minúsculas) para o cluster de banco de dados ao renomear uma instância de banco de dados. O identificador deve conter de 1 a 63 letras, números ou hífens e o primeiro caractere deve ser uma letra e não pode terminar em hífen ou conter hífens consecutivos. Use apply_immediately para renomear imediatamente, caso contrário, ele será atualizado durante a próxima janela de manutenção.
option_group_name	string		O grupo de opções a ser associado à instância de banco de dados.
performance_insights_kms_key_id	string		O identificador de chave do AWS KMS (ARN, nome ou alias) para criptografia de dados do Performance Insights.
performance_insights_retention_period	integer		A quantidade de tempo, em dias, para reter os dados do Performance Insights. Os valores válidos são 7 ou 731.
port	integer		O número da porta na qual as instâncias aceitam conexões.
preferred_backup_window aliases: [backup_window]	string		O intervalo de tempo diário (em UTC) de pelo menos 30 minutos, durante o qual os backups automatizados são criados se os backups automatizados estiverem ativados usando backup_retention_period. A opção precisa estar no formato "hh24:mi-hh24:mi" e não entrar em conflito com preferred_maintenance_window.
preferred_maintenance_window aliases: [maintenance_window]	string		O intervalo de tempo semanal (em UTC) de pelo menos 30 minutos, durante o qual a manutenção do sistema pode ocorrer. A opção deve estar no formato "ddd:hh24:mi-ddd:hh24:mi" onde ddd é um de Seg, Ter, Qua, Qui, Sex, Sáb, Dom.
processor_features (Possíveis valores)	dictionary		Um dicionário de pares Nome, Valor para indicar o número de núcleos de CPU e o número de threads por núcleo para a classe de instância de banco de dados da instância de banco de dados. Os nomes são threadsPerCore e coreCount. Defina esta opção como um dicionário vazio para usar os recursos padrão do processador.
promotion_tier	string		Um número inteiro que especifica a ordem em que uma réplica do Aurora é promovida para a instância primária após uma falha da instância primária existente.
publicly_accessible	boolean	Escolhas: - false (default) - true	Especifica as opções de acessibilidade para a instância de banco de dados. Um valor true especifica uma instância voltada para a Internet com um nome DNS que pode ser resolvido publicamente, que é resolvido para um endereço IP público. Um valor false especifica uma instância interna com um nome DNS que resolve para um endereço IP privado.
purge_cloudwatch_logs_exports	boolean	Escolhas: - false - true (default)	Defina como False para reter quaisquer logs do cloudwatch habilitados que não estejam especificados na tarefa e estejam associados à instância.
purge_security_groups	boolean	Escolhas: - false - true (default)	Defina como False para reter quaisquer grupos de segurança ativados que não estejam especificados na tarefa e estejam associados à instância. Pode ser aplicado a vpc_security_group_ids e db_security_groups
purge_tags	boolean	Escolhas: - false - true (default)	Defina como False para reter quaisquer tags que não estejam especificadas na tarefa e estejam associadas à instância.
read_replica	boolean	Escolhas: - false (default) - true	Defina como False para promover um cluster de réplica de leitura ou true para criar um. Ao criar uma réplica de leitura, o creation_source deve ser definido como 'instance' ou não fornecido. source_db_instance_identifier precisa receber essa opção.
region aliases: [aws_region, ec2_region]	string		A região da AWS a ser usada. Se não for especificado, o valor da variável de ambiente AWS_REGION ou EC2_REGION, se houver, será usado.
restore_time	string		Se estiver usando creation_source=instance, isso indica a data e hora UTC para restaurar da instância de origem. Por exemplo, "2009-09-07T23:45:00Z". Como alternativa, pode ser definido use_latest_restore_time=True.Somente um de use_latest_restorable_time e restore_time pode ser fornecido.
s3_bucket_name	string		Nome do bucket do Amazon S3 que contém os dados usados para criar a instância de banco de dados da Amazon.
s3_ingestion_role_arn	string		Nome de recurso da Amazon (ARN) da função AWS Identity and Access Management (IAM) que autoriza o Amazon RDS a acessar o bucket do Amazon S3 em seu nome.
s3_prefix	string		Prefixo para todos os nomes de arquivo que contêm os dados usados para criar a instância de banco de dados da Amazon. Se você não especificar um valor SourceS3Prefix, a instância de banco de dados do Amazon será criada usando todos os arquivos no bucket do Amazon S3.
security_token aliases: [aws_security_token, access_token]	string		Token de segurança do AWS STS. Se não for definido, o valor da variável de ambiente AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN será usado. Se perfil for definido, esse parâmetro será ignorado.
skip_final_snapshot	boolean	Escolhas: - false (default) - true	Se um snapshot de cluster de banco de dados final é criado antes que o cluster de banco de dados seja excluído. Se for falso, final_db_snapshot_identifier deve ser fornecido.
snapshot_identifier	string		O ARN do snapshot de banco de dados a ser restaurado ao usar creation_source=snapshot.
source_db_instance_identifier	string		O identificador ou ARN da instância de banco de dados de origem da qual restaurar ao criar uma réplica de leitura ou ativar uma instância de banco de dados point-in-time usando creation_source=instance. Se o banco de dados de origem não estiver na mesma região, deve ser um ARN.
source_engine	string	Escolhas: - mysql	O identificador do mecanismo de banco de dados do qual foi feito backup para criar os arquivos armazenados no bucket do Amazon S3.
source_engine_version	string		A versão do banco de dados a partir da qual os arquivos de backup foram criados.
source_region	string		A região da instância de banco de dados a partir da qual a réplica é criada.
state	string	Escolhas: - present - absent - terminated - running - started - stopped - rebooted - restarted	Se a instância deve existir ou não. restarted não é idempotente e deixará a instância de banco de dados em estado de execução e a iniciará antes de reinicializar se tiver sido interrompida. present deixará a instância de banco de dados no estado atual em execução/parada (executando se estiver criando a instância de banco de dados). state=running e state=started são sinônimos, assim como state=rebooted e state=restarted. Observação - reinicializar a instância não é idempotente.
storage_encrypted	boolean	Escolhas: - false (default) - true	Se a instância de banco de dados está criptografada.
storage_type	string	Escolhas: - standard - gp2 - io1	O tipo de armazenamento a ser associado à instância de banco de dados. storage_type não se aplica a instâncias de banco de dados do Aurora.
tags	dictionary		Um dicionário de pares de valores-chave para atribuir o cluster de banco de dados.
tde_credential_arn aliases: [transparent_data_encryption_arn]	string		O ARN do armazenamento de chaves ao qual associar a instância para Transparent Data Encryption. Isso é compatível com instâncias de banco de dados Oracle ou SQL Server e pode ser usado em conjunto com storage_encrypted, embora possa afetar um pouco o desempenho do seu banco de dados.
tde_credential_password aliases:[transparent_data_encryption_password]	string		A senha para o ARN fornecido do armazenamento de chaves para acessar o dispositivo.
timezone	string		Fuso horário da instância de banco de dados.
use_latest_restorable_time aliases: [restore_from_latest]	boolean	Escolhas: - false (default) - true	Se a instância de banco de dados deve ser restaurada para o último horário de backup restaurável.
validate_certs	boolean	Escolhas: - false - true (default)	Quando definido como "false", os certificados SSL não serão validados para comunicação com as APIs da AWS.
vpc_security_group_ids	list / elements=string		Uma lista de grupos de segurança de VPC do EC2 para associar ao cluster de banco de dados.
wait	boolean	Escolhas: - false - true (default)	Se deve esperar que o cluster esteja disponível, parado ou excluído. Mais tarde, uma opção wait_timeout pode ser adicionada. Após cada chamada de API para criar/modificar/excluir a instância, um waiter é usado com um atraso de 60 segundos 30 vezes até que a instância atinja o estado esperado (disponível/interrompido/excluído). O tempo total da tarefa também pode ser influenciado por AWSRetry, que ajuda a estabilizar se a instância estiver em um estado inválido para operar (como se você tentar pará-la quando estiver no processo de reinicialização). Se definir isso como tentativas e atrasos de tarefas falsas, pode fazer com que a execução do seu playbook lide melhor com os tempos limite para grandes modificações.

Subcampos da opção processor_features

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
coreCount	string		Número de núcleos de CPU.
threadsPerCore	string		Número de threads por núcleo.

Exemplos

# Notas: Esses exemplos não definem detalhes de autenticação, consulte o Guia AWS para obter detalhes.
# Exemplo: Crie uma instância mínima do aurora na VPC padrão e no grupo de sub-rede padrão
- rds_instance:
    engine: aurora
    db_instance_identifier: atmosphere-test-aurora-db-instance
    instance_type: db.t2.small
    password: "{{ password }}"
    username: "{{ username }}"
    cluster_id: atmosphere-test-cluster  # This cluster must exist - see rds_cluster to manage it

# Exemplo: Crie uma instância de banco de dados usando a chave de criptografia padrão do AWS KMS
- rds_instance:
    id: test-encrypted-db
    state: present
    engine: mariadb
    storage_encrypted: True
    db_instance_class: db.t2.medium
    username: "{{ username }}"
    password: "{{ password }}"
    allocated_storage: "{{ allocated_storage }}"

# Exemplo: Remova a instância de banco de dados sem um snapshot final
- rds_instance:
    id: "{{ instance_id }}"
    state: absent
    skip_final_snapshot: True

# Exemplo: Remova a instância de banco de dados com um snapshot final
- rds_instance:
    id: "{{ instance_id }}"
    state: absent
    final_snapshot_identifier: "{{ snapshot_id }}"

# Exemplo: Adicionar um novo grupo de segurança sem purge
- rds_instance:
    id: "{{ instance_id }}"
    state: present
    vpc_security_group_ids:
      - sg-0be17ba10c9286b0b
    purge_security_groups: false
    register: result

Valores retornados

Chave	Tipo	Retornado quando	Descrição
allocated_storage	integer	Sempre	Tamanho de armazenamento alocado em gibibytes. Isso é sempre 1 para mecanismos de banco de dados aurora.
auto_minor_version_upgrade	boolean	Sempre	Se pequenas atualizações de mecanismo são aplicadas automaticamente à instância de banco de dados durante a janela de manutenção.
availability_zone	string	Sempre	Zona de disponibilidade da instância de banco de dados.
backup_retention_period	integer	Sempre	Número de dias durante os quais os backups automatizados são retidos.
ca_certificate_identifier	string	Sempre	Identificador do certificado de CA para a instância de banco de dados.
copy_tags_to_snapshot	boolean	Sempre	Se as tags são copiadas da instância de banco de dados para snapshots da instância de banco de dados.
db_instance_arn	string	Sempre	Nome de recurso da Amazon (ARN) para a instância de banco de dados.
db_instance_class	string	Sempre	Nome da classe de capacidade de computação e memória da instância de banco de dados.
db_instance_identifier	string	Sempre	Identificador da instância de banco de dados.
db_instance_port	integer	Sempre	A porta na qual a instância de banco de dados atende.
db_instance_status	string	Sempre	Estado atual deste banco de dados.
db_parameter_groups	complex	Sempre	A lista de grupos de parâmetros de banco de dados aplicados a esta instância de banco de dados.
db_security_groups	list / elements=string	Sempre	Uma lista de grupos de segurança de banco de dados associados a esta instância de banco de dados.
db_subnet_group	complex	Sempre	Grupo de sub-redes associado à instância de banco de dados.
dbi_resource_id	string	Sempre	Identificador imutável e exclusivo da região da AWS para a instância de banco de dados.
domain_memberships	list / elements=string	Sempre	Os registros de associação de domínio do Active Directory associados à instância de banco de dados.
endpoint	complex	Sempre	O endpoint da conexão.
engine	string	Sempre	A versão do mecanismo de banco de dados.
engine_version	string	Sempre	A versão do mecanismo de banco de dados.
iam_database_authentication_enabled	boolean	Sempre	Se o mapeamento de contas do AWS Identity and Access Management (IAM) para contas de banco de dados está habilitado.
instance_create_time	string	Sempre	A data e hora em que a instância de banco de dados foi criada.
kms_key_id	string	Quando storage_encrypted é definido como true.	Identificador de chave do AWS KMS para a instância de banco de dados criptografada quando storage_encrypted for true.
latest_restorable_time	string	Sempre	A última hora em que um banco de dados pode ser restaurado com restauração pontual.
license_model	string	Sempre	As informações do modelo de licença para esta instância de banco de dados.
master_username	string	Sempre	Nome de usuário mestre da instância de banco de dados.
max_allocated_storage	integer	Quando o armazenamento alocado máximo é definido.	Limite superior para o qual o Amazon RDS pode dimensionar automaticamente o armazenamento da instância de banco de dados.
monitoring_interval	integer	Sempre	O intervalo, em segundos, entre os pontos quando as métricas do Enhanced Monitoring são coletadas para a instância de banco de dados. 0 significa que a coleta de métricas do Enhanced Monitoring está desabilitada.
multi_az	boolean	Sempre	Se a instância de banco de dados é uma implantação Multi-AZ.
option_group_memberships	complex	Sempre	A lista de associações de grupo de opções para esta instância de banco de dados.
pending_modified_values	complex	Sempre	As alterações na instância de banco de dados que estão pendentes.
performance_insights_enabled	boolean	Sempre	True se o Performance Insights estiver habilitado para a instância de banco de dados e, caso contrário, false.
preferred_backup_window	string	Sempre	O intervalo de tempo diário durante o qual os backups automatizados são criados se os backups automatizados estiverem ativados.
preferred_maintenance_window	string	Sempre	O intervalo de tempo semanal (em UTC) durante o qual a manutenção do sistema pode ocorrer.
publicly_accessible	boolean	Sempre	True para uma instância voltada para a Internet com um nome DNS que pode ser resolvido publicamente, False para indicar uma instância interna com um nome DNS que resolve para um endereço IP privado.
read_replica_db_instance_identifiers	list / elements=string	Sempre	Identificadores das réplicas de leitura associadas a esta instância de banco de dados.
storage_encrypted	boolean	Sempre	Se a instância de banco de dados está criptografada.
storage_type	string	Sempre	Tipo de armazenamento a ser associado à instância de banco de dados.
tags	complex	Sempre	Um dicionário de tags associadas à instância de banco de dados.
vpc_security_groups	complex	Sempre	Uma lista de elementos do security group da VPC aos quais a instância de banco de dados pertence.