ElastiCache
Sinopse
- Gerencie clusters de cache no Amazon ElastiCache.
- Retorna informações sobre o cluster de cache especificado.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
aws_access_key aliases: ec2_access_key, access_key | string | | AWS access key. Se não for definido, o valor da variável AWS_ACCESS_KEY_ID de ambiente AWS_ACCESS_KEY ou EC2_ACCESS_KEY será usado. Se o profile for definido, este parâmetro será ignorado. |
aws_ca_bundle | path | | A localização de um CA Bundle a ser usado ao validar certificados SSL. Não usado por módulos baseados em boto 2. Observação: o CA Bundle é lido no lado do 'módulo' e pode precisar ser copiado explicitamente do controlador se não for executado localmente. |
aws_config | dictionay | | 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 | | AWS secret key. Se não for definido, o valor da variável de ambiente AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY ou EC2_SECRET_KEY será usado. Se o profile for definido, este parâmetro será ignorado. |
cache_engine_version | string | | O número da versão do mecanismo de cache. |
cache_parameter_group aliases: parameter_group | string | | O nome do grupo de parâmetros de cache a ser associado a este cluster de cache. Se este argumento for omitido, o grupo de parâmetros de cache padrão para o mecanismo especificado será usado. |
cache_port | integer | | O número da porta na qual cada um dos nós de cache aceitará conexões. |
cache_security_groups | list/elements=string | | Uma lista de nomes de grupos de segurança de cache para associar a este cluster de cache. Não use se seu Cache estiver dentro de uma VPC. Nesse caso, use security_group_ids. |
cache_subnet_group | string | | O nome do grupo de sub-rede ao qual associar. Use apenas se estiver dentro de uma VPC. Obrigatório se estiver dentro de uma VPC. |
debug_botocore_endpoint_logs | boolean | Escolhas:
| Use um registrador botocore.endpoint para analisar as chamadas de API exclusivas (em vez do total) “resource:action” 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 aliases: aws_endpoint_url, endpoint_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. |
engine | string | Padrão: “memcached” | Nome do mecanismo de cache a ser usado. Os valores suportados são redise memcached. |
hard_modify | boolean | Escolhas:
| Se deve destruir e recriar um cluster de cache existente, se necessário, para modificar seu estado. |
name required | string | | O identificador do cluster de cache. |
node_type | string | Default: “cache.t2.small” | A capacidade de computação e memória dos nós no cluster de cache. |
num_nodes | integer | Padrão: 1 | O número inicial de nós de cache que o cluster de cache terá. Necessário quando state=present . |
perfil aliases: aws_profile | string | | O uso do profile substituirá aws_access_key , aws_secret_key e security_token e o suporte para passá-los ao mesmo tempo em que o profile foi descontinuado. |
profile 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_group_ids | list/elements=string | | Uma lista de IDs de security group da VPC para associar a este cluster de cache. Use apenas se estiver dentro de uma VPC. |
security_token aliases: aws_security_token, access_token | string | | AWS STS security token. Se não for definido, o valor da variável de ambiente AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN será usado. |
state required | string | Escolhas:
| absent ou present são ações idempotentes que criarão ou destruirão um cluster de cache conforme necessário. rebooted reinicializará o cluster, resultando em uma interrupção momentânea. |
valid_certs | boolean | Escolhas:
| Quando definido como “não”, os certificados SSL não serão validados para comunicação com as APIs da AWS. |
wait | boolean | Escolhas:
| Aguarde o resultado do cluster de cache antes de retornar. |
zone | string | | A zona de disponibilidade do EC2 na qual o cluster de cache será criado. |
Notas
Observação
- 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
# Observação: nenhum desses exemplos define aws_access_key, aws_secret_key ou region.
# Supõe-se que suas variáveis de ambiente correspondentes estejam definidas.
- name: Basic example
community.aws.elasticache:
name: "test-please-delete"
state: present
engine: memcached
cache_engine_version: 1.4.14
node_type: cache.m1.small
num_nodes: 1
cache_port: 11211
cache_security_groups:
- default
zone: us-east-1d
- name: Ensure cache cluster is gone
community.aws.elasticache:
name: "test-please-delete"
state: absent
- name: Reboot cache cluster
community.aws.elasticache:
name: "test-please-delete"
state: rebooted