Class: AWSCDK::ElasticLoadBalancing::CfnLoadBalancer::LBCookieStickinessPolicyProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ElasticLoadBalancing::CfnLoadBalancer::LBCookieStickinessPolicyProperty

Defined in:

elastic_load_balancing/cfn_load_balancer.rb

Overview

Specifies a policy for duration-based session stickiness for your Classic Load Balancer.

To associate a policy with a listener, use the PolicyNames property for the listener.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancing-loadbalancer-lbcookiestickinesspolicy.html

Instance Attribute Summary

• #cookie_expiration_period ⇒ String^? readonly

  The time period, in seconds, after which the cookie should be considered stale.

• #policy_name ⇒ String^? readonly

  The name of the policy.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(cookie_expiration_period: nil, policy_name: nil) ⇒ LBCookieStickinessPolicyProperty constructor

  A new instance of LBCookieStickinessPolicyProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(cookie_expiration_period: nil, policy_name: nil) ⇒ LBCookieStickinessPolicyProperty

Returns a new instance of LBCookieStickinessPolicyProperty.

Parameters:

• cookie_expiration_period (String, nil) (defaults to: nil) —

  The time period, in seconds, after which the cookie should be considered stale.

• policy_name (String, nil) (defaults to: nil) —

  The name of the policy.

# File 'elastic_load_balancing/cfn_load_balancer.rb', line 1055

def initialize(cookie_expiration_period: nil, policy_name: nil)
  @cookie_expiration_period = cookie_expiration_period
  Jsii::Type.check_type(@cookie_expiration_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cookieExpirationPeriod") unless @cookie_expiration_period.nil?
  @policy_name = policy_name
  Jsii::Type.check_type(@policy_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyName") unless @policy_name.nil?
end

Instance Attribute Details

#cookie_expiration_period ⇒ String^? (readonly)

The time period, in seconds, after which the cookie should be considered stale.

If this parameter is not specified, the stickiness session lasts for the duration of the browser session.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancing-loadbalancer-lbcookiestickinesspolicy.html#cfn-elasticloadbalancing-loadbalancer-lbcookiestickinesspolicy-cookieexpirationperiod

# File 'elastic_load_balancing/cfn_load_balancer.rb', line 1068

def cookie_expiration_period
  @cookie_expiration_period
end

#policy_name ⇒ String^? (readonly)

The name of the policy.

This name must be unique within the set of policies for this load balancer.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancing-loadbalancer-lbcookiestickinesspolicy.html#cfn-elasticloadbalancing-loadbalancer-lbcookiestickinesspolicy-policyname

# File 'elastic_load_balancing/cfn_load_balancer.rb', line 1075

def policy_name
  @policy_name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'elastic_load_balancing/cfn_load_balancer.rb', line 1077

def self.jsii_properties
  {
    :cookie_expiration_period => "cookieExpirationPeriod",
    :policy_name => "policyName",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'elastic_load_balancing/cfn_load_balancer.rb', line 1084

def to_jsii
  result = {}
  result.merge!({
    "cookieExpirationPeriod" => @cookie_expiration_period,
    "policyName" => @policy_name,
  })
  result.compact
end