Class: AWSCDK::ElasticLoadBalancingv2::ApplicationListener

Inherits:
BaseListener
  • Object
show all
Includes:
IApplicationListener
Defined in:
elastic_load_balancingv2/application_listener.rb

Overview

Define an ApplicationListener.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ ApplicationListener

Returns a new instance of ApplicationListener.

Parameters:



12
13
14
15
16
17
18
 
# File 'elastic_load_balancingv2/application_listener.rb', line 12

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::ApplicationListenerProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5BcHBsaWNhdGlvbkxpc3RlbmVyUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_application_listener_attributes(scope, id, attrs) ⇒ AWSCDK::ElasticLoadBalancingv2::IApplicationListener

Import an existing listener.

Parameters:

Returns:



57
58
59
60
61
62
63
 
# File 'elastic_load_balancingv2/application_listener.rb', line 57

def self.from_application_listener_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::ApplicationListenerAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5BcHBsaWNhdGlvbkxpc3RlbmVyQXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener", "fromApplicationListenerAttributes", [scope, id, attrs])
end

.from_lookup(scope, id, options) ⇒ AWSCDK::ElasticLoadBalancingv2::IApplicationListener

Look up an ApplicationListener.

Parameters:

Returns:



71
72
73
74
75
76
77
 
# File 'elastic_load_balancingv2/application_listener.rb', line 71

