elbv2.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {WaiterConfiguration} from '../lib/service'; 6 import {ServiceConfigurationOptions} from '../lib/service'; 7 import {ConfigBase as Config} from '../lib/config-base'; 8 interface Blob {} 9 declare class ELBv2 extends Service { 10 /** 11 * Constructs a service object. This object has one method for each API operation. 12 */ 13 constructor(options?: ELBv2.Types.ClientConfiguration) 14 config: Config & ELBv2.Types.ClientConfiguration; 15 /** 16 * Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener. If the certificate in already in the certificate list, the call is successful but the certificate is not added again. For more information, see HTTPS listeners in the Application Load Balancers Guide or TLS listeners in the Network Load Balancers Guide. 17 */ 18 addListenerCertificates(params: ELBv2.Types.AddListenerCertificatesInput, callback?: (err: AWSError, data: ELBv2.Types.AddListenerCertificatesOutput) => void): Request<ELBv2.Types.AddListenerCertificatesOutput, AWSError>; 19 /** 20 * Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener. If the certificate in already in the certificate list, the call is successful but the certificate is not added again. For more information, see HTTPS listeners in the Application Load Balancers Guide or TLS listeners in the Network Load Balancers Guide. 21 */ 22 addListenerCertificates(callback?: (err: AWSError, data: ELBv2.Types.AddListenerCertificatesOutput) => void): Request<ELBv2.Types.AddListenerCertificatesOutput, AWSError>; 23 /** 24 * Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, and rules. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value. 25 */ 26 addTags(params: ELBv2.Types.AddTagsInput, callback?: (err: AWSError, data: ELBv2.Types.AddTagsOutput) => void): Request<ELBv2.Types.AddTagsOutput, AWSError>; 27 /** 28 * Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, and rules. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value. 29 */ 30 addTags(callback?: (err: AWSError, data: ELBv2.Types.AddTagsOutput) => void): Request<ELBv2.Types.AddTagsOutput, AWSError>; 31 /** 32 * Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. For more information, see the following: Listeners for your Application Load Balancers Listeners for your Network Load Balancers Listeners for your Gateway Load Balancers This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds. 33 */ 34 createListener(params: ELBv2.Types.CreateListenerInput, callback?: (err: AWSError, data: ELBv2.Types.CreateListenerOutput) => void): Request<ELBv2.Types.CreateListenerOutput, AWSError>; 35 /** 36 * Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. For more information, see the following: Listeners for your Application Load Balancers Listeners for your Network Load Balancers Listeners for your Gateway Load Balancers This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds. 37 */ 38 createListener(callback?: (err: AWSError, data: ELBv2.Types.CreateListenerOutput) => void): Request<ELBv2.Types.CreateListenerOutput, AWSError>; 39 /** 40 * Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. For more information, see the following: Application Load Balancers Network Load Balancers Gateway Load Balancers This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds. 41 */ 42 createLoadBalancer(params: ELBv2.Types.CreateLoadBalancerInput, callback?: (err: AWSError, data: ELBv2.Types.CreateLoadBalancerOutput) => void): Request<ELBv2.Types.CreateLoadBalancerOutput, AWSError>; 43 /** 44 * Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. For more information, see the following: Application Load Balancers Network Load Balancers Gateway Load Balancers This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds. 45 */ 46 createLoadBalancer(callback?: (err: AWSError, data: ELBv2.Types.CreateLoadBalancerOutput) => void): Request<ELBv2.Types.CreateLoadBalancerOutput, AWSError>; 47 /** 48 * Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide. 49 */ 50 createRule(params: ELBv2.Types.CreateRuleInput, callback?: (err: AWSError, data: ELBv2.Types.CreateRuleOutput) => void): Request<ELBv2.Types.CreateRuleOutput, AWSError>; 51 /** 52 * Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide. 53 */ 54 createRule(callback?: (err: AWSError, data: ELBv2.Types.CreateRuleOutput) => void): Request<ELBv2.Types.CreateRuleOutput, AWSError>; 55 /** 56 * Creates a target group. For more information, see the following: Target groups for your Application Load Balancers Target groups for your Network Load Balancers Target groups for your Gateway Load Balancers This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds. 57 */ 58 createTargetGroup(params: ELBv2.Types.CreateTargetGroupInput, callback?: (err: AWSError, data: ELBv2.Types.CreateTargetGroupOutput) => void): Request<ELBv2.Types.CreateTargetGroupOutput, AWSError>; 59 /** 60 * Creates a target group. For more information, see the following: Target groups for your Application Load Balancers Target groups for your Network Load Balancers Target groups for your Gateway Load Balancers This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds. 61 */ 62 createTargetGroup(callback?: (err: AWSError, data: ELBv2.Types.CreateTargetGroupOutput) => void): Request<ELBv2.Types.CreateTargetGroupOutput, AWSError>; 63 /** 64 * Deletes the specified listener. Alternatively, your listener is deleted when you delete the load balancer to which it is attached. 65 */ 66 deleteListener(params: ELBv2.Types.DeleteListenerInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteListenerOutput) => void): Request<ELBv2.Types.DeleteListenerOutput, AWSError>; 67 /** 68 * Deletes the specified listener. Alternatively, your listener is deleted when you delete the load balancer to which it is attached. 69 */ 70 deleteListener(callback?: (err: AWSError, data: ELBv2.Types.DeleteListenerOutput) => void): Request<ELBv2.Types.DeleteListenerOutput, AWSError>; 71 /** 72 * Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners. You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds. Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them. 73 */ 74 deleteLoadBalancer(params: ELBv2.Types.DeleteLoadBalancerInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteLoadBalancerOutput) => void): Request<ELBv2.Types.DeleteLoadBalancerOutput, AWSError>; 75 /** 76 * Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners. You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds. Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them. 77 */ 78 deleteLoadBalancer(callback?: (err: AWSError, data: ELBv2.Types.DeleteLoadBalancerOutput) => void): Request<ELBv2.Types.DeleteLoadBalancerOutput, AWSError>; 79 /** 80 * Deletes the specified rule. You can't delete the default rule. 81 */ 82 deleteRule(params: ELBv2.Types.DeleteRuleInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteRuleOutput) => void): Request<ELBv2.Types.DeleteRuleOutput, AWSError>; 83 /** 84 * Deletes the specified rule. You can't delete the default rule. 85 */ 86 deleteRule(callback?: (err: AWSError, data: ELBv2.Types.DeleteRuleOutput) => void): Request<ELBv2.Types.DeleteRuleOutput, AWSError>; 87 /** 88 * Deletes the specified target group. You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks. Deleting a target group does not affect its registered targets. For example, any EC2 instances continue to run until you stop or terminate them. 89 */ 90 deleteTargetGroup(params: ELBv2.Types.DeleteTargetGroupInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteTargetGroupOutput) => void): Request<ELBv2.Types.DeleteTargetGroupOutput, AWSError>; 91 /** 92 * Deletes the specified target group. You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks. Deleting a target group does not affect its registered targets. For example, any EC2 instances continue to run until you stop or terminate them. 93 */ 94 deleteTargetGroup(callback?: (err: AWSError, data: ELBv2.Types.DeleteTargetGroupOutput) => void): Request<ELBv2.Types.DeleteTargetGroupOutput, AWSError>; 95 /** 96 * Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer. 97 */ 98 deregisterTargets(params: ELBv2.Types.DeregisterTargetsInput, callback?: (err: AWSError, data: ELBv2.Types.DeregisterTargetsOutput) => void): Request<ELBv2.Types.DeregisterTargetsOutput, AWSError>; 99 /** 100 * Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer. 101 */ 102 deregisterTargets(callback?: (err: AWSError, data: ELBv2.Types.DeregisterTargetsOutput) => void): Request<ELBv2.Types.DeregisterTargetsOutput, AWSError>; 103 /** 104 * Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account. For more information, see the following: Quotas for your Application Load Balancers Quotas for your Network Load Balancers Quotas for your Gateway Load Balancers 105 */ 106 describeAccountLimits(params: ELBv2.Types.DescribeAccountLimitsInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeAccountLimitsOutput) => void): Request<ELBv2.Types.DescribeAccountLimitsOutput, AWSError>; 107 /** 108 * Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account. For more information, see the following: Quotas for your Application Load Balancers Quotas for your Network Load Balancers Quotas for your Gateway Load Balancers 109 */ 110 describeAccountLimits(callback?: (err: AWSError, data: ELBv2.Types.DescribeAccountLimitsOutput) => void): Request<ELBv2.Types.DescribeAccountLimitsOutput, AWSError>; 111 /** 112 * Describes the default certificate and the certificate list for the specified HTTPS or TLS listener. If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false). For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide. 113 */ 114 describeListenerCertificates(params: ELBv2.Types.DescribeListenerCertificatesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeListenerCertificatesOutput) => void): Request<ELBv2.Types.DescribeListenerCertificatesOutput, AWSError>; 115 /** 116 * Describes the default certificate and the certificate list for the specified HTTPS or TLS listener. If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false). For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide. 117 */ 118 describeListenerCertificates(callback?: (err: AWSError, data: ELBv2.Types.DescribeListenerCertificatesOutput) => void): Request<ELBv2.Types.DescribeListenerCertificatesOutput, AWSError>; 119 /** 120 * Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners. 121 */ 122 describeListeners(params: ELBv2.Types.DescribeListenersInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeListenersOutput) => void): Request<ELBv2.Types.DescribeListenersOutput, AWSError>; 123 /** 124 * Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners. 125 */ 126 describeListeners(callback?: (err: AWSError, data: ELBv2.Types.DescribeListenersOutput) => void): Request<ELBv2.Types.DescribeListenersOutput, AWSError>; 127 /** 128 * Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. For more information, see the following: Load balancer attributes in the Application Load Balancers Guide Load balancer attributes in the Network Load Balancers Guide Load balancer attributes in the Gateway Load Balancers Guide 129 */ 130 describeLoadBalancerAttributes(params: ELBv2.Types.DescribeLoadBalancerAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancerAttributesOutput) => void): Request<ELBv2.Types.DescribeLoadBalancerAttributesOutput, AWSError>; 131 /** 132 * Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. For more information, see the following: Load balancer attributes in the Application Load Balancers Guide Load balancer attributes in the Network Load Balancers Guide Load balancer attributes in the Gateway Load Balancers Guide 133 */ 134 describeLoadBalancerAttributes(callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancerAttributesOutput) => void): Request<ELBv2.Types.DescribeLoadBalancerAttributesOutput, AWSError>; 135 /** 136 * Describes the specified load balancers or all of your load balancers. 137 */ 138 describeLoadBalancers(params: ELBv2.Types.DescribeLoadBalancersInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>; 139 /** 140 * Describes the specified load balancers or all of your load balancers. 141 */ 142 describeLoadBalancers(callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>; 143 /** 144 * Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules. 145 */ 146 describeRules(params: ELBv2.Types.DescribeRulesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeRulesOutput) => void): Request<ELBv2.Types.DescribeRulesOutput, AWSError>; 147 /** 148 * Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules. 149 */ 150 describeRules(callback?: (err: AWSError, data: ELBv2.Types.DescribeRulesOutput) => void): Request<ELBv2.Types.DescribeRulesOutput, AWSError>; 151 /** 152 * Describes the specified policies or all policies used for SSL negotiation. For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide. 153 */ 154 describeSSLPolicies(params: ELBv2.Types.DescribeSSLPoliciesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeSSLPoliciesOutput) => void): Request<ELBv2.Types.DescribeSSLPoliciesOutput, AWSError>; 155 /** 156 * Describes the specified policies or all policies used for SSL negotiation. For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide. 157 */ 158 describeSSLPolicies(callback?: (err: AWSError, data: ELBv2.Types.DescribeSSLPoliciesOutput) => void): Request<ELBv2.Types.DescribeSSLPoliciesOutput, AWSError>; 159 /** 160 * Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules. 161 */ 162 describeTags(params: ELBv2.Types.DescribeTagsInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTagsOutput) => void): Request<ELBv2.Types.DescribeTagsOutput, AWSError>; 163 /** 164 * Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules. 165 */ 166 describeTags(callback?: (err: AWSError, data: ELBv2.Types.DescribeTagsOutput) => void): Request<ELBv2.Types.DescribeTagsOutput, AWSError>; 167 /** 168 * Describes the attributes for the specified target group. For more information, see the following: Target group attributes in the Application Load Balancers Guide Target group attributes in the Network Load Balancers Guide Target group attributes in the Gateway Load Balancers Guide 169 */ 170 describeTargetGroupAttributes(params: ELBv2.Types.DescribeTargetGroupAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupAttributesOutput) => void): Request<ELBv2.Types.DescribeTargetGroupAttributesOutput, AWSError>; 171 /** 172 * Describes the attributes for the specified target group. For more information, see the following: Target group attributes in the Application Load Balancers Guide Target group attributes in the Network Load Balancers Guide Target group attributes in the Gateway Load Balancers Guide 173 */ 174 describeTargetGroupAttributes(callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupAttributesOutput) => void): Request<ELBv2.Types.DescribeTargetGroupAttributesOutput, AWSError>; 175 /** 176 * Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups. 177 */ 178 describeTargetGroups(params: ELBv2.Types.DescribeTargetGroupsInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupsOutput) => void): Request<ELBv2.Types.DescribeTargetGroupsOutput, AWSError>; 179 /** 180 * Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups. 181 */ 182 describeTargetGroups(callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupsOutput) => void): Request<ELBv2.Types.DescribeTargetGroupsOutput, AWSError>; 183 /** 184 * Describes the health of the specified targets or all of your targets. 185 */ 186 describeTargetHealth(params: ELBv2.Types.DescribeTargetHealthInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>; 187 /** 188 * Describes the health of the specified targets or all of your targets. 189 */ 190 describeTargetHealth(callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>; 191 /** 192 * Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged. Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties. To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action. 193 */ 194 modifyListener(params: ELBv2.Types.ModifyListenerInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyListenerOutput) => void): Request<ELBv2.Types.ModifyListenerOutput, AWSError>; 195 /** 196 * Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged. Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties. To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action. 197 */ 198 modifyListener(callback?: (err: AWSError, data: ELBv2.Types.ModifyListenerOutput) => void): Request<ELBv2.Types.ModifyListenerOutput, AWSError>; 199 /** 200 * Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values. 201 */ 202 modifyLoadBalancerAttributes(params: ELBv2.Types.ModifyLoadBalancerAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyLoadBalancerAttributesOutput) => void): Request<ELBv2.Types.ModifyLoadBalancerAttributesOutput, AWSError>; 203 /** 204 * Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values. 205 */ 206 modifyLoadBalancerAttributes(callback?: (err: AWSError, data: ELBv2.Types.ModifyLoadBalancerAttributesOutput) => void): Request<ELBv2.Types.ModifyLoadBalancerAttributesOutput, AWSError>; 207 /** 208 * Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged. To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action. 209 */ 210 modifyRule(params: ELBv2.Types.ModifyRuleInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyRuleOutput) => void): Request<ELBv2.Types.ModifyRuleOutput, AWSError>; 211 /** 212 * Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged. To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action. 213 */ 214 modifyRule(callback?: (err: AWSError, data: ELBv2.Types.ModifyRuleOutput) => void): Request<ELBv2.Types.ModifyRuleOutput, AWSError>; 215 /** 216 * Modifies the health checks used when evaluating the health state of the targets in the specified target group. 217 */ 218 modifyTargetGroup(params: ELBv2.Types.ModifyTargetGroupInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupOutput) => void): Request<ELBv2.Types.ModifyTargetGroupOutput, AWSError>; 219 /** 220 * Modifies the health checks used when evaluating the health state of the targets in the specified target group. 221 */ 222 modifyTargetGroup(callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupOutput) => void): Request<ELBv2.Types.ModifyTargetGroupOutput, AWSError>; 223 /** 224 * Modifies the specified attributes of the specified target group. 225 */ 226 modifyTargetGroupAttributes(params: ELBv2.Types.ModifyTargetGroupAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupAttributesOutput) => void): Request<ELBv2.Types.ModifyTargetGroupAttributesOutput, AWSError>; 227 /** 228 * Modifies the specified attributes of the specified target group. 229 */ 230 modifyTargetGroupAttributes(callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupAttributesOutput) => void): Request<ELBv2.Types.ModifyTargetGroupAttributesOutput, AWSError>; 231 /** 232 * Registers the specified targets with the specified target group. If the target is an EC2 instance, it must be in the running state when you register it. By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports. With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address. 233 */ 234 registerTargets(params: ELBv2.Types.RegisterTargetsInput, callback?: (err: AWSError, data: ELBv2.Types.RegisterTargetsOutput) => void): Request<ELBv2.Types.RegisterTargetsOutput, AWSError>; 235 /** 236 * Registers the specified targets with the specified target group. If the target is an EC2 instance, it must be in the running state when you register it. By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports. With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address. 237 */ 238 registerTargets(callback?: (err: AWSError, data: ELBv2.Types.RegisterTargetsOutput) => void): Request<ELBv2.Types.RegisterTargetsOutput, AWSError>; 239 /** 240 * Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener. 241 */ 242 removeListenerCertificates(params: ELBv2.Types.RemoveListenerCertificatesInput, callback?: (err: AWSError, data: ELBv2.Types.RemoveListenerCertificatesOutput) => void): Request<ELBv2.Types.RemoveListenerCertificatesOutput, AWSError>; 243 /** 244 * Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener. 245 */ 246 removeListenerCertificates(callback?: (err: AWSError, data: ELBv2.Types.RemoveListenerCertificatesOutput) => void): Request<ELBv2.Types.RemoveListenerCertificatesOutput, AWSError>; 247 /** 248 * Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules. 249 */ 250 removeTags(params: ELBv2.Types.RemoveTagsInput, callback?: (err: AWSError, data: ELBv2.Types.RemoveTagsOutput) => void): Request<ELBv2.Types.RemoveTagsOutput, AWSError>; 251 /** 252 * Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules. 253 */ 254 removeTags(callback?: (err: AWSError, data: ELBv2.Types.RemoveTagsOutput) => void): Request<ELBv2.Types.RemoveTagsOutput, AWSError>; 255 /** 256 * Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer. 257 */ 258 setIpAddressType(params: ELBv2.Types.SetIpAddressTypeInput, callback?: (err: AWSError, data: ELBv2.Types.SetIpAddressTypeOutput) => void): Request<ELBv2.Types.SetIpAddressTypeOutput, AWSError>; 259 /** 260 * Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer. 261 */ 262 setIpAddressType(callback?: (err: AWSError, data: ELBv2.Types.SetIpAddressTypeOutput) => void): Request<ELBv2.Types.SetIpAddressTypeOutput, AWSError>; 263 /** 264 * Sets the priorities of the specified rules. You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority. 265 */ 266 setRulePriorities(params: ELBv2.Types.SetRulePrioritiesInput, callback?: (err: AWSError, data: ELBv2.Types.SetRulePrioritiesOutput) => void): Request<ELBv2.Types.SetRulePrioritiesOutput, AWSError>; 267 /** 268 * Sets the priorities of the specified rules. You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority. 269 */ 270 setRulePriorities(callback?: (err: AWSError, data: ELBv2.Types.SetRulePrioritiesOutput) => void): Request<ELBv2.Types.SetRulePrioritiesOutput, AWSError>; 271 /** 272 * Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups. You can't specify a security group for a Network Load Balancer or Gateway Load Balancer. 273 */ 274 setSecurityGroups(params: ELBv2.Types.SetSecurityGroupsInput, callback?: (err: AWSError, data: ELBv2.Types.SetSecurityGroupsOutput) => void): Request<ELBv2.Types.SetSecurityGroupsOutput, AWSError>; 275 /** 276 * Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups. You can't specify a security group for a Network Load Balancer or Gateway Load Balancer. 277 */ 278 setSecurityGroups(callback?: (err: AWSError, data: ELBv2.Types.SetSecurityGroupsOutput) => void): Request<ELBv2.Types.SetSecurityGroupsOutput, AWSError>; 279 /** 280 * Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer. The specified subnets replace the previously enabled subnets. When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets. 281 */ 282 setSubnets(params: ELBv2.Types.SetSubnetsInput, callback?: (err: AWSError, data: ELBv2.Types.SetSubnetsOutput) => void): Request<ELBv2.Types.SetSubnetsOutput, AWSError>; 283 /** 284 * Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer or Network Load Balancer. The specified subnets replace the previously enabled subnets. When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets. 285 */ 286 setSubnets(callback?: (err: AWSError, data: ELBv2.Types.SetSubnetsOutput) => void): Request<ELBv2.Types.SetSubnetsOutput, AWSError>; 287 /** 288 * Waits for the loadBalancerExists state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). 289 */ 290 waitFor(state: "loadBalancerExists", params: ELBv2.Types.DescribeLoadBalancersInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>; 291 /** 292 * Waits for the loadBalancerExists state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). 293 */ 294 waitFor(state: "loadBalancerExists", callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>; 295 /** 296 * Waits for the loadBalancerAvailable state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). 297 */ 298 waitFor(state: "loadBalancerAvailable", params: ELBv2.Types.DescribeLoadBalancersInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>; 299 /** 300 * Waits for the loadBalancerAvailable state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). 301 */ 302 waitFor(state: "loadBalancerAvailable", callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>; 303 /** 304 * Waits for the loadBalancersDeleted state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). 305 */ 306 waitFor(state: "loadBalancersDeleted", params: ELBv2.Types.DescribeLoadBalancersInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>; 307 /** 308 * Waits for the loadBalancersDeleted state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times). 309 */ 310 waitFor(state: "loadBalancersDeleted", callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>; 311 /** 312 * Waits for the targetInService state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times). 313 */ 314 waitFor(state: "targetInService", params: ELBv2.Types.DescribeTargetHealthInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>; 315 /** 316 * Waits for the targetInService state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times). 317 */ 318 waitFor(state: "targetInService", callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>; 319 /** 320 * Waits for the targetDeregistered state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times). 321 */ 322 waitFor(state: "targetDeregistered", params: ELBv2.Types.DescribeTargetHealthInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>; 323 /** 324 * Waits for the targetDeregistered state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times). 325 */ 326 waitFor(state: "targetDeregistered", callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>; 327 } 328 declare namespace ELBv2 { 329 export interface Action { 330 /** 331 * The type of action. 332 */ 333 Type: ActionTypeEnum; 334 /** 335 * The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead. 336 */ 337 TargetGroupArn?: TargetGroupArn; 338 /** 339 * [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc. 340 */ 341 AuthenticateOidcConfig?: AuthenticateOidcActionConfig; 342 /** 343 * [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito. 344 */ 345 AuthenticateCognitoConfig?: AuthenticateCognitoActionConfig; 346 /** 347 * The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. 348 */ 349 Order?: ActionOrder; 350 /** 351 * [Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect. 352 */ 353 RedirectConfig?: RedirectActionConfig; 354 /** 355 * [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response. 356 */ 357 FixedResponseConfig?: FixedResponseActionConfig; 358 /** 359 * Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn. 360 */ 361 ForwardConfig?: ForwardActionConfig; 362 } 363 export type ActionOrder = number; 364 export type ActionTypeEnum = "forward"|"authenticate-oidc"|"authenticate-cognito"|"redirect"|"fixed-response"|string; 365 export type Actions = Action[]; 366 export interface AddListenerCertificatesInput { 367 /** 368 * The Amazon Resource Name (ARN) of the listener. 369 */ 370 ListenerArn: ListenerArn; 371 /** 372 * The certificate to add. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault. 373 */ 374 Certificates: CertificateList; 375 } 376 export interface AddListenerCertificatesOutput { 377 /** 378 * Information about the certificates in the certificate list. 379 */ 380 Certificates?: CertificateList; 381 } 382 export interface AddTagsInput { 383 /** 384 * The Amazon Resource Name (ARN) of the resource. 385 */ 386 ResourceArns: ResourceArns; 387 /** 388 * The tags. 389 */ 390 Tags: TagList; 391 } 392 export interface AddTagsOutput { 393 } 394 export type AllocationId = string; 395 export type AlpnPolicyName = AlpnPolicyValue[]; 396 export type AlpnPolicyValue = string; 397 export type AuthenticateCognitoActionAuthenticationRequestExtraParams = {[key: string]: AuthenticateCognitoActionAuthenticationRequestParamValue}; 398 export type AuthenticateCognitoActionAuthenticationRequestParamName = string; 399 export type AuthenticateCognitoActionAuthenticationRequestParamValue = string; 400 export type AuthenticateCognitoActionConditionalBehaviorEnum = "deny"|"allow"|"authenticate"|string; 401 export interface AuthenticateCognitoActionConfig { 402 /** 403 * The Amazon Resource Name (ARN) of the Amazon Cognito user pool. 404 */ 405 UserPoolArn: AuthenticateCognitoActionUserPoolArn; 406 /** 407 * The ID of the Amazon Cognito user pool client. 408 */ 409 UserPoolClientId: AuthenticateCognitoActionUserPoolClientId; 410 /** 411 * The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. 412 */ 413 UserPoolDomain: AuthenticateCognitoActionUserPoolDomain; 414 /** 415 * The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. 416 */ 417 SessionCookieName?: AuthenticateCognitoActionSessionCookieName; 418 /** 419 * The set of user claims to be requested from the IdP. The default is openid. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. 420 */ 421 Scope?: AuthenticateCognitoActionScope; 422 /** 423 * The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). 424 */ 425 SessionTimeout?: AuthenticateCognitoActionSessionTimeout; 426 /** 427 * The query parameters (up to 10) to include in the redirect request to the authorization endpoint. 428 */ 429 AuthenticationRequestExtraParams?: AuthenticateCognitoActionAuthenticationRequestExtraParams; 430 /** 431 * The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. 432 */ 433 OnUnauthenticatedRequest?: AuthenticateCognitoActionConditionalBehaviorEnum; 434 } 435 export type AuthenticateCognitoActionScope = string; 436 export type AuthenticateCognitoActionSessionCookieName = string; 437 export type AuthenticateCognitoActionSessionTimeout = number; 438 export type AuthenticateCognitoActionUserPoolArn = string; 439 export type AuthenticateCognitoActionUserPoolClientId = string; 440 export type AuthenticateCognitoActionUserPoolDomain = string; 441 export type AuthenticateOidcActionAuthenticationRequestExtraParams = {[key: string]: AuthenticateOidcActionAuthenticationRequestParamValue}; 442 export type AuthenticateOidcActionAuthenticationRequestParamName = string; 443 export type AuthenticateOidcActionAuthenticationRequestParamValue = string; 444 export type AuthenticateOidcActionAuthorizationEndpoint = string; 445 export type AuthenticateOidcActionClientId = string; 446 export type AuthenticateOidcActionClientSecret = string; 447 export type AuthenticateOidcActionConditionalBehaviorEnum = "deny"|"allow"|"authenticate"|string; 448 export interface AuthenticateOidcActionConfig { 449 /** 450 * The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. 451 */ 452 Issuer: AuthenticateOidcActionIssuer; 453 /** 454 * The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. 455 */ 456 AuthorizationEndpoint: AuthenticateOidcActionAuthorizationEndpoint; 457 /** 458 * The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. 459 */ 460 TokenEndpoint: AuthenticateOidcActionTokenEndpoint; 461 /** 462 * The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. 463 */ 464 UserInfoEndpoint: AuthenticateOidcActionUserInfoEndpoint; 465 /** 466 * The OAuth 2.0 client identifier. 467 */ 468 ClientId: AuthenticateOidcActionClientId; 469 /** 470 * The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true. 471 */ 472 ClientSecret?: AuthenticateOidcActionClientSecret; 473 /** 474 * The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. 475 */ 476 SessionCookieName?: AuthenticateOidcActionSessionCookieName; 477 /** 478 * The set of user claims to be requested from the IdP. The default is openid. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. 479 */ 480 Scope?: AuthenticateOidcActionScope; 481 /** 482 * The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). 483 */ 484 SessionTimeout?: AuthenticateOidcActionSessionTimeout; 485 /** 486 * The query parameters (up to 10) to include in the redirect request to the authorization endpoint. 487 */ 488 AuthenticationRequestExtraParams?: AuthenticateOidcActionAuthenticationRequestExtraParams; 489 /** 490 * The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. 491 */ 492 OnUnauthenticatedRequest?: AuthenticateOidcActionConditionalBehaviorEnum; 493 /** 494 * Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false. 495 */ 496 UseExistingClientSecret?: AuthenticateOidcActionUseExistingClientSecret; 497 } 498 export type AuthenticateOidcActionIssuer = string; 499 export type AuthenticateOidcActionScope = string; 500 export type AuthenticateOidcActionSessionCookieName = string; 501 export type AuthenticateOidcActionSessionTimeout = number; 502 export type AuthenticateOidcActionTokenEndpoint = string; 503 export type AuthenticateOidcActionUseExistingClientSecret = boolean; 504 export type AuthenticateOidcActionUserInfoEndpoint = string; 505 export interface AvailabilityZone { 506 /** 507 * The name of the Availability Zone. 508 */ 509 ZoneName?: ZoneName; 510 /** 511 * The ID of the subnet. You can specify one subnet per Availability Zone. 512 */ 513 SubnetId?: SubnetId; 514 /** 515 * [Application Load Balancers on Outposts] The ID of the Outpost. 516 */ 517 OutpostId?: OutpostId; 518 /** 519 * [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet. 520 */ 521 LoadBalancerAddresses?: LoadBalancerAddresses; 522 } 523 export type AvailabilityZones = AvailabilityZone[]; 524 export type CanonicalHostedZoneId = string; 525 export interface Certificate { 526 /** 527 * The Amazon Resource Name (ARN) of the certificate. 528 */ 529 CertificateArn?: CertificateArn; 530 /** 531 * Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates. 532 */ 533 IsDefault?: Default; 534 } 535 export type CertificateArn = string; 536 export type CertificateList = Certificate[]; 537 export interface Cipher { 538 /** 539 * The name of the cipher. 540 */ 541 Name?: CipherName; 542 /** 543 * The priority of the cipher. 544 */ 545 Priority?: CipherPriority; 546 } 547 export type CipherName = string; 548 export type CipherPriority = number; 549 export type Ciphers = Cipher[]; 550 export type ConditionFieldName = string; 551 export interface CreateListenerInput { 552 /** 553 * The Amazon Resource Name (ARN) of the load balancer. 554 */ 555 LoadBalancerArn: LoadBalancerArn; 556 /** 557 * The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer. 558 */ 559 Protocol?: ProtocolEnum; 560 /** 561 * The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer. 562 */ 563 Port?: Port; 564 /** 565 * [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide. 566 */ 567 SslPolicy?: SslPolicyName; 568 /** 569 * [HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault. 570 */ 571 Certificates?: CertificateList; 572 /** 573 * The actions for the default rule. 574 */ 575 DefaultActions: Actions; 576 /** 577 * [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values: HTTP1Only HTTP2Only HTTP2Optional HTTP2Preferred None For more information, see ALPN policies in the Network Load Balancers Guide. 578 */ 579 AlpnPolicy?: AlpnPolicyName; 580 /** 581 * The tags to assign to the listener. 582 */ 583 Tags?: TagList; 584 } 585 export interface CreateListenerOutput { 586 /** 587 * Information about the listener. 588 */ 589 Listeners?: Listeners; 590 } 591 export interface CreateLoadBalancerInput { 592 /** 593 * The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-". 594 */ 595 Name: LoadBalancerName; 596 /** 597 * The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. 598 */ 599 Subnets?: Subnets; 600 /** 601 * The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets. 602 */ 603 SubnetMappings?: SubnetMappings; 604 /** 605 * [Application Load Balancers] The IDs of the security groups for the load balancer. 606 */ 607 SecurityGroups?: SecurityGroups; 608 /** 609 * The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You cannot specify a scheme for a Gateway Load Balancer. 610 */ 611 Scheme?: LoadBalancerSchemeEnum; 612 /** 613 * The tags to assign to the load balancer. 614 */ 615 Tags?: TagList; 616 /** 617 * The type of load balancer. The default is application. 618 */ 619 Type?: LoadBalancerTypeEnum; 620 /** 621 * The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4. 622 */ 623 IpAddressType?: IpAddressType; 624 /** 625 * [Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool). 626 */ 627 CustomerOwnedIpv4Pool?: CustomerOwnedIpv4Pool; 628 } 629 export interface CreateLoadBalancerOutput { 630 /** 631 * Information about the load balancer. 632 */ 633 LoadBalancers?: LoadBalancers; 634 } 635 export interface CreateRuleInput { 636 /** 637 * The Amazon Resource Name (ARN) of the listener. 638 */ 639 ListenerArn: ListenerArn; 640 /** 641 * The conditions. 642 */ 643 Conditions: RuleConditionList; 644 /** 645 * The rule priority. A listener can't have multiple rules with the same priority. 646 */ 647 Priority: RulePriority; 648 /** 649 * The actions. 650 */ 651 Actions: Actions; 652 /** 653 * The tags to assign to the rule. 654 */ 655 Tags?: TagList; 656 } 657 export interface CreateRuleOutput { 658 /** 659 * Information about the rule. 660 */ 661 Rules?: Rules; 662 } 663 export interface CreateTargetGroupInput { 664 /** 665 * The name of the target group. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. 666 */ 667 Name: TargetGroupName; 668 /** 669 * The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply. 670 */ 671 Protocol?: ProtocolEnum; 672 /** 673 * [HTTP/HTTPS protocol] The protocol version. Specify GRPC to send requests to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The default is HTTP1, which sends requests to targets using HTTP/1.1. 674 */ 675 ProtocolVersion?: ProtocolVersion; 676 /** 677 * The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081. 678 */ 679 Port?: Port; 680 /** 681 * The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required. 682 */ 683 VpcId?: VpcId; 684 /** 685 * The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks. 686 */ 687 HealthCheckProtocol?: ProtocolEnum; 688 /** 689 * The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is traffic-port, which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80. 690 */ 691 HealthCheckPort?: HealthCheckPort; 692 /** 693 * Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance or ip, health checks are always enabled and cannot be disabled. 694 */ 695 HealthCheckEnabled?: HealthCheckEnabled; 696 /** 697 * [HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck. 698 */ 699 HealthCheckPath?: Path; 700 /** 701 * The approximate amount of time, in seconds, between health checks of an individual target. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported values are 10 and 30 seconds. If the target group protocol is HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is lambda, the default is 35 seconds. 702 */ 703 HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds; 704 /** 705 * The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds. 706 */ 707 HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds; 708 /** 709 * The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP, TLS, or GENEVE, the default is 3. If the target type is lambda, the default is 5. 710 */ 711 HealthyThresholdCount?: HealthCheckThresholdCount; 712 /** 713 * The number of consecutive health check failures required before considering a target unhealthy. If the target group protocol is HTTP or HTTPS, the default is 2. If the target group protocol is TCP or TLS, this value must be the same as the healthy threshold count. If the target group protocol is GENEVE, the default is 3. If the target type is lambda, the default is 2. 714 */ 715 UnhealthyThresholdCount?: HealthCheckThresholdCount; 716 /** 717 * [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. 718 */ 719 Matcher?: Matcher; 720 /** 721 * The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type. instance - Register targets by instance ID. This is the default value. ip - Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses. lambda - Register a single Lambda function as a target. 722 */ 723 TargetType?: TargetTypeEnum; 724 /** 725 * The tags to assign to the target group. 726 */ 727 Tags?: TagList; 728 } 729 export interface CreateTargetGroupOutput { 730 /** 731 * Information about the target group. 732 */ 733 TargetGroups?: TargetGroups; 734 } 735 export type CreatedTime = Date; 736 export type CustomerOwnedIpv4Pool = string; 737 export type DNSName = string; 738 export type Default = boolean; 739 export interface DeleteListenerInput { 740 /** 741 * The Amazon Resource Name (ARN) of the listener. 742 */ 743 ListenerArn: ListenerArn; 744 } 745 export interface DeleteListenerOutput { 746 } 747 export interface DeleteLoadBalancerInput { 748 /** 749 * The Amazon Resource Name (ARN) of the load balancer. 750 */ 751 LoadBalancerArn: LoadBalancerArn; 752 } 753 export interface DeleteLoadBalancerOutput { 754 } 755 export interface DeleteRuleInput { 756 /** 757 * The Amazon Resource Name (ARN) of the rule. 758 */ 759 RuleArn: RuleArn; 760 } 761 export interface DeleteRuleOutput { 762 } 763 export interface DeleteTargetGroupInput { 764 /** 765 * The Amazon Resource Name (ARN) of the target group. 766 */ 767 TargetGroupArn: TargetGroupArn; 768 } 769 export interface DeleteTargetGroupOutput { 770 } 771 export interface DeregisterTargetsInput { 772 /** 773 * The Amazon Resource Name (ARN) of the target group. 774 */ 775 TargetGroupArn: TargetGroupArn; 776 /** 777 * The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it. 778 */ 779 Targets: TargetDescriptions; 780 } 781 export interface DeregisterTargetsOutput { 782 } 783 export interface DescribeAccountLimitsInput { 784 /** 785 * The marker for the next set of results. (You received this marker from a previous call.) 786 */ 787 Marker?: Marker; 788 /** 789 * The maximum number of results to return with this call. 790 */ 791 PageSize?: PageSize; 792 } 793 export interface DescribeAccountLimitsOutput { 794 /** 795 * Information about the limits. 796 */ 797 Limits?: Limits; 798 /** 799 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null. 800 */ 801 NextMarker?: Marker; 802 } 803 export interface DescribeListenerCertificatesInput { 804 /** 805 * The Amazon Resource Names (ARN) of the listener. 806 */ 807 ListenerArn: ListenerArn; 808 /** 809 * The marker for the next set of results. (You received this marker from a previous call.) 810 */ 811 Marker?: Marker; 812 /** 813 * The maximum number of results to return with this call. 814 */ 815 PageSize?: PageSize; 816 } 817 export interface DescribeListenerCertificatesOutput { 818 /** 819 * Information about the certificates. 820 */ 821 Certificates?: CertificateList; 822 /** 823 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null. 824 */ 825 NextMarker?: Marker; 826 } 827 export interface DescribeListenersInput { 828 /** 829 * The Amazon Resource Name (ARN) of the load balancer. 830 */ 831 LoadBalancerArn?: LoadBalancerArn; 832 /** 833 * The Amazon Resource Names (ARN) of the listeners. 834 */ 835 ListenerArns?: ListenerArns; 836 /** 837 * The marker for the next set of results. (You received this marker from a previous call.) 838 */ 839 Marker?: Marker; 840 /** 841 * The maximum number of results to return with this call. 842 */ 843 PageSize?: PageSize; 844 } 845 export interface DescribeListenersOutput { 846 /** 847 * Information about the listeners. 848 */ 849 Listeners?: Listeners; 850 /** 851 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null. 852 */ 853 NextMarker?: Marker; 854 } 855 export interface DescribeLoadBalancerAttributesInput { 856 /** 857 * The Amazon Resource Name (ARN) of the load balancer. 858 */ 859 LoadBalancerArn: LoadBalancerArn; 860 } 861 export interface DescribeLoadBalancerAttributesOutput { 862 /** 863 * Information about the load balancer attributes. 864 */ 865 Attributes?: LoadBalancerAttributes; 866 } 867 export interface DescribeLoadBalancersInput { 868 /** 869 * The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call. 870 */ 871 LoadBalancerArns?: LoadBalancerArns; 872 /** 873 * The names of the load balancers. 874 */ 875 Names?: LoadBalancerNames; 876 /** 877 * The marker for the next set of results. (You received this marker from a previous call.) 878 */ 879 Marker?: Marker; 880 /** 881 * The maximum number of results to return with this call. 882 */ 883 PageSize?: PageSize; 884 } 885 export interface DescribeLoadBalancersOutput { 886 /** 887 * Information about the load balancers. 888 */ 889 LoadBalancers?: LoadBalancers; 890 /** 891 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null. 892 */ 893 NextMarker?: Marker; 894 } 895 export interface DescribeRulesInput { 896 /** 897 * The Amazon Resource Name (ARN) of the listener. 898 */ 899 ListenerArn?: ListenerArn; 900 /** 901 * The Amazon Resource Names (ARN) of the rules. 902 */ 903 RuleArns?: RuleArns; 904 /** 905 * The marker for the next set of results. (You received this marker from a previous call.) 906 */ 907 Marker?: Marker; 908 /** 909 * The maximum number of results to return with this call. 910 */ 911 PageSize?: PageSize; 912 } 913 export interface DescribeRulesOutput { 914 /** 915 * Information about the rules. 916 */ 917 Rules?: Rules; 918 /** 919 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null. 920 */ 921 NextMarker?: Marker; 922 } 923 export interface DescribeSSLPoliciesInput { 924 /** 925 * The names of the policies. 926 */ 927 Names?: SslPolicyNames; 928 /** 929 * The marker for the next set of results. (You received this marker from a previous call.) 930 */ 931 Marker?: Marker; 932 /** 933 * The maximum number of results to return with this call. 934 */ 935 PageSize?: PageSize; 936 } 937 export interface DescribeSSLPoliciesOutput { 938 /** 939 * Information about the security policies. 940 */ 941 SslPolicies?: SslPolicies; 942 /** 943 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null. 944 */ 945 NextMarker?: Marker; 946 } 947 export interface DescribeTagsInput { 948 /** 949 * The Amazon Resource Names (ARN) of the resources. You can specify up to 20 resources in a single call. 950 */ 951 ResourceArns: ResourceArns; 952 } 953 export interface DescribeTagsOutput { 954 /** 955 * Information about the tags. 956 */ 957 TagDescriptions?: TagDescriptions; 958 } 959 export interface DescribeTargetGroupAttributesInput { 960 /** 961 * The Amazon Resource Name (ARN) of the target group. 962 */ 963 TargetGroupArn: TargetGroupArn; 964 } 965 export interface DescribeTargetGroupAttributesOutput { 966 /** 967 * Information about the target group attributes 968 */ 969 Attributes?: TargetGroupAttributes; 970 } 971 export interface DescribeTargetGroupsInput { 972 /** 973 * The Amazon Resource Name (ARN) of the load balancer. 974 */ 975 LoadBalancerArn?: LoadBalancerArn; 976 /** 977 * The Amazon Resource Names (ARN) of the target groups. 978 */ 979 TargetGroupArns?: TargetGroupArns; 980 /** 981 * The names of the target groups. 982 */ 983 Names?: TargetGroupNames; 984 /** 985 * The marker for the next set of results. (You received this marker from a previous call.) 986 */ 987 Marker?: Marker; 988 /** 989 * The maximum number of results to return with this call. 990 */ 991 PageSize?: PageSize; 992 } 993 export interface DescribeTargetGroupsOutput { 994 /** 995 * Information about the target groups. 996 */ 997 TargetGroups?: TargetGroups; 998 /** 999 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null. 1000 */ 1001 NextMarker?: Marker; 1002 } 1003 export interface DescribeTargetHealthInput { 1004 /** 1005 * The Amazon Resource Name (ARN) of the target group. 1006 */ 1007 TargetGroupArn: TargetGroupArn; 1008 /** 1009 * The targets. 1010 */ 1011 Targets?: TargetDescriptions; 1012 } 1013 export interface DescribeTargetHealthOutput { 1014 /** 1015 * Information about the health of the targets. 1016 */ 1017 TargetHealthDescriptions?: TargetHealthDescriptions; 1018 } 1019 export type Description = string; 1020 export interface FixedResponseActionConfig { 1021 /** 1022 * The message. 1023 */ 1024 MessageBody?: FixedResponseActionMessage; 1025 /** 1026 * The HTTP response code (2XX, 4XX, or 5XX). 1027 */ 1028 StatusCode: FixedResponseActionStatusCode; 1029 /** 1030 * The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json 1031 */ 1032 ContentType?: FixedResponseActionContentType; 1033 } 1034 export type FixedResponseActionContentType = string; 1035 export type FixedResponseActionMessage = string; 1036 export type FixedResponseActionStatusCode = string; 1037 export interface ForwardActionConfig { 1038 /** 1039 * One or more target groups. For Network Load Balancers, you can specify a single target group. 1040 */ 1041 TargetGroups?: TargetGroupList; 1042 /** 1043 * The target group stickiness for the rule. 1044 */ 1045 TargetGroupStickinessConfig?: TargetGroupStickinessConfig; 1046 } 1047 export type GrpcCode = string; 1048 export type HealthCheckEnabled = boolean; 1049 export type HealthCheckIntervalSeconds = number; 1050 export type HealthCheckPort = string; 1051 export type HealthCheckThresholdCount = number; 1052 export type HealthCheckTimeoutSeconds = number; 1053 export interface HostHeaderConditionConfig { 1054 /** 1055 * One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). If you specify multiple strings, the condition is satisfied if one of the strings matches the host name. 1056 */ 1057 Values?: ListOfString; 1058 } 1059 export type HttpCode = string; 1060 export interface HttpHeaderConditionConfig { 1061 /** 1062 * The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported. You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition. 1063 */ 1064 HttpHeaderName?: HttpHeaderConditionName; 1065 /** 1066 * One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). If the same header appears multiple times in the request, we search them in order until a match is found. If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string. 1067 */ 1068 Values?: ListOfString; 1069 } 1070 export type HttpHeaderConditionName = string; 1071 export interface HttpRequestMethodConditionConfig { 1072 /** 1073 * The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match. If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached. 1074 */ 1075 Values?: ListOfString; 1076 } 1077 export type IPv6Address = string; 1078 export type IpAddress = string; 1079 export type IpAddressType = "ipv4"|"dualstack"|string; 1080 export type IsDefault = boolean; 1081 export interface Limit { 1082 /** 1083 * The name of the limit. The possible values are: application-load-balancers condition-values-per-alb-rule condition-wildcards-per-alb-rule gateway-load-balancers gateway-load-balancers-per-vpc geneve-target-groups listeners-per-application-load-balancer listeners-per-network-load-balancer network-load-balancers rules-per-application-load-balancer target-groups target-groups-per-action-on-application-load-balancer target-groups-per-action-on-network-load-balancer target-groups-per-application-load-balancer targets-per-application-load-balancer targets-per-availability-zone-per-gateway-load-balancer targets-per-availability-zone-per-network-load-balancer targets-per-network-load-balancer 1084 */ 1085 Name?: Name; 1086 /** 1087 * The maximum value of the limit. 1088 */ 1089 Max?: Max; 1090 } 1091 export type Limits = Limit[]; 1092 export type ListOfString = StringValue[]; 1093 export interface Listener { 1094 /** 1095 * The Amazon Resource Name (ARN) of the listener. 1096 */ 1097 ListenerArn?: ListenerArn; 1098 /** 1099 * The Amazon Resource Name (ARN) of the load balancer. 1100 */ 1101 LoadBalancerArn?: LoadBalancerArn; 1102 /** 1103 * The port on which the load balancer is listening. 1104 */ 1105 Port?: Port; 1106 /** 1107 * The protocol for connections from clients to the load balancer. 1108 */ 1109 Protocol?: ProtocolEnum; 1110 /** 1111 * [HTTPS or TLS listener] The default certificate for the listener. 1112 */ 1113 Certificates?: CertificateList; 1114 /** 1115 * [HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported. 1116 */ 1117 SslPolicy?: SslPolicyName; 1118 /** 1119 * The default actions for the listener. 1120 */ 1121 DefaultActions?: Actions; 1122 /** 1123 * [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy. 1124 */ 1125 AlpnPolicy?: AlpnPolicyName; 1126 } 1127 export type ListenerArn = string; 1128 export type ListenerArns = ListenerArn[]; 1129 export type Listeners = Listener[]; 1130 export interface LoadBalancer { 1131 /** 1132 * The Amazon Resource Name (ARN) of the load balancer. 1133 */ 1134 LoadBalancerArn?: LoadBalancerArn; 1135 /** 1136 * The public DNS name of the load balancer. 1137 */ 1138 DNSName?: DNSName; 1139 /** 1140 * The ID of the Amazon Route 53 hosted zone associated with the load balancer. 1141 */ 1142 CanonicalHostedZoneId?: CanonicalHostedZoneId; 1143 /** 1144 * The date and time the load balancer was created. 1145 */ 1146 CreatedTime?: CreatedTime; 1147 /** 1148 * The name of the load balancer. 1149 */ 1150 LoadBalancerName?: LoadBalancerName; 1151 /** 1152 * The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. 1153 */ 1154 Scheme?: LoadBalancerSchemeEnum; 1155 /** 1156 * The ID of the VPC for the load balancer. 1157 */ 1158 VpcId?: VpcId; 1159 /** 1160 * The state of the load balancer. 1161 */ 1162 State?: LoadBalancerState; 1163 /** 1164 * The type of load balancer. 1165 */ 1166 Type?: LoadBalancerTypeEnum; 1167 /** 1168 * The subnets for the load balancer. 1169 */ 1170 AvailabilityZones?: AvailabilityZones; 1171 /** 1172 * The IDs of the security groups for the load balancer. 1173 */ 1174 SecurityGroups?: SecurityGroups; 1175 /** 1176 * The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). 1177 */ 1178 IpAddressType?: IpAddressType; 1179 /** 1180 * [Application Load Balancers on Outposts] The ID of the customer-owned address pool. 1181 */ 1182 CustomerOwnedIpv4Pool?: CustomerOwnedIpv4Pool; 1183 } 1184 export interface LoadBalancerAddress { 1185 /** 1186 * The static IP address. 1187 */ 1188 IpAddress?: IpAddress; 1189 /** 1190 * [Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer. 1191 */ 1192 AllocationId?: AllocationId; 1193 /** 1194 * [Network Load Balancers] The private IPv4 address for an internal load balancer. 1195 */ 1196 PrivateIPv4Address?: PrivateIPv4Address; 1197 /** 1198 * [Network Load Balancers] The IPv6 address. 1199 */ 1200 IPv6Address?: IPv6Address; 1201 } 1202 export type LoadBalancerAddresses = LoadBalancerAddress[]; 1203 export type LoadBalancerArn = string; 1204 export type LoadBalancerArns = LoadBalancerArn[]; 1205 export interface LoadBalancerAttribute { 1206 /** 1207 * The name of the attribute. The following attribute is supported by all load balancers: deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false. The following attributes are supported by both Application Load Balancers and Network Load Balancers: access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false. access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs. The following attributes are supported by only Application Load Balancers: idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. routing.http.desync_mitigation_mode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive. routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false. routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false. The default is false. routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false. The default is false. routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The default is false. The following attribute is supported by Network Load Balancers and Gateway Load Balancers: load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default is false. 1208 */ 1209 Key?: LoadBalancerAttributeKey; 1210 /** 1211 * The value of the attribute. 1212 */ 1213 Value?: LoadBalancerAttributeValue; 1214 } 1215 export type LoadBalancerAttributeKey = string; 1216 export type LoadBalancerAttributeValue = string; 1217 export type LoadBalancerAttributes = LoadBalancerAttribute[]; 1218 export type LoadBalancerName = string; 1219 export type LoadBalancerNames = LoadBalancerName[]; 1220 export type LoadBalancerSchemeEnum = "internet-facing"|"internal"|string; 1221 export interface LoadBalancerState { 1222 /** 1223 * The state code. The initial state of the load balancer is provisioning. After the load balancer is fully set up and ready to route traffic, its state is active. If load balancer is routing traffic but does not have the resources it needs to scale, its state isactive_impaired. If the load balancer could not be set up, its state is failed. 1224 */ 1225 Code?: LoadBalancerStateEnum; 1226 /** 1227 * A description of the state. 1228 */ 1229 Reason?: StateReason; 1230 } 1231 export type LoadBalancerStateEnum = "active"|"provisioning"|"active_impaired"|"failed"|string; 1232 export type LoadBalancerTypeEnum = "application"|"network"|"gateway"|string; 1233 export type LoadBalancers = LoadBalancer[]; 1234 export type Marker = string; 1235 export interface Matcher { 1236 /** 1237 * For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299"). For Network Load Balancers and Gateway Load Balancers, this must be "200–399". 1238 */ 1239 HttpCode?: HttpCode; 1240 /** 1241 * You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12. 1242 */ 1243 GrpcCode?: GrpcCode; 1244 } 1245 export type Max = string; 1246 export interface ModifyListenerInput { 1247 /** 1248 * The Amazon Resource Name (ARN) of the listener. 1249 */ 1250 ListenerArn: ListenerArn; 1251 /** 1252 * The port for connections from clients to the load balancer. You cannot specify a port for a Gateway Load Balancer. 1253 */ 1254 Port?: Port; 1255 /** 1256 * The protocol for connections from clients to the load balancer. Application Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the TCP, TLS, UDP, and TCP_UDP protocols. You can’t change the protocol to UDP or TCP_UDP if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer. 1257 */ 1258 Protocol?: ProtocolEnum; 1259 /** 1260 * [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide. 1261 */ 1262 SslPolicy?: SslPolicyName; 1263 /** 1264 * [HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault. 1265 */ 1266 Certificates?: CertificateList; 1267 /** 1268 * The actions for the default rule. 1269 */ 1270 DefaultActions?: Actions; 1271 /** 1272 * [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values: HTTP1Only HTTP2Only HTTP2Optional HTTP2Preferred None For more information, see ALPN policies in the Network Load Balancers Guide. 1273 */ 1274 AlpnPolicy?: AlpnPolicyName; 1275 } 1276 export interface ModifyListenerOutput { 1277 /** 1278 * Information about the modified listener. 1279 */ 1280 Listeners?: Listeners; 1281 } 1282 export interface ModifyLoadBalancerAttributesInput { 1283 /** 1284 * The Amazon Resource Name (ARN) of the load balancer. 1285 */ 1286 LoadBalancerArn: LoadBalancerArn; 1287 /** 1288 * The load balancer attributes. 1289 */ 1290 Attributes: LoadBalancerAttributes; 1291 } 1292 export interface ModifyLoadBalancerAttributesOutput { 1293 /** 1294 * Information about the load balancer attributes. 1295 */ 1296 Attributes?: LoadBalancerAttributes; 1297 } 1298 export interface ModifyRuleInput { 1299 /** 1300 * The Amazon Resource Name (ARN) of the rule. 1301 */ 1302 RuleArn: RuleArn; 1303 /** 1304 * The conditions. 1305 */ 1306 Conditions?: RuleConditionList; 1307 /** 1308 * The actions. 1309 */ 1310 Actions?: Actions; 1311 } 1312 export interface ModifyRuleOutput { 1313 /** 1314 * Information about the modified rule. 1315 */ 1316 Rules?: Rules; 1317 } 1318 export interface ModifyTargetGroupAttributesInput { 1319 /** 1320 * The Amazon Resource Name (ARN) of the target group. 1321 */ 1322 TargetGroupArn: TargetGroupArn; 1323 /** 1324 * The attributes. 1325 */ 1326 Attributes: TargetGroupAttributes; 1327 } 1328 export interface ModifyTargetGroupAttributesOutput { 1329 /** 1330 * Information about the attributes. 1331 */ 1332 Attributes?: TargetGroupAttributes; 1333 } 1334 export interface ModifyTargetGroupInput { 1335 /** 1336 * The Amazon Resource Name (ARN) of the target group. 1337 */ 1338 TargetGroupArn: TargetGroupArn; 1339 /** 1340 * The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks. With Network Load Balancers, you can't modify this setting. 1341 */ 1342 HealthCheckProtocol?: ProtocolEnum; 1343 /** 1344 * The port the load balancer uses when performing health checks on targets. 1345 */ 1346 HealthCheckPort?: HealthCheckPort; 1347 /** 1348 * [HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck. 1349 */ 1350 HealthCheckPath?: Path; 1351 /** 1352 * Indicates whether health checks are enabled. 1353 */ 1354 HealthCheckEnabled?: HealthCheckEnabled; 1355 /** 1356 * The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 or 30 seconds. With Network Load Balancers, you can't modify this setting. 1357 */ 1358 HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds; 1359 /** 1360 * [HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check. With Network Load Balancers, you can't modify this setting. 1361 */ 1362 HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds; 1363 /** 1364 * The number of consecutive health checks successes required before considering an unhealthy target healthy. 1365 */ 1366 HealthyThresholdCount?: HealthCheckThresholdCount; 1367 /** 1368 * The number of consecutive health check failures required before considering the target unhealthy. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. 1369 */ 1370 UnhealthyThresholdCount?: HealthCheckThresholdCount; 1371 /** 1372 * [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. With Network Load Balancers, you can't modify this setting. 1373 */ 1374 Matcher?: Matcher; 1375 } 1376 export interface ModifyTargetGroupOutput { 1377 /** 1378 * Information about the modified target group. 1379 */ 1380 TargetGroups?: TargetGroups; 1381 } 1382 export type Name = string; 1383 export type OutpostId = string; 1384 export type PageSize = number; 1385 export type Path = string; 1386 export interface PathPatternConditionConfig { 1387 /** 1388 * One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig. 1389 */ 1390 Values?: ListOfString; 1391 } 1392 export type Port = number; 1393 export type PrivateIPv4Address = string; 1394 export type ProtocolEnum = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE"|string; 1395 export type ProtocolVersion = string; 1396 export interface QueryStringConditionConfig { 1397 /** 1398 * One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '\' character. If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string. 1399 */ 1400 Values?: QueryStringKeyValuePairList; 1401 } 1402 export interface QueryStringKeyValuePair { 1403 /** 1404 * The key. You can omit the key. 1405 */ 1406 Key?: StringValue; 1407 /** 1408 * The value. 1409 */ 1410 Value?: StringValue; 1411 } 1412 export type QueryStringKeyValuePairList = QueryStringKeyValuePair[]; 1413 export interface RedirectActionConfig { 1414 /** 1415 * The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. 1416 */ 1417 Protocol?: RedirectActionProtocol; 1418 /** 1419 * The port. You can specify a value from 1 to 65535 or #{port}. 1420 */ 1421 Port?: RedirectActionPort; 1422 /** 1423 * The hostname. This component is not percent-encoded. The hostname can contain #{host}. 1424 */ 1425 Host?: RedirectActionHost; 1426 /** 1427 * The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. 1428 */ 1429 Path?: RedirectActionPath; 1430 /** 1431 * The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. 1432 */ 1433 Query?: RedirectActionQuery; 1434 /** 1435 * The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302). 1436 */ 1437 StatusCode: RedirectActionStatusCodeEnum; 1438 } 1439 export type RedirectActionHost = string; 1440 export type RedirectActionPath = string; 1441 export type RedirectActionPort = string; 1442 export type RedirectActionProtocol = string; 1443 export type RedirectActionQuery = string; 1444 export type RedirectActionStatusCodeEnum = "HTTP_301"|"HTTP_302"|string; 1445 export interface RegisterTargetsInput { 1446 /** 1447 * The Amazon Resource Name (ARN) of the target group. 1448 */ 1449 TargetGroupArn: TargetGroupArn; 1450 /** 1451 * The targets. 1452 */ 1453 Targets: TargetDescriptions; 1454 } 1455 export interface RegisterTargetsOutput { 1456 } 1457 export interface RemoveListenerCertificatesInput { 1458 /** 1459 * The Amazon Resource Name (ARN) of the listener. 1460 */ 1461 ListenerArn: ListenerArn; 1462 /** 1463 * The certificate to remove. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault. 1464 */ 1465 Certificates: CertificateList; 1466 } 1467 export interface RemoveListenerCertificatesOutput { 1468 } 1469 export interface RemoveTagsInput { 1470 /** 1471 * The Amazon Resource Name (ARN) of the resource. 1472 */ 1473 ResourceArns: ResourceArns; 1474 /** 1475 * The tag keys for the tags to remove. 1476 */ 1477 TagKeys: TagKeys; 1478 } 1479 export interface RemoveTagsOutput { 1480 } 1481 export type ResourceArn = string; 1482 export type ResourceArns = ResourceArn[]; 1483 export interface Rule { 1484 /** 1485 * The Amazon Resource Name (ARN) of the rule. 1486 */ 1487 RuleArn?: RuleArn; 1488 /** 1489 * The priority. 1490 */ 1491 Priority?: String; 1492 /** 1493 * The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string. 1494 */ 1495 Conditions?: RuleConditionList; 1496 /** 1497 * The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed. 1498 */ 1499 Actions?: Actions; 1500 /** 1501 * Indicates whether this is the default rule. 1502 */ 1503 IsDefault?: IsDefault; 1504 } 1505 export type RuleArn = string; 1506 export type RuleArns = RuleArn[]; 1507 export interface RuleCondition { 1508 /** 1509 * The field in the HTTP request. The following are the possible values: http-header http-request-method host-header path-pattern query-string source-ip 1510 */ 1511 Field?: ConditionFieldName; 1512 /** 1513 * The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig. If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. A-Z, a-z, 0-9 - . * (matches 0 or more characters) ? (matches exactly 1 character) If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. A-Z, a-z, 0-9 _ - . $ / ~ " ' @ : + & (using &amp;) * (matches 0 or more characters) ? (matches exactly 1 character) 1514 */ 1515 Values?: ListOfString; 1516 /** 1517 * Information for a host header condition. Specify only when Field is host-header. 1518 */ 1519 HostHeaderConfig?: HostHeaderConditionConfig; 1520 /** 1521 * Information for a path pattern condition. Specify only when Field is path-pattern. 1522 */ 1523 PathPatternConfig?: PathPatternConditionConfig; 1524 /** 1525 * Information for an HTTP header condition. Specify only when Field is http-header. 1526 */ 1527 HttpHeaderConfig?: HttpHeaderConditionConfig; 1528 /** 1529 * Information for a query string condition. Specify only when Field is query-string. 1530 */ 1531 QueryStringConfig?: QueryStringConditionConfig; 1532 /** 1533 * Information for an HTTP method condition. Specify only when Field is http-request-method. 1534 */ 1535 HttpRequestMethodConfig?: HttpRequestMethodConditionConfig; 1536 /** 1537 * Information for a source IP condition. Specify only when Field is source-ip. 1538 */ 1539 SourceIpConfig?: SourceIpConditionConfig; 1540 } 1541 export type RuleConditionList = RuleCondition[]; 1542 export type RulePriority = number; 1543 export type RulePriorityList = RulePriorityPair[]; 1544 export interface RulePriorityPair { 1545 /** 1546 * The Amazon Resource Name (ARN) of the rule. 1547 */ 1548 RuleArn?: RuleArn; 1549 /** 1550 * The rule priority. 1551 */ 1552 Priority?: RulePriority; 1553 } 1554 export type Rules = Rule[]; 1555 export type SecurityGroupId = string; 1556 export type SecurityGroups = SecurityGroupId[]; 1557 export interface SetIpAddressTypeInput { 1558 /** 1559 * The Amazon Resource Name (ARN) of the load balancer. 1560 */ 1561 LoadBalancerArn: LoadBalancerArn; 1562 /** 1563 * The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4. You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener. 1564 */ 1565 IpAddressType: IpAddressType; 1566 } 1567 export interface SetIpAddressTypeOutput { 1568 /** 1569 * The IP address type. 1570 */ 1571 IpAddressType?: IpAddressType; 1572 } 1573 export interface SetRulePrioritiesInput { 1574 /** 1575 * The rule priorities. 1576 */ 1577 RulePriorities: RulePriorityList; 1578 } 1579 export interface SetRulePrioritiesOutput { 1580 /** 1581 * Information about the rules. 1582 */ 1583 Rules?: Rules; 1584 } 1585 export interface SetSecurityGroupsInput { 1586 /** 1587 * The Amazon Resource Name (ARN) of the load balancer. 1588 */ 1589 LoadBalancerArn: LoadBalancerArn; 1590 /** 1591 * The IDs of the security groups. 1592 */ 1593 SecurityGroups: SecurityGroups; 1594 } 1595 export interface SetSecurityGroupsOutput { 1596 /** 1597 * The IDs of the security groups associated with the load balancer. 1598 */ 1599 SecurityGroupIds?: SecurityGroups; 1600 } 1601 export interface SetSubnetsInput { 1602 /** 1603 * The Amazon Resource Name (ARN) of the load balancer. 1604 */ 1605 LoadBalancerArn: LoadBalancerArn; 1606 /** 1607 * The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. 1608 */ 1609 Subnets?: Subnets; 1610 /** 1611 * The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. 1612 */ 1613 SubnetMappings?: SubnetMappings; 1614 /** 1615 * [Network Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener. Internal load balancers must use ipv4. 1616 */ 1617 IpAddressType?: IpAddressType; 1618 } 1619 export interface SetSubnetsOutput { 1620 /** 1621 * Information about the subnets. 1622 */ 1623 AvailabilityZones?: AvailabilityZones; 1624 /** 1625 * [Network Load Balancers] The IP address type. 1626 */ 1627 IpAddressType?: IpAddressType; 1628 } 1629 export interface SourceIpConditionConfig { 1630 /** 1631 * One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported. If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig. 1632 */ 1633 Values?: ListOfString; 1634 } 1635 export type SslPolicies = SslPolicy[]; 1636 export interface SslPolicy { 1637 /** 1638 * The protocols. 1639 */ 1640 SslProtocols?: SslProtocols; 1641 /** 1642 * The ciphers. 1643 */ 1644 Ciphers?: Ciphers; 1645 /** 1646 * The name of the policy. 1647 */ 1648 Name?: SslPolicyName; 1649 } 1650 export type SslPolicyName = string; 1651 export type SslPolicyNames = SslPolicyName[]; 1652 export type SslProtocol = string; 1653 export type SslProtocols = SslProtocol[]; 1654 export type StateReason = string; 1655 export type String = string; 1656 export type StringValue = string; 1657 export type SubnetId = string; 1658 export interface SubnetMapping { 1659 /** 1660 * The ID of the subnet. 1661 */ 1662 SubnetId?: SubnetId; 1663 /** 1664 * [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer. 1665 */ 1666 AllocationId?: AllocationId; 1667 /** 1668 * [Network Load Balancers] The private IPv4 address for an internal load balancer. 1669 */ 1670 PrivateIPv4Address?: PrivateIPv4Address; 1671 /** 1672 * [Network Load Balancers] The IPv6 address. 1673 */ 1674 IPv6Address?: IPv6Address; 1675 } 1676 export type SubnetMappings = SubnetMapping[]; 1677 export type Subnets = SubnetId[]; 1678 export interface Tag { 1679 /** 1680 * The key of the tag. 1681 */ 1682 Key: TagKey; 1683 /** 1684 * The value of the tag. 1685 */ 1686 Value?: TagValue; 1687 } 1688 export interface TagDescription { 1689 /** 1690 * The Amazon Resource Name (ARN) of the resource. 1691 */ 1692 ResourceArn?: ResourceArn; 1693 /** 1694 * Information about the tags. 1695 */ 1696 Tags?: TagList; 1697 } 1698 export type TagDescriptions = TagDescription[]; 1699 export type TagKey = string; 1700 export type TagKeys = TagKey[]; 1701 export type TagList = Tag[]; 1702 export type TagValue = string; 1703 export interface TargetDescription { 1704 /** 1705 * The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. 1706 */ 1707 Id: TargetId; 1708 /** 1709 * The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. Not used if the target is a Lambda function. 1710 */ 1711 Port?: Port; 1712 /** 1713 * An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. This parameter is not supported if the target type of the target group is instance. If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required. With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all. If the target type is lambda, this parameter is optional and the only supported value is all. 1714 */ 1715 AvailabilityZone?: ZoneName; 1716 } 1717 export type TargetDescriptions = TargetDescription[]; 1718 export interface TargetGroup { 1719 /** 1720 * The Amazon Resource Name (ARN) of the target group. 1721 */ 1722 TargetGroupArn?: TargetGroupArn; 1723 /** 1724 * The name of the target group. 1725 */ 1726 TargetGroupName?: TargetGroupName; 1727 /** 1728 * The protocol to use for routing traffic to the targets. 1729 */ 1730 Protocol?: ProtocolEnum; 1731 /** 1732 * The port on which the targets are listening. Not used if the target is a Lambda function. 1733 */ 1734 Port?: Port; 1735 /** 1736 * The ID of the VPC for the targets. 1737 */ 1738 VpcId?: VpcId; 1739 /** 1740 * The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks. 1741 */ 1742 HealthCheckProtocol?: ProtocolEnum; 1743 /** 1744 * The port to use to connect with the target. 1745 */ 1746 HealthCheckPort?: HealthCheckPort; 1747 /** 1748 * Indicates whether health checks are enabled. 1749 */ 1750 HealthCheckEnabled?: HealthCheckEnabled; 1751 /** 1752 * The approximate amount of time, in seconds, between health checks of an individual target. 1753 */ 1754 HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds; 1755 /** 1756 * The amount of time, in seconds, during which no response means a failed health check. 1757 */ 1758 HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds; 1759 /** 1760 * The number of consecutive health checks successes required before considering an unhealthy target healthy. 1761 */ 1762 HealthyThresholdCount?: HealthCheckThresholdCount; 1763 /** 1764 * The number of consecutive health check failures required before considering the target unhealthy. 1765 */ 1766 UnhealthyThresholdCount?: HealthCheckThresholdCount; 1767 /** 1768 * The destination for health checks on the targets. 1769 */ 1770 HealthCheckPath?: Path; 1771 /** 1772 * The HTTP or gRPC codes to use when checking for a successful response from a target. 1773 */ 1774 Matcher?: Matcher; 1775 /** 1776 * The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group. 1777 */ 1778 LoadBalancerArns?: LoadBalancerArns; 1779 /** 1780 * The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), or lambda (register a single Lambda function as a target). 1781 */ 1782 TargetType?: TargetTypeEnum; 1783 /** 1784 * [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2. 1785 */ 1786 ProtocolVersion?: ProtocolVersion; 1787 } 1788 export type TargetGroupArn = string; 1789 export type TargetGroupArns = TargetGroupArn[]; 1790 export interface TargetGroupAttribute { 1791 /** 1792 * The name of the attribute. The following attribute is supported by all load balancers: deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported. The following attributes are supported by both Application Load Balancers and Network Load Balancers: stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false. stickiness.type - The type of sticky sessions. The possible values are lb_cookie and app_cookie for Application Load Balancers or source_ip for Network Load Balancers. The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address: load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin or least_outstanding_requests. The default is round_robin. slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled). stickiness.app_cookie.cookie_name - Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer. stickiness.app_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function: lambda.multi_value_headers.enabled - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client. The following attributes are supported only by Network Load Balancers: deregistration_delay.connection_termination.enabled - Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. The default is false. preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups. proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false. 1793 */ 1794 Key?: TargetGroupAttributeKey; 1795 /** 1796 * The value of the attribute. 1797 */ 1798 Value?: TargetGroupAttributeValue; 1799 } 1800 export type TargetGroupAttributeKey = string; 1801 export type TargetGroupAttributeValue = string; 1802 export type TargetGroupAttributes = TargetGroupAttribute[]; 1803 export type TargetGroupList = TargetGroupTuple[]; 1804 export type TargetGroupName = string; 1805 export type TargetGroupNames = TargetGroupName[]; 1806 export interface TargetGroupStickinessConfig { 1807 /** 1808 * Indicates whether target group stickiness is enabled. 1809 */ 1810 Enabled?: TargetGroupStickinessEnabled; 1811 /** 1812 * The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days). 1813 */ 1814 DurationSeconds?: TargetGroupStickinessDurationSeconds; 1815 } 1816 export type TargetGroupStickinessDurationSeconds = number; 1817 export type TargetGroupStickinessEnabled = boolean; 1818 export interface TargetGroupTuple { 1819 /** 1820 * The Amazon Resource Name (ARN) of the target group. 1821 */ 1822 TargetGroupArn?: TargetGroupArn; 1823 /** 1824 * The weight. The range is 0 to 999. 1825 */ 1826 Weight?: TargetGroupWeight; 1827 } 1828 export type TargetGroupWeight = number; 1829 export type TargetGroups = TargetGroup[]; 1830 export interface TargetHealth { 1831 /** 1832 * The state of the target. 1833 */ 1834 State?: TargetHealthStateEnum; 1835 /** 1836 * The reason code. If the target state is healthy, a reason code is not provided. If the target state is initial, the reason code can be one of the following values: Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer. Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status. If the target state is unhealthy, the reason code can be one of the following values: Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers. Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers. Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed. Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers. If the target state is unused, the reason code can be one of the following values: Target.NotRegistered - The target is not registered with the target group. Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer. Target.InvalidState - The target is in the stopped or terminated state. Target.IpUnusable - The target IP address is reserved for use by a load balancer. If the target state is draining, the reason code can be the following value: Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired. If the target state is unavailable, the reason code can be the following value: Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers. Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers. 1837 */ 1838 Reason?: TargetHealthReasonEnum; 1839 /** 1840 * A description of the target health that provides additional details. If the state is healthy, a description is not provided. 1841 */ 1842 Description?: Description; 1843 } 1844 export interface TargetHealthDescription { 1845 /** 1846 * The description of the target. 1847 */ 1848 Target?: TargetDescription; 1849 /** 1850 * The port to use to connect with the target. 1851 */ 1852 HealthCheckPort?: HealthCheckPort; 1853 /** 1854 * The health information for the target. 1855 */ 1856 TargetHealth?: TargetHealth; 1857 } 1858 export type TargetHealthDescriptions = TargetHealthDescription[]; 1859 export type TargetHealthReasonEnum = "Elb.RegistrationInProgress"|"Elb.InitialHealthChecking"|"Target.ResponseCodeMismatch"|"Target.Timeout"|"Target.FailedHealthChecks"|"Target.NotRegistered"|"Target.NotInUse"|"Target.DeregistrationInProgress"|"Target.InvalidState"|"Target.IpUnusable"|"Target.HealthCheckDisabled"|"Elb.InternalError"|string; 1860 export type TargetHealthStateEnum = "initial"|"healthy"|"unhealthy"|"unused"|"draining"|"unavailable"|string; 1861 export type TargetId = string; 1862 export type TargetTypeEnum = "instance"|"ip"|"lambda"|string; 1863 export type VpcId = string; 1864 export type ZoneName = string; 1865 /** 1866 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1867 */ 1868 export type apiVersion = "2015-12-01"|"latest"|string; 1869 export interface ClientApiVersions { 1870 /** 1871 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1872 */ 1873 apiVersion?: apiVersion; 1874 } 1875 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1876 /** 1877 * Contains interfaces for use with the ELBv2 client. 1878 */ 1879 export import Types = ELBv2; 1880 } 1881 export = ELBv2;