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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Sns

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb

Overview

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

Instance Method Summary

• #aws_access_key ⇒ Object^?

  AWS access key.

• #aws_secret_key ⇒ Object^?

  AWS secret key.

• #email ⇒ Object^?

  Message to send to email-only subscription.

• #http ⇒ Object^?

  Message to send to HTTP-only subscription.

• #https ⇒ Object^?

  Message to send to HTTPS-only subscription.

• #message_attributes ⇒ Hash^?

  Dictionary of message attributes.

• #message_structure ⇒ :json, :string

  The payload format to use for the message.,This must be ‘json’ to support non-default messages (‘http`, `https`, `email`, `sms`, `sqs`).

• #msg ⇒ String

  Default message to send.

• #region ⇒ Object^?

  The AWS region to use.

• #sms ⇒ String^?

  Message to send to SMS-only subscription.

• #sqs ⇒ Object^?

  Message to send to SQS-only subscription.

• #subject ⇒ String^?

  Subject line for email delivery.

• #topic ⇒ String

  The topic you want to publish to.

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, fix_inclusion, #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.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 43

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.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 40

attribute :aws_secret_key

#email ⇒ Object^?

Returns Message to send to email-only subscription.

Returns:

• (Object, nil) —

  Message to send to email-only subscription

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 24

attribute :email

#http ⇒ Object^?

Returns Message to send to HTTP-only subscription.

Returns:

• (Object, nil) —

  Message to send to HTTP-only subscription

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 34

attribute :http

#https ⇒ Object^?

Returns Message to send to HTTPS-only subscription.

Returns:

• (Object, nil) —

  Message to send to HTTPS-only subscription

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 37

attribute :https

#message_attributes ⇒ Hash^?

Returns Dictionary of message attributes. These are optional structured data entries to be sent along to the endpoint.,This is in AWS’s distinct Name/Type/Value format; see example below.

Returns:

• (Hash, nil) —

  Dictionary of message attributes. These are optional structured data entries to be sent along to the endpoint.,This is in AWS’s distinct Name/Type/Value format; see example below.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 49

attribute :message_attributes

#message_structure ⇒ :json, :string

Returns The payload format to use for the message.,This must be ‘json’ to support non-default messages (‘http`, `https`, `email`, `sms`, `sqs`). It must be ’string’ to support message_attributes.

Returns:

• (:json, :string) —

  The payload format to use for the message.,This must be ‘json’ to support non-default messages (‘http`, `https`, `email`, `sms`, `sqs`). It must be ’string’ to support message_attributes.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 53

attribute :message_structure

#msg ⇒ String

Returns Default message to send.

Returns:

• (String) —

  Default message to send.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 12

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.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 46

attribute :region

#sms ⇒ String^?

Returns Message to send to SMS-only subscription.

Returns:

• (String, nil) —

  Message to send to SMS-only subscription

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 30

attribute :sms

#sqs ⇒ Object^?

Returns Message to send to SQS-only subscription.

Returns:

• (Object, nil) —

  Message to send to SQS-only subscription

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 27

attribute :sqs

#subject ⇒ String^?

Returns Subject line for email delivery.

Returns:

• (String, nil) —

  Subject line for email delivery.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 16

attribute :subject

#topic ⇒ String

Returns The topic you want to publish to.

Returns:

• (String) —

  The topic you want to publish to.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns.rb', line 20

attribute :topic