aws-sdk-globalaccelerator 1.39.0 → 1.41.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -421,16 +421,80 @@ module Aws::GlobalAccelerator
421
421
  req.send_request(options)
422
422
  end
423
423
 
424
+ # Add endpoints to an endpoint group. The `AddEndpoints` API operation
425
+ # is the recommended option for adding endpoints. The alternative
426
+ # options are to add endpoints when you create an endpoint group (with
427
+ # the [CreateEndpointGroup][1] API) or when you update an endpoint group
428
+ # (with the [UpdateEndpointGroup][2] API).
429
+ #
430
+ # There are two advantages to using `AddEndpoints` to add endpoints:
431
+ #
432
+ # * It's faster, because Global Accelerator only has to resolve the new
433
+ # endpoints that you're adding.
434
+ #
435
+ # * It's more convenient, because you don't need to specify all of the
436
+ # current endpoints that are already in the endpoint group in addition
437
+ # to the new endpoints that you want to add.
438
+ #
439
+ #
440
+ #
441
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/api/API_CreateEndpointGroup.html
442
+ # [2]: https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html
443
+ #
444
+ # @option params [required, Array<Types::EndpointConfiguration>] :endpoint_configurations
445
+ # The list of endpoint objects.
446
+ #
447
+ # @option params [required, String] :endpoint_group_arn
448
+ # The Amazon Resource Name (ARN) of the endpoint group.
449
+ #
450
+ # @return [Types::AddEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
451
+ #
452
+ # * {Types::AddEndpointsResponse#endpoint_descriptions #endpoint_descriptions} => Array&lt;Types::EndpointDescription&gt;
453
+ # * {Types::AddEndpointsResponse#endpoint_group_arn #endpoint_group_arn} => String
454
+ #
455
+ # @example Request syntax with placeholder values
456
+ #
457
+ # resp = client.add_endpoints({
458
+ # endpoint_configurations: [ # required
459
+ # {
460
+ # endpoint_id: "GenericString",
461
+ # weight: 1,
462
+ # client_ip_preservation_enabled: false,
463
+ # },
464
+ # ],
465
+ # endpoint_group_arn: "GenericString", # required
466
+ # })
467
+ #
468
+ # @example Response structure
469
+ #
470
+ # resp.endpoint_descriptions #=> Array
471
+ # resp.endpoint_descriptions[0].endpoint_id #=> String
472
+ # resp.endpoint_descriptions[0].weight #=> Integer
473
+ # resp.endpoint_descriptions[0].health_state #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
474
+ # resp.endpoint_descriptions[0].health_reason #=> String
475
+ # resp.endpoint_descriptions[0].client_ip_preservation_enabled #=> Boolean
476
+ # resp.endpoint_group_arn #=> String
477
+ #
478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/AddEndpoints AWS API Documentation
479
+ #
480
+ # @overload add_endpoints(params = {})
481
+ # @param [Hash] params ({})
482
+ def add_endpoints(params = {}, options = {})
483
+ req = build_request(:add_endpoints, params)
484
+ req.send_request(options)
485
+ end
486
+
424
487
  # Advertises an IPv4 address range that is provisioned for use with your
425
- # AWS resources through bring your own IP addresses (BYOIP). It can take
426
- # a few minutes before traffic to the specified addresses starts routing
427
- # to AWS because of propagation delays.
488
+ # Amazon Web Services resources through bring your own IP addresses
489
+ # (BYOIP). It can take a few minutes before traffic to the specified
490
+ # addresses starts routing to Amazon Web Services because of propagation
491
+ # delays.
428
492
  #
429
493
  # To stop advertising the BYOIP address range, use [
430
494
  # WithdrawByoipCidr][1].
431
495
  #
432
- # For more information, see [Bring Your Own IP Addresses (BYOIP)][2] in
433
- # the *AWS Global Accelerator Developer Guide*.
496
+ # For more information, see [Bring your own IP addresses (BYOIP)][2] in
497
+ # the *Global Accelerator Developer Guide*.
434
498
  #
435
499
  #
436
500
  #
@@ -545,35 +609,44 @@ module Aws::GlobalAccelerator
545
609
  # Load Balancers.
546
610
  #
547
611
  # Global Accelerator is a global service that supports endpoints in
548
- # multiple AWS Regions but you must specify the US West (Oregon) Region
549
- # to create or update accelerators.
612
+ # multiple Amazon Web Services Regions but you must specify the US West
613
+ # (Oregon) Region to create, update, or otherwise work with
614
+ # accelerators. That is, for example, specify `--region us-west-2` on
615
+ # AWS CLI commands.
550
616
  #
551
617
  # @option params [required, String] :name
552
- # The name of an accelerator. The name can have a maximum of 32
553
- # characters, must contain only alphanumeric characters or hyphens (-),
554
- # and must not begin or end with a hyphen.
618
+ # The name of the accelerator. The name can have a maximum of 64
619
+ # characters, must contain only alphanumeric characters, periods (.), or
620
+ # hyphens (-), and must not begin or end with a hyphen or period.
555
621
  #
556
622
  # @option params [String] :ip_address_type
557
- # The value for the address type must be IPv4.
623
+ # The IP address type that an accelerator supports. For a standard
624
+ # accelerator, the value can be IPV4 or DUAL\_STACK.
558
625
  #
559
626
  # @option params [Array<String>] :ip_addresses
560
627
  # Optionally, if you've added your own IP address pool to Global
561
- # Accelerator (BYOIP), you can choose IP addresses from your own pool to
562
- # use for the accelerator's static IP addresses when you create an
563
- # accelerator. You can specify one or two addresses, separated by a
564
- # space. Do not include the /32 suffix.
628
+ # Accelerator (BYOIP), you can choose an IPv4 address from your own pool
629
+ # to use for the accelerator's static IPv4 address when you create an
630
+ # accelerator.
565
631
  #