def self.from_lookup(scope, id, options)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::ApplicationListenerLookupOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5BcHBsaWNhdGlvbkxpc3RlbmVyTG9va3VwT3B0aW9ucyJ9")), "options")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener", "fromLookup", [scope, id, options])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'elastic_load_balancingv2/application_listener.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :listener_arn => { kind: :property, name: "listenerArn", is_optional: false },
    :listener_ref => { kind: :property, name: "listenerRef", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :is_application_listener => { kind: :property, name: "isApplicationListener", is_optional: false },
    :load_balancer => { kind: :property, name: "loadBalancer", is_optional: false },
    :port => { kind: :property, name: "port", is_optional: false },
    :protocol => { kind: :property, name: "protocol", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :remove_attribute => { kind: :method, name: "removeAttribute", is_optional: false },
    :set_attribute => { kind: :method, name: "setAttribute", is_optional: false },
    :validate_listener => { kind: :method, name: "validateListener", is_optional: false },
    :add_action => { kind: :method, name: "addAction", is_optional: false },
    :add_certificates => { kind: :method, name: "addCertificates", is_optional: false },
    :add_target_groups => { kind: :method, name: "addTargetGroups", is_optional: false },
    :add_targets => { kind: :method, name: "addTargets", is_optional: false },
    :register_connectable => { kind: :method, name: "registerConnectable", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


139
140
141
 
# File 'elastic_load_balancingv2/application_listener.rb', line 139

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_action(id, props) ⇒ void

This method returns an undefined value.

Perform the given default action on incoming requests.

This allows full control of the default action of the load balancer, including Action chaining, fixed responses and redirect responses. See the ListenerAction class for all options.

It's possible to add routing conditions to the Action added in this way. At least one Action must be added without conditions (which becomes the default Action).

Parameters:



312
313
314
315
316
317
 
# File 'elastic_load_balancingv2/application_listener.rb', line 312

def add_action(id, props)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::AddApplicationActionProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5BZGRBcHBsaWNhdGlvbkFjdGlvblByb3BzIn0=")), "props")
  jsii_call_method("addAction", [id, props])
end

#add_certificates(id, certificates) ⇒ void

This method returns an undefined value.

Add one or more certificates to this listener.

After the first certificate, this creates ApplicationListenerCertificates resources since cloudformation requires the certificates array on the listener resource to have a length of 1.

Parameters:



328
329
330
331
332
 
# File 'elastic_load_balancingv2/application_listener.rb', line 328

def add_certificates(id, certificates)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(certificates, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZ3YyLklMaXN0ZW5lckNlcnRpZmljYXRlIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "certificates")
  jsii_call_method("addCertificates", [id, certificates])
end

#add_target_groups(id, props) ⇒ void

This method returns an undefined value.

Load balance incoming requests to the given target groups.

All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use add_action().

It's possible to add routing conditions to the TargetGroups added in this way. At least one TargetGroup must be added without conditions (which will become the default Action for this listener).

Parameters:



346
347
348
349
350
351
 
# File 'elastic_load_balancingv2/application_listener.rb', line 346

def add_target_groups(id, props)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::AddApplicationTargetGroupsProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5BZGRBcHBsaWNhdGlvblRhcmdldEdyb3Vwc1Byb3BzIn0=")), "props")
  jsii_call_method("addTargetGroups", [id, props])
end

#add_targets(id, props) ⇒ AWSCDK::ElasticLoadBalancingv2::ApplicationTargetGroup

Load balance incoming requests to the given load balancing targets.

This method implicitly creates an ApplicationTargetGroup for the targets involved, and a 'forward' action to route traffic to the given TargetGroup.

If you want more control over the precise setup, create the TargetGroup and use add_action yourself.

It's possible to add conditions to the targets added in this way. At least one set of targets must be added without conditions.

Parameters:

Returns:



367
368
369
370
371
372
 
# File 'elastic_load_balancingv2/application_listener.rb', line 367

def add_targets(id, props)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::AddApplicationTargetsProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5BZGRBcHBsaWNhdGlvblRhcmdldHNQcm9wcyJ9")), "props")
  jsii_call_method("addTargets", [id, props])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



214
215
216
217
 
# File 'elastic_load_balancingv2/application_listener.rb', line 214

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



231
232
233
234
 
# File 'elastic_load_balancingv2/application_listener.rb', line 231

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#connections ⇒ AWSCDK::EC2::Connections

Manage connections to this ApplicationListener.

Returns:



146
147
148
 
# File 'elastic_load_balancingv2/application_listener.rb', line 146

def connections()
  jsii_get_property("connections")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



97
98
99
 
# File 'elastic_load_balancingv2/application_listener.rb', line 97

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


237
238
239
 
# File 'elastic_load_balancingv2/application_listener.rb', line 237

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


251
252
253
254
255
256
 
# File 'elastic_load_balancingv2/application_listener.rb', line 251

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


266
267
268
269
 
# File 'elastic_load_balancingv2/application_listener.rb', line 266

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#is_application_listener ⇒ Boolean

Indicates that this is an ALB listener.

Will always return true, but is necessary to prevent accidental structural equality in TypeScript.

Returns:

  • (Boolean) 


156
157
158
 
# File 'elastic_load_balancingv2/application_listener.rb', line 156

def is_application_listener()
  jsii_get_property("isApplicationListener")
end

#listener_arn ⇒ String

ARN of the listener.

Returns:

  • (String) 


125
126
127
 
# File 'elastic_load_balancingv2/application_listener.rb', line 125

def listener_arn()
  jsii_get_property("listenerArn")
end

#listener_ref ⇒ AWSCDK::Interfaces::AWSElasticloadbalancingv2::ListenerReference

A reference to this listener.

Returns:



132
133
134
 
# File 'elastic_load_balancingv2/application_listener.rb', line 132

def listener_ref()
  jsii_get_property("listenerRef")
end

#load_balancer ⇒ AWSCDK::ElasticLoadBalancingv2::IApplicationLoadBalancer

Load balancer this listener is associated with.

Returns:



163
164
165
 
# File 'elastic_load_balancingv2/application_listener.rb', line 163

def load_balancer()
  jsii_get_property("loadBalancer")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


82
83
84
 
# File 'elastic_load_balancingv2/application_listener.rb', line 82

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


111
112
113
 
# File 'elastic_load_balancingv2/application_listener.rb', line 111

def physical_name()
  jsii_get_property("physicalName")
end

#port ⇒ Numeric

The port of the listener.

Returns:

  • (Numeric) 


170
171
172
 
# File 'elastic_load_balancingv2/application_listener.rb', line 170

def port()
  jsii_get_property("port")
end

#protocol ⇒ AWSCDK::ElasticLoadBalancingv2::ApplicationProtocol

Listener protocol for this listener.

Returns:



177
178
179
 
# File 'elastic_load_balancingv2/application_listener.rb', line 177

def protocol()
  jsii_get_property("protocol")
end

#register_connectable(connectable, port_range) ⇒ void

This method returns an undefined value.

Register that a connectable that has been added to this load balancer.

Don't call this directly. It is called by ApplicationTargetGroup.

Parameters:



381
382
383
384
385
 
# File 'elastic_load_balancingv2/application_listener.rb', line 381

def register_connectable(connectable, port_range)
  Jsii::Type.check_type(connectable, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklDb25uZWN0YWJsZSJ9")), "connectable")
  Jsii::Type.check_type(port_range, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlBvcnQifQ==")), "portRange")
  jsii_call_method("registerConnectable", [connectable, port_range])
end

#remove_attribute(key) ⇒ void

This method returns an undefined value.

Remove an attribute from the listener.

Parameters:

  • key (String) 


275
276
277
278
 
# File 'elastic_load_balancingv2/application_listener.rb', line 275

def remove_attribute(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("removeAttribute", [key])
end

#set_attribute(key, value = nil) ⇒ void

This method returns an undefined value.

Set a non-standard attribute on the listener.

Parameters:

  • key (String)
  • value (String, nil) (defaults to: nil)

See Also:



286
287
288
289
290
 
# File 'elastic_load_balancingv2/application_listener.rb', line 286

def set_attribute(key, value = nil)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless value.nil?
  jsii_call_method("setAttribute", [key, value])
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



118
119
120
 
# File 'elastic_load_balancingv2/application_listener.rb', line 118

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


184
185
186
 
# File 'elastic_load_balancingv2/application_listener.rb', line 184

def to_string()
  jsii_call_method("toString", [])
end

#validate_listener ⇒ Array<String>

Validate this listener.

Returns:

  • (Array<String>) 


295
296
297
 
# File 'elastic_load_balancingv2/application_listener.rb', line 295

def validate_listener()
  jsii_call_method("validateListener", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


197
198
199
200
201
202
 
# File 'elastic_load_balancingv2/application_listener.rb', line 197

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end