@aws-sdk/client-elastic-load-balancing-v2 3.287.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
@@ -33,6 +33,29 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
33
33
  * @see {@link AddTagsCommandOutput} for command's `response` shape.
34
34
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
35
35
  *
36
+ * @example To add tags to a load balancer
37
+ * ```javascript
38
+ * // This example adds the specified tags to the specified load balancer.
39
+ * const input = {
40
+ * "ResourceArns": [
41
+ * "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
42
+ * ],
43
+ * "Tags": [
44
+ * {
45
+ * "Key": "project",
46
+ * "Value": "lima"
47
+ * },
48
+ * {
49
+ * "Key": "department",
50
+ * "Value": "digital-media"
51
+ * }
52
+ * ]
53
+ * };
54
+ * const command = new AddTagsCommand(input);
55
+ * await client.send(command);
56
+ * // example id: elbv2-add-tags-1
57
+ * ```
58
+ *
36
59
  */
37
60
  export declare class AddTagsCommand extends $Command<AddTagsCommandInput, AddTagsCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
38
61
  readonly input: AddTagsCommandInput;
@@ -53,6 +53,92 @@ export interface CreateListenerCommandOutput extends CreateListenerOutput, __Met
53
53
  * @see {@link CreateListenerCommandOutput} for command's `response` shape.
54
54
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
55
55
  *
56
+ * @example To create an HTTP listener
57
+ * ```javascript
58
+ * // This example creates an HTTP listener for the specified load balancer that forwards requests to the specified target group.
59
+ * const input = {
60
+ * "DefaultActions": [
61
+ * {
62
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
63
+ * "Type": "forward"
64
+ * }
65
+ * ],
66
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
67
+ * "Port": 80,
68
+ * "Protocol": "HTTP"
69
+ * };
70
+ * const command = new CreateListenerCommand(input);
71
+ * const response = await client.send(command);
72
+ * /* response ==
73
+ * {
74
+ * "Listeners": [
75
+ * {
76
+ * "DefaultActions": [
77
+ * {
78
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
79
+ * "Type": "forward"
80
+ * }
81
+ * ],
82
+ * "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2",
83
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
84
+ * "Port": 80,
85
+ * "Protocol": "HTTP"
86
+ * }
87
+ * ]
88
+ * }
89
+ * *\/
90
+ * // example id: elbv2-create-listener-1
91
+ * ```
92
+ *
93
+ * @example To create an HTTPS listener
94
+ * ```javascript
95
+ * // This example creates an HTTPS listener for the specified load balancer that forwards requests to the specified target group. Note that you must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM).
96
+ * const input = {
97
+ * "Certificates": [
98
+ * {
99
+ * "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert"
100
+ * }
101
+ * ],
102
+ * "DefaultActions": [
103
+ * {
104
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
105
+ * "Type": "forward"
106
+ * }
107
+ * ],
108
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
109
+ * "Port": 443,
110
+ * "Protocol": "HTTPS",
111
+ * "SslPolicy": "ELBSecurityPolicy-2015-05"
112
+ * };
113
+ * const command = new CreateListenerCommand(input);
114
+ * const response = await client.send(command);
115
+ * /* response ==
116
+ * {
117
+ * "Listeners": [
118
+ * {
119
+ * "Certificates": [
120
+ * {
121
+ * "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert"
122
+ * }
123
+ * ],
124
+ * "DefaultActions": [
125
+ * {
126
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
127
+ * "Type": "forward"
128
+ * }
129
+ * ],
130
+ * "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2",
131
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
132
+ * "Port": 443,
133
+ * "Protocol": "HTTPS",
134
+ * "SslPolicy": "ELBSecurityPolicy-2015-05"
135
+ * }
136
+ * ]
137
+ * }
138
+ * *\/
139
+ * // example id: elbv2-create-listener-2
140
+ * ```
141
+ *
56
142
  */
57
143
  export declare class CreateListenerCommand extends $Command<CreateListenerCommandInput, CreateListenerCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
58
144
  readonly input: CreateListenerCommandInput;
@@ -52,6 +52,102 @@ export interface CreateLoadBalancerCommandOutput extends CreateLoadBalancerOutpu
52
52
  * @see {@link CreateLoadBalancerCommandOutput} for command's `response` shape.
53
53
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
54
54
  *
