@aws-sdk/client-elastic-load-balancing-v2 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 (30) hide show
  1. package/dist-types/commands/AddTagsCommand.d.ts +23 -0
  2. package/dist-types/commands/CreateListenerCommand.d.ts +86 -0
  3. package/dist-types/commands/CreateLoadBalancerCommand.d.ts +96 -0
  4. package/dist-types/commands/CreateRuleCommand.d.ts +51 -0
  5. package/dist-types/commands/CreateTargetGroupCommand.d.ts +37 -0
  6. package/dist-types/commands/DeleteListenerCommand.d.ts +11 -0
  7. package/dist-types/commands/DeleteLoadBalancerCommand.d.ts +11 -0
  8. package/dist-types/commands/DeleteRuleCommand.d.ts +11 -0
  9. package/dist-types/commands/DeleteTargetGroupCommand.d.ts +11 -0
  10. package/dist-types/commands/DeregisterTargetsCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeListenersCommand.d.ts +31 -0
  12. package/dist-types/commands/DescribeLoadBalancerAttributesCommand.d.ts +37 -0
  13. package/dist-types/commands/DescribeLoadBalancersCommand.d.ts +45 -0
  14. package/dist-types/commands/DescribeRulesCommand.d.ts +38 -0
  15. package/dist-types/commands/DescribeSSLPoliciesCommand.d.ts +105 -0
  16. package/dist-types/commands/DescribeTagsCommand.d.ts +32 -0
  17. package/dist-types/commands/DescribeTargetGroupAttributesCommand.d.ts +33 -0
  18. package/dist-types/commands/DescribeTargetGroupsCommand.d.ts +39 -0
  19. package/dist-types/commands/DescribeTargetHealthCommand.d.ts +71 -0
  20. package/dist-types/commands/ModifyListenerCommand.d.ts +75 -0
  21. package/dist-types/commands/ModifyLoadBalancerAttributesCommand.d.ts +137 -0
  22. package/dist-types/commands/ModifyRuleCommand.d.ts +44 -0
  23. package/dist-types/commands/ModifyTargetGroupAttributesCommand.d.ts +39 -0
  24. package/dist-types/commands/ModifyTargetGroupCommand.d.ts +38 -0
  25. package/dist-types/commands/RegisterTargetsCommand.d.ts +40 -0
  26. package/dist-types/commands/RemoveTagsCommand.d.ts +17 -0
  27. package/dist-types/commands/SetRulePrioritiesCommand.d.ts +41 -0
  28. package/dist-types/commands/SetSecurityGroupsCommand.d.ts +21 -0
  29. package/dist-types/commands/SetSubnetsCommand.d.ts +29 -0
  30. package/package.json +30 -30
@@ -38,6 +38,46 @@ export interface RegisterTargetsCommandOutput extends RegisterTargetsOutput, __M
38
38
  * @see {@link RegisterTargetsCommandOutput} for command's `response` shape.
39
39
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
40
40
  *
41
+ * @example To register targets with a target group
42
+ * ```javascript
43
+ * // This example registers the specified instances with the specified target group.
44
+ * const input = {
45
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
46
+ * "Targets": [
47
+ * {
48
+ * "Id": "i-80c8dd94"
49
+ * },
50
+ * {
51
+ * "Id": "i-ceddcd4d"
52
+ * }
53
+ * ]
54
+ * };
55
+ * const command = new RegisterTargetsCommand(input);
56
+ * await client.send(command);
57
+ * // example id: elbv2-register-targets-1
58
+ * ```
59
+ *
60
+ * @example To register targets with a target group using port overrides
61
+ * ```javascript
62
+ * // This example registers the specified instance with the specified target group using multiple ports. This enables you to register ECS containers on the same instance as targets in the target group.
63
+ * const input = {
64
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9",
65
+ * "Targets": [
66
+ * {
67
+ * "Id": "i-80c8dd94",
68
+ * "Port": 80
69
+ * },
70
+ * {
71
+ * "Id": "i-80c8dd94",
72
+ * "Port": 766
73
+ * }
74
+ * ]
75
+ * };
76
+ * const command = new RegisterTargetsCommand(input);
77
+ * await client.send(command);
78
+ * // example id: elbv2-register-targets-2
79
+ * ```
80
+ *
41
81
  */
42
82
  export declare class RegisterTargetsCommand extends $Command<RegisterTargetsCommandInput, RegisterTargetsCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
43
83
  readonly input: RegisterTargetsCommandInput;
@@ -31,6 +31,23 @@ export interface RemoveTagsCommandOutput extends RemoveTagsOutput, __MetadataBea
31
31
  * @see {@link RemoveTagsCommandOutput} for command's `response` shape.
32
32
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
33
33
  *
