Class: MintPress::Aws::SES::ReceiptRule

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb

Properties (Read/Write)

  • #rule_set_name ⇒ [String]
    'The name of the receipt rule set that the receipt rule belongs to.'
    Property Attributes
    • create_receipt_rule_prop ⇒ 'rule_set_name'
    • read_only ⇒ false
    • source ⇒ "update_receipt_rule"
    • delete_receipt_rule_prop ⇒ 'rule_set_name'
    • describe_receipt_rule_prop ⇒ 'rule_set_name'
    • update_receipt_rule_prop ⇒ 'rule_set_name'
    

24
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb', line 24

property :rule_set_name, create_receipt_rule_prop: 'rule_set_name', type: [String], read_only: false, source: "update_receipt_rule", description: 'The name of the receipt rule set that the receipt rule belongs to.', delete_receipt_rule_prop: 'rule_set_name', describe_receipt_rule_prop: 'rule_set_name', update_receipt_rule_prop: 'rule_set_name'
  • #after ⇒ [String]
    'The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.'
    Property Attributes
    • create_receipt_rule_prop ⇒ 'after'
    • read_only ⇒ false
    • source ⇒ "create_receipt_rule"
    

25
26
27
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb', line 25

property :after, create_receipt_rule_prop: 'after', type: [String], read_only: false, source: "create_receipt_rule", description: 'The name of an existing rule after which the new rule will be placed.
If this parameter is null, the new rule will be inserted at the
beginning of the rule list.'
  • #actions ⇒ Array of ⇒ [MintPress::Aws::SES::ReceiptAction]
    'An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::SES::ReceiptRule"
    • orig_name ⇒ 'actions'
    • create_receipt_rule_prop ⇒ 'rule.actions'
    • update_receipt_rule_prop ⇒ 'rule.actions'
    

28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb', line 28

property :actions, disposition: :attribute, description: 'An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.', source: "MintPress::Aws::SES::ReceiptRule", orig_name: 'actions', type: [MintPress::Aws::SES::ReceiptAction], create_receipt_rule_prop: 'rule.actions', array: true, update_receipt_rule_prop: 'rule.actions'
  • #enabled ⇒ [TrueClass,FalseClass]
    'If true, the receipt rule is active.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::SES::ReceiptRule"
    • orig_name ⇒ 'enabled'
    • create_receipt_rule_prop ⇒ 'rule.enabled'
    • update_receipt_rule_prop ⇒ 'rule.enabled'
    

29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb', line 29

property :enabled, disposition: :attribute, description: 'If true, the receipt rule is active.', source: "MintPress::Aws::SES::ReceiptRule", orig_name: 'enabled', type: [TrueClass,FalseClass], create_receipt_rule_prop: 'rule.enabled', update_receipt_rule_prop: 'rule.enabled'
  • #name ⇒ [String]
    'The name of the receipt rule.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::SES::ReceiptRule"
    • orig_name ⇒ 'name'
    • create_receipt_rule_prop ⇒ 'rule.name'
    • update_receipt_rule_prop ⇒ 'rule.name'
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb', line 30

property :name, disposition: :attribute, description: 'The name of the receipt rule.', source: "MintPress::Aws::SES::ReceiptRule", orig_name: 'name', type: [String], create_receipt_rule_prop: 'rule.name', update_receipt_rule_prop: 'rule.name'
  • #recipients ⇒ Array of ⇒ [String]
    'The recipient domains and email addresses that the receipt rule applies to.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::SES::ReceiptRule"
    • orig_name ⇒ 'recipients'
    • create_receipt_rule_prop ⇒ 'rule.recipients'
    • update_receipt_rule_prop ⇒ 'rule.recipients'
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb', line 31

property :recipients, disposition: :attribute, description: 'The recipient domains and email addresses that the receipt rule applies to.', source: "MintPress::Aws::SES::ReceiptRule", orig_name: 'recipients', type: [String], create_receipt_rule_prop: 'rule.recipients', array: true, update_receipt_rule_prop: 'rule.recipients'
  • #scan_enabled ⇒ [TrueClass,FalseClass]
    'If true, then messages that this receipt rule applies to are scanned for spam and viruses.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::SES::ReceiptRule"
    • orig_name ⇒ 'scan_enabled'
    • create_receipt_rule_prop ⇒ 'rule.scan_enabled'
    • update_receipt_rule_prop ⇒ 'rule.scan_enabled'
    

32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb', line 32

property :scan_enabled, disposition: :attribute, description: 'If true, then messages that this receipt rule applies to are scanned for spam and viruses.', source: "MintPress::Aws::SES::ReceiptRule", orig_name: 'scan_enabled', type: [TrueClass,FalseClass], create_receipt_rule_prop: 'rule.scan_enabled', update_receipt_rule_prop: 'rule.scan_enabled'
  • #tls_policy ⇒ [String]
    'Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::SES::ReceiptRule"
    • orig_name ⇒ 'tls_policy'
    • create_receipt_rule_prop ⇒ 'rule.tls_policy'
    • update_receipt_rule_prop ⇒ 'rule.tls_policy'
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb', line 33

property :tls_policy, disposition: :attribute, description: 'Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).', source: "MintPress::Aws::SES::ReceiptRule", orig_name: 'tls_policy', type: [String], create_receipt_rule_prop: 'rule.tls_policy', update_receipt_rule_prop: 'rule.tls_policy'
  • #rule_name ⇒ [String]
    'The name of the receipt rule.'
    Property Attributes
    • delete_receipt_rule_prop ⇒ 'rule_name'
    • read_only ⇒ false
    • source ⇒ "describe_receipt_rule"
    • describe_receipt_rule_prop ⇒ 'rule_name'
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb', line 34

property :rule_name, delete_receipt_rule_prop: 'rule_name', type: [String], read_only: false, source: "describe_receipt_rule", description: 'The name of the receipt rule.', describe_receipt_rule_prop: 'rule_name'
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb', line 38

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/receipt_rule.rb', line 41

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ ReceiptRule

Returns a new instance of ReceiptRule.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#update ⇒ Object