RDS Instance Snapshot

5 min

Resumo

Cria ou exclui snaphot do RDS.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
aws_access_key aliases: ec2_access_key, access_key	string		Chave de acesso da AWS. Se não for definido, o valor da variável de ambiente AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY ou EC2_ACCESS_KEY é usado. Se o profile for definido, este parâmetro será ignorado.
aws_ca_bundle	path		A localização de um pacote CA para usar ao validar certificados SSL. Usado apenas para módulos baseados em boto3. Observação: o pacote CA é lido no lado do 'módulo' e pode precisar ser copiado explicitamente do controlador se não for executado localmente.
aws_config	dictionary		Um dicionário para modificar a configuração do botocore. Os parâmetros podem ser encontrados em https://botocore.amazonaws.com/ . Apenas a chave 'user_agent' é usada para módulos boto. Consulte http://boto.cloudhackers.com para obter mais configurações de boto.
aws_secret_key aliases: ec2_secret_key, secret_key	string		Chave secreta da AWS. Se não for definido, o valor da variável de ambiente AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY ou EC2_SECRET_KEY é usado. Se o profile for definido, este parâmetro será ignorado.
db_instance_identifier	string		Identificador de instância do banco de dados. Necessário quando o estado está present.
db_snapshot_identifier - required	string		O snapshot a ser gerenciado.
debug_botocore_endpoint_logs	boolean	Escolhas: - false(default) - true	Use um registrador botocore.endpoint para analisar as chamadas de API "resource:action" exclusivas (em vez de totais) feitas durante uma tarefa, enviando o conjunto para a chave resource_actions nos resultados da tarefa. Use o retorno de chamada aws_resource_action para gerar a lista total feita durante um playbook.
ec2_url	string		URL a ser usada para conectar-se ao EC2 ou à sua nuvem Eucalyptus (por padrão, o módulo usará endpoints do EC2). Ignorado para módulos onde a região é necessária. Deve ser especificado para todos os outros módulos se a região não for usada. Se não for definido, o valor da variável de ambiente EC2_URL, se houver, será usado.
profile aliases: aws_profile	string		Usa um perfil de boto. Funciona apenas com boto >= 2.24.0. O uso de profile sobrescreverá aws_access_key, aws_secret_key e security_token e o suporte para passá-los ao mesmo tempo que o profile foi descontinuado.
purge_tags	boolean	Escolhas: - false - true(default)	Se sim, tags existentese seram apagadas do resource para corresponder exatamente oque é definido pelos parametros de tags. Se o parametro tags não for setado então tags não será modificado.
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. Consulte http://docs.aws.amazon.com
security_token aliases: aws_security_token, access_token	string		Token de segurança AWS STS. Se não for definido, o valor da variável de ambiente AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN será usado. Se o profile for definido, este parâmetro será ignorado.
state	string	Escolhas: - present(default) - absent	tags ditam para aplicar a um snapshot.
tags	dictionary		tags ditam para aplicar a um instantâneo.
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.
wait	boolen	Escolhas: - false(default) - true	Se deve ou não aguardar a criação ou exclusão do instantâneo.
wait_timeout	integer	Default: - 300	quanto tempo antes de esperar desiste, em segundos.

Extende fragmentos da documentação do módulo aws e ec2.

Notas

Se os parâmetros não forem definidos no módulo, as seguintes variáveis de ambiente podem ser usadas em ordem decrescente de precedência:
- AWS_URL ou EC2_URL,
- AWS_PROFILE ou AWS_DEFAULT_PROFILE,
- AWS_ACCESS_KEY_ID ou AWS_ACCESS_KEY ou EC2_ACCESS_KEY,
- AWS_SECRET_ACCESS_KEY ou AWS_SECRET_KEY ou EC2_SECRET_KEY,
- AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN,
- AWS_REGION ou EC2_REGION,
- AWS_CA_BUNDLE
Quando nenhuma credencial é fornecida explicitamente, o AWS SDK (boto3) que o Ansible usa retornará aos seus arquivos de configuração (normalmente ~/.aws/credentials). Consulte https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html para obter mais informações.
Módulos baseados no AWS SDK original (boto) podem ler sua configuração padrão de arquivos diferentes. Consulte https://boto.readthedocs.io/en/latest/boto_config_tut.html para obter mais informações.
AWS_REGION ou EC2_REGION pode ser normalmente usado para especificar a região da AWS, quando necessário, mas isso também pode ser definido nos arquivos de configuração.

Exemplos

- name: Create snapshot
  rds_instance_snapshot:
    db_instance_identifier: new-database
    db_snapshot_identifier: new-database-snapshot

- name: Delete snapshot
  rds_instance_snapshot:
    db_snapshot_identifier: new-database-snapshot
    state: absent

Valores retornados

Chave	Tipo	Retornado quando	Descrição
allocated_storage	integer	Sempre	Quanto armazenamento é alocado em GB.
availability_zone	string	Sempre	Zona de disponibilidade do banco de dados a partir do qual o snapshot foi criado.
db_instance_identifier	string	Sempre	Banco de dados a partir do qual o instantâneo foi criado.
db_snapshot_arn	string	Sempre	Nome de recurso da Amazon para o snapshot.
db_snapshot_identifier	string	Sempre	Nome do snapshot.
dbi_resource_id	string	Sempre	O identificador da instância de banco de dados de origem, que não pode ser alterado e que é exclusivo de uma região da AWS.
encrypted	boolean	Sempre	Se o snapshot é criptografado.
engine	string	Sempre	Mecanismo do banco de dados a partir do qual o snapshot foi criado.
engine_version	string	Sempre	Versão do banco de dados a partir do qual o snapshot foi criado.
iam_database_authentication_enabled	boolean	Sempre	Se a autenticação do banco de dados do IAM está habilitada.
instance_create_time	string	Sempre	Hora de criação da instância a partir da qual o snapshot foi criado.
license_model	string	Sempre	Modelo de licença do banco de dados.
master_username	string	Sempre	Nome de usuário mestre do banco de dados.
option_group_name	string	Sempre	Grupo de opções do banco de dados.
percent_progress	integer	Sempre	Quanto progresso foi feito ao tirar o snapshot. Será 100 para um snapshot disponível.
port	integer	Sempre	Porta na qual o banco de dados está escutando.
processor_features	list / elements=string	Sempre	Lista de recursos do processador do banco de dados.
snapshot_create_time	string	Sempre	Hora de criação do instantâneo.
snapshot_type	string	Sempre	Como o snapshot foi criado (sempre manual para este módulo!).
status	string	Sempre	Status do snapshot.
storage_type	string	Sempre	Tipo de armazenamento do banco de dados.
tags	complex	Sempre	Tags aplicadas ao instantâneo.
vpc_id	string	Sempre	ID da VPC na qual o banco de dados reside.