34
+ * @example To remove tags from a load balancer
35
+ * ```javascript
36
+ * // This example removes the specified tags from the specified load balancer.
37
+ * const input = {
38
+ * "ResourceArns": [
39
+ * "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
40
+ * ],
41
+ * "TagKeys": [
42
+ * "project",
43
+ * "department"
44
+ * ]
45
+ * };
46
+ * const command = new RemoveTagsCommand(input);
47
+ * await client.send(command);
48
+ * // example id: elbv2-remove-tags-1
49
+ * ```
50
+ *
34
51
  */
35
52
  export declare class RemoveTagsCommand extends $Command<RemoveTagsCommandInput, RemoveTagsCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
36
53
  readonly input: RemoveTagsCommandInput;
@@ -31,6 +31,47 @@ export interface SetRulePrioritiesCommandOutput extends SetRulePrioritiesOutput,
31
31
  * @see {@link SetRulePrioritiesCommandOutput} for command's `response` shape.
32
32
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
33
33
  *
34
+ * @example To set the rule priority
35
+ * ```javascript
36
+ * // This example sets the priority of the specified rule.
37
+ * const input = {
38
+ * "RulePriorities": [
39
+ * {
40
+ * "Priority": 5,
41
+ * "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3"
42
+ * }
43
+ * ]
44
+ * };
45
+ * const command = new SetRulePrioritiesCommand(input);
46
+ * const response = await client.send(command);
47
+ * /* response ==
48
+ * {
49
+ * "Rules": [
50
+ * {
51
+ * "Actions": [
52
+ * {
53
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
54
+ * "Type": "forward"
55
+ * }
56
+ * ],
57
+ * "Conditions": [
58
+ * {
59
+ * "Field": "path-pattern",
60
+ * "Values": [
61
+ * "/img/*"
62
+ * ]
63
+ * }
64
+ * ],
65
+ * "IsDefault": false,
66
+ * "Priority": "5",
67
+ * "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3"
68
+ * }
69
+ * ]
70
+ * }
71
+ * *\/
72
+ * // example id: elbv2-set-rule-priorities-1
73
+ * ```
74
+ *
34
75
  */
35
76
  export declare class SetRulePrioritiesCommand extends $Command<SetRulePrioritiesCommandInput, SetRulePrioritiesCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
36
77
  readonly input: SetRulePrioritiesCommandInput;
@@ -32,6 +32,27 @@ export interface SetSecurityGroupsCommandOutput extends SetSecurityGroupsOutput,
32
32
  * @see {@link SetSecurityGroupsCommandOutput} for command's `response` shape.
33
33
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
34
34
  *
35
+ * @example To associate a security group with a load balancer
36
+ * ```javascript
37
+ * // This example associates the specified security group with the specified load balancer.
38
+ * const input = {
39
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
40
+ * "SecurityGroups": [
41
+ * "sg-5943793c"
42
+ * ]
43
+ * };
44
+ * const command = new SetSecurityGroupsCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "SecurityGroupIds": [
49
+ * "sg-5943793c"
50
+ * ]
51
+ * }
52
+ * *\/
53
+ * // example id: elbv2-set-security-groups-1
54
+ * ```
55
+ *
35
56
  */
36
57
  export declare class SetSecurityGroupsCommand extends $Command<SetSecurityGroupsCommandInput, SetSecurityGroupsCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
37
58
  readonly input: SetSecurityGroupsCommandInput;
@@ -34,6 +34,35 @@ export interface SetSubnetsCommandOutput extends SetSubnetsOutput, __MetadataBea
34
34
  * @see {@link SetSubnetsCommandOutput} for command's `response` shape.
35
35
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
36
36
  *
37
+ * @example To enable Availability Zones for a load balancer
38
+ * ```javascript
39
+ * // This example enables the Availability Zones for the specified subnets for the specified load balancer.
40
+ * const input = {
41
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
42
+ * "Subnets": [
43
+ * "subnet-8360a9e7",
44
+ * "subnet-b7d581c0"
45
+ * ]
46
+ * };
47
+ * const command = new SetSubnetsCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "AvailabilityZones": [
52
+ * {
53
+ * "SubnetId": "subnet-8360a9e7",
54
+ * "ZoneName": "us-west-2a"
55
+ * },
56
+ * {
57
+ * "SubnetId": "subnet-b7d581c0",
58
+ * "ZoneName": "us-west-2b"
59
+ * }
60
+ * ]
61
+ * }
62
+ * *\/
63
+ * // example id: elbv2-set-subnets-1
64
+ * ```
65
+ *
37
66
  */
38
67
  export declare class SetSubnetsCommand extends $Command<SetSubnetsCommandInput, SetSubnetsCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
39
68
  readonly input: SetSubnetsCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-elastic-load-balancing-v2",
3
3
  "description": "AWS SDK for JavaScript Elastic Load Balancing V2 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
  },