566
- # Only one IP address from each of your IP address ranges can be used
567
- # for each accelerator. If you specify only one IP address from your IP
568
- # address range, Global Accelerator assigns a second static IP address
569
- # for the accelerator from the AWS IP address pool.
632
+ # After you bring an address range to Amazon Web Services, it appears in
633
+ # your account as an address pool. When you create an accelerator, you
634
+ # can assign one IPv4 address from your range to it. Global Accelerator
635
+ # assigns you a second static IPv4 address from an Amazon IP address
636
+ # range. If you bring two IPv4 address ranges to Amazon Web Services,
637
+ # you can assign one IPv4 address from each range to your accelerator.
638
+ # This restriction is because Global Accelerator assigns each address
639
+ # range to a different network zone, for high availability.
640
+ #
641
+ # You can specify one or two addresses, separated by a space. Do not
642
+ # include the /32 suffix.
570
643
  #
571
644
  # Note that you can't update IP addresses for an existing accelerator.
572
645
  # To change them, you must create a new accelerator with the new
573
646
  # addresses.
574
647
  #
575
- # For more information, see [Bring Your Own IP Addresses (BYOIP)][1] in
576
- # the *AWS Global Accelerator Developer Guide*.
648
+ # For more information, see [Bring your own IP addresses (BYOIP)][1] in
649
+ # the *Global Accelerator Developer Guide*.
577
650
  #
578
651
  #
579
652
  #
@@ -596,8 +669,8 @@ module Aws::GlobalAccelerator
596
669
  # @option params [Array<Types::Tag>] :tags
597
670
  # Create tags for an accelerator.
598
671
  #
599
- # For more information, see [Tagging in AWS Global Accelerator][1] in
600
- # the *AWS Global Accelerator Developer Guide*.
672
+ # For more information, see [Tagging in Global Accelerator][1] in the
673
+ # *Global Accelerator Developer Guide*.
601
674
  #
602
675
  #
603
676
  #
@@ -611,7 +684,7 @@ module Aws::GlobalAccelerator
611
684
  #
612
685
  # resp = client.create_accelerator({
613
686
  # name: "GenericString", # required
614
- # ip_address_type: "IPV4", # accepts IPV4
687
+ # ip_address_type: "IPV4", # accepts IPV4, DUAL_STACK
615
688
  # ip_addresses: ["IpAddress"],
616
689
  # enabled: false,
617
690
  # idempotency_token: "IdempotencyToken", # required
@@ -627,16 +700,21 @@ module Aws::GlobalAccelerator
627
700
  #
628
701
  # resp.accelerator.accelerator_arn #=> String
629
702
  # resp.accelerator.name #=> String
630
- # resp.accelerator.ip_address_type #=> String, one of "IPV4"
703
+ # resp.accelerator.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
631
704
  # resp.accelerator.enabled #=> Boolean
632
705
  # resp.accelerator.ip_sets #=> Array
633
706
  # resp.accelerator.ip_sets[0].ip_family #=> String
634
707
  # resp.accelerator.ip_sets[0].ip_addresses #=> Array
635
708
  # resp.accelerator.ip_sets[0].ip_addresses[0] #=> String
709
+ # resp.accelerator.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
636
710
  # resp.accelerator.dns_name #=> String
637
711
  # resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
638
712
  # resp.accelerator.created_time #=> Time
639
713
  # resp.accelerator.last_modified_time #=> Time
714
+ # resp.accelerator.dual_stack_dns_name #=> String
715
+ # resp.accelerator.events #=> Array
716
+ # resp.accelerator.events[0].message #=> String
717
+ # resp.accelerator.events[0].timestamp #=> Time
640
718
  #
641
719
  # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateAccelerator AWS API Documentation
642
720
  #
@@ -658,8 +736,10 @@ module Aws::GlobalAccelerator
658
736
  # receive traffic, see the [ AllowCustomRoutingTraffic][1] operation.
659
737
  #
660
738
  # Global Accelerator is a global service that supports endpoints in
661
- # multiple AWS Regions but you must specify the US West (Oregon) Region
662
- # to create or update accelerators.
739
+ # multiple Amazon Web Services Regions but you must specify the US West
740
+ # (Oregon) Region to create, update, or otherwise work with
741
+ # accelerators. That is, for example, specify `--region us-west-2` on
742
+ # AWS CLI commands.
663
743
  #
664
744
  #
665
745
  #
@@ -671,26 +751,33 @@ module Aws::GlobalAccelerator
671
751
  # (-), and must not begin or end with a hyphen.
672
752
  #
673
753
  # @option params [String] :ip_address_type
674
- # The value for the address type must be IPv4.
754
+ # The IP address type that an accelerator supports. For a custom routing
755
+ # accelerator, the value must be IPV4.
675
756
  #
676
757
  # @option params [Array<String>] :ip_addresses
677
758
  # Optionally, if you've added your own IP address pool to Global
678
- # Accelerator (BYOIP), you can choose IP addresses from your own pool to
679
- # use for the accelerator's static IP addresses when you create an
680
- # accelerator. You can specify one or two addresses, separated by a
681
- # space. Do not include the /32 suffix.
759
+ # Accelerator (BYOIP), you can choose an IPv4 address from your own pool
760
+ # to use for the accelerator's static IPv4 address when you create an
761
+ # accelerator.
682
762
  #
683
- # Only one IP address from each of your IP address ranges can be used
684
- # for each accelerator. If you specify only one IP address from your IP
685
- # address range, Global Accelerator assigns a second static IP address
686
- # for the accelerator from the AWS IP address pool.
763
+ # After you bring an address range to Amazon Web Services, it appears in
764
+ # your account as an address pool. When you create an accelerator, you
765
+ # can assign one IPv4 address from your range to it. Global Accelerator
766
+ # assigns you a second static IPv4 address from an Amazon IP address
767
+ # range. If you bring two IPv4 address ranges to Amazon Web Services,
768
+ # you can assign one IPv4 address from each range to your accelerator.
769
+ # This restriction is because Global Accelerator assigns each address
770
+ # range to a different network zone, for high availability.
771
+ #
772
+ # You can specify one or two addresses, separated by a space. Do not
773
+ # include the /32 suffix.
687
774
  #
