Class: MintPress::Aws::Lightsail::LoadBalancer

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

Properties (Read/Write)

  • #load_balancer_name ⇒ [String]
    'The name of the load balancer.'
    Property Attributes
    • create_load_balancer_prop ⇒ 'load_balancer_name'
    • read_only ⇒ false
    • source ⇒ "get_load_balancer"
    • delete_load_balancer_prop ⇒ 'load_balancer_name'
    • get_load_balancer_prop ⇒ 'load_balancer_name'
    

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

property :load_balancer_name, create_load_balancer_prop: 'load_balancer_name', type: [String], read_only: false, source: "get_load_balancer", description: 'The name of the load balancer.', delete_load_balancer_prop: 'load_balancer_name', get_load_balancer_prop: 'load_balancer_name'
  • #instance_port ⇒ [Integer]
    'The port where the load balancer will direct traffic to your Lightsail instances.'
    Property Attributes
    • create_load_balancer_prop ⇒ 'instance_port'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'instance_port'
    

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

property :instance_port, create_load_balancer_prop: 'instance_port', type: [Integer], disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::LoadBalancer", description: 'The port where the load balancer will direct traffic to your Lightsail instances.', orig_name: 'instance_port'
  • #health_check_path ⇒ [String]
    'The path you specified to perform your health checks.'
    Property Attributes
    • create_load_balancer_prop ⇒ 'health_check_path'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'health_check_path'
    

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

property :health_check_path, create_load_balancer_prop: 'health_check_path', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::LoadBalancer", description: 'The path you specified to perform your health checks.', orig_name: 'health_check_path'
  • #certificate_name ⇒ [String]
    'The name of the SSL/TLS certificate. If you specify certificateName, then certificateDomainName is required (and vice-versa).'
    Property Attributes
    • create_load_balancer_prop ⇒ 'certificate_name'
    • read_only ⇒ false
    • source ⇒ "create_load_balancer"
    

28
29
30
31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 28

property :certificate_name, create_load_balancer_prop: 'certificate_name', type: [String], read_only: false, source: "create_load_balancer", description: 'The name of the SSL/TLS certificate.

If you specify certificateName, then certificateDomainName is
required (and vice-versa).'
  • #certificate_domain_name ⇒ [String]
    'The domain name with which your certificate is associated (e.g., example.com). If you specify certificateDomainName, then certificateName is required (and vice-versa).'
    Property Attributes
    • create_load_balancer_prop ⇒ 'certificate_domain_name'
    • read_only ⇒ false
    • source ⇒ "create_load_balancer"
    

32
33
34
35
36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 32

property :certificate_domain_name, create_load_balancer_prop: 'certificate_domain_name', type: [String], read_only: false, source: "create_load_balancer", description: 'The domain name with which your certificate is associated (e.g.,
example.com).

If you specify certificateDomainName, then certificateName is
required (and vice-versa).'
  • #certificate_alternative_names ⇒ Array of ⇒ [String]
    'The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com).'
    Property Attributes
    • create_load_balancer_prop ⇒ 'certificate_alternative_names'
    • read_only ⇒ false
    • source ⇒ "create_load_balancer"
    

37
38
39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 37

property :certificate_alternative_names, create_load_balancer_prop: 'certificate_alternative_names', type: [String], array: true, read_only: false, source: "create_load_balancer", description: 'The optional alternative domains and subdomains to use with your
SSL/TLS certificate (e.g., www.example.com, example.com,
m.example.com, blog.example.com).'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::Tag]
    'The tag keys and optional values for the resource.'
    Property Attributes
    • create_load_balancer_prop ⇒ 'tags'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'tags'
    

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

property :tags, create_load_balancer_prop: 'tags', type: [MintPress::Aws::Lightsail::Tag], array: false, disposition: :attribute, read_only: false, source: "MintPress::Aws::Lightsail::LoadBalancer", description: 'The tag keys and optional values for the resource.', orig_name: 'tags', hash: true
  • #arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the load balancer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'arn'
    

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

property :arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the load balancer.', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'arn', type: [String]
  • #configuration_options ⇒ []
    'A string to string map of the configuration options for your load balancer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'configuration_options'
    

42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 42

