@aws-sdk/client-elastic-load-balancing 3.288.0 → 3.289.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/dist-types/commands/AddTagsCommand.d.ts +23 -0
  2. package/dist-types/commands/ApplySecurityGroupsToLoadBalancerCommand.d.ts +21 -0
  3. package/dist-types/commands/AttachLoadBalancerToSubnetsCommand.d.ts +22 -0
  4. package/dist-types/commands/ConfigureHealthCheckCommand.d.ts +29 -0
  5. package/dist-types/commands/CreateAppCookieStickinessPolicyCommand.d.ts +13 -0
  6. package/dist-types/commands/CreateLBCookieStickinessPolicyCommand.d.ts +13 -0
  7. package/dist-types/commands/CreateLoadBalancerCommand.d.ts +159 -0
  8. package/dist-types/commands/CreateLoadBalancerListenersCommand.d.ts +39 -0
  9. package/dist-types/commands/CreateLoadBalancerPolicyCommand.d.ts +57 -0
  10. package/dist-types/commands/DeleteLoadBalancerCommand.d.ts +11 -0
  11. package/dist-types/commands/DeleteLoadBalancerListenersCommand.d.ts +14 -0
  12. package/dist-types/commands/DeleteLoadBalancerPolicyCommand.d.ts +12 -0
  13. package/dist-types/commands/DeregisterInstancesFromLoadBalancerCommand.d.ts +28 -0
  14. package/dist-types/commands/DescribeInstanceHealthCommand.d.ts +29 -0
  15. package/dist-types/commands/DescribeLoadBalancerAttributesCommand.d.ts +30 -0
  16. package/dist-types/commands/DescribeLoadBalancerPoliciesCommand.d.ts +30 -0
  17. package/dist-types/commands/DescribeLoadBalancerPolicyTypesCommand.d.ts +30 -0
  18. package/dist-types/commands/DescribeLoadBalancersCommand.d.ts +103 -0
  19. package/dist-types/commands/DescribeTagsCommand.d.ts +32 -0
  20. package/dist-types/commands/DetachLoadBalancerFromSubnetsCommand.d.ts +21 -0
  21. package/dist-types/commands/DisableAvailabilityZonesForLoadBalancerCommand.d.ts +21 -0
  22. package/dist-types/commands/EnableAvailabilityZonesForLoadBalancerCommand.d.ts +22 -0
  23. package/dist-types/commands/ModifyLoadBalancerAttributesCommand.d.ts +54 -0
  24. package/dist-types/commands/RegisterInstancesWithLoadBalancerCommand.d.ts +31 -0
  25. package/dist-types/commands/RemoveTagsCommand.d.ts +18 -0
  26. package/dist-types/commands/SetLoadBalancerListenerSSLCertificateCommand.d.ts +13 -0
  27. package/dist-types/commands/SetLoadBalancerPoliciesForBackendServerCommand.d.ts +15 -0
  28. package/dist-types/commands/SetLoadBalancerPoliciesOfListenerCommand.d.ts +15 -0
  29. package/package.json +30 -30
@@ -35,6 +35,29 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
35
35
  * @see {@link AddTagsCommandOutput} for command's `response` shape.
36
36
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
37
37
  *
38
+ * @example To add tags to a load balancer
39
+ * ```javascript
40
+ * // This example adds two tags to the specified load balancer.
41
+ * const input = {
42
+ * "LoadBalancerNames": [
43
+ * "my-load-balancer"
44
+ * ],
45
+ * "Tags": [
46
+ * {
47
+ * "Key": "project",
48
+ * "Value": "lima"
49
+ * },
50
+ * {
51
+ * "Key": "department",
52
+ * "Value": "digital-media"
53
+ * }
54
+ * ]
55
+ * };
56
+ * const command = new AddTagsCommand(input);
57
+ * await client.send(command);
58
+ * // example id: elb-add-tags-1
59
+ * ```
60
+ *
38
61
  */
39
62
  export declare class AddTagsCommand extends $Command<AddTagsCommandInput, AddTagsCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
40
63
  readonly input: AddTagsCommandInput;
@@ -31,6 +31,27 @@ export interface ApplySecurityGroupsToLoadBalancerCommandOutput extends ApplySec
31
31
  * @see {@link ApplySecurityGroupsToLoadBalancerCommandOutput} for command's `response` shape.
32
32
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
33
33
  *
34
+ * @example To associate a security group with a load balancer in a VPC
35
+ * ```javascript
36
+ * // This example associates a security group with the specified load balancer in a VPC.
37
+ * const input = {
38
+ * "LoadBalancerName": "my-load-balancer",
39
+ * "SecurityGroups": [
40
+ * "sg-fc448899"
41
+ * ]
42
+ * };
43
+ * const command = new ApplySecurityGroupsToLoadBalancerCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "SecurityGroups": [
48
+ * "sg-fc448899"
49
+ * ]
50
+ * }
51
+ * *\/
52
+ * // example id: elb-apply-security-groups-to-load-balancer-1
53
+ * ```
54
+ *
34
55
  */
35
56
  export declare class ApplySecurityGroupsToLoadBalancerCommand extends $Command<ApplySecurityGroupsToLoadBalancerCommandInput, ApplySecurityGroupsToLoadBalancerCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
36
57
  readonly input: ApplySecurityGroupsToLoadBalancerCommandInput;
@@ -32,6 +32,28 @@ export interface AttachLoadBalancerToSubnetsCommandOutput extends AttachLoadBala
32
32
  * @see {@link AttachLoadBalancerToSubnetsCommandOutput} for command's `response` shape.
33
33
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
34
34
  *
35
+ * @example To attach subnets to a load balancer
36
+ * ```javascript
37
+ * // This example adds the specified subnet to the set of configured subnets for the specified load balancer.
38
+ * const input = {
39
+ * "LoadBalancerName": "my-load-balancer",
40
+ * "Subnets": [
41
+ * "subnet-0ecac448"
42
+ * ]
43
+ * };
44
+ * const command = new AttachLoadBalancerToSubnetsCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "Subnets": [
49
+ * "subnet-15aaab61",
50
+ * "subnet-0ecac448"
51
+ * ]
52
+ * }
53
+ * *\/
54
+ * // example id: elb-attach-load-balancer-to-subnets-1
55
+ * ```
56
+ *
35
57
  */
36
58
  export declare class AttachLoadBalancerToSubnetsCommand extends $Command<AttachLoadBalancerToSubnetsCommandInput, AttachLoadBalancerToSubnetsCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
37
59
  readonly input: AttachLoadBalancerToSubnetsCommandInput;
@@ -31,6 +31,35 @@ export interface ConfigureHealthCheckCommandOutput extends ConfigureHealthCheckO
31
31
  * @see {@link ConfigureHealthCheckCommandOutput} for command's `response` shape.
32
32
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
33
33
  *
