You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Lightsail::Types::CreateLoadBalancerRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Note:

When making an API call, you may pass CreateLoadBalancerRequest data as a hash:

{
  load_balancer_name: "ResourceName", # required
  instance_port: 1, # required
  health_check_path: "string",
  certificate_name: "ResourceName",
  certificate_domain_name: "DomainName",
  certificate_alternative_names: ["DomainName"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_alternative_namesArray<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).

Returns:

  • (Array<String>)


960
961
962
963
964
965
966
967
968
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 960

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names)
  include Aws::Structure
end

#certificate_domain_nameString

The domain name with which your certificate is associated (e.g., example.com).

If you specify certificateDomainName, then certificateName is required (and vice-versa).

Returns:

  • (String)


960
961
962
963
964
965
966
967
968
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 960

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names)
  include Aws::Structure
end

#certificate_nameString

The name of the SSL/TLS certificate.

If you specify certificateName, then certificateDomainName is required (and vice-versa).

Returns:

  • (String)


960
961
962
963
964
965
966
967
968
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 960

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names)
  include Aws::Structure
end

#health_check_pathString

The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/").

You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

Returns:

  • (String)


960
961
962
963
964
965
966
967
968
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 960

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names)
  include Aws::Structure
end

#instance_portInteger

The instance port where you're creating your load balancer.

Returns:

  • (Integer)


960
961
962
963
964
965
966
967
968
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 960

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names)
  include Aws::Structure
end

#load_balancer_nameString

The name of your load balancer.

Returns:

  • (String)


960
961
962
963
964
965
966
967
968
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 960

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names)
  include Aws::Structure
end