688
775
  # Note that you can't update IP addresses for an existing accelerator.
689
776
  # To change them, you must create a new accelerator with the new
690
777
  # addresses.
691
778
  #
692
779
  # For more information, see [Bring your own IP addresses (BYOIP)][1] in
693
- # the *AWS Global Accelerator Developer Guide*.
780
+ # the *Global Accelerator Developer Guide*.
694
781
  #
695
782
  #
696
783
  #
@@ -713,8 +800,8 @@ module Aws::GlobalAccelerator
713
800
  # @option params [Array<Types::Tag>] :tags
714
801
  # Create tags for an accelerator.
715
802
  #
716
- # For more information, see [Tagging in AWS Global Accelerator][1] in
717
- # the *AWS Global Accelerator Developer Guide*.
803
+ # For more information, see [Tagging in Global Accelerator][1] in the
804
+ # *Global Accelerator Developer Guide*.
718
805
  #
719
806
  #
720
807
  #
@@ -728,7 +815,7 @@ module Aws::GlobalAccelerator
728
815
  #
729
816
  # resp = client.create_custom_routing_accelerator({
730
817
  # name: "GenericString", # required
731
- # ip_address_type: "IPV4", # accepts IPV4
818
+ # ip_address_type: "IPV4", # accepts IPV4, DUAL_STACK
732
819
  # ip_addresses: ["IpAddress"],
733
820
  # enabled: false,
734
821
  # idempotency_token: "IdempotencyToken", # required
@@ -744,12 +831,13 @@ module Aws::GlobalAccelerator
744
831
  #
745
832
  # resp.accelerator.accelerator_arn #=> String
746
833
  # resp.accelerator.name #=> String
747
- # resp.accelerator.ip_address_type #=> String, one of "IPV4"
834
+ # resp.accelerator.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
748
835
  # resp.accelerator.enabled #=> Boolean
749
836
  # resp.accelerator.ip_sets #=> Array
750
837
  # resp.accelerator.ip_sets[0].ip_family #=> String
751
838
  # resp.accelerator.ip_sets[0].ip_addresses #=> Array
752
839
  # resp.accelerator.ip_sets[0].ip_addresses[0] #=> String
840
+ # resp.accelerator.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
753
841
  # resp.accelerator.dns_name #=> String
754
842
  # resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
755
843
  # resp.accelerator.created_time #=> Time
@@ -766,15 +854,15 @@ module Aws::GlobalAccelerator
766
854
 
767
855
  # Create an endpoint group for the specified listener for a custom
768
856
  # routing accelerator. An endpoint group is a collection of endpoints in
769
- # one AWS Region.
857
+ # one Amazon Web Services Region.
770
858
  #
771
859
  # @option params [required, String] :listener_arn
772
860
  # The Amazon Resource Name (ARN) of the listener for a custom routing
773
861
  # endpoint.
774
862
  #
775
863
  # @option params [required, String] :endpoint_group_region
776
- # The AWS Region where the endpoint group is located. A listener can
777
- # have only one endpoint group in a specific Region.
864
+ # The Amazon Web Services Region where the endpoint group is located. A
865
+ # listener can have only one endpoint group in a specific Region.
778
866
  #
779
867
  # @option params [required, Array<Types::CustomRoutingDestinationConfiguration>] :destination_configurations
780
868
  # Sets the port range and protocol for all endpoints (virtual private
@@ -888,22 +976,23 @@ module Aws::GlobalAccelerator
888
976
  end
889
977
 
890
978
  # Create an endpoint group for the specified listener. An endpoint group
891
- # is a collection of endpoints in one AWS Region. A resource must be
892
- # valid and active when you add it as an endpoint.
979
+ # is a collection of endpoints in one Amazon Web Services Region. A
980
+ # resource must be valid and active when you add it as an endpoint.
893
981
  #
894
982
  # @option params [required, String] :listener_arn
895
983
  # The Amazon Resource Name (ARN) of the listener.
896
984
  #
897
985
  # @option params [required, String] :endpoint_group_region
898
- # The AWS Region where the endpoint group is located. A listener can
899
- # have only one endpoint group in a specific Region.
986
+ # The Amazon Web Services Region where the endpoint group is located. A
987
+ # listener can have only one endpoint group in a specific Region.
900
988
  #
901
989
  # @option params [Array<Types::EndpointConfiguration>] :endpoint_configurations
902
990
  # The list of endpoint objects.
903
991
  #
904
992
  # @option params [Float] :traffic_dial_percentage
905
- # The percentage of traffic to send to an AWS Region. Additional traffic
906
- # is distributed to other endpoint groups for this listener.
993
+ # The percentage of traffic to send to an Amazon Web Services Region.
994
+ # Additional traffic is distributed to other endpoint groups for this
995
+ # listener.
907
996
  #
908
997
  # Use this action to increase (dial up) or decrease (dial down) traffic
909
998
  # to a specific Region. The percentage is applied to the traffic that
@@ -913,14 +1002,13 @@ module Aws::GlobalAccelerator
913
1002
  # The default value is 100.
914
1003
  #
915
1004
  # @option params [Integer] :health_check_port
916
- # The port that AWS Global Accelerator uses to check the health of
917
- # endpoints that are part of this endpoint group. The default port is
918
- # the listener port that this endpoint group is associated with. If
919
- # listener port is a list of ports, Global Accelerator uses the first
920
- # port in the list.
1005
+ # The port that Global Accelerator uses to check the health of endpoints
1006
+ # that are part of this endpoint group. The default port is the listener
1007
+ # port that this endpoint group is associated with. If listener port is
1008
+ # a list of ports, Global Accelerator uses the first port in the list.
921
1009
  #
922
1010
  # @option params [String] :health_check_protocol
923
- # The protocol that AWS Global Accelerator uses to check the health of
1011
+ # The protocol that Global Accelerator uses to check the health of
924
1012
  # endpoints that are part of this endpoint group. The default value is
925
1013
  # TCP.
926
1014
  #