34
+ * @example To specify the health check settings for your backend EC2 instances
35
+ * ```javascript
36
+ * // This example specifies the health check settings used to evaluate the health of your backend EC2 instances.
37
+ * const input = {
38
+ * "HealthCheck": {
39
+ * "HealthyThreshold": 2,
40
+ * "Interval": 30,
41
+ * "Target": "HTTP:80/png",
42
+ * "Timeout": 3,
43
+ * "UnhealthyThreshold": 2
44
+ * },
45
+ * "LoadBalancerName": "my-load-balancer"
46
+ * };
47
+ * const command = new ConfigureHealthCheckCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "HealthCheck": {
52
+ * "HealthyThreshold": 2,
53
+ * "Interval": 30,
54
+ * "Target": "HTTP:80/png",
55
+ * "Timeout": 3,
56
+ * "UnhealthyThreshold": 2
57
+ * }
58
+ * }
59
+ * *\/
60
+ * // example id: elb-configure-health-check-1
61
+ * ```
62
+ *
34
63
  */
35
64
  export declare class ConfigureHealthCheckCommand extends $Command<ConfigureHealthCheckCommandInput, ConfigureHealthCheckCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
36
65
  readonly input: ConfigureHealthCheckCommandInput;
@@ -37,6 +37,19 @@ export interface CreateAppCookieStickinessPolicyCommandOutput extends CreateAppC
37
37
  * @see {@link CreateAppCookieStickinessPolicyCommandOutput} for command's `response` shape.
38
38
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
39
39
  *
40
+ * @example To generate a stickiness policy for your load balancer
41
+ * ```javascript
42
+ * // This example generates a stickiness policy that follows the sticky session lifetimes of the application-generated cookie.
43
+ * const input = {
44
+ * "CookieName": "my-app-cookie",
45
+ * "LoadBalancerName": "my-load-balancer",
46
+ * "PolicyName": "my-app-cookie-policy"
47
+ * };
48
+ * const command = new CreateAppCookieStickinessPolicyCommand(input);
49
+ * await client.send(command);
50
+ * // example id: elb-create-app-cookie-stickiness-policy-1
51
+ * ```
52
+ *
40
53
  */
41
54
  export declare class CreateAppCookieStickinessPolicyCommand extends $Command<CreateAppCookieStickinessPolicyCommandInput, CreateAppCookieStickinessPolicyCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
42
55
  readonly input: CreateAppCookieStickinessPolicyCommandInput;
@@ -35,6 +35,19 @@ export interface CreateLBCookieStickinessPolicyCommandOutput extends CreateLBCoo
35
35
  * @see {@link CreateLBCookieStickinessPolicyCommandOutput} for command's `response` shape.
36
36
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
37
37
  *
38
+ * @example To generate a duration-based stickiness policy for your load balancer
39
+ * ```javascript
40
+ * // This example generates a stickiness policy with sticky session lifetimes controlled by the specified expiration period.
41
+ * const input = {
42
+ * "CookieExpirationPeriod": 60,
43
+ * "LoadBalancerName": "my-load-balancer",
44
+ * "PolicyName": "my-duration-cookie-policy"
45
+ * };
46
+ * const command = new CreateLBCookieStickinessPolicyCommand(input);
47
+ * await client.send(command);
48
+ * // example id: elb-create-lb-cookie-stickiness-policy-1
49
+ * ```
50
+ *
38
51
  */
39
52
  export declare class CreateLBCookieStickinessPolicyCommand extends $Command<CreateLBCookieStickinessPolicyCommandInput, CreateLBCookieStickinessPolicyCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
40
53
  readonly input: CreateLBCookieStickinessPolicyCommandInput;
@@ -42,6 +42,165 @@ export interface CreateLoadBalancerCommandOutput extends CreateAccessPointOutput
42
42
  * @see {@link CreateLoadBalancerCommandOutput} for command's `response` shape.
43
43
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
44
44
  *
45
+ * @example To create an HTTP load balancer in a VPC
46
+ * ```javascript
47
+ * // This example creates a load balancer with an HTTP listener in a VPC.
48
+ * const input = {
49
+ * "Listeners": [
50
+ * {
51
+ * "InstancePort": 80,
52
+ * "InstanceProtocol": "HTTP",
53
+ * "LoadBalancerPort": 80,
54
+ * "Protocol": "HTTP"
55
+ * }
56
+ * ],
57
+ * "LoadBalancerName": "my-load-balancer",
58
+ * "SecurityGroups": [
59
+ * "sg-a61988c3"
60
+ * ],
61
+ * "Subnets": [
62
+ * "subnet-15aaab61"
63
+ * ]
64
+ * };
65
+ * const command = new CreateLoadBalancerCommand(input);
66
+ * const response = await client.send(command);
67
+ * /* response ==
68
+ * {
69
+ * "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com"
70
+ * }
71
+ * *\/
72
+ * // example id: elb-create-load-balancer-1
73
+ * ```
74
+ *
75
+ * @example To create an HTTP load balancer in EC2-Classic
76
+ * ```javascript
77
+ * // This example creates a load balancer with an HTTP listener in EC2-Classic.
78
+ * const input = {
79
+ * "AvailabilityZones": [
80
+ * "us-west-2a"
81
+ * ],
82
+ * "Listeners": [
83
+ * {
84
+ * "InstancePort": 80,
85
+ * "InstanceProtocol": "HTTP",
86
+ * "LoadBalancerPort": 80,
87
+ * "Protocol": "HTTP"
88
+ * }
89
+ * ],
90
+ * "LoadBalancerName": "my-load-balancer"
91
+ * };
92
+ * const command = new CreateLoadBalancerCommand(input);
93
+ * const response = await client.send(command);
94
+ * /* response ==
95
+ * {
96
+ * "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com"
97
+ * }
98
+ * *\/
99
+ * // example id: elb-create-load-balancer-2
100
+ * ```
101
+ *
102
+ * @example To create an HTTPS load balancer in a VPC
103
+ * ```javascript
104
+ * // This example creates a load balancer with an HTTPS listener in a VPC.
105
+ * const input = {
106
+ * "Listeners": [
107
+ * {
108
+ * "InstancePort": 80,
109
+ * "InstanceProtocol": "HTTP",
110
+ * "LoadBalancerPort": 80,
111
+ * "Protocol": "HTTP"
112
+ * },
113
+ * {
114
+ * "InstancePort": 80,
115
+ * "InstanceProtocol": "HTTP",
116
+ * "LoadBalancerPort": 443,
117
+ * "Protocol": "HTTPS",
118
+ * "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert"
119
+ * }
120
+ * ],
121
+ * "LoadBalancerName": "my-load-balancer",
122
+ * "SecurityGroups": [
123
+ * "sg-a61988c3"
124
+ * ],
125
+ * "Subnets": [
126
+ * "subnet-15aaab61"
127
+ * ]
128
+ * };
129
+ * const command = new CreateLoadBalancerCommand(input);
130
+ * const response = await client.send(command);
131
+ * /* response ==
132
+ * {
133
+ * "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com"
134
+ * }
135
+ * *\/
136
+ * // example id: elb-create-load-balancer-3
137
+ * ```
138
+ *
139
+ * @example To create an HTTPS load balancer in EC2-Classic
140
+ * ```javascript
141
+ * // This example creates a load balancer with an HTTPS listener in EC2-Classic.
142
+ * const input = {
143
+ * "AvailabilityZones": [
144
+ * "us-west-2a"
145
+ * ],
146
+ * "Listeners": [
147
+ * {
148
+ * "InstancePort": 80,
149
+ * "InstanceProtocol": "HTTP",
150
+ * "LoadBalancerPort": 80,
151
+ * "Protocol": "HTTP"
152
+ * },
153
+ * {
154
+ * "InstancePort": 80,
155
+ * "InstanceProtocol": "HTTP",
156
+ * "LoadBalancerPort": 443,
157
+ * "Protocol": "HTTPS",
158
+ * "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert"
159
+ * }
160
+ * ],
161
+ * "LoadBalancerName": "my-load-balancer"
162
+ * };
163
+ * const command = new CreateLoadBalancerCommand(input);
164
+ * const response = await client.send(command);
165
+ * /* response ==
166
+ * {
167
+ * "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com"
168
+ * }
169
+ * *\/
170
+ * // example id: elb-create-load-balancer-4
171
+ * ```
172
+ *
173
+ * @example To create an internal load balancer
174
+ * ```javascript
175
+ * // This example creates an internal load balancer with an HTTP listener in a VPC.
176
+ * const input = {
177
+ * "Listeners": [
178
+ * {
179
+ * "InstancePort": 80,
180
+ * "InstanceProtocol": "HTTP",
181
+ * "LoadBalancerPort": 80,
182
+ * "Protocol": "HTTP"
183
+ * }
184
+ * ],
185
+ * "LoadBalancerName": "my-load-balancer",
186
+ * "Scheme": "internal",
187
+ * "SecurityGroups": [
188
+ * "sg-a61988c3"
189
+ * ],
190
+ * "Subnets": [
191
+ * "subnet-15aaab61"
192
+ * ]
193
+ * };
194
+ * const command = new CreateLoadBalancerCommand(input);
195
+ * const response = await client.send(command);
196
+ * /* response ==
197
+ * {
198
+ * "DNSName": "internal-my-load-balancer-123456789.us-west-2.elb.amazonaws.com"
199
+ * }
200
+ * *\/
201
+ * // example id: elb-create-load-balancer-5
202
+ * ```
203
+ *
45
204
  */
