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"],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  ip_address_type: "dualstack", # accepts dualstack, ipv4
  tls_policy_name: "string",
}

Constant Summary collapse

SENSITIVE =
[]

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>)


4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4714

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names,
  :tags,
  :ip_address_type,
  :tls_policy_name)
  SENSITIVE = []
  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)


4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4714

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names,
  :tags,
  :ip_address_type,
  :tls_policy_name)
  SENSITIVE = []
  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)


4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4714

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names,
  :tags,
  :ip_address_type,
  :tls_policy_name)
  SENSITIVE = []
  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)


4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4714

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names,
  :tags,
  :ip_address_type,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#instance_portInteger

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

Returns:

  • (Integer)


4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4714

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names,
  :tags,
  :ip_address_type,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_typeString

The IP address type for the load balancer.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

Returns:

  • (String)


4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4714

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names,
  :tags,
  :ip_address_type,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#load_balancer_nameString

The name of your load balancer.

Returns:

  • (String)


4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4714

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names,
  :tags,
  :ip_address_type,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Returns:



4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4714

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names,
  :tags,
  :ip_address_type,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end

#tls_policy_nameString

The name of the TLS policy to apply to the load balancer.

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

Returns:

  • (String)


4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4714

class CreateLoadBalancerRequest < Struct.new(
  :load_balancer_name,
  :instance_port,
  :health_check_path,
  :certificate_name,
  :certificate_domain_name,
  :certificate_alternative_names,
  :tags,
  :ip_address_type,
  :tls_policy_name)
  SENSITIVE = []
  include Aws::Structure
end