@@ -951,8 +1039,8 @@ module Aws::GlobalAccelerator
951
1039
  # and 443, but your accelerator routes that traffic to ports 1080 and
952
1040
  # 1443, respectively, on the endpoints.
953
1041
  #
954
- # For more information, see [ Port overrides][1] in the *AWS Global
955
- # Accelerator Developer Guide*.
1042
+ # For more information, see [ Overriding listener ports][1] in the
1043
+ # *Global Accelerator Developer Guide*.
956
1044
  #
957
1045
  #
958
1046
  #
@@ -1039,15 +1127,14 @@ module Aws::GlobalAccelerator
1039
1127
  # over whether to always route each client to the same specific
1040
1128
  # endpoint.
1041
1129
  #
1042
- # AWS Global Accelerator uses a consistent-flow hashing algorithm to
1043
- # choose the optimal endpoint for a connection. If client affinity is
1044
- # `NONE`, Global Accelerator uses the "five-tuple" (5-tuple)
1045
- # properties—source IP address, source port, destination IP address,
1046
- # destination port, and protocol—to select the hash value, and then
1047
- # chooses the best endpoint. However, with this setting, if someone uses
1048
- # different ports to connect to Global Accelerator, their connections
1049
- # might not be always routed to the same endpoint because the hash value
1050
- # changes.
1130
+ # Global Accelerator uses a consistent-flow hashing algorithm to choose
1131
+ # the optimal endpoint for a connection. If client affinity is `NONE`,
1132
+ # Global Accelerator uses the "five-tuple" (5-tuple) properties—source
1133
+ # IP address, source port, destination IP address, destination port, and
1134
+ # protocol—to select the hash value, and then chooses the best endpoint.
1135
+ # However, with this setting, if someone uses different ports to connect
1136
+ # to Global Accelerator, their connections might not be always routed to
1137
+ # the same endpoint because the hash value changes.
1051
1138
  #
1052
1139
  # If you want a given client to always be routed to the same endpoint,
1053
1140
  # set client affinity to `SOURCE_IP` instead. When you use the
@@ -1119,8 +1206,8 @@ module Aws::GlobalAccelerator
1119
1206
  # that you have permissions in place to avoid inadvertently deleting
1120
1207
  # accelerators. You can use IAM policies with Global Accelerator to
1121
1208
  # limit the users who have permissions to delete an accelerator. For
1122
- # more information, see [Authentication and Access Control][1] in the
1123
- # *AWS Global Accelerator Developer Guide*.
1209
+ # more information, see [Identity and access management][1] in the
1210
+ # *Global Accelerator Developer Guide*.
1124
1211
  #
1125
1212
  #
1126
1213
  #
@@ -1162,8 +1249,8 @@ module Aws::GlobalAccelerator
1162
1249
  # that you have permissions in place to avoid inadvertently deleting
1163
1250
  # accelerators. You can use IAM policies with Global Accelerator to
1164
1251
  # limit the users who have permissions to delete an accelerator. For
1165
- # more information, see [Authentication and Access Control][1] in the
1166
- # *AWS Global Accelerator Developer Guide*.
1252
+ # more information, see [Identity and access management][1] in the
1253
+ # *Global Accelerator Developer Guide*.
1167
1254
  #
1168
1255
  #
1169
1256
  #
@@ -1346,15 +1433,15 @@ module Aws::GlobalAccelerator
1346
1433
  end
1347
1434
 
1348
1435
  # Releases the specified address range that you provisioned to use with
1349
- # your AWS resources through bring your own IP addresses (BYOIP) and
1350
- # deletes the corresponding address pool.
1436
+ # your Amazon Web Services resources through bring your own IP addresses
1437
+ # (BYOIP) and deletes the corresponding address pool.
1351
1438
  #
1352
1439
  # Before you can release an address range, you must stop advertising it
1353
1440
  # by using [WithdrawByoipCidr][1] and you must not have any accelerators
1354
1441
  # that are using static IP addresses allocated from its address range.
1355
1442
  #
1356
- # For more information, see [Bring Your Own IP Addresses (BYOIP)][2] in
1357
- # the *AWS Global Accelerator Developer Guide*.
1443
+ # For more information, see [Bring your own IP addresses (BYOIP)][2] in
1444
+ # the *Global Accelerator Developer Guide*.
1358
1445
  #
1359
1446
  #
1360
1447
  #
@@ -1411,16 +1498,21 @@ module Aws::GlobalAccelerator
1411
1498
  #
1412
1499
  # resp.accelerator.accelerator_arn #=> String
1413
1500
  # resp.accelerator.name #=> String
1414
- # resp.accelerator.ip_address_type #=> String, one of "IPV4"
1501
+ # resp.accelerator.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
1415
1502
  # resp.accelerator.enabled #=> Boolean
1416
1503
  # resp.accelerator.ip_sets #=> Array
1417
1504
  # resp.accelerator.ip_sets[0].ip_family #=> String
1418
1505
  # resp.accelerator.ip_sets[0].ip_addresses #=> Array
1419
1506
  # resp.accelerator.ip_sets[0].ip_addresses[0] #=> String
1507
+ # resp.accelerator.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
1420
1508
  # resp.accelerator.dns_name #=> String
1421
1509
  # resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
1422
1510
  # resp.accelerator.created_time #=> Time
1423
1511
  # resp.accelerator.last_modified_time #=> Time
1512
+ # resp.accelerator.dual_stack_dns_name #=> String
1513
+ # resp.accelerator.events #=> Array
1514
+ # resp.accelerator.events[0].message #=> String
1515
+ # resp.accelerator.events[0].timestamp #=> Time
1424
1516
  #
1425
1517
  # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeAccelerator AWS API Documentation
1426
1518
  #
@@ -1481,12 +1573,13 @@ module Aws::GlobalAccelerator
1481
1573
  #
1482
1574
  # resp.accelerator.accelerator_arn #=> String
1483
1575
  # resp.accelerator.name #=> String