46
205
  export declare class CreateLoadBalancerCommand extends $Command<CreateLoadBalancerCommandInput, CreateLoadBalancerCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
47
206
  readonly input: CreateLoadBalancerCommandInput;
@@ -31,6 +31,45 @@ export interface CreateLoadBalancerListenersCommandOutput extends CreateLoadBala
31
31
  * @see {@link CreateLoadBalancerListenersCommandOutput} for command's `response` shape.
32
32
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
33
33
  *
34
+ * @example To create an HTTP listener for a load balancer
35
+ * ```javascript
36
+ * // This example creates a listener for your load balancer at port 80 using the HTTP protocol.
37
+ * const input = {
38
+ * "Listeners": [
39
+ * {
40
+ * "InstancePort": 80,
41
+ * "InstanceProtocol": "HTTP",
42
+ * "LoadBalancerPort": 80,
43
+ * "Protocol": "HTTP"
44
+ * }
45
+ * ],
46
+ * "LoadBalancerName": "my-load-balancer"
47
+ * };
48
+ * const command = new CreateLoadBalancerListenersCommand(input);
49
+ * await client.send(command);
50
+ * // example id: elb-create-load-balancer-listeners-1
51
+ * ```
52
+ *
53
+ * @example To create an HTTPS listener for a load balancer
54
+ * ```javascript
55
+ * // This example creates a listener for your load balancer at port 443 using the HTTPS protocol.
56
+ * const input = {
57
+ * "Listeners": [
58
+ * {
59
+ * "InstancePort": 80,
60
+ * "InstanceProtocol": "HTTP",
61
+ * "LoadBalancerPort": 443,
62
+ * "Protocol": "HTTPS",
63
+ * "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert"
64
+ * }
65
+ * ],
66
+ * "LoadBalancerName": "my-load-balancer"
67
+ * };
68
+ * const command = new CreateLoadBalancerListenersCommand(input);
69
+ * await client.send(command);
70
+ * // example id: elb-create-load-balancer-listeners-2
71
+ * ```
72
+ *
34
73
  */
35
74
  export declare class CreateLoadBalancerListenersCommand extends $Command<CreateLoadBalancerListenersCommandInput, CreateLoadBalancerListenersCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
36
75
  readonly input: CreateLoadBalancerListenersCommandInput;
@@ -30,6 +30,63 @@ export interface CreateLoadBalancerPolicyCommandOutput extends CreateLoadBalance
30
30
  * @see {@link CreateLoadBalancerPolicyCommandOutput} for command's `response` shape.
31
31
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
32
32
  *
