Class: AWSCDK::GlobalAccelerator::CfnEndpointGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
global_accelerator/cfn_endpoint_group_props.rb

Overview

Properties for defining a CfnEndpointGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint_group_region:, listener_arn:, endpoint_configurations: nil, health_check_interval_seconds: nil, health_check_path: nil, health_check_port: nil, health_check_protocol: nil, port_overrides: nil, threshold_count: nil, traffic_dial_percentage: nil) ⇒ CfnEndpointGroupProps

Returns a new instance of CfnEndpointGroupProps.

Parameters:

  • endpoint_group_region (String) —

    The AWS Regions where the endpoint group is located.

  • listener_arn (String, AWSCDK::Interfaces::AWSGlobalaccelerator::IListenerRef) —

    The Amazon Resource Name (ARN) of the listener.

  • endpoint_configurations (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::GlobalAccelerator::CfnEndpointGroup::EndpointConfigurationProperty>, nil) (defaults to: nil) —

    The list of endpoint objects.

  • health_check_interval_seconds (Numeric, nil) (defaults to: nil) —

    The time—10 seconds or 30 seconds—between health checks for each endpoint.

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

    If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks.

  • health_check_port (Numeric, nil) (defaults to: nil) —

    The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

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

    The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

  • port_overrides (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::GlobalAccelerator::CfnEndpointGroup::PortOverrideProperty>, nil) (defaults to: nil) —

    Allows you to override the destination ports used to route traffic to an endpoint.

  • threshold_count (Numeric, nil) (defaults to: nil) —

    The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.

  • traffic_dial_percentage (Numeric, nil) (defaults to: nil) —

    The percentage of traffic to send to an AWS Regions .



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 19

def initialize(endpoint_group_region:, listener_arn:, endpoint_configurations: nil, health_check_interval_seconds: nil, health_check_path: nil, health_check_port: nil, health_check_protocol: nil, port_overrides: nil, threshold_count: nil, traffic_dial_percentage: nil)
  @endpoint_group_region = endpoint_group_region
  Jsii::Type.check_type(@endpoint_group_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointGroupRegion")
  @listener_arn = listener_arn
  Jsii::Type.check_type(@listener_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19nbG9iYWxhY2NlbGVyYXRvci5JTGlzdGVuZXJSZWYifV19fQ==")), "listenerArn")
  @endpoint_configurations = endpoint_configurations
  Jsii::Type.check_type(@endpoint_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2xvYmFsYWNjZWxlcmF0b3IuQ2ZuRW5kcG9pbnRHcm91cC5FbmRwb2ludENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "endpointConfigurations") unless @endpoint_configurations.nil?
  @health_check_interval_seconds = health_check_interval_seconds
  Jsii::Type.check_type(@health_check_interval_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "healthCheckIntervalSeconds") unless @health_check_interval_seconds.nil?
  @health_check_path = health_check_path
  Jsii::Type.check_type(@health_check_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "healthCheckPath") unless @health_check_path.nil?
  @health_check_port = health_check_port
  Jsii::Type.check_type(@health_check_port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "healthCheckPort") unless @health_check_port.nil?
  @health_check_protocol = health_check_protocol
  Jsii::Type.check_type(@health_check_protocol, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "healthCheckProtocol") unless @health_check_protocol.nil?
  @port_overrides = port_overrides
  Jsii::Type.check_type(@port_overrides, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2xvYmFsYWNjZWxlcmF0b3IuQ2ZuRW5kcG9pbnRHcm91cC5Qb3J0T3ZlcnJpZGVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "portOverrides") unless @port_overrides.nil?
  @threshold_count = threshold_count
  Jsii::Type.check_type(@threshold_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "thresholdCount") unless @threshold_count.nil?
  @traffic_dial_percentage = traffic_dial_percentage
  Jsii::Type.check_type(@traffic_dial_percentage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "trafficDialPercentage") unless @traffic_dial_percentage.nil?
end

Instance Attribute Details

#endpoint_configurations ⇒ AWSCDK::IResolvable, ... (readonly)

The list of endpoint objects.

Returns:

See Also:



56
57
58
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 56

def endpoint_configurations
  @endpoint_configurations
end

#endpoint_group_region ⇒ String (readonly)

The AWS Regions where the endpoint group is located.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 46

def endpoint_group_region
  @endpoint_group_region
end

#health_check_interval_seconds ⇒ Numeric? (readonly)

Note:

Default: - 30

The time—10 seconds or 30 seconds—between health checks for each endpoint.

The default value is 30.

Returns:

  • (Numeric, nil)

See Also:



64
65
66
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 64

def health_check_interval_seconds
  @health_check_interval_seconds
end

#health_check_path ⇒ String? (readonly)

Note:

Default: - "/"

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks.

The default is slash (/).

Returns:

  • (String, nil)

See Also:



72
73
74
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 72

def health_check_path
  @health_check_path
end

#health_check_port ⇒ Numeric? (readonly)

Note:

Default: - -1

The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

Returns:

  • (Numeric, nil)

See Also:



80
81
82
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 80

def health_check_port
  @health_check_port
end

#health_check_protocol ⇒ String? (readonly)

Note:

Default: - "TCP"

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default value is TCP.

Returns:

  • (String, nil)

See Also:



88
89
90
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 88

def health_check_protocol
  @health_check_protocol
end

#listener_arn ⇒ String, AWSCDK::Interfaces::AWSGlobalaccelerator::IListenerRef (readonly)

The Amazon Resource Name (ARN) of the listener.

Returns:

See Also:



51
52
53
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 51

def listener_arn
  @listener_arn
end

#port_overrides ⇒ AWSCDK::IResolvable, ... (readonly)

Allows you to override the destination ports used to route traffic to an endpoint.

Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

Returns:

See Also:



95
96
97
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 95

def port_overrides
  @port_overrides
end

#threshold_count ⇒ Numeric? (readonly)

Note:

Default: - 3

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.

The default value is 3.

Returns:

  • (Numeric, nil)

See Also:



103
104
105
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 103

def threshold_count
  @threshold_count
end

#traffic_dial_percentage ⇒ Numeric? (readonly)

Note:

Default: - 100

The percentage of traffic to send to an AWS Regions .

Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

Returns:

  • (Numeric, nil)

See Also:



115
116
117
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 115

def traffic_dial_percentage
  @traffic_dial_percentage
end

Class Method Details

.jsii_properties ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 117

def self.jsii_properties
  {
    :endpoint_group_region => "endpointGroupRegion",
    :listener_arn => "listenerArn",
    :endpoint_configurations => "endpointConfigurations",
    :health_check_interval_seconds => "healthCheckIntervalSeconds",
    :health_check_path => "healthCheckPath",
    :health_check_port => "healthCheckPort",
    :health_check_protocol => "healthCheckProtocol",
    :port_overrides => "portOverrides",
    :threshold_count => "thresholdCount",
    :traffic_dial_percentage => "trafficDialPercentage",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'global_accelerator/cfn_endpoint_group_props.rb', line 132

def to_jsii
  result = {}
  result.merge!({
    "endpointGroupRegion" => @endpoint_group_region,
    "listenerArn" => @listener_arn,
    "endpointConfigurations" => @endpoint_configurations,
    "healthCheckIntervalSeconds" => @health_check_interval_seconds,
    "healthCheckPath" => @health_check_path,
    "healthCheckPort" => @health_check_port,
    "healthCheckProtocol" => @health_check_protocol,
    "portOverrides" => @port_overrides,
    "thresholdCount" => @threshold_count,
    "trafficDialPercentage" => @traffic_dial_percentage,
  })
  result.compact
end