Class: Ansible::Ruby::Modules::Aws_ses_identity

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/aws_ses_identity.rb

Overview

This module allows the user to manage verified email and domain identity for SES. This covers verifying and removing identities as well as setting up complaint, bounce and delivery notification settings.

Instance Method Summary collapse

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

#bounce_notifications ⇒ Hash?

Returns Setup the SNS topic used to report bounce notifications.,If omitted, bounce notifications will not be delivered to a SNS topic.,If bounce notifications are not delivered to a SNS topic, I(feedback_forwarding) must be enabled.

Returns:

  • (Hash, nil) —

    Setup the SNS topic used to report bounce notifications.,If omitted, bounce notifications will not be delivered to a SNS topic.,If bounce notifications are not delivered to a SNS topic, I(feedback_forwarding) must be enabled.



21
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_ses_identity.rb', line 21

attribute :bounce_notifications

#complaint_notifications ⇒ Hash?

Returns Setup the SNS topic used to report complaint notifications.,If omitted, complaint notifications will not be delivered to a SNS topic.,If complaint notifications are not delivered to a SNS topic, I(feedback_forwarding) must be enabled.

Returns:

  • (Hash, nil) —

    Setup the SNS topic used to report complaint notifications.,If omitted, complaint notifications will not be delivered to a SNS topic.,If complaint notifications are not delivered to a SNS topic, I(feedback_forwarding) must be enabled.



25
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_ses_identity.rb', line 25

attribute :complaint_notifications

#delivery_notifications ⇒ Hash?

Returns Setup the SNS topic used to report delivery notifications.,If omitted, delivery notifications will not be delivered to a SNS topic.

Returns:

  • (Hash, nil) —

    Setup the SNS topic used to report delivery notifications.,If omitted, delivery notifications will not be delivered to a SNS topic.



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_ses_identity.rb', line 29

attribute :delivery_notifications

#feedback_forwarding ⇒ Boolean?

Returns Whether or not to enable feedback forwarding.,This can only be false if both I(bounce_notifications) and I(complaint_notifications) specify SNS topics.

Returns:

  • (Boolean, nil) —

    Whether or not to enable feedback forwarding.,This can only be false if both I(bounce_notifications) and I(complaint_notifications) specify SNS topics.



33
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_ses_identity.rb', line 33

attribute :feedback_forwarding

#identity ⇒ String

Returns This is the email address or domain to verify / delete.,If this contains an ‘@’ then it will be considered an email. Otherwise it will be considered a domain.

Returns:

  • (String) —

    This is the email address or domain to verify / delete.,If this contains an ‘@’ then it will be considered an email. Otherwise it will be considered a domain.



13
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_ses_identity.rb', line 13

attribute :identity

#state ⇒ :present, ...

Returns Whether to create(or update) or delete the identity.

Returns:

  • (:present, :absent, nil) —

    Whether to create(or update) or delete the identity.



17
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_ses_identity.rb', line 17

attribute :state