33
+ * @example To create a policy that enables Proxy Protocol on a load balancer
34
+ * ```javascript
35
+ * // This example creates a policy that enables Proxy Protocol on the specified load balancer.
36
+ * const input = {
37
+ * "LoadBalancerName": "my-load-balancer",
38
+ * "PolicyAttributes": [
39
+ * {
40
+ * "AttributeName": "ProxyProtocol",
41
+ * "AttributeValue": "true"
42
+ * }
43
+ * ],
44
+ * "PolicyName": "my-ProxyProtocol-policy",
45
+ * "PolicyTypeName": "ProxyProtocolPolicyType"
46
+ * };
47
+ * const command = new CreateLoadBalancerPolicyCommand(input);
48
+ * await client.send(command);
49
+ * // example id: elb-create-load-balancer-policy-1
50
+ * ```
51
+ *
52
+ * @example To create a public key policy
53
+ * ```javascript
54
+ * // This example creates a public key policy.
55
+ * const input = {
56
+ * "LoadBalancerName": "my-load-balancer",
57
+ * "PolicyAttributes": [
58
+ * {
59
+ * "AttributeName": "PublicKey",
60
+ * "AttributeValue": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwAYUjnfyEyXr1pxjhFWBpMlggUcqoi3kl+dS74kj//c6x7ROtusUaeQCTgIUkayttRDWchuqo1pHC1u+n5xxXnBBe2ejbb2WRsKIQ5rXEeixsjFpFsojpSQKkzhVGI6mJVZBJDVKSHmswnwLBdofLhzvllpovBPTHe+o4haAWvDBALJU0pkSI1FecPHcs2hwxf14zHoXy1e2k36A64nXW43wtfx5qcVSIxtCEOjnYRg7RPvybaGfQ+v6Iaxb/+7J5kEvZhTFQId+bSiJImF1FSUT1W1xwzBZPUbcUkkXDj45vC2s3Z8E+Lk7a3uZhvsQHLZnrfuWjBWGWvZ/MhZYgEXAMPLE"
61
+ * }
62
+ * ],
63
+ * "PolicyName": "my-PublicKey-policy",
64
+ * "PolicyTypeName": "PublicKeyPolicyType"
65
+ * };
66
+ * const command = new CreateLoadBalancerPolicyCommand(input);
67
+ * await client.send(command);
68
+ * // example id: elb-create-load-balancer-policy-2
69
+ * ```
70
+ *
71
+ * @example To create a backend server authentication policy
72
+ * ```javascript
73
+ * // This example creates a backend server authentication policy that enables authentication on your backend instance using a public key policy.
74
+ * const input = {
75
+ * "LoadBalancerName": "my-load-balancer",
76
+ * "PolicyAttributes": [
77
+ * {
78
+ * "AttributeName": "PublicKeyPolicyName",
79
+ * "AttributeValue": "my-PublicKey-policy"
80
+ * }
81
+ * ],
82
+ * "PolicyName": "my-authentication-policy",
83
+ * "PolicyTypeName": "BackendServerAuthenticationPolicyType"
84
+ * };
85
+ * const command = new CreateLoadBalancerPolicyCommand(input);
86
+ * await client.send(command);
87
+ * // example id: elb-create-load-balancer-policy-3
88
+ * ```
89
+ *
33
90
  */
34
91
  export declare class CreateLoadBalancerPolicyCommand extends $Command<CreateLoadBalancerPolicyCommandInput, CreateLoadBalancerPolicyCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
35
92
  readonly input: CreateLoadBalancerPolicyCommandInput;
@@ -32,6 +32,17 @@ export interface DeleteLoadBalancerCommandOutput extends DeleteAccessPointOutput
32
32
  * @see {@link DeleteLoadBalancerCommandOutput} for command's `response` shape.
33
33
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
34
34
  *
35
+ * @example To delete a load balancer
36
+ * ```javascript
37
+ * // This example deletes the specified load balancer.
38
+ * const input = {
39
+ * "LoadBalancerName": "my-load-balancer"
40
+ * };
41
+ * const command = new DeleteLoadBalancerCommand(input);
42
+ * await client.send(command);
43
+ * // example id: elb-delete-load-balancer-1
44
+ * ```
45
+ *
35
46
  */
36
47
  export declare class DeleteLoadBalancerCommand extends $Command<DeleteLoadBalancerCommandInput, DeleteLoadBalancerCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
37
48
  readonly input: DeleteLoadBalancerCommandInput;
