aws-cdk-lib 2.161.0__py3-none-any.whl → 2.162.0__py3-none-any.whl

aws_cdk/aws_elasticloadbalancingv2/__init__.py

@@ -416,6 +416,24 @@ lb = elbv2.NetworkLoadBalancer(self, "LB",
 )
 ```
 
+### Network Load Balancer Listener attributes
+
+You can modify attributes of Network Load Balancer Listener:
+
+```python
+# lb: elbv2.NetworkLoadBalancer
+# group: elbv2.NetworkTargetGroup
+
+
+listener = lb.add_listener("Listener",
+    port=80,
+    default_action=elbv2.NetworkListenerAction.forward([group]),
+
+    # The tcp idle timeout value. The valid range is 60-6000 seconds. The default is 350 seconds.
+    tcp_idle_timeout=Duration.seconds(100)
+)
+```
+
 ## Targets and Target Groups
 
 Application and Network Load Balancers organize load balancing targets in Target
@@ -3076,6 +3094,7 @@ class BaseLoadBalancerProps:
         "default_target_groups": "defaultTargetGroups",
         "protocol": "protocol",
         "ssl_policy": "sslPolicy",
+        "tcp_idle_timeout": "tcpIdleTimeout",
     },
 )
 class BaseNetworkListenerProps:
@@ -3089,6 +3108,7 @@ class BaseNetworkListenerProps:
         default_target_groups: typing.Optional[typing.Sequence["INetworkTargetGroup"]] = None,
         protocol: typing.Optional["Protocol"] = None,
         ssl_policy: typing.Optional["SslPolicy"] = None,
+        tcp_idle_timeout: typing.Optional[_Duration_4839e8c3] = None,
     ) -> None:
         '''Basic properties for a Network Listener.
 
@@ -3099,31 +3119,36 @@ class BaseNetworkListenerProps:
         :param default_target_groups: Default target groups to load balance to. All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use either ``defaultAction`` or ``addAction()``. Cannot be specified together with ``defaultAction``. Default: - None.
         :param protocol: Protocol for listener, expects TCP, TLS, UDP, or TCP_UDP. Default: - TLS if certificates are provided. TCP otherwise.
         :param ssl_policy: SSL Policy. Default: - Current predefined security policy.
+        :param tcp_idle_timeout: The load balancer TCP idle timeout. Default: Duration.seconds(350)
 
         :exampleMetadata: infused
 
         Example::
 
-            import aws_cdk.aws_elasticloadbalancing as elb
-            import aws_cdk.aws_elasticloadbalancingv2 as elb2
-            
-            # clb: elb.LoadBalancer
-            # alb: elb2.ApplicationLoadBalancer
-            # nlb: elb2.NetworkLoadBalancer
+            # vpc: ec2.Vpc
+            # asg: autoscaling.AutoScalingGroup
+            # sg1: ec2.ISecurityGroup
+            # sg2: ec2.ISecurityGroup
             
             
-            alb_listener = alb.add_listener("ALBListener", port=80)
-            alb_target_group = alb_listener.add_targets("ALBFleet", port=80)
+            # Create the load balancer in a VPC. 'internetFacing' is 'false'
+            # by default, which creates an internal load balancer.
+            lb = elbv2.NetworkLoadBalancer(self, "LB",
+                vpc=vpc,
+                internet_facing=True,
+                security_groups=[sg1]
+            )
+            lb.add_security_group(sg2)
             
-            nlb_listener = nlb.add_listener("NLBListener", port=80)
-            nlb_target_group = nlb_listener.add_targets("NLBFleet", port=80)
+            # Add a listener on a particular port.
+            listener = lb.add_listener("Listener",
+                port=443
+            )
             
-            deployment_group = codedeploy.ServerDeploymentGroup(self, "DeploymentGroup",
-                load_balancers=[
-                    codedeploy.LoadBalancer.classic(clb),
-                    codedeploy.LoadBalancer.application(alb_target_group),
-                    codedeploy.LoadBalancer.network(nlb_target_group)
-                ]
+            # Add targets on a particular port.
+            listener.add_targets("AppFleet",
+                port=443,
+                targets=[asg]
             )
         '''
         if __debug__:
@@ -3135,6 +3160,7 @@ class BaseNetworkListenerProps:
             check_type(argname="argument default_target_groups", value=default_target_groups, expected_type=type_hints["default_target_groups"])
             check_type(argname="argument protocol", value=protocol, expected_type=type_hints["protocol"])
             check_type(argname="argument ssl_policy", value=ssl_policy, expected_type=type_hints["ssl_policy"])
+            check_type(argname="argument tcp_idle_timeout", value=tcp_idle_timeout, expected_type=type_hints["tcp_idle_timeout"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "port": port,
         }
@@ -3150,6 +3176,8 @@ class BaseNetworkListenerProps:
             self._values["protocol"] = protocol
         if ssl_policy is not None:
             self._values["ssl_policy"] = ssl_policy
+        if tcp_idle_timeout is not None:
+            self._values["tcp_idle_timeout"] = tcp_idle_timeout
 
     @builtins.property
     def port(self) -> jsii.Number:
@@ -3232,6 +3260,15 @@ class BaseNetworkListenerProps:
         result = self._values.get("ssl_policy")
         return typing.cast(typing.Optional["SslPolicy"], result)
 
+    @builtins.property
+    def tcp_idle_timeout(self) -> typing.Optional[_Duration_4839e8c3]:
+        '''The load balancer TCP idle timeout.
+
+        :default: Duration.seconds(350)
+        '''
+        result = self._values.get("tcp_idle_timeout")
+        return typing.cast(typing.Optional[_Duration_4839e8c3], result)
+
     def __eq__(self, rhs: typing.Any) -> builtins.bool:
         return isinstance(rhs, self.__class__) and rhs._values == self._values
 
@@ -14026,6 +14063,7 @@ class INetworkLoadBalancer(
         default_target_groups: typing.Optional[typing.Sequence["INetworkTargetGroup"]] = None,
         protocol: typing.Optional["Protocol"] = None,
         ssl_policy: typing.Optional["SslPolicy"] = None,
+        tcp_idle_timeout: typing.Optional[_Duration_4839e8c3] = None,
     ) -> "NetworkListener":
         '''Add a listener to this load balancer.
 
@@ -14037,6 +14075,7 @@ class INetworkLoadBalancer(
         :param default_target_groups: Default target groups to load balance to. All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use either ``defaultAction`` or ``addAction()``. Cannot be specified together with ``defaultAction``. Default: - None.
         :param protocol: Protocol for listener, expects TCP, TLS, UDP, or TCP_UDP. Default: - TLS if certificates are provided. TCP otherwise.
         :param ssl_policy: SSL Policy. Default: - Current predefined security policy.
+        :param tcp_idle_timeout: The load balancer TCP idle timeout. Default: Duration.seconds(350)
 
         :return: The newly created listener
         '''
@@ -14102,6 +14141,7 @@ class _INetworkLoadBalancerProxy(
         default_target_groups: typing.Optional[typing.Sequence["INetworkTargetGroup"]] = None,
         protocol: typing.Optional["Protocol"] = None,
         ssl_policy: typing.Optional["SslPolicy"] = None,
+        tcp_idle_timeout: typing.Optional[_Duration_4839e8c3] = None,
     ) -> "NetworkListener":
         '''Add a listener to this load balancer.
 
@@ -14113,6 +14153,7 @@ class _INetworkLoadBalancerProxy(
         :param default_target_groups: Default target groups to load balance to. All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use either ``defaultAction`` or ``addAction()``. Cannot be specified together with ``defaultAction``. Default: - None.
         :param protocol: Protocol for listener, expects TCP, TLS, UDP, or TCP_UDP. Default: - TLS if certificates are provided. TCP otherwise.
         :param ssl_policy: SSL Policy. Default: - Current predefined security policy.
+        :param tcp_idle_timeout: The load balancer TCP idle timeout. Default: Duration.seconds(350)
 
         :return: The newly created listener
         '''
@@ -14127,6 +14168,7 @@ class _INetworkLoadBalancerProxy(
             default_target_groups=default_target_groups,
             protocol=protocol,
             ssl_policy=ssl_policy,
+            tcp_idle_timeout=tcp_idle_timeout,
         )
 
         return typing.cast("NetworkListener", jsii.invoke(self, "addListener", [id, props]))
@@ -15953,19 +15995,20 @@ class NetworkListenerAction(
     If an action supports chaining, the next action can be indicated
     by passing it in the ``next`` property.
 
-    :exampleMetadata: fixture=_generated
+    :exampleMetadata: infused
 
     Example::
 
-        # The code below shows an example of how to instantiate this type.
-        # The values are placeholders you should change.
-        import aws_cdk as cdk
-        from aws_cdk import aws_elasticloadbalancingv2 as elbv2
+        # lb: elbv2.NetworkLoadBalancer
+        # group: elbv2.NetworkTargetGroup
         
-        # network_target_group: elbv2.NetworkTargetGroup
         
-        network_listener_action = elbv2.NetworkListenerAction.forward([network_target_group],
-            stickiness_duration=cdk.Duration.minutes(30)
+        listener = lb.add_listener("Listener",
+            port=80,
+            default_action=elbv2.NetworkListenerAction.forward([group]),
+        
+            # The tcp idle timeout value. The valid range is 60-6000 seconds. The default is 350 seconds.
+            tcp_idle_timeout=Duration.seconds(100)
         )
     '''
 
@@ -16197,6 +16240,7 @@ class NetworkListenerLookupOptions(BaseListenerLookupOptions):
         "default_target_groups": "defaultTargetGroups",
         "protocol": "protocol",
         "ssl_policy": "sslPolicy",
+        "tcp_idle_timeout": "tcpIdleTimeout",
         "load_balancer": "loadBalancer",
     },
 )
@@ -16211,6 +16255,7 @@ class NetworkListenerProps(BaseNetworkListenerProps):
         default_target_groups: typing.Optional[typing.Sequence["INetworkTargetGroup"]] = None,
         protocol: typing.Optional["Protocol"] = None,
         ssl_policy: typing.Optional["SslPolicy"] = None,
+        tcp_idle_timeout: typing.Optional[_Duration_4839e8c3] = None,
         load_balancer: INetworkLoadBalancer,
     ) -> None:
         '''Properties for a Network Listener attached to a Load Balancer.
@@ -16222,6 +16267,7 @@ class NetworkListenerProps(BaseNetworkListenerProps):
         :param default_target_groups: Default target groups to load balance to. All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use either ``defaultAction`` or ``addAction()``. Cannot be specified together with ``defaultAction``. Default: - None.
         :param protocol: Protocol for listener, expects TCP, TLS, UDP, or TCP_UDP. Default: - TLS if certificates are provided. TCP otherwise.
         :param ssl_policy: SSL Policy. Default: - Current predefined security policy.
+        :param tcp_idle_timeout: The load balancer TCP idle timeout. Default: Duration.seconds(350)
         :param load_balancer: The load balancer to attach this listener to.
 
         :exampleMetadata: fixture=_generated
@@ -16230,6 +16276,7 @@ class NetworkListenerProps(BaseNetworkListenerProps):
 
             # The code below shows an example of how to instantiate this type.
             # The values are placeholders you should change.
+            import aws_cdk as cdk
             from aws_cdk import aws_elasticloadbalancingv2 as elbv2
             
             # listener_certificate: elbv2.ListenerCertificate
@@ -16247,7 +16294,8 @@ class NetworkListenerProps(BaseNetworkListenerProps):
                 default_action=network_listener_action,
                 default_target_groups=[network_target_group],
                 protocol=elbv2.Protocol.HTTP,
-                ssl_policy=elbv2.SslPolicy.RECOMMENDED_TLS
+                ssl_policy=elbv2.SslPolicy.RECOMMENDED_TLS,
+                tcp_idle_timeout=cdk.Duration.minutes(30)
             )
         '''
         if __debug__:
@@ -16259,6 +16307,7 @@ class NetworkListenerProps(BaseNetworkListenerProps):
             check_type(argname="argument default_target_groups", value=default_target_groups, expected_type=type_hints["default_target_groups"])
             check_type(argname="argument protocol", value=protocol, expected_type=type_hints["protocol"])
             check_type(argname="argument ssl_policy", value=ssl_policy, expected_type=type_hints["ssl_policy"])
+            check_type(argname="argument tcp_idle_timeout", value=tcp_idle_timeout, expected_type=type_hints["tcp_idle_timeout"])
             check_type(argname="argument load_balancer", value=load_balancer, expected_type=type_hints["load_balancer"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "port": port,
@@ -16276,6 +16325,8 @@ class NetworkListenerProps(BaseNetworkListenerProps):
             self._values["protocol"] = protocol
         if ssl_policy is not None:
             self._values["ssl_policy"] = ssl_policy
+        if tcp_idle_timeout is not None:
+            self._values["tcp_idle_timeout"] = tcp_idle_timeout
 
     @builtins.property
     def port(self) -> jsii.Number:
@@ -16358,6 +16409,15 @@ class NetworkListenerProps(BaseNetworkListenerProps):
         result = self._values.get("ssl_policy")
         return typing.cast(typing.Optional["SslPolicy"], result)
 
+    @builtins.property
+    def tcp_idle_timeout(self) -> typing.Optional[_Duration_4839e8c3]:
+        '''The load balancer TCP idle timeout.
+
+        :default: Duration.seconds(350)
+        '''
+        result = self._values.get("tcp_idle_timeout")
+        return typing.cast(typing.Optional[_Duration_4839e8c3], result)
+
     @builtins.property
     def load_balancer(self) -> INetworkLoadBalancer:
         '''The load balancer to attach this listener to.'''
@@ -16532,6 +16592,7 @@ class NetworkLoadBalancer(
         default_target_groups: typing.Optional[typing.Sequence["INetworkTargetGroup"]] = None,
         protocol: typing.Optional["Protocol"] = None,
         ssl_policy: typing.Optional["SslPolicy"] = None,
+        tcp_idle_timeout: typing.Optional[_Duration_4839e8c3] = None,
     ) -> "NetworkListener":
         '''Add a listener to this load balancer.
 
@@ -16543,6 +16604,7 @@ class NetworkLoadBalancer(
         :param default_target_groups: Default target groups to load balance to. All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use either ``defaultAction`` or ``addAction()``. Cannot be specified together with ``defaultAction``. Default: - None.
         :param protocol: Protocol for listener, expects TCP, TLS, UDP, or TCP_UDP. Default: - TLS if certificates are provided. TCP otherwise.
         :param ssl_policy: SSL Policy. Default: - Current predefined security policy.
+        :param tcp_idle_timeout: The load balancer TCP idle timeout. Default: Duration.seconds(350)
 
         :return: The newly created listener
         '''
@@ -16557,6 +16619,7 @@ class NetworkLoadBalancer(
             default_target_groups=default_target_groups,
             protocol=protocol,
             ssl_policy=ssl_policy,
+            tcp_idle_timeout=tcp_idle_timeout,
         )
 
         return typing.cast("NetworkListener", jsii.invoke(self, "addListener", [id, props]))
@@ -20988,6 +21051,36 @@ class BaseListener(
             check_type(argname="argument additional_props", value=additional_props, expected_type=type_hints["additional_props"])
         jsii.create(self.__class__, self, [scope, id, additional_props])
 
+    @jsii.member(jsii_name="removeAttribute")
+    def remove_attribute(self, key: builtins.str) -> None:
+        '''Remove an attribute from the listener.
+
+        :param key: -
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__c50cdcdb39546c11e1129be3e435478ae3110391c8b527b7e659324c42ebeae6)
+            check_type(argname="argument key", value=key, expected_type=type_hints["key"])
+        return typing.cast(None, jsii.invoke(self, "removeAttribute", [key]))
+
+    @jsii.member(jsii_name="setAttribute")
+    def set_attribute(
+        self,
+        key: builtins.str,
+        value: typing.Optional[builtins.str] = None,
+    ) -> None:
+        '''Set a non-standard attribute on the listener.
+
+        :param key: -
+        :param value: -
+
+        :see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-listenerattribute.html
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__42b74f8396752d37baeef333f99c80d4ed81c443c6410c4f4002f7a35e29fdc6)
+            check_type(argname="argument key", value=key, expected_type=type_hints["key"])
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        return typing.cast(None, jsii.invoke(self, "setAttribute", [key, value]))
+
     @jsii.member(jsii_name="validateListener")
     def _validate_listener(self) -> typing.List[builtins.str]:
         '''Validate this listener.'''
@@ -21748,6 +21841,7 @@ class NetworkListener(
         default_target_groups: typing.Optional[typing.Sequence[INetworkTargetGroup]] = None,
         protocol: typing.Optional[Protocol] = None,
         ssl_policy: typing.Optional[SslPolicy] = None,
+        tcp_idle_timeout: typing.Optional[_Duration_4839e8c3] = None,
     ) -> None:
         '''
         :param scope: -
@@ -21760,6 +21854,7 @@ class NetworkListener(
         :param default_target_groups: Default target groups to load balance to. All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use either ``defaultAction`` or ``addAction()``. Cannot be specified together with ``defaultAction``. Default: - None.
         :param protocol: Protocol for listener, expects TCP, TLS, UDP, or TCP_UDP. Default: - TLS if certificates are provided. TCP otherwise.
         :param ssl_policy: SSL Policy. Default: - Current predefined security policy.
+        :param tcp_idle_timeout: The load balancer TCP idle timeout. Default: Duration.seconds(350)
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__cac0b8bab6f5e8734bcf3c5bf0647c916d90f092956b733c3913017a1cc4c8c8)
@@ -21774,6 +21869,7 @@ class NetworkListener(
             default_target_groups=default_target_groups,
             protocol=protocol,
             ssl_policy=ssl_policy,
+            tcp_idle_timeout=tcp_idle_timeout,
         )
 
         jsii.create(self.__class__, self, [scope, id, props])
@@ -24894,6 +24990,7 @@ def _typecheckingstub__a385469057e83b68d89a4be7454c5a114db610783f984a1d85c9d4b71
     default_target_groups: typing.Optional[typing.Sequence[INetworkTargetGroup]] = None,
     protocol: typing.Optional[Protocol] = None,
     ssl_policy: typing.Optional[SslPolicy] = None,
+    tcp_idle_timeout: typing.Optional[_Duration_4839e8c3] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -25962,6 +26059,7 @@ def _typecheckingstub__f31e236fbcfbdcbd2f2735523996b00775cf0ec61e4f5c56362cc6947
     default_target_groups: typing.Optional[typing.Sequence[INetworkTargetGroup]] = None,
     protocol: typing.Optional[Protocol] = None,
     ssl_policy: typing.Optional[SslPolicy] = None,
+    tcp_idle_timeout: typing.Optional[_Duration_4839e8c3] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -26182,6 +26280,7 @@ def _typecheckingstub__b9de84d3c251bc8c169b44e63c24a91fe9722b0e26642417a58f3f27d
     default_target_groups: typing.Optional[typing.Sequence[INetworkTargetGroup]] = None,
     protocol: typing.Optional[Protocol] = None,
     ssl_policy: typing.Optional[SslPolicy] = None,
+    tcp_idle_timeout: typing.Optional[_Duration_4839e8c3] = None,
     load_balancer: INetworkLoadBalancer,
 ) -> None:
     """Type checking stubs"""
@@ -26239,6 +26338,7 @@ def _typecheckingstub__d4ebcfe1ae99726fbce8c195c9275af3be58b68db2286da916071da8a
     default_target_groups: typing.Optional[typing.Sequence[INetworkTargetGroup]] = None,
     protocol: typing.Optional[Protocol] = None,
     ssl_policy: typing.Optional[SslPolicy] = None,
+    tcp_idle_timeout: typing.Optional[_Duration_4839e8c3] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -26584,6 +26684,19 @@ def _typecheckingstub__129019265615450bb18b1d54a4cbac59e8aa311742b971671f0b94701
     """Type checking stubs"""
     pass
 
+def _typecheckingstub__c50cdcdb39546c11e1129be3e435478ae3110391c8b527b7e659324c42ebeae6(
+    key: builtins.str,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__42b74f8396752d37baeef333f99c80d4ed81c443c6410c4f4002f7a35e29fdc6(
+    key: builtins.str,
+    value: typing.Optional[builtins.str] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__078c8c060ef52d807e9a62da847c7c1f9a2fb0a3f7bf8900246c80b1d9ff0a2e(
     id: builtins.str,
     *,
@@ -26699,6 +26812,7 @@ def _typecheckingstub__cac0b8bab6f5e8734bcf3c5bf0647c916d90f092956b733c3913017a1
     default_target_groups: typing.Optional[typing.Sequence[INetworkTargetGroup]] = None,
     protocol: typing.Optional[Protocol] = None,
     ssl_policy: typing.Optional[SslPolicy] = None,
+    tcp_idle_timeout: typing.Optional[_Duration_4839e8c3] = None,
 ) -> None:
     """Type checking stubs"""
     pass