Class: MintPress::Aws::SES::CustomVerificationEmailTemplate

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

Properties (Read/Write)

  • #template_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the custom verification email template that you want to update.'
    Property Attributes
    • create_custom_verification_email_template_prop ⇒ 'template_name'
    • read_only ⇒ false
    • source ⇒ "update_custom_verification_email_template"
    • delete_custom_verification_email_template_prop ⇒ 'template_name'
    • get_custom_verification_email_template_prop ⇒ 'template_name'
    • orig_name ⇒ 'template_name'
    • update_custom_verification_email_template_prop ⇒ 'template_name'
    • default ⇒ Proc.new { self.name }
    

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

property :template_name, create_custom_verification_email_template_prop: 'template_name', type: [String], read_only: false, source: "update_custom_verification_email_template", description: 'The name of the custom verification email template that you want to
update.', delete_custom_verification_email_template_prop: 'template_name', get_custom_verification_email_template_prop: 'template_name', orig_name: 'template_name', update_custom_verification_email_template_prop: 'template_name', default: Proc.new { self.name }
  • #from_email_address ⇒ [String]
    'The email address that the custom verification email is sent from.'
    Property Attributes
    • create_custom_verification_email_template_prop ⇒ 'from_email_address'
    • read_only ⇒ false
    • source ⇒ "update_custom_verification_email_template"
    • orig_name ⇒ 'from_email_address'
    • update_custom_verification_email_template_prop ⇒ 'from_email_address'
    

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

property :from_email_address, create_custom_verification_email_template_prop: 'from_email_address', type: [String], read_only: false, source: "update_custom_verification_email_template", description: 'The email address that the custom verification email is sent from.', orig_name: 'from_email_address', update_custom_verification_email_template_prop: 'from_email_address'
  • #template_subject ⇒ [String]
    'The subject line of the custom verification email.'
    Property Attributes
    • create_custom_verification_email_template_prop ⇒ 'template_subject'
    • read_only ⇒ false
    • source ⇒ "update_custom_verification_email_template"
    • orig_name ⇒ 'template_subject'
    • update_custom_verification_email_template_prop ⇒ 'template_subject'
    

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

property :template_subject, create_custom_verification_email_template_prop: 'template_subject', type: [String], read_only: false, source: "update_custom_verification_email_template", description: 'The subject line of the custom verification email.', orig_name: 'template_subject', update_custom_verification_email_template_prop: 'template_subject'
  • #template_content ⇒ [String]
    'The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.'
    Property Attributes
    • create_custom_verification_email_template_prop ⇒ 'template_content'
    • read_only ⇒ false
    • source ⇒ "update_custom_verification_email_template"
    • update_custom_verification_email_template_prop ⇒ 'template_content'
    

29
30
31
32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/custom_verification_email_template.rb', line 29

property :template_content, create_custom_verification_email_template_prop: 'template_content', type: [String], read_only: false, source: "update_custom_verification_email_template", description: 'The content of the custom verification email. The total size of the
email must be less than 10 MB. The message body may contain HTML, with
some limitations. For more information, see Custom Verification Email
Frequently Asked Questions in the Amazon SES Developer Guide.', update_custom_verification_email_template_prop: 'template_content'
  • #success_redirection_url ⇒ [String]
    'The URL that the recipient of the verification email is sent to if his or her address is successfully verified.'
    Property Attributes
    • create_custom_verification_email_template_prop ⇒ 'success_redirection_url'
    • read_only ⇒ false
    • source ⇒ "update_custom_verification_email_template"
    • orig_name ⇒ 'success_redirection_url'
    • update_custom_verification_email_template_prop ⇒ 'success_redirection_url'
    

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

property :success_redirection_url, create_custom_verification_email_template_prop: 'success_redirection_url', type: [String], read_only: false, source: "update_custom_verification_email_template", description: 'The URL that the recipient of the verification email is sent to if his
or her address is successfully verified.', orig_name: 'success_redirection_url', update_custom_verification_email_template_prop: 'success_redirection_url'
  • #failure_redirection_url ⇒ [String]
    'The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.'
    Property Attributes
    • create_custom_verification_email_template_prop ⇒ 'failure_redirection_url'
    • read_only ⇒ false
    • source ⇒ "update_custom_verification_email_template"
    • orig_name ⇒ 'failure_redirection_url'
    • update_custom_verification_email_template_prop ⇒ 'failure_redirection_url'
    

35
36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/custom_verification_email_template.rb', line 35

property :failure_redirection_url, create_custom_verification_email_template_prop: 'failure_redirection_url', type: [String], read_only: false, source: "update_custom_verification_email_template", description: 'The URL that the recipient of the verification email is sent to if his
or her address is not successfully verified.', orig_name: 'failure_redirection_url', update_custom_verification_email_template_prop: 'failure_redirection_url'
  • #max_results ⇒ [Integer]
    'The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation will return up to 50 results.'
    Property Attributes
    • list_custom_verification_email_templates_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_custom_verification_email_templates"
    

37
38
39
40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ses/custom_verification_email_template.rb', line 37

property :max_results, list_custom_verification_email_templates_prop: 'max_results', type: [Integer], read_only: false, source: "list_custom_verification_email_templates", description: 'The maximum number of custom verification email templates to return.
This value must be at least 1 and less than or equal to 50. If you do
not specify a value, or if you specify a value less than 1 or greater
than 50, the operation will return up to 50 results.'
  • #name ⇒ [String]

    Property Attributes 
    

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

property :name, type: [String]
  • #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 
    

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

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
    

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

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 = {}) ⇒ CustomVerificationEmailTemplate

Returns a new instance of CustomVerificationEmailTemplate.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object

#list ⇒ Object

#update ⇒ Object