55
+ * @example To create an Internet-facing load balancer
56
+ * ```javascript
57
+ * // This example creates an Internet-facing load balancer and enables the Availability Zones for the specified subnets.
58
+ * const input = {
59
+ * "Name": "my-load-balancer",
60
+ * "Subnets": [
61
+ * "subnet-b7d581c0",
62
+ * "subnet-8360a9e7"
63
+ * ]
64
+ * };
65
+ * const command = new CreateLoadBalancerCommand(input);
66
+ * const response = await client.send(command);
67
+ * /* response ==
68
+ * {
69
+ * "LoadBalancers": [
70
+ * {
71
+ * "AvailabilityZones": [
72
+ * {
73
+ * "SubnetId": "subnet-8360a9e7",
74
+ * "ZoneName": "us-west-2a"
75
+ * },
76
+ * {
77
+ * "SubnetId": "subnet-b7d581c0",
78
+ * "ZoneName": "us-west-2b"
79
+ * }
80
+ * ],
81
+ * "CanonicalHostedZoneId": "Z2P70J7EXAMPLE",
82
+ * "CreatedTime": "2016-03-25T21:26:12.920Z",
83
+ * "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com",
84
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
85
+ * "LoadBalancerName": "my-load-balancer",
86
+ * "Scheme": "internet-facing",
87
+ * "SecurityGroups": [
88
+ * "sg-5943793c"
89
+ * ],
90
+ * "State": {
91
+ * "Code": "provisioning"
92
+ * },
93
+ * "Type": "application",
94
+ * "VpcId": "vpc-3ac0fb5f"
95
+ * }
96
+ * ]
97
+ * }
98
+ * *\/
99
+ * // example id: elbv2-create-load-balancer-1
100
+ * ```
101
+ *
102
+ * @example To create an internal load balancer
103
+ * ```javascript
104
+ * // This example creates an internal load balancer and enables the Availability Zones for the specified subnets.
105
+ * const input = {
106
+ * "Name": "my-internal-load-balancer",
107
+ * "Scheme": "internal",
108
+ * "SecurityGroups": [],
109
+ * "Subnets": [
110
+ * "subnet-b7d581c0",
111
+ * "subnet-8360a9e7"
112
+ * ]
113
+ * };
114
+ * const command = new CreateLoadBalancerCommand(input);
115
+ * const response = await client.send(command);
116
+ * /* response ==
117
+ * {
118
+ * "LoadBalancers": [
119
+ * {
120
+ * "AvailabilityZones": [
121
+ * {
122
+ * "SubnetId": "subnet-8360a9e7",
123
+ * "ZoneName": "us-west-2a"
124
+ * },
125
+ * {
126
+ * "SubnetId": "subnet-b7d581c0",
127
+ * "ZoneName": "us-west-2b"
128
+ * }
129
+ * ],
130
+ * "CanonicalHostedZoneId": "Z2P70J7EXAMPLE",
131
+ * "CreatedTime": "2016-03-25T21:29:48.850Z",
132
+ * "DNSName": "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com",
133
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2",
134
+ * "LoadBalancerName": "my-internal-load-balancer",
135
+ * "Scheme": "internal",
136
+ * "SecurityGroups": [
137
+ * "sg-5943793c"
138
+ * ],
139
+ * "State": {
140
+ * "Code": "provisioning"
141
+ * },
142
+ * "Type": "application",
143
+ * "VpcId": "vpc-3ac0fb5f"
144
+ * }
145
+ * ]
146
+ * }
147
+ * *\/
148
+ * // example id: elbv2-create-load-balancer-2
149
+ * ```
150
+ *
55
151
  */
56
152
  export declare class CreateLoadBalancerCommand extends $Command<CreateLoadBalancerCommandInput, CreateLoadBalancerCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
57
153
  readonly input: CreateLoadBalancerCommandInput;
@@ -34,6 +34,57 @@ export interface CreateRuleCommandOutput extends CreateRuleOutput, __MetadataBea
34
34
  * @see {@link CreateRuleCommandOutput} for command's `response` shape.
35
35
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
36
36
  *