@@ -29,6 +29,20 @@ export interface DeleteLoadBalancerListenersCommandOutput extends DeleteLoadBala
29
29
  * @see {@link DeleteLoadBalancerListenersCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
31
31
  *
32
+ * @example To delete a listener from your load balancer
33
+ * ```javascript
34
+ * // This example deletes the listener for the specified port from the specified load balancer.
35
+ * const input = {
36
+ * "LoadBalancerName": "my-load-balancer",
37
+ * "LoadBalancerPorts": [
38
+ * 80
39
+ * ]
40
+ * };
41
+ * const command = new DeleteLoadBalancerListenersCommand(input);
42
+ * await client.send(command);
43
+ * // example id: elb-delete-load-balancer-listeners-1
44
+ * ```
45
+ *
32
46
  */
33
47
  export declare class DeleteLoadBalancerListenersCommand extends $Command<DeleteLoadBalancerListenersCommandInput, DeleteLoadBalancerListenersCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
34
48
  readonly input: DeleteLoadBalancerListenersCommandInput;
@@ -29,6 +29,18 @@ export interface DeleteLoadBalancerPolicyCommandOutput extends DeleteLoadBalance
29
29
  * @see {@link DeleteLoadBalancerPolicyCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
31
31
  *
32
+ * @example To delete a policy from your load balancer
33
+ * ```javascript
34
+ * // This example deletes the specified policy from the specified load balancer. The policy must not be enabled on any listener.
35
+ * const input = {
36
+ * "LoadBalancerName": "my-load-balancer",
37
+ * "PolicyName": "my-duration-cookie-policy"
38
+ * };
39
+ * const command = new DeleteLoadBalancerPolicyCommand(input);
40
+ * await client.send(command);
41
+ * // example id: elb-delete-load-balancer-policy-1
42
+ * ```
43
+ *
32
44
  */
33
45
  export declare class DeleteLoadBalancerPolicyCommand extends $Command<DeleteLoadBalancerPolicyCommandInput, DeleteLoadBalancerPolicyCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
34
46
  readonly input: DeleteLoadBalancerPolicyCommandInput;
@@ -34,6 +34,34 @@ export interface DeregisterInstancesFromLoadBalancerCommandOutput extends Deregi
34
34
  * @see {@link DeregisterInstancesFromLoadBalancerCommandOutput} for command's `response` shape.
35
35
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
36
36
  *
37
+ * @example To deregister instances from a load balancer
38
+ * ```javascript
39
+ * // This example deregisters the specified instance from the specified load balancer.
40
+ * const input = {
41
+ * "Instances": [
42
+ * {
43
+ * "InstanceId": "i-d6f6fae3"
44
+ * }
45
+ * ],
46
+ * "LoadBalancerName": "my-load-balancer"
47
+ * };
48
+ * const command = new DeregisterInstancesFromLoadBalancerCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "Instances": [
53
+ * {
54
+ * "InstanceId": "i-207d9717"
55
+ * },
56
+ * {
57
+ * "InstanceId": "i-afefb49b"
58
+ * }
59
+ * ]
60
+ * }
61
+ * *\/
62
+ * // example id: elb-deregister-instances-from-load-balancer-1
63
+ * ```
64
+ *
37
65
  */
38
66
  export declare class DeregisterInstancesFromLoadBalancerCommand extends $Command<DeregisterInstancesFromLoadBalancerCommandInput, DeregisterInstancesFromLoadBalancerCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
39
67
  readonly input: DeregisterInstancesFromLoadBalancerCommandInput;
@@ -29,6 +29,35 @@ export interface DescribeInstanceHealthCommandOutput extends DescribeEndPointSta
29
29
  * @see {@link DescribeInstanceHealthCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
31
31
  *
32
+ * @example To describe the health of the instances for a load balancer
33
+ * ```javascript
34
+ * // This example describes the health of the instances for the specified load balancer.
35
+ * const input = {
36
+ * "LoadBalancerName": "my-load-balancer"
37
+ * };
38
+ * const command = new DescribeInstanceHealthCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "InstanceStates": [
43
+ * {
44
+ * "Description": "N/A",
45
+ * "InstanceId": "i-207d9717",
46
+ * "ReasonCode": "N/A",
47
+ * "State": "InService"
48
+ * },
49
+ * {
50
+ * "Description": "N/A",
51
+ * "InstanceId": "i-afefb49b",
52
+ * "ReasonCode": "N/A",
53
+ * "State": "InService"
54
+ * }
55
+ * ]
56
+ * }
57
+ * *\/
58
+ * // example id: elb-describe-instance-health-1
59
+ * ```
60
+ *
32
61
  */
33
62
  export declare class DescribeInstanceHealthCommand extends $Command<DescribeInstanceHealthCommandInput, DescribeInstanceHealthCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
34
63
  readonly input: DescribeInstanceHealthCommandInput;
@@ -29,6 +29,36 @@ export interface DescribeLoadBalancerAttributesCommandOutput extends DescribeLoa
29
29
  * @see {@link DescribeLoadBalancerAttributesCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
31
31
  *
32
+ * @example To describe the attributes of a load balancer
33
+ * ```javascript
34
+ * // This example describes the attributes of the specified load balancer.
35
+ * const input = {
36
+ * "LoadBalancerName": "my-load-balancer"
37
+ * };
38
+ * const command = new DescribeLoadBalancerAttributesCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "LoadBalancerAttributes": {
43
+ * "AccessLog": {
44
+ * "Enabled": false
45
+ * },
46
+ * "ConnectionDraining": {
47
+ * "Enabled": false,
48
+ * "Timeout": 300
49
+ * },
50
+ * "ConnectionSettings": {
51
+ * "IdleTimeout": 60
52
+ * },
53
+ * "CrossZoneLoadBalancing": {
54
+ * "Enabled": false
55
+ * }
56
+ * }
57
+ * }
58
+ * *\/
59
+ * // example id: elb-describe-load-balancer-attributes-1
60
+ * ```
61
+ *
32
62
  */
33
63
  export declare class DescribeLoadBalancerAttributesCommand extends $Command<DescribeLoadBalancerAttributesCommandInput, DescribeLoadBalancerAttributesCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
34
64
  readonly input: DescribeLoadBalancerAttributesCommandInput;
@@ -33,6 +33,36 @@ export interface DescribeLoadBalancerPoliciesCommandOutput extends DescribeLoadB
33
33
  * @see {@link DescribeLoadBalancerPoliciesCommandOutput} for command's `response` shape.
34
34
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
35
35
  *
36
+ * @example To describe a policy associated with a load balancer
37
+ * ```javascript
38
+ * // This example describes the specified policy associated with the specified load balancer.
39
+ * const input = {
40
+ * "LoadBalancerName": "my-load-balancer",
41
+ * "PolicyNames": [
42
+ * "my-authentication-policy"
43
+ * ]
44
+ * };
45
+ * const command = new DescribeLoadBalancerPoliciesCommand(input);
46
+ * const response = await client.send(command);
47
+ * /* response ==
48
+ * {
49
+ * "PolicyDescriptions": [
50
+ * {
51
+ * "PolicyAttributeDescriptions": [
52
+ * {
53
+ * "AttributeName": "PublicKeyPolicyName",
54
+ * "AttributeValue": "my-PublicKey-policy"
55
+ * }
56
+ * ],
57
+ * "PolicyName": "my-authentication-policy",
58
+ * "PolicyTypeName": "BackendServerAuthenticationPolicyType"
59
+ * }
60
+ * ]
61
+ * }
62
+ * *\/
63
+ * // example id: elb-describe-load-balancer-policies-1
64
+ * ```
65
+ *
36
66
  */
37
67
  export declare class DescribeLoadBalancerPoliciesCommand extends $Command<DescribeLoadBalancerPoliciesCommandInput, DescribeLoadBalancerPoliciesCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
38
68
  readonly input: DescribeLoadBalancerPoliciesCommandInput;
@@ -36,6 +36,36 @@ export interface DescribeLoadBalancerPolicyTypesCommandOutput extends DescribeLo
36
36
  * @see {@link DescribeLoadBalancerPolicyTypesCommandOutput} for command's `response` shape.
37
37
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
38
38
  *
39
+ * @example To describe a load balancer policy type defined by Elastic Load Balancing
40
+ * ```javascript
41
+ * // This example describes the specified load balancer policy type.
42
+ * const input = {
43
+ * "PolicyTypeNames": [
44
+ * "ProxyProtocolPolicyType"
45
+ * ]
46
+ * };
47
+ * const command = new DescribeLoadBalancerPolicyTypesCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "PolicyTypeDescriptions": [
52
+ * {
53
+ * "Description": "Policy that controls whether to include the IP address and port of the originating request for TCP messages. This policy operates on TCP listeners only.",
54
+ * "PolicyAttributeTypeDescriptions": [
55
+ * {
56
+ * "AttributeName": "ProxyProtocol",
57
+ * "AttributeType": "Boolean",
58
+ * "Cardinality": "ONE"
59
+ * }
60
+ * ],
61
+ * "PolicyTypeName": "ProxyProtocolPolicyType"
62
+ * }
63
+ * ]
64
+ * }
65
+ * *\/
66
+ * // example id: elb-describe-load-balancer-policy-types-1
67
+ * ```
68
+ *
39
69
  */
40
70
  export declare class DescribeLoadBalancerPolicyTypesCommand extends $Command<DescribeLoadBalancerPolicyTypesCommandInput, DescribeLoadBalancerPolicyTypesCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
41
71
  readonly input: DescribeLoadBalancerPolicyTypesCommandInput;
@@ -29,6 +29,109 @@ export interface DescribeLoadBalancersCommandOutput extends DescribeAccessPoints
29
29
  * @see {@link DescribeLoadBalancersCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
31
31
  *
32
+ * @example To describe one of your load balancers
33
+ * ```javascript
34
+ * // This example describes the specified load balancer.
35
+ * const input = {
36
+ * "LoadBalancerNames": [
37
+ * "my-load-balancer"
38
+ * ]
39
+ * };
40
+ * const command = new DescribeLoadBalancersCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "LoadBalancerDescriptions": [
45
+ * {
46
+ * "AvailabilityZones": [
47
+ * "us-west-2a"
48
+ * ],
49
+ * "BackendServerDescriptions": [
50
+ * {
51
+ * "InstancePort": 80,
52
+ * "PolicyNames": [
53
+ * "my-ProxyProtocol-policy"
54
+ * ]
55
+ * }
56
+ * ],
57
+ * "CanonicalHostedZoneName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com",
58
+ * "CanonicalHostedZoneNameID": "Z3DZXE0EXAMPLE",
59
+ * "CreatedTime": "2015-03-19T03:24:02.650Z",
60
+ * "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com",
61
+ * "HealthCheck": {
62
+ * "HealthyThreshold": 2,
63
+ * "Interval": 30,
64
+ * "Target": "HTTP:80/png",
65
+ * "Timeout": 3,
66
+ * "UnhealthyThreshold": 2
67
+ * },
68
+ * "Instances": [
69
+ * {
70
+ * "InstanceId": "i-207d9717"
71
+ * },
72
+ * {
73
+ * "InstanceId": "i-afefb49b"
74
+ * }
75
+ * ],
76
+ * "ListenerDescriptions": [
77
+ * {
78
+ * "Listener": {
79
+ * "InstancePort": 80,
80
+ * "InstanceProtocol": "HTTP",
81
+ * "LoadBalancerPort": 80,
82
+ * "Protocol": "HTTP"
83
+ * },
84
+ * "PolicyNames": []
85
+ * },
86
+ * {
87
+ * "Listener": {
88
+ * "InstancePort": 443,
89
+ * "InstanceProtocol": "HTTPS",
90
+ * "LoadBalancerPort": 443,
91
+ * "Protocol": "HTTPS",
92
+ * "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert"
93
+ * },
94
+ * "PolicyNames": [
95
+ * "ELBSecurityPolicy-2015-03"
96
+ * ]
97
+ * }
98
+ * ],
99
+ * "LoadBalancerName": "my-load-balancer",
100
+ * "Policies": {
101
+ * "AppCookieStickinessPolicies": [],
102
+ * "LBCookieStickinessPolicies": [
103
+ * {
104
+ * "CookieExpirationPeriod": 60,
105
+ * "PolicyName": "my-duration-cookie-policy"
106
+ * }
107
+ * ],
108
+ * "OtherPolicies": [
109
+ * "my-PublicKey-policy",
110
+ * "my-authentication-policy",
111
+ * "my-SSLNegotiation-policy",
112
+ * "my-ProxyProtocol-policy",
113
+ * "ELBSecurityPolicy-2015-03"
114
+ * ]
115
+ * },
116
+ * "Scheme": "internet-facing",
117
+ * "SecurityGroups": [
118
+ * "sg-a61988c3"
119
+ * ],
120
+ * "SourceSecurityGroup": {
121
+ * "GroupName": "my-elb-sg",
122
+ * "OwnerAlias": "123456789012"
123
+ * },
124
+ * "Subnets": [
125
+ * "subnet-15aaab61"
126
+ * ],
127
+ * "VPCId": "vpc-a01106c2"
128
+ * }
129
+ * ]
130
+ * }
131
+ * *\/
132
+ * // example id: elb-describe-load-balancers-1
133
+ * ```
134
+ *
32
135
  */
33
136
  export declare class DescribeLoadBalancersCommand extends $Command<DescribeLoadBalancersCommandInput, DescribeLoadBalancersCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
34
137
  readonly input: DescribeLoadBalancersCommandInput;
@@ -29,6 +29,38 @@ export interface DescribeTagsCommandOutput extends DescribeTagsOutput, __Metadat
29
29
  * @see {@link DescribeTagsCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
31
31
  *
32
+ * @example To describe the tags for a load balancer
33
+ * ```javascript
34
+ * // This example describes the tags for the specified load balancer.
35
+ * const input = {
36
+ * "LoadBalancerNames": [
37
+ * "my-load-balancer"
38
+ * ]
39
+ * };
40
+ * const command = new DescribeTagsCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "TagDescriptions": [
45
+ * {
46
+ * "LoadBalancerName": "my-load-balancer",
47
+ * "Tags": [
48
+ * {
49
+ * "Key": "project",
50
+ * "Value": "lima"
51
+ * },
52
+ * {
53
+ * "Key": "department",
54
+ * "Value": "digital-media"
55
+ * }
56
+ * ]
57
+ * }
58
+ * ]
59
+ * }
60
+ * *\/
61
+ * // example id: elb-describe-tags-1
62
+ * ```
63
+ *
32
64
  */
33
65
  export declare class DescribeTagsCommand extends $Command<DescribeTagsCommandInput, DescribeTagsCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
34
66
  readonly input: DescribeTagsCommandInput;
@@ -32,6 +32,27 @@ export interface DetachLoadBalancerFromSubnetsCommandOutput extends DetachLoadBa
32
32
  * @see {@link DetachLoadBalancerFromSubnetsCommandOutput} for command's `response` shape.
33
33
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
34
34
  *
35
+ * @example To detach a load balancer from a subnet
36
+ * ```javascript
37
+ * // This example detaches the specified load balancer from the specified subnet.
38
+ * const input = {
39
+ * "LoadBalancerName": "my-load-balancer",
40
+ * "Subnets": [
41
+ * "subnet-0ecac448"
42
+ * ]
43
+ * };
44
+ * const command = new DetachLoadBalancerFromSubnetsCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "Subnets": [
49
+ * "subnet-15aaab61"
50
+ * ]
51
+ * }
52
+ * *\/
53
+ * // example id: elb-detach-load-balancer-from-subnets-1
54
+ * ```
55
+ *
35
56
  */
36
57
  export declare class DetachLoadBalancerFromSubnetsCommand extends $Command<DetachLoadBalancerFromSubnetsCommandInput, DetachLoadBalancerFromSubnetsCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
37
58
  readonly input: DetachLoadBalancerFromSubnetsCommandInput;
@@ -37,6 +37,27 @@ export interface DisableAvailabilityZonesForLoadBalancerCommandOutput extends Re
37
37
  * @see {@link DisableAvailabilityZonesForLoadBalancerCommandOutput} for command's `response` shape.
38
38
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
39
39
  *
40
+ * @example To disable an Availability Zone for a load balancer
41
+ * ```javascript
42
+ * // This example removes the specified Availability Zone from the set of Availability Zones for the specified load balancer.
43
+ * const input = {
44
+ * "AvailabilityZones": [
45
+ * "us-west-2a"
46
+ * ],
47
+ * "LoadBalancerName": "my-load-balancer"
48
+ * };
49
+ * const command = new DisableAvailabilityZonesForLoadBalancerCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "AvailabilityZones": [
54
+ * "us-west-2b"
55
+ * ]
56
+ * }
57
+ * *\/
58
+ * // example id: elb-disable-availability-zones-for-load-balancer-1
59
+ * ```
60
+ *
40
61
  */
41
62
  export declare class DisableAvailabilityZonesForLoadBalancerCommand extends $Command<DisableAvailabilityZonesForLoadBalancerCommandInput, DisableAvailabilityZonesForLoadBalancerCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
42
63
  readonly input: DisableAvailabilityZonesForLoadBalancerCommandInput;
@@ -34,6 +34,28 @@ export interface EnableAvailabilityZonesForLoadBalancerCommandOutput extends Add
34
34
  * @see {@link EnableAvailabilityZonesForLoadBalancerCommandOutput} for command's `response` shape.
35
35
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
36
36
  *
37
+ * @example To enable an Availability Zone for a load balancer
38
+ * ```javascript
39
+ * // This example adds the specified Availability Zone to the specified load balancer.
40
+ * const input = {
41
+ * "AvailabilityZones": [
42
+ * "us-west-2b"
43
+ * ],
44
+ * "LoadBalancerName": "my-load-balancer"
45
+ * };
46
+ * const command = new EnableAvailabilityZonesForLoadBalancerCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "AvailabilityZones": [
51
+ * "us-west-2a",
52
+ * "us-west-2b"
53
+ * ]
54
+ * }
55
+ * *\/
56
+ * // example id: elb-enable-availability-zones-for-load-balancer-1
57
+ * ```
58
+ *
37
59
  */
38
60
  export declare class EnableAvailabilityZonesForLoadBalancerCommand extends $Command<EnableAvailabilityZonesForLoadBalancerCommandInput, EnableAvailabilityZonesForLoadBalancerCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
39
61
  readonly input: EnableAvailabilityZonesForLoadBalancerCommandInput;
@@ -55,6 +55,60 @@ export interface ModifyLoadBalancerAttributesCommandOutput extends ModifyLoadBal
55
55
  * @see {@link ModifyLoadBalancerAttributesCommandOutput} for command's `response` shape.
56
56
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
57
57
  *
58
+ * @example To enable cross-zone load balancing
59
+ * ```javascript
60
+ * // This example enables cross-zone load balancing for the specified load balancer.
61
+ * const input = {
62
+ * "LoadBalancerAttributes": {
63
+ * "CrossZoneLoadBalancing": {
64
+ * "Enabled": true
65
+ * }
66
+ * },
67
+ * "LoadBalancerName": "my-load-balancer"
68
+ * };
69
+ * const command = new ModifyLoadBalancerAttributesCommand(input);
70
+ * const response = await client.send(command);
71
+ * /* response ==
72
+ * {
73
+ * "LoadBalancerAttributes": {
74
+ * "CrossZoneLoadBalancing": {
75
+ * "Enabled": true
76
+ * }
77
+ * },
78
+ * "LoadBalancerName": "my-load-balancer"
79
+ * }
80
+ * *\/
81
+ * // example id: elb-modify-load-balancer-attributes-1
82
+ * ```
83
+ *
84
+ * @example To enable connection draining
85
+ * ```javascript
86
+ * // This example enables connection draining for the specified load balancer.
87
+ * const input = {
88
+ * "LoadBalancerAttributes": {
89
+ * "ConnectionDraining": {
90
+ * "Enabled": true,
91
+ * "Timeout": 300
92
+ * }
93
+ * },
94
+ * "LoadBalancerName": "my-load-balancer"
95
+ * };
96
+ * const command = new ModifyLoadBalancerAttributesCommand(input);
97
+ * const response = await client.send(command);
98
+ * /* response ==
99
+ * {
100
+ * "LoadBalancerAttributes": {
101
+ * "ConnectionDraining": {
102
+ * "Enabled": true,
103
+ * "Timeout": 300
104
+ * }
105
+ * },
106
+ * "LoadBalancerName": "my-load-balancer"
107
+ * }
108
+ * *\/
109
+ * // example id: elb-modify-load-balancer-attributes-2
110
+ * ```
111
+ *
58
112
  */
59
113
  export declare class ModifyLoadBalancerAttributesCommand extends $Command<ModifyLoadBalancerAttributesCommandInput, ModifyLoadBalancerAttributesCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
60
114
  readonly input: ModifyLoadBalancerAttributesCommandInput;
@@ -47,6 +47,37 @@ export interface RegisterInstancesWithLoadBalancerCommandOutput extends Register
47
47
  * @see {@link RegisterInstancesWithLoadBalancerCommandOutput} for command's `response` shape.
48
48
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
49
49
  *
50
+ * @example To register instances with a load balancer
51
+ * ```javascript
52
+ * // This example registers the specified instance with the specified load balancer.
53
+ * const input = {
54
+ * "Instances": [
55
+ * {
56
+ * "InstanceId": "i-d6f6fae3"
57
+ * }
58
+ * ],
59
+ * "LoadBalancerName": "my-load-balancer"
60
+ * };
61
+ * const command = new RegisterInstancesWithLoadBalancerCommand(input);
62
+ * const response = await client.send(command);
63
+ * /* response ==
64
+ * {
65
+ * "Instances": [
66
+ * {
67
+ * "InstanceId": "i-d6f6fae3"
68
+ * },
69
+ * {
70
+ * "InstanceId": "i-207d9717"
71
+ * },
72
+ * {
73
+ * "InstanceId": "i-afefb49b"
74
+ * }
75
+ * ]
76
+ * }
77
+ * *\/
78
+ * // example id: elb-register-instances-with-load-balancer-1
79
+ * ```
80
+ *
50
81
  */
51
82
  export declare class RegisterInstancesWithLoadBalancerCommand extends $Command<RegisterInstancesWithLoadBalancerCommandInput, RegisterInstancesWithLoadBalancerCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
52
83
  readonly input: RegisterInstancesWithLoadBalancerCommandInput;
@@ -29,6 +29,24 @@ export interface RemoveTagsCommandOutput extends RemoveTagsOutput, __MetadataBea
29
29
  * @see {@link RemoveTagsCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
31
31
  *
32
+ * @example To remove tags from a load balancer
33
+ * ```javascript
34
+ * // This example removes the specified tag from the specified load balancer.
35
+ * const input = {
36
+ * "LoadBalancerNames": [
37
+ * "my-load-balancer"
38
+ * ],
39
+ * "Tags": [
40
+ * {
41
+ * "Key": "project"
42
+ * }
43
+ * ]
44
+ * };
45
+ * const command = new RemoveTagsCommand(input);
46
+ * await client.send(command);
47
+ * // example id: elb-remove-tags-1
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class RemoveTagsCommand extends $Command<RemoveTagsCommandInput, RemoveTagsCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
34
52
  readonly input: RemoveTagsCommandInput;
@@ -33,6 +33,19 @@ export interface SetLoadBalancerListenerSSLCertificateCommandOutput extends SetL
33
33
  * @see {@link SetLoadBalancerListenerSSLCertificateCommandOutput} for command's `response` shape.
34
34
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
35
35
  *
36
+ * @example To update the SSL certificate for an HTTPS listener
37
+ * ```javascript
38
+ * // This example replaces the existing SSL certificate for the specified HTTPS listener.
39
+ * const input = {
40
+ * "LoadBalancerName": "my-load-balancer",
41
+ * "LoadBalancerPort": 443,
42
+ * "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/new-server-cert"
43
+ * };
44
+ * const command = new SetLoadBalancerListenerSSLCertificateCommand(input);
45
+ * await client.send(command);
46
+ * // example id: elb-set-load-balancer-listener-ssl-certificate-1
47
+ * ```
48
+ *
36
49
  */
37
50
  export declare class SetLoadBalancerListenerSSLCertificateCommand extends $Command<SetLoadBalancerListenerSSLCertificateCommandInput, SetLoadBalancerListenerSSLCertificateCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
38
51
  readonly input: SetLoadBalancerListenerSSLCertificateCommandInput;
@@ -39,6 +39,21 @@ export interface SetLoadBalancerPoliciesForBackendServerCommandOutput extends Se
39
39
  * @see {@link SetLoadBalancerPoliciesForBackendServerCommandOutput} for command's `response` shape.
40
40
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
41
41
  *
42
+ * @example To replace the policies associated with a port for a backend instance
43
+ * ```javascript
44
+ * // This example replaces the policies that are currently associated with the specified port.
45
+ * const input = {
46
+ * "InstancePort": 80,
47
+ * "LoadBalancerName": "my-load-balancer",
48
+ * "PolicyNames": [
49
+ * "my-ProxyProtocol-policy"
50
+ * ]
51
+ * };
52
+ * const command = new SetLoadBalancerPoliciesForBackendServerCommand(input);
53
+ * await client.send(command);
54
+ * // example id: elb-set-load-balancer-policies-for-backend-server-1
55
+ * ```
56
+ *
42
57
  */
43
58
  export declare class SetLoadBalancerPoliciesForBackendServerCommand extends $Command<SetLoadBalancerPoliciesForBackendServerCommandInput, SetLoadBalancerPoliciesForBackendServerCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
44
59
  readonly input: SetLoadBalancerPoliciesForBackendServerCommandInput;
@@ -35,6 +35,21 @@ export interface SetLoadBalancerPoliciesOfListenerCommandOutput extends SetLoadB
35
35
  * @see {@link SetLoadBalancerPoliciesOfListenerCommandOutput} for command's `response` shape.
36
36
  * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for ElasticLoadBalancingClient's `config` shape.
37
37
  *
38
+ * @example To replace the policies associated with a listener
39
+ * ```javascript
40
+ * // This example replaces the policies that are currently associated with the specified listener.
41
+ * const input = {
42
+ * "LoadBalancerName": "my-load-balancer",
43
+ * "LoadBalancerPort": 80,
44
+ * "PolicyNames": [
45
+ * "my-SSLNegotiation-policy"
46
+ * ]
47
+ * };
48
+ * const command = new SetLoadBalancerPoliciesOfListenerCommand(input);
49
+ * await client.send(command);
50
+ * // example id: elb-set-load-balancer-policies-of-listener-1
51
+ * ```
52
+ *
38
53
  */
39
54
  export declare class SetLoadBalancerPoliciesOfListenerCommand extends $Command<SetLoadBalancerPoliciesOfListenerCommandInput, SetLoadBalancerPoliciesOfListenerCommandOutput, ElasticLoadBalancingClientResolvedConfig> {
40
55
  readonly input: SetLoadBalancerPoliciesOfListenerCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-elastic-load-balancing",
3
3
  "description": "AWS SDK for JavaScript Elastic Load Balancing Client for Node.js, Browser and React Native",
4
- "version": "3.288.0",
4
+ "version": "3.289.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,39 +20,39 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.288.0",
24
- "@aws-sdk/config-resolver": "3.287.0",
25
- "@aws-sdk/credential-provider-node": "3.288.0",
26
- "@aws-sdk/fetch-http-handler": "3.282.0",
27
- "@aws-sdk/hash-node": "3.272.0",
28
- "@aws-sdk/invalid-dependency": "3.272.0",
29
- "@aws-sdk/middleware-content-length": "3.282.0",
30
- "@aws-sdk/middleware-endpoint": "3.282.0",
31
- "@aws-sdk/middleware-host-header": "3.282.0",
32
- "@aws-sdk/middleware-logger": "3.288.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
- "@aws-sdk/middleware-retry": "3.287.0",
35
- "@aws-sdk/middleware-serde": "3.272.0",
36
- "@aws-sdk/middleware-signing": "3.282.0",
37
- "@aws-sdk/middleware-stack": "3.272.0",
38
- "@aws-sdk/middleware-user-agent": "3.282.0",
39
- "@aws-sdk/node-config-provider": "3.287.0",
40
- "@aws-sdk/node-http-handler": "3.282.0",
41
- "@aws-sdk/protocol-http": "3.282.0",
42
- "@aws-sdk/smithy-client": "3.279.0",
43
- "@aws-sdk/types": "3.272.0",
44
- "@aws-sdk/url-parser": "3.272.0",
23
+ "@aws-sdk/client-sts": "3.289.0",
24
+ "@aws-sdk/config-resolver": "3.289.0",
25
+ "@aws-sdk/credential-provider-node": "3.289.0",
26
+ "@aws-sdk/fetch-http-handler": "3.289.0",
27
+ "@aws-sdk/hash-node": "3.289.0",
28
+ "@aws-sdk/invalid-dependency": "3.289.0",
29
+ "@aws-sdk/middleware-content-length": "3.289.0",
30
+ "@aws-sdk/middleware-endpoint": "3.289.0",
31
+ "@aws-sdk/middleware-host-header": "3.289.0",
32
+ "@aws-sdk/middleware-logger": "3.289.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.289.0",
34
+ "@aws-sdk/middleware-retry": "3.289.0",
35
+ "@aws-sdk/middleware-serde": "3.289.0",
36
+ "@aws-sdk/middleware-signing": "3.289.0",
37
+ "@aws-sdk/middleware-stack": "3.289.0",
38
+ "@aws-sdk/middleware-user-agent": "3.289.0",
39
+ "@aws-sdk/node-config-provider": "3.289.0",
40
+ "@aws-sdk/node-http-handler": "3.289.0",
41
+ "@aws-sdk/protocol-http": "3.289.0",
42
+ "@aws-sdk/smithy-client": "3.289.0",
43
+ "@aws-sdk/types": "3.289.0",
44
+ "@aws-sdk/url-parser": "3.289.0",
45
45
  "@aws-sdk/util-base64": "3.208.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.188.0",
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.279.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.287.0",
50
- "@aws-sdk/util-endpoints": "3.272.0",
51
- "@aws-sdk/util-retry": "3.272.0",
52
- "@aws-sdk/util-user-agent-browser": "3.282.0",
53
- "@aws-sdk/util-user-agent-node": "3.287.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.289.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.289.0",
50
+ "@aws-sdk/util-endpoints": "3.289.0",
51
+ "@aws-sdk/util-retry": "3.289.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.289.0",
53
+ "@aws-sdk/util-user-agent-node": "3.289.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
- "@aws-sdk/util-waiter": "3.272.0",
55
+ "@aws-sdk/util-waiter": "3.289.0",
56
56
  "fast-xml-parser": "4.1.2",
57
57
  "tslib": "^2.3.1"
58
58
  },