RDS Snapshot Info

7 min

Resumo

Obtem informções sobre um ou mais snapshots do RDS.Esses podem ser snapshots não agrupados ou snapshots de DBs agrupados (Aurora).
Informações sobre o snapshto de Aurora pode ser obtido se nenhum parametro indentificador é passado ou se um dos parametros de agrupamentos foi fornecido.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
apply_immediately	boolean	Escolhas: - no(default) - yes	Quando apply_immediately=true, as modificações serão aplicadas o mais breve possivel ao invéz de esperar pela próxima manutenção. Usado somente quando command=modify.
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 perfil for definido, este parâmetro será ignorado.Passar as opções aws_access_key e de perfil ao mesmo tempo se tornou obsoleto e as opções se tornarão mutuamente exclusivas após 01/06/2022.
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/v1/documentation/api/latest/reference/config.html#botocore.config.Config .Apenas a chave 'user_agent' é usada para módulos boto. Consulte http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto 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 perfil for definido, este parâmetro será ignorado.Passar as opções aws_secret_key e de perfil ao mesmo tempo se tornou obsoleto e as opções se tornarão mutuamente exclusivas após 01/06/2022.
db_cluster_identifier	string		Nome do cluster RDS para encontrar seus snapshots. Mutualmente exclusivo com db_snapshot_identifier, db_instance_identifiere db_cluster_snapshot_identifier
db_cluster_snapshot_identifier	string		Nome de um snapshot de um cluster RDS Mutalmente exclusivo com db_instance_identifier, db_snapshot_identifier e db_cluster_identifier
db_instance_identifier	string		Nome da instacia RDS para encontrar seus snapshots. Mutualmente exclusivo com db_snapshot_identifier, db_cluster_identifier e db_cluster_snapshot_identifier
db_snapshot_identifier	string		Nome de um snapshot de uma RDS desagrupada (unclustered). Mutualmente exclusivo entre db_instance_identifier, db_cluster_identifier e db_cluster_snapshot_identifier
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 do total): feitas durante uma tarefa, enviando o conjunto para a chave resource_actions nos resultados da tarefa.
ec2_url aliases: aws_endpoint_url, endpoint_url	string		Url a ser usado para se conectar ao EC2 ou à nuvem Eucalyptus (por padrão, o módulo usará endpoints 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.aws_access_key , aws_secret_key e security_token serão mutuamente exclusivos com o perfil após 2022-06-01.
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/general/latest/gr/rande.html#ec2_region
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 perfil for definido, este parâmetro será ignorado.Passar as opções security_token e profile ao mesmo tempo se tornou obsoleto e as opções serão mutuamente exclusivas após 2022-06-01.
snapshot_type	string	Escolhas: automated manual shared public	Tipo de snapshot para ser encontrado. Por padrão ambos snapshots automared e manual serão retornados
validate_certs	boolean	Escolhas: - false - true(default)	Quando definido como "não", os certificados SSL não serão validados para versões boto> = 2.6.0.

Documentação nos módulos aws e ec2.

Notas

Nota

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_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
O Atmosphere usa o arquivo de configuração boto (geralmente ~/.boto) se nenhuma credencial for fornecida. Veja https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION ou EC2_REGION geralmente podem ser usados para especificar a região da AWS, quando necessário, mas isso também pode ser configurado no arquivo de configuração boto.

Exemplos

- name: Get information about an snapshot
  community.aws.rds_snapshot_info:
    db_snapshot_identifier: snapshot_name
  register: new_database_info

- name: Get all RDS snapshots for an RDS instance
  community.aws.rds_snapshot_info:
    db_instance_identifier: helloworld-rds-master

Valores retornados

Chave	Tipo	Escolhas \| Valor Padrão	Descrição
cluster_snapshots	complexo	sempre	Lista de snapshots de clusters.
snapshots	complexo	quando os parametros de cluster não são fornecidos	Lista de snapshots de não clusters

Subcampos de cluster snapshots

Chave	Tipo	Retornado quando	Descrição
allocated_storage	interger	sempre	O quanto de armazenamento está alocado em GB
availability_zone	string	sempre	Zonas disponíveis do databse do qual o snapshot foi criado.
cluster_create_time	string	sempre	Dia e hora que o cluster foi criado
db_instance_identifier	string	sempre	Database do qual o snapshot foi criado
db_snapshot_arn	string	sempre	Amazon Resouce Name para o snapshot
db_snapshot_identifier	string	sempre	Nome do snapshot
engine	string	sempre	Engine do databse no qual o snapshot foi criado.
engine_version	string	sempre	Vesão do databse no qual o snapshot foi criado.
iam_database_authentication_enabled	boolean	sempre	Se a autenticação do database está acionado ou não
kms_key_id	string	sempre	ID da chave KMS encriptando o snapshot
license_model	string	sempre	Modelo de licensa do database
master_username	string	sempre	Username master do database
option_group_name	string	sempre	Opção de grupo do database
port	interger	sempre	Porta no qual a database está escutando
percent_progress	interger	sempre	Progresso em porcentagem de um snapshot
snapshot_create_time	string	sempre	Tempo de criação de um snapshot
snapshot_type	string	sempre	Como o snapshot foi criado (sempre manual para esse modulo).
status	string	sempre	Status do snapshot
storage_encrypted	boolean	sempre	Se o snapshot está encriptado ou não
tags	complex	sempre	Tags aplicadas no snapshot
vpc_id	string	sempre	ID do VPC no qual o DB está alocado.

Subcampos de snapshots

Chave	Tipo	Retornado quando	Descrição
allocated_storage	interger	sempre	O quanto de armazenamento está alocado em GB
availability_zone	string	sempre	Zonas disponíveis do databse do qual o snapshot foi criado.
db_instance_identifier	string	sempre	Database do qual o snapshot foi criado
db_snapshot_arn	string	sempre	Amazon Resouce Name para o snapshot
db_snapshot_identifier	string	sempre	Nome do snapshot
dbi_resource_id	string	sempre	O identificador para a instancia DB fonte, no qual não pode ser mudada e é unica para única para uma região AWS.
encrypted	string	sempre	Se o snapshot está ou não ecriptado
engine	string	sempre	Engine do databse no qual o snapshot foi criado.
engine_version	string	sempre	Vesão do databse no qual o snapshot foi criado.
iam_database_authentication_enabled	boolean	sempre	Se a autenticação do database está acionado ou não
instance_create_time	string	sempre	Tempo de criação de uma instancia do qual o snapshot foi criado
kms_key_id	string	sempre	ID da chave KMS encriptando o snapshot
license_model	string	sempre	Modelo de licensa do database
master_username	string	sempre	Username master do database
option_group_name	string	sempre	Opção de grupo do database
percent_progress	string	sempre	Progresso em porcentagem de um snapshot
processor_features	list / elements=string	sempre	Lista das caracteristicas do processador de uma database
snapshot_create_time	string	sempre	Tempo de criação de um snapshot
snapshot_type	string	sempre	Como o snapshot foi criado (sempre manual para esse modulo).
status	string	sempre	Status do snapshot
storage_type	string	sempre	Tipo de armazenamento do database
tags	complex	sempre	Tags aplicadas no snapshot
vpc_id	string	sempre	ID do VPC no qual o DB está alocado.