37
+ * @example To create a rule
38
+ * ```javascript
39
+ * // This example creates a rule that forwards requests to the specified target group if the URL contains the specified pattern (for example, /img/*).
40
+ * const input = {
41
+ * "Actions": [
42
+ * {
43
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
44
+ * "Type": "forward"
45
+ * }
46
+ * ],
47
+ * "Conditions": [
48
+ * {
49
+ * "Field": "path-pattern",
50
+ * "Values": [
51
+ * "/img/*"
52
+ * ]
53
+ * }
54
+ * ],
55
+ * "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2",
56
+ * "Priority": 10
57
+ * };
58
+ * const command = new CreateRuleCommand(input);
59
+ * const response = await client.send(command);
60
+ * /* response ==
61
+ * {
62
+ * "Rules": [
63
+ * {
64
+ * "Actions": [
65
+ * {
66
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
67
+ * "Type": "forward"
68
+ * }
69
+ * ],
70
+ * "Conditions": [
71
+ * {
72
+ * "Field": "path-pattern",
73
+ * "Values": [
74
+ * "/img/*"
75
+ * ]
76
+ * }
77
+ * ],
78
+ * "IsDefault": false,
79
+ * "Priority": "10",
80
+ * "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee"
81
+ * }
82
+ * ]
83
+ * }
84
+ * *\/
85
+ * // example id: elbv2-create-rule-1
86
+ * ```
87
+ *
37
88
  */
38
89
  export declare class CreateRuleCommand extends $Command<CreateRuleCommandInput, CreateRuleCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
39
90
  readonly input: CreateRuleCommandInput;
@@ -52,6 +52,43 @@ export interface CreateTargetGroupCommandOutput extends CreateTargetGroupOutput,
52
52
  * @see {@link CreateTargetGroupCommandOutput} for command's `response` shape.
53
53
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
54
54
  *
55
+ * @example To create a target group
56
+ * ```javascript
57
+ * // This example creates a target group that you can use to route traffic to targets using HTTP on port 80. This target group uses the default health check configuration.
58
+ * const input = {
59
+ * "Name": "my-targets",
60
+ * "Port": 80,
61
+ * "Protocol": "HTTP",
62
+ * "VpcId": "vpc-3ac0fb5f"
63
+ * };
64
+ * const command = new CreateTargetGroupCommand(input);
65
+ * const response = await client.send(command);
66
+ * /* response ==
67
+ * {
68
+ * "TargetGroups": [
69
+ * {
70
+ * "HealthCheckIntervalSeconds": 30,
71
+ * "HealthCheckPath": "/",
72
+ * "HealthCheckPort": "traffic-port",
73
+ * "HealthCheckProtocol": "HTTP",
74
+ * "HealthCheckTimeoutSeconds": 5,
75
+ * "HealthyThresholdCount": 5,
76
+ * "Matcher": {
77
+ * "HttpCode": "200"
78
+ * },
79
+ * "Port": 80,
80
+ * "Protocol": "HTTP",
81
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
82
+ * "TargetGroupName": "my-targets",
83
+ * "UnhealthyThresholdCount": 2,
84
+ * "VpcId": "vpc-3ac0fb5f"
85
+ * }
86
+ * ]
87
+ * }
88
+ * *\/
89
+ * // example id: elbv2-create-target-group-1
90
+ * ```
91
+ *
55
92
  */
56
93
  export declare class CreateTargetGroupCommand extends $Command<CreateTargetGroupCommandInput, CreateTargetGroupCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
57
94
  readonly input: CreateTargetGroupCommandInput;
@@ -31,6 +31,17 @@ export interface DeleteListenerCommandOutput extends DeleteListenerOutput, __Met
31
31
  * @see {@link DeleteListenerCommandOutput} for command's `response` shape.
32
32
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
33
33
  *
34
+ * @example To delete a listener
35
+ * ```javascript
36
+ * // This example deletes the specified listener.
37
+ * const input = {
38
+ * "ListenerArn": "arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"
39
+ * };
40
+ * const command = new DeleteListenerCommand(input);
41
+ * await client.send(command);
42
+ * // example id: elbv2-delete-listener-1
43
+ * ```
44
+ *
34
45
  */
35
46
  export declare class DeleteListenerCommand extends $Command<DeleteListenerCommandInput, DeleteListenerCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
36
47
  readonly input: DeleteListenerCommandInput;
@@ -35,6 +35,17 @@ export interface DeleteLoadBalancerCommandOutput extends DeleteLoadBalancerOutpu
35
35
  * @see {@link DeleteLoadBalancerCommandOutput} for command's `response` shape.
36
36
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
37
37
  *
38
+ * @example To delete a load balancer
39
+ * ```javascript
40
+ * // This example deletes the specified load balancer.
41
+ * const input = {
42
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
43
+ * };
44
+ * const command = new DeleteLoadBalancerCommand(input);
45
+ * await client.send(command);
46
+ * // example id: elbv2-delete-load-balancer-1
47
+ * ```
48
+ *
38
49
  */
39
50
  export declare class DeleteLoadBalancerCommand extends $Command<DeleteLoadBalancerCommandInput, DeleteLoadBalancerCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
