UNPKG

114 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare 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. To get the certificate list for a listener, use DescribeListenerCertificates. To remove certificates from the certificate list for a listener, use RemoveListenerCertificates. To replace the default certificate for a listener, use ModifyListener. For more information, see SSL Certificates in the Application 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. To get the certificate list for a listener, use DescribeListenerCertificates. To remove certificates from the certificate list for a listener, use RemoveListenerCertificates. To replace the default certificate for a listener, use ModifyListener. For more information, see SSL Certificates in the Application 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, and your target groups. 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. To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.
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, and your target groups. 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. To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.
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 or Network Load Balancer. To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer. 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. For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.
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 or Network Load Balancer. To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer. 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. For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.
37 */
38 createListener(callback?: (err: AWSError, data: ELBv2.Types.CreateListenerOutput) => void): Request<ELBv2.Types.CreateListenerOutput, AWSError>;
39 /**
40 * Creates an Application Load Balancer or a Network Load Balancer. When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags. To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer. For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide. 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. For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.
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 or a Network Load Balancer. When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags. To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer. For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide. 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. For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.
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. 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. To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
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. 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. To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
53 */
54 createRule(callback?: (err: AWSError, data: ELBv2.Types.CreateRuleOutput) => void): Request<ELBv2.Types.CreateRuleOutput, AWSError>;
55 /**
56 * Creates a target group. To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth. To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule. To delete a target group, use DeleteTargetGroup. 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. For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.
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. To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth. To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule. To delete a target group, use DeleteTargetGroup. 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. For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.
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, using DeleteLoadBalancer.
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, using DeleteLoadBalancer.
69 */
70 deleteListener(callback?: (err: AWSError, data: ELBv2.Types.DeleteListenerOutput) => void): Request<ELBv2.Types.DeleteListenerOutput, AWSError>;
71 /**
72 * Deletes the specified Application Load Balancer or Network Load Balancer and its attached 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 or Network Load Balancer and its attached 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.
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.
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.
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.
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 AWS account. For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.
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 AWS account. For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.
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.
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.
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 or Network Load Balancer. You must specify either a load balancer or one or more listeners. For an HTTPS or TLS listener, the output includes the default certificate for the listener. To describe the certificate list for the listener, use DescribeListenerCertificates.
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 or Network Load Balancer. You must specify either a load balancer or one or more listeners. For an HTTPS or TLS listener, the output includes the default certificate for the listener. To describe the certificate list for the listener, use DescribeListenerCertificates.
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 or Network Load Balancer. For more information, see Load Balancer Attributes in the Application Load Balancers Guide or Load Balancer Attributes in the Network 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 or Network Load Balancer. For more information, see Load Balancer Attributes in the Application Load Balancers Guide or Load Balancer Attributes in the Network 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. To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
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. To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
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.
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.
157 */
158 describeSSLPolicies(callback?: (err: AWSError, data: ELBv2.Types.DescribeSSLPoliciesOutput) => void): Request<ELBv2.Types.DescribeSSLPoliciesOutput, AWSError>;
159 /**
160 * Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.
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 resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.
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 Target Group Attributes in the Application Load Balancers Guide or Target Group Attributes in the Network 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 Target Group Attributes in the Application Load Balancers Guide or Target Group Attributes in the Network 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. To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
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. To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
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 or Network 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 or Network 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. To modify the actions for the default rule, use ModifyListener.
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. To modify the actions for the default rule, use ModifyListener.
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. To monitor the health of the targets, use DescribeTargetHealth.
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. To monitor the health of the targets, use DescribeTargetHealth.
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. To remove a target from a target group, use DeregisterTargets.
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. To remove a target from a target group, use DeregisterTargets.
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. You can't remove the default certificate for a listener. To replace the default certificate, call ModifyListener. To list the certificates for your listener, use DescribeListenerCertificates.
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. You can't remove the default certificate for a listener. To replace the default certificate, call ModifyListener. To list the certificates for your listener, use DescribeListenerCertificates.
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 resource. To list the current tags for your resources, use DescribeTags.
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 resource. To list the current tags for your resources, use DescribeTags.
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.
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.
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 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 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}
328declare 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. The last action to be performed must be one of the following types of actions: a forward, fixed-response, or redirect.
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 AuthenticateCognitoActionAuthenticationRequestExtraParams = {[key: string]: AuthenticateCognitoActionAuthenticationRequestParamValue};
396 export type AuthenticateCognitoActionAuthenticationRequestParamName = string;
397 export type AuthenticateCognitoActionAuthenticationRequestParamValue = string;
398 export type AuthenticateCognitoActionConditionalBehaviorEnum = "deny"|"allow"|"authenticate"|string;
399 export interface AuthenticateCognitoActionConfig {
400 /**
401 * The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
402 */
403 UserPoolArn: AuthenticateCognitoActionUserPoolArn;
404 /**
405 * The ID of the Amazon Cognito user pool client.
406 */
407 UserPoolClientId: AuthenticateCognitoActionUserPoolClientId;
408 /**
409 * The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
410 */
411 UserPoolDomain: AuthenticateCognitoActionUserPoolDomain;
412 /**
413 * The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
414 */
415 SessionCookieName?: AuthenticateCognitoActionSessionCookieName;
416 /**
417 * 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.
418 */
419 Scope?: AuthenticateCognitoActionScope;
420 /**
421 * The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
422 */
423 SessionTimeout?: AuthenticateCognitoActionSessionTimeout;
424 /**
425 * The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
426 */
427 AuthenticationRequestExtraParams?: AuthenticateCognitoActionAuthenticationRequestExtraParams;
428 /**
429 * 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.
430 */
431 OnUnauthenticatedRequest?: AuthenticateCognitoActionConditionalBehaviorEnum;
432 }
433 export type AuthenticateCognitoActionScope = string;
434 export type AuthenticateCognitoActionSessionCookieName = string;
435 export type AuthenticateCognitoActionSessionTimeout = number;
436 export type AuthenticateCognitoActionUserPoolArn = string;
437 export type AuthenticateCognitoActionUserPoolClientId = string;
438 export type AuthenticateCognitoActionUserPoolDomain = string;
439 export type AuthenticateOidcActionAuthenticationRequestExtraParams = {[key: string]: AuthenticateOidcActionAuthenticationRequestParamValue};
440 export type AuthenticateOidcActionAuthenticationRequestParamName = string;
441 export type AuthenticateOidcActionAuthenticationRequestParamValue = string;
442 export type AuthenticateOidcActionAuthorizationEndpoint = string;
443 export type AuthenticateOidcActionClientId = string;
444 export type AuthenticateOidcActionClientSecret = string;
445 export type AuthenticateOidcActionConditionalBehaviorEnum = "deny"|"allow"|"authenticate"|string;
446 export interface AuthenticateOidcActionConfig {
447 /**
448 * The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
449 */
450 Issuer: AuthenticateOidcActionIssuer;
451 /**
452 * The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
453 */
454 AuthorizationEndpoint: AuthenticateOidcActionAuthorizationEndpoint;
455 /**
456 * The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
457 */
458 TokenEndpoint: AuthenticateOidcActionTokenEndpoint;
459 /**
460 * The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
461 */
462 UserInfoEndpoint: AuthenticateOidcActionUserInfoEndpoint;
463 /**
464 * The OAuth 2.0 client identifier.
465 */
466 ClientId: AuthenticateOidcActionClientId;
467 /**
468 * 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.
469 */
470 ClientSecret?: AuthenticateOidcActionClientSecret;
471 /**
472 * The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
473 */
474 SessionCookieName?: AuthenticateOidcActionSessionCookieName;
475 /**
476 * 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.
477 */
478 Scope?: AuthenticateOidcActionScope;
479 /**
480 * The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
481 */
482 SessionTimeout?: AuthenticateOidcActionSessionTimeout;
483 /**
484 * The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
485 */
486 AuthenticationRequestExtraParams?: AuthenticateOidcActionAuthenticationRequestExtraParams;
487 /**
488 * 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.
489 */
490 OnUnauthenticatedRequest?: AuthenticateOidcActionConditionalBehaviorEnum;
491 /**
492 * 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.
493 */
494 UseExistingClientSecret?: AuthenticateOidcActionUseExistingClientSecret;
495 }
496 export type AuthenticateOidcActionIssuer = string;
497 export type AuthenticateOidcActionScope = string;
498 export type AuthenticateOidcActionSessionCookieName = string;
499 export type AuthenticateOidcActionSessionTimeout = number;
500 export type AuthenticateOidcActionTokenEndpoint = string;
501 export type AuthenticateOidcActionUseExistingClientSecret = boolean;
502 export type AuthenticateOidcActionUserInfoEndpoint = string;
503 export interface AvailabilityZone {
504 /**
505 * The name of the Availability Zone.
506 */
507 ZoneName?: ZoneName;
508 /**
509 * The ID of the subnet. You can specify one subnet per Availability Zone.
510 */
511 SubnetId?: SubnetId;
512 /**
513 * [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.
514 */
515 LoadBalancerAddresses?: LoadBalancerAddresses;
516 }
517 export type AvailabilityZones = AvailabilityZone[];
518 export type CanonicalHostedZoneId = string;
519 export interface Certificate {
520 /**
521 * The Amazon Resource Name (ARN) of the certificate.
522 */
523 CertificateArn?: CertificateArn;
524 /**
525 * 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.
526 */
527 IsDefault?: Default;
528 }
529 export type CertificateArn = string;
530 export type CertificateList = Certificate[];
531 export interface Cipher {
532 /**
533 * The name of the cipher.
534 */
535 Name?: CipherName;
536 /**
537 * The priority of the cipher.
538 */
539 Priority?: CipherPriority;
540 }
541 export type CipherName = string;
542 export type CipherPriority = number;
543 export type Ciphers = Cipher[];
544 export type ConditionFieldName = string;
545 export interface CreateListenerInput {
546 /**
547 * The Amazon Resource Name (ARN) of the load balancer.
548 */
549 LoadBalancerArn: LoadBalancerArn;
550 /**
551 * 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.
552 */
553 Protocol: ProtocolEnum;
554 /**
555 * The port on which the load balancer is listening.
556 */
557 Port: Port;
558 /**
559 * [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. The following are the possible values: ELBSecurityPolicy-2016-08 ELBSecurityPolicy-TLS-1-0-2015-04 ELBSecurityPolicy-TLS-1-1-2017-01 ELBSecurityPolicy-TLS-1-2-2017-01 ELBSecurityPolicy-TLS-1-2-Ext-2018-06 ELBSecurityPolicy-FS-2018-06 ELBSecurityPolicy-FS-1-1-2019-08 ELBSecurityPolicy-FS-1-2-2019-08 ELBSecurityPolicy-FS-1-2-Res-2019-08 For more information, see Security Policies in the Application Load Balancers Guide and Security Policies in the Network Load Balancers Guide.
560 */
561 SslPolicy?: SslPolicyName;
562 /**
563 * [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. To create a certificate list for the listener, use AddListenerCertificates.
564 */
565 Certificates?: CertificateList;
566 /**
567 * The actions for the default rule. The rule must include one forward action or one or more fixed-response actions. If the action type is forward, you specify one or more target groups. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.
568 */
569 DefaultActions: Actions;
570 }
571 export interface CreateListenerOutput {
572 /**
573 * Information about the listener.
574 */
575 Listeners?: Listeners;
576 }
577 export interface CreateLoadBalancerInput {
578 /**
579 * 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-".
580 */
581 Name: LoadBalancerName;
582 /**
583 * 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. [Network Load Balancers] You can specify subnets from one or more Availability Zones.
584 */
585 Subnets?: Subnets;
586 /**
587 * 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. [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.
588 */
589 SubnetMappings?: SubnetMappings;
590 /**
591 * [Application Load Balancers] The IDs of the security groups for the load balancer.
592 */
593 SecurityGroups?: SecurityGroups;
594 /**
595 * 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.
596 */
597 Scheme?: LoadBalancerSchemeEnum;
598 /**
599 * One or more tags to assign to the load balancer.
600 */
601 Tags?: TagList;
602 /**
603 * The type of load balancer. The default is application.
604 */
605 Type?: LoadBalancerTypeEnum;
606 /**
607 * [Application 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). Internal load balancers must use ipv4.
608 */
609 IpAddressType?: IpAddressType;
610 }
611 export interface CreateLoadBalancerOutput {
612 /**
613 * Information about the load balancer.
614 */
615 LoadBalancers?: LoadBalancers;
616 }
617 export interface CreateRuleInput {
618 /**
619 * The Amazon Resource Name (ARN) of the listener.
620 */
621 ListenerArn: ListenerArn;
622 /**
623 * 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.
624 */
625 Conditions: RuleConditionList;
626 /**
627 * The rule priority. A listener can't have multiple rules with the same priority.
628 */
629 Priority: RulePriority;
630 /**
631 * The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed. If the action type is forward, you specify one or more target groups. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.
632 */
633 Actions: Actions;
634 }
635 export interface CreateRuleOutput {
636 /**
637 * Information about the rule.
638 */
639 Rules?: Rules;
640 }
641 export interface CreateTargetGroupInput {
642 /**
643 * 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.
644 */
645 Name: TargetGroupName;
646 /**
647 * 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. 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.
648 */
649 Protocol?: ProtocolEnum;
650 /**
651 * 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.
652 */
653 Port?: Port;
654 /**
655 * 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.
656 */
657 VpcId?: VpcId;
658 /**
659 * The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.
660 */
661 HealthCheckProtocol?: ProtocolEnum;
662 /**
663 * The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.
664 */
665 HealthCheckPort?: HealthCheckPort;
666 /**
667 * 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.
668 */
669 HealthCheckEnabled?: HealthCheckEnabled;
670 /**
671 * [HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.
672 */
673 HealthCheckPath?: Path;
674 /**
675 * The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds.
676 */
677 HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds;
678 /**
679 * 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 or HTTPS, 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.
680 */
681 HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds;
682 /**
683 * 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 or TLS, the default is 3. If the target type is lambda, the default is 5.
684 */
685 HealthyThresholdCount?: HealthCheckThresholdCount;
686 /**
687 * The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. If the target type is lambda, the default is 2.
688 */
689 UnhealthyThresholdCount?: HealthCheckThresholdCount;
690 /**
691 * [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
692 */
693 Matcher?: Matcher;
694 /**
695 * 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 - Targets are specified by instance ID. This is the default value. If the target group protocol is UDP or TCP_UDP, the target type must be instance. ip - Targets are specified 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 - The target groups contains a single Lambda function.
696 */
697 TargetType?: TargetTypeEnum;
698 }
699 export interface CreateTargetGroupOutput {
700 /**
701 * Information about the target group.
702 */
703 TargetGroups?: TargetGroups;
704 }
705 export type CreatedTime = Date;
706 export type DNSName = string;
707 export type Default = boolean;
708 export interface DeleteListenerInput {
709 /**
710 * The Amazon Resource Name (ARN) of the listener.
711 */
712 ListenerArn: ListenerArn;
713 }
714 export interface DeleteListenerOutput {
715 }
716 export interface DeleteLoadBalancerInput {
717 /**
718 * The Amazon Resource Name (ARN) of the load balancer.
719 */
720 LoadBalancerArn: LoadBalancerArn;
721 }
722 export interface DeleteLoadBalancerOutput {
723 }
724 export interface DeleteRuleInput {
725 /**
726 * The Amazon Resource Name (ARN) of the rule.
727 */
728 RuleArn: RuleArn;
729 }
730 export interface DeleteRuleOutput {
731 }
732 export interface DeleteTargetGroupInput {
733 /**
734 * The Amazon Resource Name (ARN) of the target group.
735 */
736 TargetGroupArn: TargetGroupArn;
737 }
738 export interface DeleteTargetGroupOutput {
739 }
740 export interface DeregisterTargetsInput {
741 /**
742 * The Amazon Resource Name (ARN) of the target group.
743 */
744 TargetGroupArn: TargetGroupArn;
745 /**
746 * 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.
747 */
748 Targets: TargetDescriptions;
749 }
750 export interface DeregisterTargetsOutput {
751 }
752 export interface DescribeAccountLimitsInput {
753 /**
754 * The marker for the next set of results. (You received this marker from a previous call.)
755 */
756 Marker?: Marker;
757 /**
758 * The maximum number of results to return with this call.
759 */
760 PageSize?: PageSize;
761 }
762 export interface DescribeAccountLimitsOutput {
763 /**
764 * Information about the limits.
765 */
766 Limits?: Limits;
767 /**
768 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
769 */
770 NextMarker?: Marker;
771 }
772 export interface DescribeListenerCertificatesInput {
773 /**
774 * The Amazon Resource Names (ARN) of the listener.
775 */
776 ListenerArn: ListenerArn;
777 /**
778 * The marker for the next set of results. (You received this marker from a previous call.)
779 */
780 Marker?: Marker;
781 /**
782 * The maximum number of results to return with this call.
783 */
784 PageSize?: PageSize;
785 }
786 export interface DescribeListenerCertificatesOutput {
787 /**
788 * Information about the certificates.
789 */
790 Certificates?: CertificateList;
791 /**
792 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
793 */
794 NextMarker?: Marker;
795 }
796 export interface DescribeListenersInput {
797 /**
798 * The Amazon Resource Name (ARN) of the load balancer.
799 */
800 LoadBalancerArn?: LoadBalancerArn;
801 /**
802 * The Amazon Resource Names (ARN) of the listeners.
803 */
804 ListenerArns?: ListenerArns;
805 /**
806 * The marker for the next set of results. (You received this marker from a previous call.)
807 */
808 Marker?: Marker;
809 /**
810 * The maximum number of results to return with this call.
811 */
812 PageSize?: PageSize;
813 }
814 export interface DescribeListenersOutput {
815 /**
816 * Information about the listeners.
817 */
818 Listeners?: Listeners;
819 /**
820 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
821 */
822 NextMarker?: Marker;
823 }
824 export interface DescribeLoadBalancerAttributesInput {
825 /**
826 * The Amazon Resource Name (ARN) of the load balancer.
827 */
828 LoadBalancerArn: LoadBalancerArn;
829 }
830 export interface DescribeLoadBalancerAttributesOutput {
831 /**
832 * Information about the load balancer attributes.
833 */
834 Attributes?: LoadBalancerAttributes;
835 }
836 export interface DescribeLoadBalancersInput {
837 /**
838 * The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
839 */
840 LoadBalancerArns?: LoadBalancerArns;
841 /**
842 * The names of the load balancers.
843 */
844 Names?: LoadBalancerNames;
845 /**
846 * The marker for the next set of results. (You received this marker from a previous call.)
847 */
848 Marker?: Marker;
849 /**
850 * The maximum number of results to return with this call.
851 */
852 PageSize?: PageSize;
853 }
854 export interface DescribeLoadBalancersOutput {
855 /**
856 * Information about the load balancers.
857 */
858 LoadBalancers?: LoadBalancers;
859 /**
860 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
861 */
862 NextMarker?: Marker;
863 }
864 export interface DescribeRulesInput {
865 /**
866 * The Amazon Resource Name (ARN) of the listener.
867 */
868 ListenerArn?: ListenerArn;
869 /**
870 * The Amazon Resource Names (ARN) of the rules.
871 */
872 RuleArns?: RuleArns;
873 /**
874 * The marker for the next set of results. (You received this marker from a previous call.)
875 */
876 Marker?: Marker;
877 /**
878 * The maximum number of results to return with this call.
879 */
880 PageSize?: PageSize;
881 }
882 export interface DescribeRulesOutput {
883 /**
884 * Information about the rules.
885 */
886 Rules?: Rules;
887 /**
888 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
889 */
890 NextMarker?: Marker;
891 }
892 export interface DescribeSSLPoliciesInput {
893 /**
894 * The names of the policies.
895 */
896 Names?: SslPolicyNames;
897 /**
898 * The marker for the next set of results. (You received this marker from a previous call.)
899 */
900 Marker?: Marker;
901 /**
902 * The maximum number of results to return with this call.
903 */
904 PageSize?: PageSize;
905 }
906 export interface DescribeSSLPoliciesOutput {
907 /**
908 * Information about the security policies.
909 */
910 SslPolicies?: SslPolicies;
911 /**
912 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
913 */
914 NextMarker?: Marker;
915 }
916 export interface DescribeTagsInput {
917 /**
918 * The Amazon Resource Names (ARN) of the resources. You can specify up to 20 resources in a single call.
919 */
920 ResourceArns: ResourceArns;
921 }
922 export interface DescribeTagsOutput {
923 /**
924 * Information about the tags.
925 */
926 TagDescriptions?: TagDescriptions;
927 }
928 export interface DescribeTargetGroupAttributesInput {
929 /**
930 * The Amazon Resource Name (ARN) of the target group.
931 */
932 TargetGroupArn: TargetGroupArn;
933 }
934 export interface DescribeTargetGroupAttributesOutput {
935 /**
936 * Information about the target group attributes
937 */
938 Attributes?: TargetGroupAttributes;
939 }
940 export interface DescribeTargetGroupsInput {
941 /**
942 * The Amazon Resource Name (ARN) of the load balancer.
943 */
944 LoadBalancerArn?: LoadBalancerArn;
945 /**
946 * The Amazon Resource Names (ARN) of the target groups.
947 */
948 TargetGroupArns?: TargetGroupArns;
949 /**
950 * The names of the target groups.
951 */
952 Names?: TargetGroupNames;
953 /**
954 * The marker for the next set of results. (You received this marker from a previous call.)
955 */
956 Marker?: Marker;
957 /**
958 * The maximum number of results to return with this call.
959 */
960 PageSize?: PageSize;
961 }
962 export interface DescribeTargetGroupsOutput {
963 /**
964 * Information about the target groups.
965 */
966 TargetGroups?: TargetGroups;
967 /**
968 * If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
969 */
970 NextMarker?: Marker;
971 }
972 export interface DescribeTargetHealthInput {
973 /**
974 * The Amazon Resource Name (ARN) of the target group.
975 */
976 TargetGroupArn: TargetGroupArn;
977 /**
978 * The targets.
979 */
980 Targets?: TargetDescriptions;
981 }
982 export interface DescribeTargetHealthOutput {
983 /**
984 * Information about the health of the targets.
985 */
986 TargetHealthDescriptions?: TargetHealthDescriptions;
987 }
988 export type Description = string;
989 export interface FixedResponseActionConfig {
990 /**
991 * The message.
992 */
993 MessageBody?: FixedResponseActionMessage;
994 /**
995 * The HTTP response code (2XX, 4XX, or 5XX).
996 */
997 StatusCode: FixedResponseActionStatusCode;
998 /**
999 * The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json
1000 */
1001 ContentType?: FixedResponseActionContentType;
1002 }
1003 export type FixedResponseActionContentType = string;
1004 export type FixedResponseActionMessage = string;
1005 export type FixedResponseActionStatusCode = string;
1006 export interface ForwardActionConfig {
1007 /**
1008 * One or more target groups. For Network Load Balancers, you can specify a single target group.
1009 */
1010 TargetGroups?: TargetGroupList;
1011 /**
1012 * The target group stickiness for the rule.
1013 */
1014 TargetGroupStickinessConfig?: TargetGroupStickinessConfig;
1015 }
1016 export type HealthCheckEnabled = boolean;
1017 export type HealthCheckIntervalSeconds = number;
1018 export type HealthCheckPort = string;
1019 export type HealthCheckThresholdCount = number;
1020 export type HealthCheckTimeoutSeconds = number;
1021 export interface HostHeaderConditionConfig {
1022 /**
1023 * 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.
1024 */
1025 Values?: ListOfString;
1026 }
1027 export type HttpCode = string;
1028 export interface HttpHeaderConditionConfig {
1029 /**
1030 * 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.
1031 */
1032 HttpHeaderName?: HttpHeaderConditionName;
1033 /**
1034 * 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.
1035 */
1036 Values?: ListOfString;
1037 }
1038 export type HttpHeaderConditionName = string;
1039 export interface HttpRequestMethodConditionConfig {
1040 /**
1041 * 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.
1042 */
1043 Values?: ListOfString;
1044 }
1045 export type IpAddress = string;
1046 export type IpAddressType = "ipv4"|"dualstack"|string;
1047 export type IsDefault = boolean;
1048 export interface Limit {
1049 /**
1050 * The name of the limit. The possible values are: application-load-balancers 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-network-load-balancer targets-per-network-load-balancer
1051 */
1052 Name?: Name;
1053 /**
1054 * The maximum value of the limit.
1055 */
1056 Max?: Max;
1057 }
1058 export type Limits = Limit[];
1059 export type ListOfString = StringValue[];
1060 export interface Listener {
1061 /**
1062 * The Amazon Resource Name (ARN) of the listener.
1063 */
1064 ListenerArn?: ListenerArn;
1065 /**
1066 * The Amazon Resource Name (ARN) of the load balancer.
1067 */
1068 LoadBalancerArn?: LoadBalancerArn;
1069 /**
1070 * The port on which the load balancer is listening.
1071 */
1072 Port?: Port;
1073 /**
1074 * The protocol for connections from clients to the load balancer.
1075 */
1076 Protocol?: ProtocolEnum;
1077 /**
1078 * [HTTPS or TLS listener] The default certificate for the listener.
1079 */
1080 Certificates?: CertificateList;
1081 /**
1082 * [HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.
1083 */
1084 SslPolicy?: SslPolicyName;
1085 /**
1086 * The default actions for the listener.
1087 */
1088 DefaultActions?: Actions;
1089 }
1090 export type ListenerArn = string;
1091 export type ListenerArns = ListenerArn[];
1092 export type Listeners = Listener[];
1093 export interface LoadBalancer {
1094 /**
1095 * The Amazon Resource Name (ARN) of the load balancer.
1096 */
1097 LoadBalancerArn?: LoadBalancerArn;
1098 /**
1099 * The public DNS name of the load balancer.
1100 */
1101 DNSName?: DNSName;
1102 /**
1103 * The ID of the Amazon Route 53 hosted zone associated with the load balancer.
1104 */
1105 CanonicalHostedZoneId?: CanonicalHostedZoneId;
1106 /**
1107 * The date and time the load balancer was created.
1108 */
1109 CreatedTime?: CreatedTime;
1110 /**
1111 * The name of the load balancer.
1112 */
1113 LoadBalancerName?: LoadBalancerName;
1114 /**
1115 * 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.
1116 */
1117 Scheme?: LoadBalancerSchemeEnum;
1118 /**
1119 * The ID of the VPC for the load balancer.
1120 */
1121 VpcId?: VpcId;
1122 /**
1123 * The state of the load balancer.
1124 */
1125 State?: LoadBalancerState;
1126 /**
1127 * The type of load balancer.
1128 */
1129 Type?: LoadBalancerTypeEnum;
1130 /**
1131 * The Availability Zones for the load balancer.
1132 */
1133 AvailabilityZones?: AvailabilityZones;
1134 /**
1135 * The IDs of the security groups for the load balancer.
1136 */
1137 SecurityGroups?: SecurityGroups;
1138 /**
1139 * 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).
1140 */
1141 IpAddressType?: IpAddressType;
1142 }
1143 export interface LoadBalancerAddress {
1144 /**
1145 * The static IP address.
1146 */
1147 IpAddress?: IpAddress;
1148 /**
1149 * [Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.
1150 */
1151 AllocationId?: AllocationId;
1152 /**
1153 * [Network Load Balancers] The private IPv4 address for an internal load balancer.
1154 */
1155 PrivateIPv4Address?: PrivateIPv4Address;
1156 }
1157 export type LoadBalancerAddresses = LoadBalancerAddress[];
1158 export type LoadBalancerArn = string;
1159 export type LoadBalancerArns = LoadBalancerArn[];
1160 export interface LoadBalancerAttribute {
1161 /**
1162 * The name of the attribute. 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. 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 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.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.http2.enabled - Indicates whether HTTP/2 is enabled. The value is true or false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. The following attributes are supported by only Network Load Balancers: load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The value is true or false. The default is false.
1163 */
1164 Key?: LoadBalancerAttributeKey;
1165 /**
1166 * The value of the attribute.
1167 */
1168 Value?: LoadBalancerAttributeValue;
1169 }
1170 export type LoadBalancerAttributeKey = string;
1171 export type LoadBalancerAttributeValue = string;
1172 export type LoadBalancerAttributes = LoadBalancerAttribute[];
1173 export type LoadBalancerName = string;
1174 export type LoadBalancerNames = LoadBalancerName[];
1175 export type LoadBalancerSchemeEnum = "internet-facing"|"internal"|string;
1176 export interface LoadBalancerState {
1177 /**
1178 * 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 the load balancer could not be set up, its state is failed.
1179 */
1180 Code?: LoadBalancerStateEnum;
1181 /**
1182 * A description of the state.
1183 */
1184 Reason?: StateReason;
1185 }
1186 export type LoadBalancerStateEnum = "active"|"provisioning"|"active_impaired"|"failed"|string;
1187 export type LoadBalancerTypeEnum = "application"|"network"|string;
1188 export type LoadBalancers = LoadBalancer[];
1189 export type Marker = string;
1190 export interface Matcher {
1191 /**
1192 * The HTTP codes. 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, this is 200–399.
1193 */
1194 HttpCode: HttpCode;
1195 }
1196 export type Max = string;
1197 export interface ModifyListenerInput {
1198 /**
1199 * The Amazon Resource Name (ARN) of the listener.
1200 */
1201 ListenerArn: ListenerArn;
1202 /**
1203 * The port for connections from clients to the load balancer.
1204 */
1205 Port?: Port;
1206 /**
1207 * 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.
1208 */
1209 Protocol?: ProtocolEnum;
1210 /**
1211 * [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. The following are the possible values: ELBSecurityPolicy-2016-08 ELBSecurityPolicy-TLS-1-0-2015-04 ELBSecurityPolicy-TLS-1-1-2017-01 ELBSecurityPolicy-TLS-1-2-2017-01 ELBSecurityPolicy-TLS-1-2-Ext-2018-06 ELBSecurityPolicy-FS-2018-06 ELBSecurityPolicy-FS-1-1-2019-08 ELBSecurityPolicy-FS-1-2-2019-08 ELBSecurityPolicy-FS-1-2-Res-2019-08 For more information, see Security Policies in the Application Load Balancers Guide and Security Policies in the Network Load Balancers Guide.
1212 */
1213 SslPolicy?: SslPolicyName;
1214 /**
1215 * [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. To create a certificate list, use AddListenerCertificates.
1216 */
1217 Certificates?: CertificateList;
1218 /**
1219 * The actions for the default rule. The rule must include one forward action or one or more fixed-response actions. If the action type is forward, you specify one or more target groups. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.
1220 */
1221 DefaultActions?: Actions;
1222 }
1223 export interface ModifyListenerOutput {
1224 /**
1225 * Information about the modified listener.
1226 */
1227 Listeners?: Listeners;
1228 }
1229 export interface ModifyLoadBalancerAttributesInput {
1230 /**
1231 * The Amazon Resource Name (ARN) of the load balancer.
1232 */
1233 LoadBalancerArn: LoadBalancerArn;
1234 /**
1235 * The load balancer attributes.
1236 */
1237 Attributes: LoadBalancerAttributes;
1238 }
1239 export interface ModifyLoadBalancerAttributesOutput {
1240 /**
1241 * Information about the load balancer attributes.
1242 */
1243 Attributes?: LoadBalancerAttributes;
1244 }
1245 export interface ModifyRuleInput {
1246 /**
1247 * The Amazon Resource Name (ARN) of the rule.
1248 */
1249 RuleArn: RuleArn;
1250 /**
1251 * 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.
1252 */
1253 Conditions?: RuleConditionList;
1254 /**
1255 * The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed. If the action type is forward, you specify one or more target groups. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.
1256 */
1257 Actions?: Actions;
1258 }
1259 export interface ModifyRuleOutput {
1260 /**
1261 * Information about the modified rule.
1262 */
1263 Rules?: Rules;
1264 }
1265 export interface ModifyTargetGroupAttributesInput {
1266 /**
1267 * The Amazon Resource Name (ARN) of the target group.
1268 */
1269 TargetGroupArn: TargetGroupArn;
1270 /**
1271 * The attributes.
1272 */
1273 Attributes: TargetGroupAttributes;
1274 }
1275 export interface ModifyTargetGroupAttributesOutput {
1276 /**
1277 * Information about the attributes.
1278 */
1279 Attributes?: TargetGroupAttributes;
1280 }
1281 export interface ModifyTargetGroupInput {
1282 /**
1283 * The Amazon Resource Name (ARN) of the target group.
1284 */
1285 TargetGroupArn: TargetGroupArn;
1286 /**
1287 * The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks. With Network Load Balancers, you can't modify this setting.
1288 */
1289 HealthCheckProtocol?: ProtocolEnum;
1290 /**
1291 * The port the load balancer uses when performing health checks on targets.
1292 */
1293 HealthCheckPort?: HealthCheckPort;
1294 /**
1295 * [HTTP/HTTPS health checks] The ping path that is the destination for the health check request.
1296 */
1297 HealthCheckPath?: Path;
1298 /**
1299 * Indicates whether health checks are enabled.
1300 */
1301 HealthCheckEnabled?: HealthCheckEnabled;
1302 /**
1303 * The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. With Network Load Balancers, you can't modify this setting.
1304 */
1305 HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds;
1306 /**
1307 * [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.
1308 */
1309 HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds;
1310 /**
1311 * The number of consecutive health checks successes required before considering an unhealthy target healthy.
1312 */
1313 HealthyThresholdCount?: HealthCheckThresholdCount;
1314 /**
1315 * The number of consecutive health check failures required before considering the target unhealthy. For Network Load Balancers, this value must be the same as the healthy threshold count.
1316 */
1317 UnhealthyThresholdCount?: HealthCheckThresholdCount;
1318 /**
1319 * [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target. With Network Load Balancers, you can't modify this setting.
1320 */
1321 Matcher?: Matcher;
1322 }
1323 export interface ModifyTargetGroupOutput {
1324 /**
1325 * Information about the modified target group.
1326 */
1327 TargetGroups?: TargetGroups;
1328 }
1329 export type Name = string;
1330 export type PageSize = number;
1331 export type Path = string;
1332 export interface PathPatternConditionConfig {
1333 /**
1334 * 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.
1335 */
1336 Values?: ListOfString;
1337 }
1338 export type Port = number;
1339 export type PrivateIPv4Address = string;
1340 export type ProtocolEnum = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|string;
1341 export interface QueryStringConditionConfig {
1342 /**
1343 * 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.
1344 */
1345 Values?: QueryStringKeyValuePairList;
1346 }
1347 export interface QueryStringKeyValuePair {
1348 /**
1349 * The key. You can omit the key.
1350 */
1351 Key?: StringValue;
1352 /**
1353 * The value.
1354 */
1355 Value?: StringValue;
1356 }
1357 export type QueryStringKeyValuePairList = QueryStringKeyValuePair[];
1358 export interface RedirectActionConfig {
1359 /**
1360 * 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.
1361 */
1362 Protocol?: RedirectActionProtocol;
1363 /**
1364 * The port. You can specify a value from 1 to 65535 or #{port}.
1365 */
1366 Port?: RedirectActionPort;
1367 /**
1368 * The hostname. This component is not percent-encoded. The hostname can contain #{host}.
1369 */
1370 Host?: RedirectActionHost;
1371 /**
1372 * The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
1373 */
1374 Path?: RedirectActionPath;
1375 /**
1376 * 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.
1377 */
1378 Query?: RedirectActionQuery;
1379 /**
1380 * The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
1381 */
1382 StatusCode: RedirectActionStatusCodeEnum;
1383 }
1384 export type RedirectActionHost = string;
1385 export type RedirectActionPath = string;
1386 export type RedirectActionPort = string;
1387 export type RedirectActionProtocol = string;
1388 export type RedirectActionQuery = string;
1389 export type RedirectActionStatusCodeEnum = "HTTP_301"|"HTTP_302"|string;
1390 export interface RegisterTargetsInput {
1391 /**
1392 * The Amazon Resource Name (ARN) of the target group.
1393 */
1394 TargetGroupArn: TargetGroupArn;
1395 /**
1396 * The targets. To register a target by instance ID, specify the instance ID. To register a target by IP address, specify the IP address. To register a Lambda function, specify the ARN of the Lambda function.
1397 */
1398 Targets: TargetDescriptions;
1399 }
1400 export interface RegisterTargetsOutput {
1401 }
1402 export interface RemoveListenerCertificatesInput {
1403 /**
1404 * The Amazon Resource Name (ARN) of the listener.
1405 */
1406 ListenerArn: ListenerArn;
1407 /**
1408 * The certificate to remove. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.
1409 */
1410 Certificates: CertificateList;
1411 }
1412 export interface RemoveListenerCertificatesOutput {
1413 }
1414 export interface RemoveTagsInput {
1415 /**
1416 * The Amazon Resource Name (ARN) of the resource.
1417 */
1418 ResourceArns: ResourceArns;
1419 /**
1420 * The tag keys for the tags to remove.
1421 */
1422 TagKeys: TagKeys;
1423 }
1424 export interface RemoveTagsOutput {
1425 }
1426 export type ResourceArn = string;
1427 export type ResourceArns = ResourceArn[];
1428 export interface Rule {
1429 /**
1430 * The Amazon Resource Name (ARN) of the rule.
1431 */
1432 RuleArn?: RuleArn;
1433 /**
1434 * The priority.
1435 */
1436 Priority?: String;
1437 /**
1438 * 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.
1439 */
1440 Conditions?: RuleConditionList;
1441 /**
1442 * 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.
1443 */
1444 Actions?: Actions;
1445 /**
1446 * Indicates whether this is the default rule.
1447 */
1448 IsDefault?: IsDefault;
1449 }
1450 export type RuleArn = string;
1451 export type RuleArns = RuleArn[];
1452 export interface RuleCondition {
1453 /**
1454 * 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
1455 */
1456 Field?: ConditionFieldName;
1457 /**
1458 * The condition value. You can use Values if the rule contains only host-header and path-pattern conditions. Otherwise, you can use HostHeaderConfig for host-header conditions and PathPatternConfig for path-pattern conditions. If Field is host-header, you can specify a single host name (for example, my.example.com). 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, you can specify a single path pattern (for example, /img/*). 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 _ - . $ / ~ " ' @ : + &amp; (using &amp;amp;) * (matches 0 or more characters) ? (matches exactly 1 character)
1459 */
1460 Values?: ListOfString;
1461 /**
1462 * Information for a host header condition. Specify only when Field is host-header.
1463 */
1464 HostHeaderConfig?: HostHeaderConditionConfig;
1465 /**
1466 * Information for a path pattern condition. Specify only when Field is path-pattern.
1467 */
1468 PathPatternConfig?: PathPatternConditionConfig;
1469 /**
1470 * Information for an HTTP header condition. Specify only when Field is http-header.
1471 */
1472 HttpHeaderConfig?: HttpHeaderConditionConfig;
1473 /**
1474 * Information for a query string condition. Specify only when Field is query-string.
1475 */
1476 QueryStringConfig?: QueryStringConditionConfig;
1477 /**
1478 * Information for an HTTP method condition. Specify only when Field is http-request-method.
1479 */
1480 HttpRequestMethodConfig?: HttpRequestMethodConditionConfig;
1481 /**
1482 * Information for a source IP condition. Specify only when Field is source-ip.
1483 */
1484 SourceIpConfig?: SourceIpConditionConfig;
1485 }
1486 export type RuleConditionList = RuleCondition[];
1487 export type RulePriority = number;
1488 export type RulePriorityList = RulePriorityPair[];
1489 export interface RulePriorityPair {
1490 /**
1491 * The Amazon Resource Name (ARN) of the rule.
1492 */
1493 RuleArn?: RuleArn;
1494 /**
1495 * The rule priority.
1496 */
1497 Priority?: RulePriority;
1498 }
1499 export type Rules = Rule[];
1500 export type SecurityGroupId = string;
1501 export type SecurityGroups = SecurityGroupId[];
1502 export interface SetIpAddressTypeInput {
1503 /**
1504 * The Amazon Resource Name (ARN) of the load balancer.
1505 */
1506 LoadBalancerArn: LoadBalancerArn;
1507 /**
1508 * 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. Network Load Balancers must use ipv4.
1509 */
1510 IpAddressType: IpAddressType;
1511 }
1512 export interface SetIpAddressTypeOutput {
1513 /**
1514 * The IP address type.
1515 */
1516 IpAddressType?: IpAddressType;
1517 }
1518 export interface SetRulePrioritiesInput {
1519 /**
1520 * The rule priorities.
1521 */
1522 RulePriorities: RulePriorityList;
1523 }
1524 export interface SetRulePrioritiesOutput {
1525 /**
1526 * Information about the rules.
1527 */
1528 Rules?: Rules;
1529 }
1530 export interface SetSecurityGroupsInput {
1531 /**
1532 * The Amazon Resource Name (ARN) of the load balancer.
1533 */
1534 LoadBalancerArn: LoadBalancerArn;
1535 /**
1536 * The IDs of the security groups.
1537 */
1538 SecurityGroups: SecurityGroups;
1539 }
1540 export interface SetSecurityGroupsOutput {
1541 /**
1542 * The IDs of the security groups associated with the load balancer.
1543 */
1544 SecurityGroupIds?: SecurityGroups;
1545 }
1546 export interface SetSubnetsInput {
1547 /**
1548 * The Amazon Resource Name (ARN) of the load balancer.
1549 */
1550 LoadBalancerArn: LoadBalancerArn;
1551 /**
1552 * The IDs of the public subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
1553 */
1554 Subnets?: Subnets;
1555 /**
1556 * 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. [Network Load Balancers] You can specify subnets from one or more Availability Zones. If you need static IP addresses for your internet-facing load balancer, you can specify one Elastic IP address per subnet. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet.
1557 */
1558 SubnetMappings?: SubnetMappings;
1559 }
1560 export interface SetSubnetsOutput {
1561 /**
1562 * Information about the subnet and Availability Zone.
1563 */
1564 AvailabilityZones?: AvailabilityZones;
1565 }
1566 export interface SourceIpConditionConfig {
1567 /**
1568 * 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.
1569 */
1570 Values?: ListOfString;
1571 }
1572 export type SslPolicies = SslPolicy[];
1573 export interface SslPolicy {
1574 /**
1575 * The protocols.
1576 */
1577 SslProtocols?: SslProtocols;
1578 /**
1579 * The ciphers.
1580 */
1581 Ciphers?: Ciphers;
1582 /**
1583 * The name of the policy.
1584 */
1585 Name?: SslPolicyName;
1586 }
1587 export type SslPolicyName = string;
1588 export type SslPolicyNames = SslPolicyName[];
1589 export type SslProtocol = string;
1590 export type SslProtocols = SslProtocol[];
1591 export type StateReason = string;
1592 export type String = string;
1593 export type StringValue = string;
1594 export type SubnetId = string;
1595 export interface SubnetMapping {
1596 /**
1597 * The ID of the subnet.
1598 */
1599 SubnetId?: SubnetId;
1600 /**
1601 * [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
1602 */
1603 AllocationId?: AllocationId;
1604 /**
1605 * [Network Load Balancers] The private IPv4 address for an internal load balancer.
1606 */
1607 PrivateIPv4Address?: PrivateIPv4Address;
1608 }
1609 export type SubnetMappings = SubnetMapping[];
1610 export type Subnets = SubnetId[];
1611 export interface Tag {
1612 /**
1613 * The key of the tag.
1614 */
1615 Key: TagKey;
1616 /**
1617 * The value of the tag.
1618 */
1619 Value?: TagValue;
1620 }
1621 export interface TagDescription {
1622 /**
1623 * The Amazon Resource Name (ARN) of the resource.
1624 */
1625 ResourceArn?: ResourceArn;
1626 /**
1627 * Information about the tags.
1628 */
1629 Tags?: TagList;
1630 }
1631 export type TagDescriptions = TagDescription[];
1632 export type TagKey = string;
1633 export type TagKeys = TagKey[];
1634 export type TagList = Tag[];
1635 export type TagValue = string;
1636 export interface TargetDescription {
1637 /**
1638 * 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.
1639 */
1640 Id: TargetId;
1641 /**
1642 * The port on which the target is listening. Not used if the target is a Lambda function.
1643 */
1644 Port?: Port;
1645 /**
1646 * 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.
1647 */
1648 AvailabilityZone?: ZoneName;
1649 }
1650 export type TargetDescriptions = TargetDescription[];
1651 export interface TargetGroup {
1652 /**
1653 * The Amazon Resource Name (ARN) of the target group.
1654 */
1655 TargetGroupArn?: TargetGroupArn;
1656 /**
1657 * The name of the target group.
1658 */
1659 TargetGroupName?: TargetGroupName;
1660 /**
1661 * The protocol to use for routing traffic to the targets.
1662 */
1663 Protocol?: ProtocolEnum;
1664 /**
1665 * The port on which the targets are listening. Not used if the target is a Lambda function.
1666 */
1667 Port?: Port;
1668 /**
1669 * The ID of the VPC for the targets.
1670 */
1671 VpcId?: VpcId;
1672 /**
1673 * The protocol to use to connect with the target.
1674 */
1675 HealthCheckProtocol?: ProtocolEnum;
1676 /**
1677 * The port to use to connect with the target.
1678 */
1679 HealthCheckPort?: HealthCheckPort;
1680 /**
1681 * Indicates whether health checks are enabled.
1682 */
1683 HealthCheckEnabled?: HealthCheckEnabled;
1684 /**
1685 * The approximate amount of time, in seconds, between health checks of an individual target.
1686 */
1687 HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds;
1688 /**
1689 * The amount of time, in seconds, during which no response means a failed health check.
1690 */
1691 HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds;
1692 /**
1693 * The number of consecutive health checks successes required before considering an unhealthy target healthy.
1694 */
1695 HealthyThresholdCount?: HealthCheckThresholdCount;
1696 /**
1697 * The number of consecutive health check failures required before considering the target unhealthy.
1698 */
1699 UnhealthyThresholdCount?: HealthCheckThresholdCount;
1700 /**
1701 * The destination for the health check request.
1702 */
1703 HealthCheckPath?: Path;
1704 /**
1705 * The HTTP codes to use when checking for a successful response from a target.
1706 */
1707 Matcher?: Matcher;
1708 /**
1709 * The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
1710 */
1711 LoadBalancerArns?: LoadBalancerArns;
1712 /**
1713 * The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
1714 */
1715 TargetType?: TargetTypeEnum;
1716 }
1717 export type TargetGroupArn = string;
1718 export type TargetGroupArns = TargetGroupArn[];
1719 export interface TargetGroupAttribute {
1720 /**
1721 * The name of the attribute. The following attributes are supported by both Application Load Balancers and Network 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. 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 for Application Load Balancers or source_ip for Network Load Balancers. The following attributes are supported by Application Load Balancers if the target is not a Lambda function: 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 a linearly 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). Slow start mode is disabled by default. 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 target is a Lambda function. lambda.multi_value_headers.enabled - Indicates whether the request and response headers 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 attribute is supported only by Network Load Balancers: proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.
1722 */
1723 Key?: TargetGroupAttributeKey;
1724 /**
1725 * The value of the attribute.
1726 */
1727 Value?: TargetGroupAttributeValue;
1728 }
1729 export type TargetGroupAttributeKey = string;
1730 export type TargetGroupAttributeValue = string;
1731 export type TargetGroupAttributes = TargetGroupAttribute[];
1732 export type TargetGroupList = TargetGroupTuple[];
1733 export type TargetGroupName = string;
1734 export type TargetGroupNames = TargetGroupName[];
1735 export interface TargetGroupStickinessConfig {
1736 /**
1737 * Indicates whether target group stickiness is enabled.
1738 */
1739 Enabled?: TargetGroupStickinessEnabled;
1740 /**
1741 * 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).
1742 */
1743 DurationSeconds?: TargetGroupStickinessDurationSeconds;
1744 }
1745 export type TargetGroupStickinessDurationSeconds = number;
1746 export type TargetGroupStickinessEnabled = boolean;
1747 export interface TargetGroupTuple {
1748 /**
1749 * The Amazon Resource Name (ARN) of the target group.
1750 */
1751 TargetGroupArn?: TargetGroupArn;
1752 /**
1753 * The weight. The range is 0 to 999.
1754 */
1755 Weight?: TargetGroupWeight;
1756 }
1757 export type TargetGroupWeight = number;
1758 export type TargetGroups = TargetGroup[];
1759 export interface TargetHealth {
1760 /**
1761 * The state of the target.
1762 */
1763 State?: TargetHealthStateEnum;
1764 /**
1765 * 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. Target.Timeout - The health check requests timed out. Applies only to Application 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.
1766 */
1767 Reason?: TargetHealthReasonEnum;
1768 /**
1769 * A description of the target health that provides additional details. If the state is healthy, a description is not provided.
1770 */
1771 Description?: Description;
1772 }
1773 export interface TargetHealthDescription {
1774 /**
1775 * The description of the target.
1776 */
1777 Target?: TargetDescription;
1778 /**
1779 * The port to use to connect with the target.
1780 */
1781 HealthCheckPort?: HealthCheckPort;
1782 /**
1783 * The health information for the target.
1784 */
1785 TargetHealth?: TargetHealth;
1786 }
1787 export type TargetHealthDescriptions = TargetHealthDescription[];
1788 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;
1789 export type TargetHealthStateEnum = "initial"|"healthy"|"unhealthy"|"unused"|"draining"|"unavailable"|string;
1790 export type TargetId = string;
1791 export type TargetTypeEnum = "instance"|"ip"|"lambda"|string;
1792 export type VpcId = string;
1793 export type ZoneName = string;
1794 /**
1795 * 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.
1796 */
1797 export type apiVersion = "2015-12-01"|"latest"|string;
1798 export interface ClientApiVersions {
1799 /**
1800 * 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.
1801 */
1802 apiVersion?: apiVersion;
1803 }
1804 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1805 /**
1806 * Contains interfaces for use with the ELBv2 client.
1807 */
1808 export import Types = ELBv2;
1809}
1810export = ELBv2;