Class: Ansible::Ruby::Modules::Sns_topic

Inherits:

Base

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

Defined in:

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

Overview

The C(sns_topic) module allows you to create, delete, and manage subscriptions for AWS SNS topics. As of 2.6, this module can be use to subscribe and unsubscribe to topics outside of your AWS account.

Instance Method Summary

• #delivery_policy ⇒ Hash^?

  Delivery policy to apply to the SNS topic.

• #display_name ⇒ String^?

  Display name of the topic.

• #name ⇒ String

  The name or ARN of the SNS topic to manage.

• #policy ⇒ Object^?

  Policy to apply to the SNS topic.

• #purge_subscriptions ⇒ String^?

  Whether to purge any subscriptions not listed here.

• #state ⇒ :absent, ...

  Whether to create or destroy an SNS topic.

• #subscriptions ⇒ Object^?

  List of subscriptions to apply to the topic.

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

#delivery_policy ⇒ Hash^?

Returns Delivery policy to apply to the SNS topic.

Returns:

• (Hash, nil) —

  Delivery policy to apply to the SNS topic

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

attribute :delivery_policy

#display_name ⇒ String^?

Returns Display name of the topic.

Returns:

• (String, nil) —

  Display name of the topic

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

attribute :display_name

#name ⇒ String

Returns The name or ARN of the SNS topic to manage.

Returns:

• (String) —

  The name or ARN of the SNS topic to manage

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

attribute :name

#policy ⇒ Object^?

Returns Policy to apply to the SNS topic.

Returns:

• (Object, nil) —

  Policy to apply to the SNS topic

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

attribute :policy

#purge_subscriptions ⇒ String^?

Returns Whether to purge any subscriptions not listed here. NOTE: AWS does not allow you to purge any PendingConfirmation subscriptions, so if any exist and would be purged, they are silently skipped. This means that somebody could come back later and confirm the subscription. Sorry. Blame Amazon.

Returns:

• (String, nil) —

  Whether to purge any subscriptions not listed here. NOTE: AWS does not allow you to purge any PendingConfirmation subscriptions, so if any exist and would be purged, they are silently skipped. This means that somebody could come back later and confirm the subscription. Sorry. Blame Amazon.

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

attribute :purge_subscriptions

#state ⇒ :absent, ...

Returns Whether to create or destroy an SNS topic.

Returns:

• (:absent, :present, nil) —

  Whether to create or destroy an SNS topic

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

attribute :state

#subscriptions ⇒ Object^?

Returns List of subscriptions to apply to the topic. Note that AWS requires subscriptions to be confirmed, so you will need to confirm any new subscriptions.

Returns:

• (Object, nil) —

  List of subscriptions to apply to the topic. Note that AWS requires subscriptions to be confirmed, so you will need to confirm any new subscriptions.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/sns_topic.rb', line 31

attribute :subscriptions