1484
- # resp.accelerator.ip_address_type #=> String, one of "IPV4"
1576
+ # resp.accelerator.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
1485
1577
  # resp.accelerator.enabled #=> Boolean
1486
1578
  # resp.accelerator.ip_sets #=> Array
1487
1579
  # resp.accelerator.ip_sets[0].ip_family #=> String
1488
1580
  # resp.accelerator.ip_sets[0].ip_addresses #=> Array
1489
1581
  # resp.accelerator.ip_sets[0].ip_addresses[0] #=> String
1582
+ # resp.accelerator.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
1490
1583
  # resp.accelerator.dns_name #=> String
1491
1584
  # resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
1492
1585
  # resp.accelerator.created_time #=> Time
@@ -1676,7 +1769,7 @@ module Aws::GlobalAccelerator
1676
1769
  req.send_request(options)
1677
1770
  end
1678
1771
 
1679
- # List the accelerators for an AWS account.
1772
+ # List the accelerators for an Amazon Web Services account.
1680
1773
  #
1681
1774
  # @option params [Integer] :max_results
1682
1775
  # The number of Global Accelerator objects that you want to return with
@@ -1705,16 +1798,21 @@ module Aws::GlobalAccelerator
1705
1798
  # resp.accelerators #=> Array
1706
1799
  # resp.accelerators[0].accelerator_arn #=> String
1707
1800
  # resp.accelerators[0].name #=> String
1708
- # resp.accelerators[0].ip_address_type #=> String, one of "IPV4"
1801
+ # resp.accelerators[0].ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
1709
1802
  # resp.accelerators[0].enabled #=> Boolean
1710
1803
  # resp.accelerators[0].ip_sets #=> Array
1711
1804
  # resp.accelerators[0].ip_sets[0].ip_family #=> String
1712
1805
  # resp.accelerators[0].ip_sets[0].ip_addresses #=> Array
1713
1806
  # resp.accelerators[0].ip_sets[0].ip_addresses[0] #=> String
1807
+ # resp.accelerators[0].ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
1714
1808
  # resp.accelerators[0].dns_name #=> String
1715
1809
  # resp.accelerators[0].status #=> String, one of "DEPLOYED", "IN_PROGRESS"
1716
1810
  # resp.accelerators[0].created_time #=> Time
1717
1811
  # resp.accelerators[0].last_modified_time #=> Time
1812
+ # resp.accelerators[0].dual_stack_dns_name #=> String
1813
+ # resp.accelerators[0].events #=> Array
1814
+ # resp.accelerators[0].events[0].message #=> String
1815
+ # resp.accelerators[0].events[0].timestamp #=> Time
1718
1816
  # resp.next_token #=> String
1719
1817
  #
1720
1818
  # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListAccelerators AWS API Documentation
@@ -1775,7 +1873,8 @@ module Aws::GlobalAccelerator
1775
1873
  req.send_request(options)
1776
1874
  end
1777
1875
 
1778
- # List the custom routing accelerators for an AWS account.
1876
+ # List the custom routing accelerators for an Amazon Web Services
1877
+ # account.
1779
1878
  #
1780
1879
  # @option params [Integer] :max_results
1781
1880
  # The number of custom routing Global Accelerator objects that you want
@@ -1804,12 +1903,13 @@ module Aws::GlobalAccelerator
1804
1903
  # resp.accelerators #=> Array
1805
1904
  # resp.accelerators[0].accelerator_arn #=> String
1806
1905
  # resp.accelerators[0].name #=> String
1807
- # resp.accelerators[0].ip_address_type #=> String, one of "IPV4"
1906
+ # resp.accelerators[0].ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
1808
1907
  # resp.accelerators[0].enabled #=> Boolean
1809
1908
  # resp.accelerators[0].ip_sets #=> Array
1810
1909
  # resp.accelerators[0].ip_sets[0].ip_family #=> String
1811
1910
  # resp.accelerators[0].ip_sets[0].ip_addresses #=> Array
1812
1911
  # resp.accelerators[0].ip_sets[0].ip_addresses[0] #=> String
1912
+ # resp.accelerators[0].ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
1813
1913
  # resp.accelerators[0].dns_name #=> String
1814
1914
  # resp.accelerators[0].status #=> String, one of "DEPLOYED", "IN_PROGRESS"
1815
1915
  # resp.accelerators[0].created_time #=> Time
@@ -2047,7 +2147,7 @@ module Aws::GlobalAccelerator
2047
2147
  # resp.destination_port_mappings[0].endpoint_group_region #=> String
2048
2148
  # resp.destination_port_mappings[0].destination_socket_address.ip_address #=> String
2049
2149
  # resp.destination_port_mappings[0].destination_socket_address.port #=> Integer
2050
- # resp.destination_port_mappings[0].ip_address_type #=> String, one of "IPV4"
2150
+ # resp.destination_port_mappings[0].ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
2051
2151
  # resp.destination_port_mappings[0].destination_traffic_state #=> String, one of "ALLOW", "DENY"
2052
2152
  # resp.next_token #=> String
2053
2153
  #
@@ -2170,8 +2270,8 @@ module Aws::GlobalAccelerator
2170
2270
 
2171
2271
  # List all tags for an accelerator.
2172
2272
  #
2173
- # For more information, see [Tagging in AWS Global Accelerator][1] in
2174
- # the *AWS Global Accelerator Developer Guide*.
2273
+ # For more information, see [Tagging in Global Accelerator][1] in the
2274
+ # *Global Accelerator Developer Guide*.
2175
2275
  #
2176
2276
  #
2177
2277
  #
@@ -2206,13 +2306,13 @@ module Aws::GlobalAccelerator
2206
2306
  req.send_request(options)
2207
2307
  end
2208
2308
 
2209
- # Provisions an IP address range to use with your AWS resources through
2210
- # bring your own IP addresses (BYOIP) and creates a corresponding
2211
- # address pool. After the address range is provisioned, it is ready to
2212
- # be advertised using [ AdvertiseByoipCidr][1].
2309
+ # Provisions an IP address range to use with your Amazon Web Services
2310
+ # resources through bring your own IP addresses (BYOIP) and creates a
2311
+ # corresponding address pool. After the address range is provisioned, it
2312
+ # is ready to be advertised using [ AdvertiseByoipCidr][1].
2213
2313
  #
