SNS Topic
Resumo
-
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. |
delivery_policy | dictionary | | Entrega a policy para aplicar no topic SNS |
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. |
display_name
| string | | Mostra o nome do topic |
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. |
policy | dictionary | | Policy para aplicar no topic 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 | | Criar ou não novas subscrições não listadas. NOTA: AWS não permite que você deletar qualquer subscrição em pendencia de confirmação (PendingConfirmation), então se qualquer dessas existir que seria deletada, será ignorada sem qualquer aviso. Isso significa que qualquer pessoa poderia voltar mais tarde e confirmar a subscrição. |
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. |
subscriptions | list / elements=dictionary | | Lista de subscrições para aplicar no topic. Note que AWS requere subscrições a serem confirmadas, então você precisara de confiramar novas subscrições. |
state | string | Escolhas:
| Criar ou deletar topic SNS |
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. |
Subcampos da opção delivery_policy
Parâmetro | Tipo | Escolhas | Valor Padrão | Descrição |
|---|---|---|---|
http | dictionary | | Delivery policy para mensagens HTTP(S).Consulte https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html para obter mais informações. |
Subcampos da opção http
Parâmetro | Tipo | Escolhas | Valor Padrão | Descrição |
|---|---|---|---|
defaultHealthyRetryPolicy
| dictionary | | Retry policy para mensagens HTTP(S). |
defaultThrottlePolicy | dictionary | | Limite a taxa de mensagens enviadas para assinaturas. |
disableSubscriptionOverrides | boolean | Choices:
| Aplica esta política a todas as assinaturas, mesmo que tenham suas próprias políticas. |
Subcampos da opção defaultHealthyRetryPolicy
Parâmetro | Tipo | Escolhas | Valor Padrão | Descrição |
|---|---|---|---|
backoffFunction | string | Choices:
| A função para recuo entre tentativas. |
maxDelayTarget | integer | | O atraso máximo para uma nova tentativa. |
minDelayTarget | integer | | O atraso mínimo para uma nova tentativa. |
numMaxDelayRetries | integer | | O número de tentativas com o atraso máximo entre elas. |
numMinDelayRetries | integer | | O número de tentativas com apenas o atraso mínimo entre elas. |
numNoDelayRetries | integer | | O número de tentativas a serem executadas imediatamente. |
numRetries | integer | | O número total de tentativas. |
Subcampos da opção defaultThrottlePolicy
Parâmetro | Tipo | Escolhas | Valor Padrão | Descrição |
|---|---|---|---|
maxReceivesPerSecond | integer | | O número máximo de entregas por segundo por assinatura. |
Subcampos da opção subscriptions
Parâmetro | Tipo | Escolhas | Valor Padrão | Descrição |
|---|---|---|---|
endpoint
| string | | Endpoint da subscription. |
protocol | string | | Protocolo da subscription. |
Exemplos
- name: Create alarm SNS topic
sns_topic:
name: "alarms"
state: present
display_name: "alarm SNS topic"
delivery_policy:
http:
defaultHealthyRetryPolicy:
minDelayTarget: 2
maxDelayTarget: 4
numRetries: 3
numMaxDelayRetries: 5
backoffFunction: "linear"
disableSubscriptionOverrides: True
defaultThrottlePolicy:
maxReceivesPerSecond: 10
subscriptions:
- endpoint: "[email protected]"
protocol: "email"
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
sns_topic | complex | sempre | Detalhes do tópico Dict of sns |
sns_arn | string | sempre | O ARN do tópico que você está modificando |
Subcampos da opção sns_topic
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
attributes_set | list / elements=string | sempre | lista de atributos setados durante esta execução |
check_mode | boolean | sempre | se o check mode estava on |
delivery_policy | string | quando o topic é pertencido a essa AWS account | delivey policy para o SNS topic |
display_name | string | quando o topic é pertencido a essa AWS account | exibe o nome para os SNS topic |
name | string | sempre | nome do topic |
owner | string | quando o topic é pertencido a essa AWS account | conta AWS que pertence ao topic |
policy | string | quando o topic é pertencido a essa AWS account | policy para o SNS topic |
state | string | sempre | se o topic está presente ou ausente |
subscriptions | list / elements=string | sempre | lista de subsribers para o topic nessea conta AWS |
subscriptions_added | list / elements=string | sempre | lista de subscribers adicionados nesta execução |
subscriptions_confirmed | string | quando o topic é pertencido a essa AWS account | total de subscriptions confirmadas |
subscriptions_deleted | string | quando o topic é pertencido a essa AWS account | total de subscriptions deletadas |
subscriptions_existing | list / elements=string | sempre | lista de subscriptions existentes |
subscriptions_new | list / elements=string | sempre | lista de novas subscriptions |
subscriptions_pending | string | quando o topic é pertencido a essa AWS account | total de subscriptions pendentes |
subscriptions_purge | boolean | sempre | se purge_subscriptions foi setada ou não |
topic_arn | string | quando o topic é pertencido a essa AWS account | ARN do SNS topic (equivalente a sns_arn) |
topic_created | boolean | sempre | se o topic foi criado |
topic_deleted | boolean | sempre | se o topic foi deletado |