elasticloadbalancingv2-2015-12-01.examples.json (44281B)
1 { 2 "version": "1.0", 3 "examples": { 4 "AddTags": [ 5 { 6 "input": { 7 "ResourceArns": [ 8 "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" 9 ], 10 "Tags": [ 11 { 12 "Key": "project", 13 "Value": "lima" 14 }, 15 { 16 "Key": "department", 17 "Value": "digital-media" 18 } 19 ] 20 }, 21 "comments": { 22 "input": { 23 }, 24 "output": { 25 } 26 }, 27 "description": "This example adds the specified tags to the specified load balancer.", 28 "id": "elbv2-add-tags-1", 29 "title": "To add tags to a load balancer" 30 } 31 ], 32 "CreateListener": [ 33 { 34 "input": { 35 "DefaultActions": [ 36 { 37 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 38 "Type": "forward" 39 } 40 ], 41 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 42 "Port": 80, 43 "Protocol": "HTTP" 44 }, 45 "output": { 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 "comments": { 62 "input": { 63 }, 64 "output": { 65 } 66 }, 67 "description": "This example creates an HTTP listener for the specified load balancer that forwards requests to the specified target group.", 68 "id": "elbv2-create-listener-1", 69 "title": "To create an HTTP listener" 70 }, 71 { 72 "input": { 73 "Certificates": [ 74 { 75 "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" 76 } 77 ], 78 "DefaultActions": [ 79 { 80 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 81 "Type": "forward" 82 } 83 ], 84 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 85 "Port": 443, 86 "Protocol": "HTTPS", 87 "SslPolicy": "ELBSecurityPolicy-2015-05" 88 }, 89 "output": { 90 "Listeners": [ 91 { 92 "Certificates": [ 93 { 94 "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" 95 } 96 ], 97 "DefaultActions": [ 98 { 99 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 100 "Type": "forward" 101 } 102 ], 103 "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 104 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 105 "Port": 443, 106 "Protocol": "HTTPS", 107 "SslPolicy": "ELBSecurityPolicy-2015-05" 108 } 109 ] 110 }, 111 "comments": { 112 "input": { 113 }, 114 "output": { 115 } 116 }, 117 "description": "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).", 118 "id": "elbv2-create-listener-2", 119 "title": "To create an HTTPS listener" 120 } 121 ], 122 "CreateLoadBalancer": [ 123 { 124 "input": { 125 "Name": "my-load-balancer", 126 "Subnets": [ 127 "subnet-b7d581c0", 128 "subnet-8360a9e7" 129 ] 130 }, 131 "output": { 132 "LoadBalancers": [ 133 { 134 "AvailabilityZones": [ 135 { 136 "SubnetId": "subnet-8360a9e7", 137 "ZoneName": "us-west-2a" 138 }, 139 { 140 "SubnetId": "subnet-b7d581c0", 141 "ZoneName": "us-west-2b" 142 } 143 ], 144 "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", 145 "CreatedTime": "2016-03-25T21:26:12.920Z", 146 "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", 147 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 148 "LoadBalancerName": "my-load-balancer", 149 "Scheme": "internet-facing", 150 "SecurityGroups": [ 151 "sg-5943793c" 152 ], 153 "State": { 154 "Code": "provisioning" 155 }, 156 "Type": "application", 157 "VpcId": "vpc-3ac0fb5f" 158 } 159 ] 160 }, 161 "comments": { 162 "input": { 163 }, 164 "output": { 165 } 166 }, 167 "description": "This example creates an Internet-facing load balancer and enables the Availability Zones for the specified subnets.", 168 "id": "elbv2-create-load-balancer-1", 169 "title": "To create an Internet-facing load balancer" 170 }, 171 { 172 "input": { 173 "Name": "my-internal-load-balancer", 174 "Scheme": "internal", 175 "SecurityGroups": [ 176 177 ], 178 "Subnets": [ 179 "subnet-b7d581c0", 180 "subnet-8360a9e7" 181 ] 182 }, 183 "output": { 184 "LoadBalancers": [ 185 { 186 "AvailabilityZones": [ 187 { 188 "SubnetId": "subnet-8360a9e7", 189 "ZoneName": "us-west-2a" 190 }, 191 { 192 "SubnetId": "subnet-b7d581c0", 193 "ZoneName": "us-west-2b" 194 } 195 ], 196 "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", 197 "CreatedTime": "2016-03-25T21:29:48.850Z", 198 "DNSName": "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com", 199 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2", 200 "LoadBalancerName": "my-internal-load-balancer", 201 "Scheme": "internal", 202 "SecurityGroups": [ 203 "sg-5943793c" 204 ], 205 "State": { 206 "Code": "provisioning" 207 }, 208 "Type": "application", 209 "VpcId": "vpc-3ac0fb5f" 210 } 211 ] 212 }, 213 "comments": { 214 "input": { 215 }, 216 "output": { 217 } 218 }, 219 "description": "This example creates an internal load balancer and enables the Availability Zones for the specified subnets.", 220 "id": "elbv2-create-load-balancer-2", 221 "title": "To create an internal load balancer" 222 } 223 ], 224 "CreateRule": [ 225 { 226 "input": { 227 "Actions": [ 228 { 229 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 230 "Type": "forward" 231 } 232 ], 233 "Conditions": [ 234 { 235 "Field": "path-pattern", 236 "Values": [ 237 "/img/*" 238 ] 239 } 240 ], 241 "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 242 "Priority": 10 243 }, 244 "output": { 245 "Rules": [ 246 { 247 "Actions": [ 248 { 249 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 250 "Type": "forward" 251 } 252 ], 253 "Conditions": [ 254 { 255 "Field": "path-pattern", 256 "Values": [ 257 "/img/*" 258 ] 259 } 260 ], 261 "IsDefault": false, 262 "Priority": "10", 263 "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" 264 } 265 ] 266 }, 267 "comments": { 268 "input": { 269 }, 270 "output": { 271 } 272 }, 273 "description": "This example creates a rule that forwards requests to the specified target group if the URL contains the specified pattern (for example, /img/*).", 274 "id": "elbv2-create-rule-1", 275 "title": "To create a rule" 276 } 277 ], 278 "CreateTargetGroup": [ 279 { 280 "input": { 281 "Name": "my-targets", 282 "Port": 80, 283 "Protocol": "HTTP", 284 "VpcId": "vpc-3ac0fb5f" 285 }, 286 "output": { 287 "TargetGroups": [ 288 { 289 "HealthCheckIntervalSeconds": 30, 290 "HealthCheckPath": "/", 291 "HealthCheckPort": "traffic-port", 292 "HealthCheckProtocol": "HTTP", 293 "HealthCheckTimeoutSeconds": 5, 294 "HealthyThresholdCount": 5, 295 "Matcher": { 296 "HttpCode": "200" 297 }, 298 "Port": 80, 299 "Protocol": "HTTP", 300 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 301 "TargetGroupName": "my-targets", 302 "UnhealthyThresholdCount": 2, 303 "VpcId": "vpc-3ac0fb5f" 304 } 305 ] 306 }, 307 "comments": { 308 "input": { 309 }, 310 "output": { 311 } 312 }, 313 "description": "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.", 314 "id": "elbv2-create-target-group-1", 315 "title": "To create a target group" 316 } 317 ], 318 "DeleteListener": [ 319 { 320 "input": { 321 "ListenerArn": "arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" 322 }, 323 "comments": { 324 "input": { 325 }, 326 "output": { 327 } 328 }, 329 "description": "This example deletes the specified listener.", 330 "id": "elbv2-delete-listener-1", 331 "title": "To delete a listener" 332 } 333 ], 334 "DeleteLoadBalancer": [ 335 { 336 "input": { 337 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" 338 }, 339 "comments": { 340 "input": { 341 }, 342 "output": { 343 } 344 }, 345 "description": "This example deletes the specified load balancer.", 346 "id": "elbv2-delete-load-balancer-1", 347 "title": "To delete a load balancer" 348 } 349 ], 350 "DeleteRule": [ 351 { 352 "input": { 353 "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3" 354 }, 355 "comments": { 356 "input": { 357 }, 358 "output": { 359 } 360 }, 361 "description": "This example deletes the specified rule.", 362 "id": "elbv2-delete-rule-1", 363 "title": "To delete a rule" 364 } 365 ], 366 "DeleteTargetGroup": [ 367 { 368 "input": { 369 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" 370 }, 371 "comments": { 372 "input": { 373 }, 374 "output": { 375 } 376 }, 377 "description": "This example deletes the specified target group.", 378 "id": "elbv2-delete-target-group-1", 379 "title": "To delete a target group" 380 } 381 ], 382 "DeregisterTargets": [ 383 { 384 "input": { 385 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 386 "Targets": [ 387 { 388 "Id": "i-0f76fade" 389 } 390 ] 391 }, 392 "comments": { 393 "input": { 394 }, 395 "output": { 396 } 397 }, 398 "description": "This example deregisters the specified instance from the specified target group.", 399 "id": "elbv2-deregister-targets-1", 400 "title": "To deregister a target from a target group" 401 } 402 ], 403 "DescribeListeners": [ 404 { 405 "input": { 406 "ListenerArns": [ 407 "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" 408 ] 409 }, 410 "output": { 411 "Listeners": [ 412 { 413 "DefaultActions": [ 414 { 415 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 416 "Type": "forward" 417 } 418 ], 419 "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 420 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 421 "Port": 80, 422 "Protocol": "HTTP" 423 } 424 ] 425 }, 426 "comments": { 427 "input": { 428 }, 429 "output": { 430 } 431 }, 432 "description": "This example describes the specified listener.", 433 "id": "elbv2-describe-listeners-1", 434 "title": "To describe a listener" 435 } 436 ], 437 "DescribeLoadBalancerAttributes": [ 438 { 439 "input": { 440 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" 441 }, 442 "output": { 443 "Attributes": [ 444 { 445 "Key": "access_logs.s3.enabled", 446 "Value": "false" 447 }, 448 { 449 "Key": "idle_timeout.timeout_seconds", 450 "Value": "60" 451 }, 452 { 453 "Key": "access_logs.s3.prefix", 454 "Value": "" 455 }, 456 { 457 "Key": "deletion_protection.enabled", 458 "Value": "false" 459 }, 460 { 461 "Key": "access_logs.s3.bucket", 462 "Value": "" 463 } 464 ] 465 }, 466 "comments": { 467 "input": { 468 }, 469 "output": { 470 } 471 }, 472 "description": "This example describes the attributes of the specified load balancer.", 473 "id": "elbv2-describe-load-balancer-attributes-1", 474 "title": "To describe load balancer attributes" 475 } 476 ], 477 "DescribeLoadBalancers": [ 478 { 479 "input": { 480 "LoadBalancerArns": [ 481 "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" 482 ] 483 }, 484 "output": { 485 "LoadBalancers": [ 486 { 487 "AvailabilityZones": [ 488 { 489 "SubnetId": "subnet-8360a9e7", 490 "ZoneName": "us-west-2a" 491 }, 492 { 493 "SubnetId": "subnet-b7d581c0", 494 "ZoneName": "us-west-2b" 495 } 496 ], 497 "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", 498 "CreatedTime": "2016-03-25T21:26:12.920Z", 499 "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", 500 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 501 "LoadBalancerName": "my-load-balancer", 502 "Scheme": "internet-facing", 503 "SecurityGroups": [ 504 "sg-5943793c" 505 ], 506 "State": { 507 "Code": "active" 508 }, 509 "Type": "application", 510 "VpcId": "vpc-3ac0fb5f" 511 } 512 ] 513 }, 514 "comments": { 515 "input": { 516 }, 517 "output": { 518 } 519 }, 520 "description": "This example describes the specified load balancer.", 521 "id": "elbv2-describe-load-balancers-1", 522 "title": "To describe a load balancer" 523 } 524 ], 525 "DescribeRules": [ 526 { 527 "input": { 528 "RuleArns": [ 529 "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" 530 ] 531 }, 532 "output": { 533 "Rules": [ 534 { 535 "Actions": [ 536 { 537 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 538 "Type": "forward" 539 } 540 ], 541 "Conditions": [ 542 { 543 "Field": "path-pattern", 544 "Values": [ 545 "/img/*" 546 ] 547 } 548 ], 549 "IsDefault": false, 550 "Priority": "10", 551 "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" 552 } 553 ] 554 }, 555 "comments": { 556 "input": { 557 }, 558 "output": { 559 } 560 }, 561 "description": "This example describes the specified rule.", 562 "id": "elbv2-describe-rules-1", 563 "title": "To describe a rule" 564 } 565 ], 566 "DescribeSSLPolicies": [ 567 { 568 "input": { 569 "Names": [ 570 "ELBSecurityPolicy-2015-05" 571 ] 572 }, 573 "output": { 574 "SslPolicies": [ 575 { 576 "Ciphers": [ 577 { 578 "Name": "ECDHE-ECDSA-AES128-GCM-SHA256", 579 "Priority": 1 580 }, 581 { 582 "Name": "ECDHE-RSA-AES128-GCM-SHA256", 583 "Priority": 2 584 }, 585 { 586 "Name": "ECDHE-ECDSA-AES128-SHA256", 587 "Priority": 3 588 }, 589 { 590 "Name": "ECDHE-RSA-AES128-SHA256", 591 "Priority": 4 592 }, 593 { 594 "Name": "ECDHE-ECDSA-AES128-SHA", 595 "Priority": 5 596 }, 597 { 598 "Name": "ECDHE-RSA-AES128-SHA", 599 "Priority": 6 600 }, 601 { 602 "Name": "DHE-RSA-AES128-SHA", 603 "Priority": 7 604 }, 605 { 606 "Name": "ECDHE-ECDSA-AES256-GCM-SHA384", 607 "Priority": 8 608 }, 609 { 610 "Name": "ECDHE-RSA-AES256-GCM-SHA384", 611 "Priority": 9 612 }, 613 { 614 "Name": "ECDHE-ECDSA-AES256-SHA384", 615 "Priority": 10 616 }, 617 { 618 "Name": "ECDHE-RSA-AES256-SHA384", 619 "Priority": 11 620 }, 621 { 622 "Name": "ECDHE-RSA-AES256-SHA", 623 "Priority": 12 624 }, 625 { 626 "Name": "ECDHE-ECDSA-AES256-SHA", 627 "Priority": 13 628 }, 629 { 630 "Name": "AES128-GCM-SHA256", 631 "Priority": 14 632 }, 633 { 634 "Name": "AES128-SHA256", 635 "Priority": 15 636 }, 637 { 638 "Name": "AES128-SHA", 639 "Priority": 16 640 }, 641 { 642 "Name": "AES256-GCM-SHA384", 643 "Priority": 17 644 }, 645 { 646 "Name": "AES256-SHA256", 647 "Priority": 18 648 }, 649 { 650 "Name": "AES256-SHA", 651 "Priority": 19 652 } 653 ], 654 "Name": "ELBSecurityPolicy-2015-05", 655 "SslProtocols": [ 656 "TLSv1", 657 "TLSv1.1", 658 "TLSv1.2" 659 ] 660 } 661 ] 662 }, 663 "comments": { 664 "input": { 665 }, 666 "output": { 667 } 668 }, 669 "description": "This example describes the specified policy used for SSL negotiation.", 670 "id": "elbv2-describe-ssl-policies-1", 671 "title": "To describe a policy used for SSL negotiation" 672 } 673 ], 674 "DescribeTags": [ 675 { 676 "input": { 677 "ResourceArns": [ 678 "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" 679 ] 680 }, 681 "output": { 682 "TagDescriptions": [ 683 { 684 "ResourceArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 685 "Tags": [ 686 { 687 "Key": "project", 688 "Value": "lima" 689 }, 690 { 691 "Key": "department", 692 "Value": "digital-media" 693 } 694 ] 695 } 696 ] 697 }, 698 "comments": { 699 "input": { 700 }, 701 "output": { 702 } 703 }, 704 "description": "This example describes the tags assigned to the specified load balancer.", 705 "id": "elbv2-describe-tags-1", 706 "title": "To describe the tags assigned to a load balancer" 707 } 708 ], 709 "DescribeTargetGroupAttributes": [ 710 { 711 "input": { 712 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" 713 }, 714 "output": { 715 "Attributes": [ 716 { 717 "Key": "stickiness.enabled", 718 "Value": "false" 719 }, 720 { 721 "Key": "deregistration_delay.timeout_seconds", 722 "Value": "300" 723 }, 724 { 725 "Key": "stickiness.type", 726 "Value": "lb_cookie" 727 }, 728 { 729 "Key": "stickiness.lb_cookie.duration_seconds", 730 "Value": "86400" 731 } 732 ] 733 }, 734 "comments": { 735 "input": { 736 }, 737 "output": { 738 } 739 }, 740 "description": "This example describes the attributes of the specified target group.", 741 "id": "elbv2-describe-target-group-attributes-1", 742 "title": "To describe target group attributes" 743 } 744 ], 745 "DescribeTargetGroups": [ 746 { 747 "input": { 748 "TargetGroupArns": [ 749 "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" 750 ] 751 }, 752 "output": { 753 "TargetGroups": [ 754 { 755 "HealthCheckIntervalSeconds": 30, 756 "HealthCheckPath": "/", 757 "HealthCheckPort": "traffic-port", 758 "HealthCheckProtocol": "HTTP", 759 "HealthCheckTimeoutSeconds": 5, 760 "HealthyThresholdCount": 5, 761 "LoadBalancerArns": [ 762 "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" 763 ], 764 "Matcher": { 765 "HttpCode": "200" 766 }, 767 "Port": 80, 768 "Protocol": "HTTP", 769 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 770 "TargetGroupName": "my-targets", 771 "UnhealthyThresholdCount": 2, 772 "VpcId": "vpc-3ac0fb5f" 773 } 774 ] 775 }, 776 "comments": { 777 "input": { 778 }, 779 "output": { 780 } 781 }, 782 "description": "This example describes the specified target group.", 783 "id": "elbv2-describe-target-groups-1", 784 "title": "To describe a target group" 785 } 786 ], 787 "DescribeTargetHealth": [ 788 { 789 "input": { 790 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" 791 }, 792 "output": { 793 "TargetHealthDescriptions": [ 794 { 795 "Target": { 796 "Id": "i-0f76fade", 797 "Port": 80 798 }, 799 "TargetHealth": { 800 "Description": "Given target group is not configured to receive traffic from ELB", 801 "Reason": "Target.NotInUse", 802 "State": "unused" 803 } 804 }, 805 { 806 "HealthCheckPort": "80", 807 "Target": { 808 "Id": "i-0f76fade", 809 "Port": 80 810 }, 811 "TargetHealth": { 812 "State": "healthy" 813 } 814 } 815 ] 816 }, 817 "comments": { 818 "input": { 819 }, 820 "output": { 821 } 822 }, 823 "description": "This example describes the health of the targets for the specified target group. One target is healthy but the other is not specified in an action, so it can't receive traffic from the load balancer.", 824 "id": "elbv2-describe-target-health-1", 825 "title": "To describe the health of the targets for a target group" 826 }, 827 { 828 "input": { 829 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 830 "Targets": [ 831 { 832 "Id": "i-0f76fade", 833 "Port": 80 834 } 835 ] 836 }, 837 "output": { 838 "TargetHealthDescriptions": [ 839 { 840 "HealthCheckPort": "80", 841 "Target": { 842 "Id": "i-0f76fade", 843 "Port": 80 844 }, 845 "TargetHealth": { 846 "State": "healthy" 847 } 848 } 849 ] 850 }, 851 "comments": { 852 "input": { 853 }, 854 "output": { 855 } 856 }, 857 "description": "This example describes the health of the specified target. This target is healthy.", 858 "id": "elbv2-describe-target-health-2", 859 "title": "To describe the health of a target" 860 } 861 ], 862 "ModifyListener": [ 863 { 864 "input": { 865 "DefaultActions": [ 866 { 867 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", 868 "Type": "forward" 869 } 870 ], 871 "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" 872 }, 873 "output": { 874 "Listeners": [ 875 { 876 "DefaultActions": [ 877 { 878 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", 879 "Type": "forward" 880 } 881 ], 882 "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", 883 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 884 "Port": 80, 885 "Protocol": "HTTP" 886 } 887 ] 888 }, 889 "comments": { 890 "input": { 891 }, 892 "output": { 893 } 894 }, 895 "description": "This example changes the default action for the specified listener.", 896 "id": "elbv2-modify-listener-1", 897 "title": "To change the default action for a listener" 898 }, 899 { 900 "input": { 901 "Certificates": [ 902 { 903 "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" 904 } 905 ], 906 "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" 907 }, 908 "output": { 909 "Listeners": [ 910 { 911 "Certificates": [ 912 { 913 "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" 914 } 915 ], 916 "DefaultActions": [ 917 { 918 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 919 "Type": "forward" 920 } 921 ], 922 "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65", 923 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 924 "Port": 443, 925 "Protocol": "HTTPS", 926 "SslPolicy": "ELBSecurityPolicy-2015-05" 927 } 928 ] 929 }, 930 "comments": { 931 "input": { 932 }, 933 "output": { 934 } 935 }, 936 "description": "This example changes the server certificate for the specified HTTPS listener.", 937 "id": "elbv2-modify-listener-2", 938 "title": "To change the server certificate" 939 } 940 ], 941 "ModifyLoadBalancerAttributes": [ 942 { 943 "input": { 944 "Attributes": [ 945 { 946 "Key": "deletion_protection.enabled", 947 "Value": "true" 948 } 949 ], 950 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" 951 }, 952 "output": { 953 "Attributes": [ 954 { 955 "Key": "deletion_protection.enabled", 956 "Value": "true" 957 }, 958 { 959 "Key": "access_logs.s3.enabled", 960 "Value": "false" 961 }, 962 { 963 "Key": "idle_timeout.timeout_seconds", 964 "Value": "60" 965 }, 966 { 967 "Key": "access_logs.s3.prefix", 968 "Value": "" 969 }, 970 { 971 "Key": "access_logs.s3.bucket", 972 "Value": "" 973 } 974 ] 975 }, 976 "comments": { 977 "input": { 978 }, 979 "output": { 980 } 981 }, 982 "description": "This example enables deletion protection for the specified load balancer.", 983 "id": "elbv2-modify-load-balancer-attributes-1", 984 "title": "To enable deletion protection" 985 }, 986 { 987 "input": { 988 "Attributes": [ 989 { 990 "Key": "idle_timeout.timeout_seconds", 991 "Value": "30" 992 } 993 ], 994 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" 995 }, 996 "output": { 997 "Attributes": [ 998 { 999 "Key": "idle_timeout.timeout_seconds", 1000 "Value": "30" 1001 }, 1002 { 1003 "Key": "access_logs.s3.enabled", 1004 "Value": "false" 1005 }, 1006 { 1007 "Key": "access_logs.s3.prefix", 1008 "Value": "" 1009 }, 1010 { 1011 "Key": "deletion_protection.enabled", 1012 "Value": "true" 1013 }, 1014 { 1015 "Key": "access_logs.s3.bucket", 1016 "Value": "" 1017 } 1018 ] 1019 }, 1020 "comments": { 1021 "input": { 1022 }, 1023 "output": { 1024 } 1025 }, 1026 "description": "This example changes the idle timeout value for the specified load balancer.", 1027 "id": "elbv2-modify-load-balancer-attributes-2", 1028 "title": "To change the idle timeout" 1029 }, 1030 { 1031 "input": { 1032 "Attributes": [ 1033 { 1034 "Key": "access_logs.s3.enabled", 1035 "Value": "true" 1036 }, 1037 { 1038 "Key": "access_logs.s3.bucket", 1039 "Value": "my-loadbalancer-logs" 1040 }, 1041 { 1042 "Key": "access_logs.s3.prefix", 1043 "Value": "myapp" 1044 } 1045 ], 1046 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" 1047 }, 1048 "output": { 1049 "Attributes": [ 1050 { 1051 "Key": "access_logs.s3.enabled", 1052 "Value": "true" 1053 }, 1054 { 1055 "Key": "access_logs.s3.bucket", 1056 "Value": "my-load-balancer-logs" 1057 }, 1058 { 1059 "Key": "access_logs.s3.prefix", 1060 "Value": "myapp" 1061 }, 1062 { 1063 "Key": "idle_timeout.timeout_seconds", 1064 "Value": "60" 1065 }, 1066 { 1067 "Key": "deletion_protection.enabled", 1068 "Value": "false" 1069 } 1070 ] 1071 }, 1072 "comments": { 1073 "input": { 1074 }, 1075 "output": { 1076 } 1077 }, 1078 "description": "This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.", 1079 "id": "elbv2-modify-load-balancer-attributes-3", 1080 "title": "To enable access logs" 1081 } 1082 ], 1083 "ModifyRule": [ 1084 { 1085 "input": { 1086 "Conditions": [ 1087 { 1088 "Field": "path-pattern", 1089 "Values": [ 1090 "/images/*" 1091 ] 1092 } 1093 ], 1094 "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" 1095 }, 1096 "output": { 1097 "Rules": [ 1098 { 1099 "Actions": [ 1100 { 1101 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 1102 "Type": "forward" 1103 } 1104 ], 1105 "Conditions": [ 1106 { 1107 "Field": "path-pattern", 1108 "Values": [ 1109 "/images/*" 1110 ] 1111 } 1112 ], 1113 "IsDefault": false, 1114 "Priority": "10", 1115 "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" 1116 } 1117 ] 1118 }, 1119 "comments": { 1120 "input": { 1121 }, 1122 "output": { 1123 } 1124 }, 1125 "description": "This example modifies the condition for the specified rule.", 1126 "id": "elbv2-modify-rule-1", 1127 "title": "To modify a rule" 1128 } 1129 ], 1130 "ModifyTargetGroup": [ 1131 { 1132 "input": { 1133 "HealthCheckPort": "443", 1134 "HealthCheckProtocol": "HTTPS", 1135 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f" 1136 }, 1137 "output": { 1138 "TargetGroups": [ 1139 { 1140 "HealthCheckIntervalSeconds": 30, 1141 "HealthCheckPort": "443", 1142 "HealthCheckProtocol": "HTTPS", 1143 "HealthCheckTimeoutSeconds": 5, 1144 "HealthyThresholdCount": 5, 1145 "LoadBalancerArns": [ 1146 "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" 1147 ], 1148 "Matcher": { 1149 "HttpCode": "200" 1150 }, 1151 "Port": 443, 1152 "Protocol": "HTTPS", 1153 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f", 1154 "TargetGroupName": "my-https-targets", 1155 "UnhealthyThresholdCount": 2, 1156 "VpcId": "vpc-3ac0fb5f" 1157 } 1158 ] 1159 }, 1160 "comments": { 1161 "input": { 1162 }, 1163 "output": { 1164 } 1165 }, 1166 "description": "This example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group.", 1167 "id": "elbv2-modify-target-group-1", 1168 "title": "To modify the health check configuration for a target group" 1169 } 1170 ], 1171 "ModifyTargetGroupAttributes": [ 1172 { 1173 "input": { 1174 "Attributes": [ 1175 { 1176 "Key": "deregistration_delay.timeout_seconds", 1177 "Value": "600" 1178 } 1179 ], 1180 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" 1181 }, 1182 "output": { 1183 "Attributes": [ 1184 { 1185 "Key": "stickiness.enabled", 1186 "Value": "false" 1187 }, 1188 { 1189 "Key": "deregistration_delay.timeout_seconds", 1190 "Value": "600" 1191 }, 1192 { 1193 "Key": "stickiness.type", 1194 "Value": "lb_cookie" 1195 }, 1196 { 1197 "Key": "stickiness.lb_cookie.duration_seconds", 1198 "Value": "86400" 1199 } 1200 ] 1201 }, 1202 "comments": { 1203 "input": { 1204 }, 1205 "output": { 1206 } 1207 }, 1208 "description": "This example sets the deregistration delay timeout to the specified value for the specified target group.", 1209 "id": "elbv2-modify-target-group-attributes-1", 1210 "title": "To modify the deregistration delay timeout" 1211 } 1212 ], 1213 "RegisterTargets": [ 1214 { 1215 "input": { 1216 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 1217 "Targets": [ 1218 { 1219 "Id": "i-80c8dd94" 1220 }, 1221 { 1222 "Id": "i-ceddcd4d" 1223 } 1224 ] 1225 }, 1226 "comments": { 1227 "input": { 1228 }, 1229 "output": { 1230 } 1231 }, 1232 "description": "This example registers the specified instances with the specified target group.", 1233 "id": "elbv2-register-targets-1", 1234 "title": "To register targets with a target group" 1235 }, 1236 { 1237 "input": { 1238 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9", 1239 "Targets": [ 1240 { 1241 "Id": "i-80c8dd94", 1242 "Port": 80 1243 }, 1244 { 1245 "Id": "i-80c8dd94", 1246 "Port": 766 1247 } 1248 ] 1249 }, 1250 "comments": { 1251 "input": { 1252 }, 1253 "output": { 1254 } 1255 }, 1256 "description": "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.", 1257 "id": "elbv2-register-targets-2", 1258 "title": "To register targets with a target group using port overrides" 1259 } 1260 ], 1261 "RemoveTags": [ 1262 { 1263 "input": { 1264 "ResourceArns": [ 1265 "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" 1266 ], 1267 "TagKeys": [ 1268 "project", 1269 "department" 1270 ] 1271 }, 1272 "comments": { 1273 "input": { 1274 }, 1275 "output": { 1276 } 1277 }, 1278 "description": "This example removes the specified tags from the specified load balancer.", 1279 "id": "elbv2-remove-tags-1", 1280 "title": "To remove tags from a load balancer" 1281 } 1282 ], 1283 "SetRulePriorities": [ 1284 { 1285 "input": { 1286 "RulePriorities": [ 1287 { 1288 "Priority": 5, 1289 "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3" 1290 } 1291 ] 1292 }, 1293 "output": { 1294 "Rules": [ 1295 { 1296 "Actions": [ 1297 { 1298 "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", 1299 "Type": "forward" 1300 } 1301 ], 1302 "Conditions": [ 1303 { 1304 "Field": "path-pattern", 1305 "Values": [ 1306 "/img/*" 1307 ] 1308 } 1309 ], 1310 "IsDefault": false, 1311 "Priority": "5", 1312 "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3" 1313 } 1314 ] 1315 }, 1316 "comments": { 1317 "input": { 1318 }, 1319 "output": { 1320 } 1321 }, 1322 "description": "This example sets the priority of the specified rule.", 1323 "id": "elbv2-set-rule-priorities-1", 1324 "title": "To set the rule priority" 1325 } 1326 ], 1327 "SetSecurityGroups": [ 1328 { 1329 "input": { 1330 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 1331 "SecurityGroups": [ 1332 "sg-5943793c" 1333 ] 1334 }, 1335 "output": { 1336 "SecurityGroupIds": [ 1337 "sg-5943793c" 1338 ] 1339 }, 1340 "comments": { 1341 "input": { 1342 }, 1343 "output": { 1344 } 1345 }, 1346 "description": "This example associates the specified security group with the specified load balancer.", 1347 "id": "elbv2-set-security-groups-1", 1348 "title": "To associate a security group with a load balancer" 1349 } 1350 ], 1351 "SetSubnets": [ 1352 { 1353 "input": { 1354 "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", 1355 "Subnets": [ 1356 "subnet-8360a9e7", 1357 "subnet-b7d581c0" 1358 ] 1359 }, 1360 "output": { 1361 "AvailabilityZones": [ 1362 { 1363 "SubnetId": "subnet-8360a9e7", 1364 "ZoneName": "us-west-2a" 1365 }, 1366 { 1367 "SubnetId": "subnet-b7d581c0", 1368 "ZoneName": "us-west-2b" 1369 } 1370 ] 1371 }, 1372 "comments": { 1373 "input": { 1374 }, 1375 "output": { 1376 } 1377 }, 1378 "description": "This example enables the Availability Zones for the specified subnets for the specified load balancer.", 1379 "id": "elbv2-set-subnets-1", 1380 "title": "To enable Availability Zones for a load balancer" 1381 } 1382 ] 1383 } 1384 }