Class: Aws::Lightsail::Types::UpdateLoadBalancerAttributeRequest

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 UpdateLoadBalancerAttributeRequest data as a hash:

{
  load_balancer_name: "ResourceName", # required
  attribute_name: "HealthCheckPath", # required, accepts HealthCheckPath, SessionStickinessEnabled, SessionStickiness_LB_CookieDurationSeconds, HttpsRedirectionEnabled, TlsPolicyName
  attribute_value: "StringMax256", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

The name of the attribute you want to update.

Returns:

  • (String)


15728
15729
15730
15731
15732
15733
15734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15728

class UpdateLoadBalancerAttributeRequest < Struct.new(
  :load_balancer_name,
  :attribute_name,
  :attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_valueString

The value that you want to specify for the attribute name.

The following values are supported depending on what you specify for the attributeName request parameter:

  • If you specify HealthCheckPath for the attributeName request parameter, then the attributeValue request parameter must be the path to ping on the target (for example, /weather/us/wa/seattle).

  • If you specify SessionStickinessEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate session stickiness or false to deactivate session stickiness.

  • If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName request parameter, then the attributeValue request parameter must be an interger that represents the cookie duration in seconds.

  • If you specify HttpsRedirectionEnabled for the attributeName request parameter, then the attributeValue request parameter must be true to activate HTTP to HTTPS redirection or false to deactivate HTTP to HTTPS redirection.

  • If you specify TlsPolicyName for the attributeName request parameter, then the attributeValue request parameter must be the name of the TLS policy.

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

Returns:

  • (String)


15728
15729
15730
15731
15732
15733
15734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15728

class UpdateLoadBalancerAttributeRequest < Struct.new(
  :load_balancer_name,
  :attribute_name,
  :attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#load_balancer_nameString

The name of the load balancer that you want to modify (e.g., my-load-balancer.

Returns:

  • (String)


15728
15729
15730
15731
15732
15733
15734
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15728

class UpdateLoadBalancerAttributeRequest < Struct.new(
  :load_balancer_name,
  :attribute_name,
  :attribute_value)
  SENSITIVE = []
  include Aws::Structure
end