2214
- # For more information, see [Bring Your Own IP Addresses (BYOIP)][2] in
2215
- # the *AWS Global Accelerator Developer Guide*.
2314
+ # For more information, see [Bring your own IP addresses (BYOIP)][2] in
2315
+ # the *Global Accelerator Developer Guide*.
2216
2316
  #
2217
2317
  #
2218
2318
  #
@@ -2288,10 +2388,61 @@ module Aws::GlobalAccelerator
2288
2388
  req.send_request(options)
2289
2389
  end
2290
2390
 
2391
+ # Remove endpoints from an endpoint group.
2392
+ #
2393
+ # The `RemoveEndpoints` API operation is the recommended option for
2394
+ # removing endpoints. The alternative is to remove endpoints by updating
2395
+ # an endpoint group by using the [UpdateEndpointGroup][1] API operation.
2396
+ # There are two advantages to using `AddEndpoints` to remove endpoints
2397
+ # instead:
2398
+ #
2399
+ # * It's more convenient, because you only need to specify the
2400
+ # endpoints that you want to remove. With the `UpdateEndpointGroup`
2401
+ # API operation, you must specify all of the endpoints in the endpoint
2402
+ # group except the ones that you want to remove from the group.
2403
+ #
2404
+ # * It's faster, because Global Accelerator doesn't need to resolve
2405
+ # any endpoints. With the `UpdateEndpointGroup` API operation, Global
2406
+ # Accelerator must resolve all of the endpoints that remain in the
2407
+ # group.
2408
+ #
2409
+ #
2410
+ #
2411
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html
2412
+ #
2413
+ # @option params [required, Array<Types::EndpointIdentifier>] :endpoint_identifiers
2414
+ # The identifiers of the endpoints that you want to remove.
2415
+ #
2416
+ # @option params [required, String] :endpoint_group_arn
2417
+ # The Amazon Resource Name (ARN) of the endpoint group.
2418
+ #
2419
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2420
+ #
2421
+ # @example Request syntax with placeholder values
2422
+ #
2423
+ # resp = client.remove_endpoints({
2424
+ # endpoint_identifiers: [ # required
2425
+ # {
2426
+ # endpoint_id: "GenericString", # required
2427
+ # client_ip_preservation_enabled: false,
2428
+ # },
2429
+ # ],
2430
+ # endpoint_group_arn: "GenericString", # required
2431
+ # })
2432
+ #
2433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/RemoveEndpoints AWS API Documentation
2434
+ #
2435
+ # @overload remove_endpoints(params = {})
2436
+ # @param [Hash] params ({})
2437
+ def remove_endpoints(params = {}, options = {})
2438
+ req = build_request(:remove_endpoints, params)
2439
+ req.send_request(options)
2440
+ end
2441
+
2291
2442
  # Add tags to an accelerator resource.
2292
2443
  #
2293
- # For more information, see [Tagging in AWS Global Accelerator][1] in
2294
- # the *AWS Global Accelerator Developer Guide*.
2444
+ # For more information, see [Tagging in Global Accelerator][1] in the
2445
+ # *Global Accelerator Developer Guide*.
2295
2446
  #
2296
2447
  #
2297
2448
  #
@@ -2333,8 +2484,8 @@ module Aws::GlobalAccelerator
2333
2484
  # operation succeeds even if you attempt to remove tags from an
2334
2485
  # accelerator that was already removed.
2335
2486
  #
2336
- # For more information, see [Tagging in AWS Global Accelerator][1] in
2337
- # the *AWS Global Accelerator Developer Guide*.
2487
+ # For more information, see [Tagging in Global Accelerator][1] in the
2488
+ # *Global Accelerator Developer Guide*.
2338
2489
  #
2339
2490
  #
2340
2491
  #
@@ -2369,19 +2520,22 @@ module Aws::GlobalAccelerator
2369
2520
  # Update an accelerator.
2370
2521
  #
2371
2522
  # Global Accelerator is a global service that supports endpoints in
2372
- # multiple AWS Regions but you must specify the US West (Oregon) Region
2373
- # to create or update accelerators.
2523
+ # multiple Amazon Web Services Regions but you must specify the US West
2524
+ # (Oregon) Region to create, update, or otherwise work with
2525
+ # accelerators. That is, for example, specify `--region us-west-2` on
2526
+ # AWS CLI commands.
2374
2527
  #
2375
2528
  # @option params [required, String] :accelerator_arn
2376
2529
  # The Amazon Resource Name (ARN) of the accelerator to update.
2377
2530
  #
2378
2531
  # @option params [String] :name
2379
- # The name of the accelerator. The name can have a maximum of 32
2380
- # characters, must contain only alphanumeric characters or hyphens (-),
2381
- # and must not begin or end with a hyphen.
2532
+ # The name of the accelerator. The name can have a maximum of 64
2533
+ # characters, must contain only alphanumeric characters, periods (.), or
2534
+ # hyphens (-), and must not begin or end with a hyphen or period.
2382
2535
  #
2383
2536
  # @option params [String] :ip_address_type
2384
- # The IP address type, which must be IPv4.
2537
+ # The IP address type that an accelerator supports. For a standard
2538
+ # accelerator, the value can be IPV4 or DUAL\_STACK.
2385
2539
  #
2386
2540
  # @option params [Boolean] :enabled
2387
2541
  # Indicates whether an accelerator is enabled. The value is true or
@@ -2399,7 +2553,7 @@ module Aws::GlobalAccelerator
2399
2553
  # resp = client.update_accelerator({
2400
2554
  # accelerator_arn: "GenericString", # required
2401
2555
  # name: "GenericString",
2402
- # ip_address_type: "IPV4", # accepts IPV4
2556
+ # ip_address_type: "IPV4", # accepts IPV4, DUAL_STACK
2403
2557
  # enabled: false,
