Class: MintPress::Aws::Route53::HealthCheckConfig

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

Properties (Read/Write)

  • #alarm_identifier ⇒ [MintPress::Aws::Route53::AlarmIdentifier] (Default Value: MintPress::Aws::Route53::AlarmIdentifier.new)
    'A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'alarm_identifier'
    • default ⇒ MintPress::Aws::Route53::AlarmIdentifier.new
    • create_health_check_prop ⇒ 'alarm_identifier'
    

16
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 16

property :alarm_identifier, disposition: :attribute, description: 'A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'alarm_identifier', type: [MintPress::Aws::Route53::AlarmIdentifier], default: MintPress::Aws::Route53::AlarmIdentifier.new, create_health_check_prop: 'alarm_identifier'
  • #child_health_checks ⇒ Array of ⇒ [String]
    '(CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'child_health_checks'
    • create_health_check_prop ⇒ 'child_health_checks'
    

17
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 17

property :child_health_checks, disposition: :attribute, description: '(CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'child_health_checks', type: [String], array: true, create_health_check_prop: 'child_health_checks'
  • #disabled ⇒ [TrueClass,FalseClass]
    'Stops Route 53 from performing health checks.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'disabled'
    • create_health_check_prop ⇒ 'disabled'
    

18
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 18

property :disabled, disposition: :attribute, description: 'Stops Route 53 from performing health checks.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'disabled', type: [TrueClass,FalseClass], create_health_check_prop: 'disabled'
  • #enable_sni ⇒ [TrueClass,FalseClass]
    'Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'enable_sni'
    • create_health_check_prop ⇒ 'enable_sni'
    

19
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 19

property :enable_sni, disposition: :attribute, description: 'Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'enable_sni', type: [TrueClass,FalseClass], create_health_check_prop: 'enable_sni'
  • #failure_threshold ⇒ [Integer]
    'The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'failure_threshold'
    • create_health_check_prop ⇒ 'failure_threshold'
    

20
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 20

property :failure_threshold, disposition: :attribute, description: 'The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'failure_threshold', type: [Integer], create_health_check_prop: 'failure_threshold'
  • #fully_qualified_domain_name ⇒ [String] (Default Value: Proc.new { self.name })
    'Amazon Route 53 behavior depends on whether you specify a value for IPAddress.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'fully_qualified_domain_name'
    • create_health_check_prop ⇒ 'fully_qualified_domain_name'
    • default ⇒ Proc.new { self.name }
    

21
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 21

property :fully_qualified_domain_name, disposition: :attribute, description: 'Amazon Route 53 behavior depends on whether you specify a value for IPAddress.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'fully_qualified_domain_name', type: [String], create_health_check_prop: 'fully_qualified_domain_name', default: Proc.new { self.name }
  • #health_threshold ⇒ [Integer]
    'The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'health_threshold'
    • create_health_check_prop ⇒ 'health_threshold'
    

22
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 22

property :health_threshold, disposition: :attribute, description: 'The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'health_threshold', type: [Integer], create_health_check_prop: 'health_threshold'
  • #insufficient_data_health_status ⇒ [String]
    'When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'insufficient_data_health_status'
    • create_health_check_prop ⇒ 'insufficient_data_health_status'
    

23
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 23

property :insufficient_data_health_status, disposition: :attribute, description: 'When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'insufficient_data_health_status', type: [String], create_health_check_prop: 'insufficient_data_health_status'
  • #inverted ⇒ [TrueClass,FalseClass]
    'Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'inverted'
    • create_health_check_prop ⇒ 'inverted'
    

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

property :inverted, disposition: :attribute, description: 'Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'inverted', type: [TrueClass,FalseClass], create_health_check_prop: 'inverted'
  • #ip_address ⇒ [String]
    'The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'ip_address'
    • create_health_check_prop ⇒ 'ip_address'
    

25
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 25

property :ip_address, disposition: :attribute, description: 'The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'ip_address', type: [String], create_health_check_prop: 'ip_address'
  • #measure_latency ⇒ [TrueClass,FalseClass]
    'Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'measure_latency'
    • create_health_check_prop ⇒ 'measure_latency'
    

26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 26

property :measure_latency, disposition: :attribute, description: 'Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'measure_latency', type: [TrueClass,FalseClass], create_health_check_prop: 'measure_latency'
  • #port ⇒ [Integer]
    'The port on the endpoint that you want Amazon Route 53 to perform health checks on.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'port'
    • create_health_check_prop ⇒ 'port'
    

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

property :port, disposition: :attribute, description: 'The port on the endpoint that you want Amazon Route 53 to perform health checks on.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'port', type: [Integer], create_health_check_prop: 'port'
  • #regions ⇒ Array of ⇒ [String]
    'A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'regions'
    • create_health_check_prop ⇒ 'regions'
    

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

property :regions, disposition: :attribute, description: 'A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'regions', type: [String], array: true, create_health_check_prop: 'regions'
  • #request_interval ⇒ [Integer]
    'The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'request_interval'
    • create_health_check_prop ⇒ 'request_interval'
    

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

property :request_interval, disposition: :attribute, description: 'The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'request_interval', type: [Integer], create_health_check_prop: 'request_interval'
  • #resource_path ⇒ [String]
    'The path, if any, that you want Amazon Route 53 to request when performing health checks.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'resource_path'
    • create_health_check_prop ⇒ 'resource_path'
    

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

property :resource_path, disposition: :attribute, description: 'The path, if any, that you want Amazon Route 53 to request when performing health checks.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'resource_path', type: [String], create_health_check_prop: 'resource_path'
  • #search_string ⇒ [String]
    'If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'search_string'
    • create_health_check_prop ⇒ 'search_string'
    

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

property :search_string, disposition: :attribute, description: 'If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'search_string', type: [String], create_health_check_prop: 'search_string'
  • #type ⇒ [String]
    'The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::HealthCheckConfig"
    • orig_name ⇒ 'type'
    • create_health_check_prop ⇒ 'type'
    

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

property :type, disposition: :attribute, description: 'The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.', source: "MintPress::Aws::Route53::HealthCheckConfig", orig_name: 'type', type: [String], create_health_check_prop: 'type'
  • #name ⇒ [String]

    Property Attributes 
    

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

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 
    

37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 37

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
    

40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/health_check_config.rb', line 40

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

Returns a new instance of HealthCheckConfig.