40
51
  readonly input: DeleteLoadBalancerCommandInput;
@@ -30,6 +30,17 @@ export interface DeleteRuleCommandOutput extends DeleteRuleOutput, __MetadataBea
30
30
  * @see {@link DeleteRuleCommandOutput} for command's `response` shape.
31
31
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
32
32
  *
33
+ * @example To delete a rule
34
+ * ```javascript
35
+ * // This example deletes the specified rule.
36
+ * const input = {
37
+ * "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3"
38
+ * };
39
+ * const command = new DeleteRuleCommand(input);
40
+ * await client.send(command);
41
+ * // example id: elbv2-delete-rule-1
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class DeleteRuleCommand extends $Command<DeleteRuleCommandInput, DeleteRuleCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
35
46
  readonly input: DeleteRuleCommandInput;
@@ -33,6 +33,17 @@ export interface DeleteTargetGroupCommandOutput extends DeleteTargetGroupOutput,
33
33
  * @see {@link DeleteTargetGroupCommandOutput} for command's `response` shape.
34
34
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
35
35
  *
36
+ * @example To delete a target group
37
+ * ```javascript
38
+ * // This example deletes the specified target group.
39
+ * const input = {
40
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
41
+ * };
42
+ * const command = new DeleteTargetGroupCommand(input);
43
+ * await client.send(command);
44
+ * // example id: elbv2-delete-target-group-1
45
+ * ```
46
+ *
36
47
  */
37
48
  export declare class DeleteTargetGroupCommand extends $Command<DeleteTargetGroupCommandInput, DeleteTargetGroupCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
38
49
  readonly input: DeleteTargetGroupCommandInput;
@@ -30,6 +30,22 @@ export interface DeregisterTargetsCommandOutput extends DeregisterTargetsOutput,
30
30
  * @see {@link DeregisterTargetsCommandOutput} for command's `response` shape.
31
31
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
32
32
  *
33
+ * @example To deregister a target from a target group
34
+ * ```javascript
35
+ * // This example deregisters the specified instance from the specified target group.
36
+ * const input = {
37
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
38
+ * "Targets": [
39
+ * {
40
+ * "Id": "i-0f76fade"
41
+ * }
42
+ * ]
43
+ * };
44
+ * const command = new DeregisterTargetsCommand(input);
45
+ * await client.send(command);
46
+ * // example id: elbv2-deregister-targets-1
47
+ * ```
48
+ *
33
49
  */
34
50
  export declare class DeregisterTargetsCommand extends $Command<DeregisterTargetsCommandInput, DeregisterTargetsCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
35
51
  readonly input: DeregisterTargetsCommandInput;
@@ -31,6 +31,37 @@ export interface DescribeListenersCommandOutput extends DescribeListenersOutput,
31
31
  * @see {@link DescribeListenersCommandOutput} for command's `response` shape.
32
32
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
33
33
  *
34
+ * @example To describe a listener
35
+ * ```javascript
36
+ * // This example describes the specified listener.
37
+ * const input = {
38
+ * "ListenerArns": [
39
+ * "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"
40
+ * ]
41
+ * };
42
+ * const command = new DescribeListenersCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "Listeners": [
47
+ * {
48
+ * "DefaultActions": [
49
+ * {
50
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
51
+ * "Type": "forward"
52
+ * }
53
+ * ],
54
+ * "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2",
55
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
56
+ * "Port": 80,
57
+ * "Protocol": "HTTP"
58
+ * }
59
+ * ]
60
+ * }
61
+ * *\/
62
+ * // example id: elbv2-describe-listeners-1
63
+ * ```
64
+ *
34
65
  */
35
66
  export declare class DescribeListenersCommand extends $Command<DescribeListenersCommandInput, DescribeListenersCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
36
67
  readonly input: DescribeListenersCommandInput;
@@ -51,6 +51,43 @@ export interface DescribeLoadBalancerAttributesCommandOutput extends DescribeLoa
51
51
  * @see {@link DescribeLoadBalancerAttributesCommandOutput} for command's `response` shape.
52
52
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
53
53
  *
54
+ * @example To describe load balancer attributes
55
+ * ```javascript
56
+ * // This example describes the attributes of the specified load balancer.
57
+ * const input = {
58
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
59
+ * };
60
+ * const command = new DescribeLoadBalancerAttributesCommand(input);
61
+ * const response = await client.send(command);
62
+ * /* response ==
63
+ * {
64
+ * "Attributes": [
65
+ * {
66
+ * "Key": "access_logs.s3.enabled",
67
+ * "Value": "false"
68
+ * },
69
+ * {
70
+ * "Key": "idle_timeout.timeout_seconds",
71
+ * "Value": "60"
72
+ * },
73
+ * {
74
+ * "Key": "access_logs.s3.prefix",
75
+ * "Value": ""
76
+ * },
77
+ * {
78
+ * "Key": "deletion_protection.enabled",
79
+ * "Value": "false"
80
+ * },
81
+ * {
82
+ * "Key": "access_logs.s3.bucket",
83
+ * "Value": ""
84
+ * }
85
+ * ]
86
+ * }
87
+ * *\/
88
+ * // example id: elbv2-describe-load-balancer-attributes-1
89
+ * ```
90
+ *
54
91
  */