2404
2558
  # })
2405
2559
  #
@@ -2407,16 +2561,21 @@ module Aws::GlobalAccelerator
2407
2561
  #
2408
2562
  # resp.accelerator.accelerator_arn #=> String
2409
2563
  # resp.accelerator.name #=> String
2410
- # resp.accelerator.ip_address_type #=> String, one of "IPV4"
2564
+ # resp.accelerator.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
2411
2565
  # resp.accelerator.enabled #=> Boolean
2412
2566
  # resp.accelerator.ip_sets #=> Array
2413
2567
  # resp.accelerator.ip_sets[0].ip_family #=> String
2414
2568
  # resp.accelerator.ip_sets[0].ip_addresses #=> Array
2415
2569
  # resp.accelerator.ip_sets[0].ip_addresses[0] #=> String
2570
+ # resp.accelerator.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
2416
2571
  # resp.accelerator.dns_name #=> String
2417
2572
  # resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
2418
2573
  # resp.accelerator.created_time #=> Time
2419
2574
  # resp.accelerator.last_modified_time #=> Time
2575
+ # resp.accelerator.dual_stack_dns_name #=> String
2576
+ # resp.accelerator.events #=> Array
2577
+ # resp.accelerator.events[0].message #=> String
2578
+ # resp.accelerator.events[0].timestamp #=> Time
2420
2579
  #
2421
2580
  # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateAccelerator AWS API Documentation
2422
2581
  #
@@ -2438,8 +2597,8 @@ module Aws::GlobalAccelerator
2438
2597
  # the value is true, `FlowLogsS3Bucket` and `FlowLogsS3Prefix` must be
2439
2598
  # specified.
2440
2599
  #
2441
- # For more information, see [Flow Logs][1] in the *AWS Global
2442
- # Accelerator Developer Guide*.
2600
+ # For more information, see [Flow Logs][1] in the *Global Accelerator
2601
+ # Developer Guide*.
2443
2602
  #
2444
2603
  #
2445
2604
  #
@@ -2448,17 +2607,15 @@ module Aws::GlobalAccelerator
2448
2607
  # @option params [String] :flow_logs_s3_bucket
2449
2608
  # The name of the Amazon S3 bucket for the flow logs. Attribute is
2450
2609
  # required if `FlowLogsEnabled` is `true`. The bucket must exist and
2451
- # have a bucket policy that grants AWS Global Accelerator permission to
2610
+ # have a bucket policy that grants Global Accelerator permission to
2452
2611
  # write to the bucket.
2453
2612
  #
2454
2613
  # @option params [String] :flow_logs_s3_prefix
2455
2614
  # Update the prefix for the location in the Amazon S3 bucket for the
2456
2615
  # flow logs. Attribute is required if `FlowLogsEnabled` is `true`.
2457
2616
  #
2458
- # If you don’t specify a prefix, the flow logs are stored in the root of
2459
- # the bucket. If you specify slash (/) for the S3 bucket prefix, the log
2460
- # file bucket folder structure will include a double slash (//), like
2461
- # the following:
2617
+ # If you specify slash (/) for the S3 bucket prefix, the log file bucket
2618
+ # folder structure will include a double slash (//), like the following:
2462
2619
  #
2463
2620
  # s3-bucket\_name//AWSLogs/aws\_account\_id
2464
2621
  #
@@ -2496,12 +2653,13 @@ module Aws::GlobalAccelerator
2496
2653
  # The Amazon Resource Name (ARN) of the accelerator to update.
2497
2654
  #
2498
2655
  # @option params [String] :name
2499
- # The name of the accelerator. The name can have a maximum of 32
2500
- # characters, must contain only alphanumeric characters or hyphens (-),
2501
- # and must not begin or end with a hyphen.
2656
+ # The name of the accelerator. The name can have a maximum of 64
2657
+ # characters, must contain only alphanumeric characters, periods (.), or
2658
+ # hyphens (-), and must not begin or end with a hyphen or period.
2502
2659
  #
2503
2660
  # @option params [String] :ip_address_type
2504
- # The value for the address type must be IPv4.
2661
+ # The IP address type that an accelerator supports. For a custom routing
2662
+ # accelerator, the value must be IPV4.
2505
2663
  #
2506
2664
  # @option params [Boolean] :enabled
2507
2665
  # Indicates whether an accelerator is enabled. The value is true or
@@ -2519,7 +2677,7 @@ module Aws::GlobalAccelerator
2519
2677
  # resp = client.update_custom_routing_accelerator({
2520
2678
  # accelerator_arn: "GenericString", # required
2521
2679
  # name: "GenericString",
2522
- # ip_address_type: "IPV4", # accepts IPV4
2680
+ # ip_address_type: "IPV4", # accepts IPV4, DUAL_STACK
2523
2681
  # enabled: false,
2524
2682
  # })
2525
2683
  #
@@ -2527,12 +2685,13 @@ module Aws::GlobalAccelerator
2527
2685
  #
2528
2686
  # resp.accelerator.accelerator_arn #=> String
2529
2687
  # resp.accelerator.name #=> String
2530
- # resp.accelerator.ip_address_type #=> String, one of "IPV4"
2688
+ # resp.accelerator.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
2531
2689
  # resp.accelerator.enabled #=> Boolean
2532
2690
  # resp.accelerator.ip_sets #=> Array
2533
2691
  # resp.accelerator.ip_sets[0].ip_family #=> String
2534
2692
  # resp.accelerator.ip_sets[0].ip_addresses #=> Array
2535
2693
  # resp.accelerator.ip_sets[0].ip_addresses[0] #=> String
2694
+ # resp.accelerator.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
2536
2695
  # resp.accelerator.dns_name #=> String
2537
2696
  # resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
2538
2697
  # resp.accelerator.created_time #=> Time
@@ -2558,8 +2717,8 @@ module Aws::GlobalAccelerator
2558
2717
  # the value is true, `FlowLogsS3Bucket` and `FlowLogsS3Prefix` must be
