Class: Ansible::Ruby::Modules::Sns

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/notification/sns.rb

Overview

The M(sns) module sends notifications to a topic on your Amazon SNS account

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#aws_access_key ⇒ Object?

Returns AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.

Returns:

  • (Object, nil) —

    AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.



42
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/sns.rb', line 42

attribute :aws_access_key

#aws_secret_key ⇒ Object?

Returns AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.

Returns:

  • (Object, nil) —

    AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.



39
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/sns.rb', line 39

attribute :aws_secret_key

#email ⇒ Object?

Returns Message to send to email-only subscription.

Returns:

  • (Object, nil) —

    Message to send to email-only subscription



23
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/sns.rb', line 23

attribute :email

#http ⇒ Object?

Returns Message to send to HTTP-only subscription.

Returns:

  • (Object, nil) —

    Message to send to HTTP-only subscription



33
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/sns.rb', line 33

attribute :http

#https ⇒ Object?

Returns Message to send to HTTPS-only subscription.

Returns:

  • (Object, nil) —

    Message to send to HTTPS-only subscription



36
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/sns.rb', line 36

attribute :https

#msg ⇒ String

Returns Default message to send.

Returns:

  • (String) —

    Default message to send.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/sns.rb', line 11

attribute :msg

#region ⇒ Object?

Returns The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used.

Returns:

  • (Object, nil) —

    The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used.



45
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/sns.rb', line 45

attribute :region

#sms ⇒ String?

Returns Message to send to SMS-only subscription.

Returns:

  • (String, nil) —

    Message to send to SMS-only subscription



29
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/sns.rb', line 29

attribute :sms

#sqs ⇒ Object?

Returns Message to send to SQS-only subscription.

Returns:

  • (Object, nil) —

    Message to send to SQS-only subscription



26
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/sns.rb', line 26

attribute :sqs

#subject ⇒ String?

Returns Subject line for email delivery.

Returns:

  • (String, nil) —

    Subject line for email delivery.



15
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/sns.rb', line 15

attribute :subject

#topic ⇒ String

Returns The topic you want to publish to.

Returns:

  • (String) —

    The topic you want to publish to.



19
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/sns.rb', line 19

attribute :topic