55
92
  export declare class DescribeLoadBalancerAttributesCommand extends $Command<DescribeLoadBalancerAttributesCommandInput, DescribeLoadBalancerAttributesCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
56
93
  readonly input: DescribeLoadBalancerAttributesCommandInput;
@@ -29,6 +29,51 @@ export interface DescribeLoadBalancersCommandOutput extends DescribeLoadBalancer
29
29
  * @see {@link DescribeLoadBalancersCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
31
31
  *
32
+ * @example To describe a load balancer
33
+ * ```javascript
34
+ * // This example describes the specified load balancer.
35
+ * const input = {
36
+ * "LoadBalancerArns": [
37
+ * "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188"
38
+ * ]
39
+ * };
40
+ * const command = new DescribeLoadBalancersCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "LoadBalancers": [
45
+ * {
46
+ * "AvailabilityZones": [
47
+ * {
48
+ * "SubnetId": "subnet-8360a9e7",
49
+ * "ZoneName": "us-west-2a"
50
+ * },
51
+ * {
52
+ * "SubnetId": "subnet-b7d581c0",
53
+ * "ZoneName": "us-west-2b"
54
+ * }
55
+ * ],
56
+ * "CanonicalHostedZoneId": "Z2P70J7EXAMPLE",
57
+ * "CreatedTime": "2016-03-25T21:26:12.920Z",
58
+ * "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com",
59
+ * "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
60
+ * "LoadBalancerName": "my-load-balancer",
61
+ * "Scheme": "internet-facing",
62
+ * "SecurityGroups": [
63
+ * "sg-5943793c"
64
+ * ],
65
+ * "State": {
66
+ * "Code": "active"
67
+ * },
68
+ * "Type": "application",
69
+ * "VpcId": "vpc-3ac0fb5f"
70
+ * }
71
+ * ]
72
+ * }
73
+ * *\/
74
+ * // example id: elbv2-describe-load-balancers-1
75
+ * ```
76
+ *
32
77
  */
33
78
  export declare class DescribeLoadBalancersCommand extends $Command<DescribeLoadBalancersCommandInput, DescribeLoadBalancersCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
34
79
  readonly input: DescribeLoadBalancersCommandInput;
@@ -30,6 +30,44 @@ export interface DescribeRulesCommandOutput extends DescribeRulesOutput, __Metad
30
30
  * @see {@link DescribeRulesCommandOutput} for command's `response` shape.
31
31
  * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for ElasticLoadBalancingV2Client's `config` shape.
32
32
  *
33
+ * @example To describe a rule
34
+ * ```javascript
35
+ * // This example describes the specified rule.
36
+ * const input = {
37
+ * "RuleArns": [
38
+ * "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee"
39
+ * ]
40
+ * };
41
+ * const command = new DescribeRulesCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "Rules": [
46
+ * {
47
+ * "Actions": [
48
+ * {
49
+ * "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
50
+ * "Type": "forward"
51
+ * }
52
+ * ],
53
+ * "Conditions": [
54
+ * {
55
+ * "Field": "path-pattern",
56
+ * "Values": [
57
+ * "/img/*"
58
+ * ]
59
+ * }
60
+ * ],
61
+ * "IsDefault": false,
62
+ * "Priority": "10",
63
+ * "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee"
64
+ * }
65
+ * ]
66
+ * }
67
+ * *\/
68
+ * // example id: elbv2-describe-rules-1
69
+ * ```
70
+ *
33
71
  */
34
72
  export declare class DescribeRulesCommand extends $Command<DescribeRulesCommandInput, DescribeRulesCommandOutput, ElasticLoadBalancingV2ClientResolvedConfig> {
35
73
  readonly input: DescribeRulesCommandInput;