2559
2718
  # specified.
2560
2719
  #
2561
- # For more information, see [Flow Logs][1] in the *AWS Global
2562
- # Accelerator Developer Guide*.
2720
+ # For more information, see [Flow logs][1] in the *Global Accelerator
2721
+ # Developer Guide*.
2563
2722
  #
2564
2723
  #
2565
2724
  #
@@ -2568,7 +2727,7 @@ module Aws::GlobalAccelerator
2568
2727
  # @option params [String] :flow_logs_s3_bucket
2569
2728
  # The name of the Amazon S3 bucket for the flow logs. Attribute is
2570
2729
  # required if `FlowLogsEnabled` is `true`. The bucket must exist and
2571
- # have a bucket policy that grants AWS Global Accelerator permission to
2730
+ # have a bucket policy that grants Global Accelerator permission to
2572
2731
  # write to the bucket.
2573
2732
  #
2574
2733
  # @option params [String] :flow_logs_s3_prefix
@@ -2670,8 +2829,9 @@ module Aws::GlobalAccelerator
2670
2829
  # you add it as an endpoint.
2671
2830
  #
2672
2831
  # @option params [Float] :traffic_dial_percentage
2673
- # The percentage of traffic to send to an AWS Region. Additional traffic
2674
- # is distributed to other endpoint groups for this listener.
2832
+ # The percentage of traffic to send to an Amazon Web Services Region.
2833
+ # Additional traffic is distributed to other endpoint groups for this
2834
+ # listener.
2675
2835
  #
2676
2836
  # Use this action to increase (dial up) or decrease (dial down) traffic
2677
2837
  # to a specific Region. The percentage is applied to the traffic that
@@ -2681,14 +2841,14 @@ module Aws::GlobalAccelerator
2681
2841
  # The default value is 100.
2682
2842
  #
2683
2843
  # @option params [Integer] :health_check_port
2684
- # The port that AWS Global Accelerator uses to check the health of
2685
- # endpoints that are part of this endpoint group. The default port is
2686
- # the listener port that this endpoint group is associated with. If the
2687
- # listener port is a list of ports, Global Accelerator uses the first
2688
- # port in the list.
2844
+ # The port that Global Accelerator uses to check the health of endpoints
2845
+ # that are part of this endpoint group. The default port is the listener
2846
+ # port that this endpoint group is associated with. If the listener port
2847
+ # is a list of ports, Global Accelerator uses the first port in the
2848
+ # list.
2689
2849
  #
2690
2850
  # @option params [String] :health_check_protocol
2691
- # The protocol that AWS Global Accelerator uses to check the health of
2851
+ # The protocol that Global Accelerator uses to check the health of
2692
2852
  # endpoints that are part of this endpoint group. The default value is
2693
2853
  # TCP.
2694
2854
  #
@@ -2712,8 +2872,8 @@ module Aws::GlobalAccelerator
2712
2872
  # and 443, but your accelerator routes that traffic to ports 1080 and
2713
2873
  # 1443, respectively, on the endpoints.
2714
2874
  #
2715
- # For more information, see [ Port overrides][1] in the *AWS Global
2716
- # Accelerator Developer Guide*.
2875
+ # For more information, see [ Overriding listener ports][1] in the
2876
+ # *Global Accelerator Developer Guide*.
2717
2877
  #
2718
2878
  #
2719
2879
  #
@@ -2797,15 +2957,14 @@ module Aws::GlobalAccelerator
2797
2957
  # over whether to always route each client to the same specific
2798
2958
  # endpoint.
2799
2959
  #
2800
- # AWS Global Accelerator uses a consistent-flow hashing algorithm to
2801
- # choose the optimal endpoint for a connection. If client affinity is
2802
- # `NONE`, Global Accelerator uses the "five-tuple" (5-tuple)
2803
- # properties—source IP address, source port, destination IP address,
2804
- # destination port, and protocol—to select the hash value, and then
2805
- # chooses the best endpoint. However, with this setting, if someone uses
2806
- # different ports to connect to Global Accelerator, their connections
2807
- # might not be always routed to the same endpoint because the hash value
2808
- # changes.
2960
+ # Global Accelerator uses a consistent-flow hashing algorithm to choose
2961
+ # the optimal endpoint for a connection. If client affinity is `NONE`,
2962
+ # Global Accelerator uses the "five-tuple" (5-tuple) properties—source
2963
+ # IP address, source port, destination IP address, destination port, and
2964
+ # protocol—to select the hash value, and then chooses the best endpoint.
2965
+ # However, with this setting, if someone uses different ports to connect
2966
+ # to Global Accelerator, their connections might not be always routed to
2967
+ # the same endpoint because the hash value changes.
2809
2968
  #
2810
2969
  # If you want a given client to always be routed to the same endpoint,
2811
2970
  # set client affinity to `SOURCE_IP` instead. When you use the
@@ -2856,10 +3015,10 @@ module Aws::GlobalAccelerator
2856
3015
  # even if you specify different address ranges each time.
2857
3016
  #
2858
3017
  # It can take a few minutes before traffic to the specified addresses
2859
- # stops routing to AWS because of propagation delays.
3018
+ # stops routing to Amazon Web Services because of propagation delays.
2860
3019
  #
2861
- # For more information, see [Bring Your Own IP Addresses (BYOIP)][1] in
2862
- # the *AWS Global Accelerator Developer Guide*.
3020
+ # For more information, see [Bring your own IP addresses (BYOIP)][1] in
3021
+ # the *Global Accelerator Developer Guide*.
2863
3022
  #
2864
3023
  #
2865
3024
  #
@@ -2908,7 +3067,7 @@ module Aws::GlobalAccelerator
2908
3067
  params: params,
2909
3068
  config: config)
2910
3069
  context[:gem_name] = 'aws-sdk-globalaccelerator'
2911
- context[:gem_version] = '1.39.0'
3070
+ context[:gem_version] = '1.41.0'
2912
3071
  Seahorse::Client::Request.new(handlers, context)
2913
3072
  end
2914
3073