property :configuration_options, disposition: :attribute, description: 'A string to string map of the configuration options for your load balancer.', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'configuration_options', type: []
  • #created_at ⇒ [Time]
    'The date when your load balancer was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'created_at'
    

43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 43

property :created_at, disposition: :attribute, description: 'The date when your load balancer was created.', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'created_at', type: [Time]
  • #dns_name ⇒ [String]
    'The DNS name of your Lightsail load balancer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'dns_name'
    

44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 44

property :dns_name, disposition: :attribute, description: 'The DNS name of your Lightsail load balancer.', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'dns_name', type: [String]
  • #instance_health_summary ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::InstanceHealthSummary]
    'An array of InstanceHealthSummary objects describing the health of the load balancer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'instance_health_summary'
    

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

property :instance_health_summary, disposition: :attribute, description: 'An array of InstanceHealthSummary objects describing the health of the load balancer.', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'instance_health_summary', type: [MintPress::Aws::Lightsail::InstanceHealthSummary], array: false, hash: true
  • #location ⇒ [MintPress::Aws::Lightsail::ResourceLocation] (Default Value: MintPress::Aws::Lightsail::ResourceLocation.new)
    'The AWS Region where your load balancer was created (e.g., us-east-2a).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'location'
    • default ⇒ MintPress::Aws::Lightsail::ResourceLocation.new
    

46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 46

property :location, disposition: :attribute, description: 'The AWS Region where your load balancer was created (e.g., us-east-2a).', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'location', type: [MintPress::Aws::Lightsail::ResourceLocation], default: MintPress::Aws::Lightsail::ResourceLocation.new
  • #name ⇒ [String]
    'The name of the load balancer (e.g., my-load-balancer).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'name'
    

47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 47

property :name, disposition: :attribute, description: 'The name of the load balancer (e.g., my-load-balancer).', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'name', type: [String]
  • #protocol ⇒ [String]
    'The protocol you have enabled for your load balancer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'protocol'
    

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

property :protocol, disposition: :attribute, description: 'The protocol you have enabled for your load balancer.', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'protocol', type: [String]
  • #public_ports ⇒ Array of ⇒ [Integer]
    'An array of public port settings for your load balancer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'public_ports'
    

49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 49

property :public_ports, disposition: :attribute, description: 'An array of public port settings for your load balancer.', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'public_ports', type: [Integer], array: true
  • #resource_type ⇒ [String]
    'The resource type (e.g., LoadBalancer..'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'resource_type'
    

50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 50

property :resource_type, disposition: :attribute, description: 'The resource type (e.g., LoadBalancer..', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'resource_type', type: [String]
  • #state ⇒ [String]
    'The status of your load balancer.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'state'
    

51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 51

property :state, disposition: :attribute, description: 'The status of your load balancer.', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'state', type: [String]
  • #support_code ⇒ [String]
    'The support code.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'support_code'
    

52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 52

property :support_code, disposition: :attribute, description: 'The support code.', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'support_code', type: [String]
  • #tls_certificate_summaries ⇒ Hash of ⇒ [MintPress::Aws::Lightsail::LoadBalancerTlsCertificateSummary]
    'An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::LoadBalancer"
    • orig_name ⇒ 'tls_certificate_summaries'
    

53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 53

property :tls_certificate_summaries, disposition: :attribute, description: 'An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates.', source: "MintPress::Aws::Lightsail::LoadBalancer", orig_name: 'tls_certificate_summaries', type: [MintPress::Aws::Lightsail::LoadBalancerTlsCertificateSummary], array: false, hash: true
  • #page_token ⇒ [String]
    'The token to advance to the next page of results from your request. To get a page token, perform an initial GetLoadBalancers request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.'
    Property Attributes
    • get_load_balancers_prop ⇒ 'page_token'
    • read_only ⇒ false
    • source ⇒ "get_load_balancers"
    

54
55
56
57
58
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 54

property :page_token, get_load_balancers_prop: 'page_token', type: [String], read_only: false, source: "get_load_balancers", description: 'The token to advance to the next page of results from your request.

To get a page token, perform an initial GetLoadBalancers request. If
your results are paginated, the response will return a next page token
that you can specify as the page token in a subsequent request.'
  • #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 
    

62
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 62

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
    

65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer.rb', line 65

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

Returns a new instance of LoadBalancer.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object