SNS Topic Info
Resumo
O módulo topic_info permite coletar todos os AWS SNS topic ou propriedades de um AWS SNS topic específico.
Parâmetros
Parâmetro | Tipos | 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 perfil estiver definido, este parâmetro será ignorado. A transmissão das opções aws_access_key e profile ao mesmo tempo foi suspensa e as opções serão mutuamente exclusivas após 01/06/2022. |
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 | 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 | 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 estiver definido, este parâmetro será ignorado. A transmissão das opções aws_secret_key e perfil ao mesmo tempo foi suspensa e as opções serão mutuamente exclusivas após 01/06/2022. |
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. A variável de ambiente ANSIBLE_DEBUG_BOTOCORE_LOGS também pode ser usada. |
delivery_policy | dictionary | | Delivery policy to apply to the SNS topic. |
display_name | string | | Exibe o nome do topico |
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. |
name
| string | | O nome ou ARN do tópico do SNS a ser gerenciado. |
policy | dictionary | | Política a ser aplicada ao tópico SNS. |
profile | string | | O uso de profile substituirá aws_access_key, aws_secret_key e security_token e o suporte para passá-los ao mesmo tempo em que profile foi obsoleto. aws_access_key, aws_secret_key e security_token serão mutuamente exclusivos com perfil após 01/06/2022. |
purge_subscriptions | boolean | Escolhas:
| Se deve limpar quaisquer assinaturas não listadas aqui. OBSERVAÇÃO: a AWS não permite que você limpe nenhuma assinatura PendingConfirmation, portanto, se alguma existir e for eliminada, ela será ignorada silenciosamente. Isso significa que alguém pode voltar mais tarde e confirmar a assinatura. |
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/rand.html#ec2_region |
security_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 é usado. Se o perfil estiver definido, este parâmetro será ignorado. A passagem das opções security_token e perfil ao mesmo tempo foi suspensa e as opções serão mutuamente exclusivas após 01/06/2022. |
topic_arn | string | | O ARN da topic AWS SNS onde você deseja encontrar subscrições ou lista de atributos |
subscriptions | list / elements=dictionary | Default: [] | Lista de assinaturas a serem aplicadas ao tópico. Observe que a AWS exige que as assinaturas sejam confirmadas, portanto, você precisará confirmar quaisquer novas assinaturas. |
topic_type | string | Escolhas:
| O tipo de tópico que deve ser criado. Qualquer padrão para FIFO (first-in, first-out) |
validate_certs | boolean | Escolhas:
| Quando definido como “não”, os certificados SSL não serão validados para comunicação com as APIs da AWS. |
Exemplos
- name: list all the topics
community.aws.sns_topic_info:
register: sns_topic_list
- name: get info on specific topic
community.aws.sns_topic_info:
topic_arn: "{{ sns_arn }}"
register: sns_topic_info
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
result | list / elements=string | sucesso | O resultado contendo os deltalhes de um ou mais topic AWS SNS. |
Subcampos da opção result
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
sns_arn | string | sempre | O resultado contendo os deltalhes de um ou mais topic AWS SNS. |
sns_topic | complex | sempre | Dict de detalhes de topic SNS |
Subcampos da opção sns_topic
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
delivery_policy | string | quando o topic é pertencido a conta AWS | O resultado contendo os deltalhes de um ou mais topic AWS SNS. |
display_name | string | quando o topic é pertencido a conta AWS | Dict de detalhes de topic SNS |
owner | string | quando o topic é pertencido a conta AWS | Conta AWS que o topic pertence |
policy | string | quando o topic é pertencido a conta AWS | Policy para o topic SNS |
subscriptions | list / elements=string | sempre | Lista de subscritos nesse topic nesta conta AWS |
subscriptions_added | list / elements=string | sempre | Lista de subscritos adicionados a essa execução |
subscriptions_confirmed | string | quando o topic é pertencido a conta AWS | Número subscrições confirmadas |
subscriptions_deleted | string | quando o topic é pertencido a conta AWS | Número de subscrições deletadas |
subscriptions_existing | list / elements=string | sempre | Lista de subscrições existentes |
subscriptions_new | list / elements=string | sempre | Lista de novas subscrições |
subscriptions_pending | string | quando o topic é pertencido a conta AWS | Número de subscrições pendetes |
subscriptions_purge | boolean | sempre | Se purge_subscriptions foi dado ou não |
topic_arn | string | quando o topic é pertencido a conta AWS | ARN no topic SNS (equivalente a sns_arn) |
topic_type | string | sucesso | O tipo de topic |