Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- AcceleratorNotDisabledException
- AcceleratorNotFoundException
- AccessDeniedException
- AssociatedEndpointGroupFoundException
- AssociatedListenerFoundException
- ByoipCidrNotFoundException
- ConflictException
- EndpointAlreadyExistsException
- EndpointGroupAlreadyExistsException
- EndpointGroupNotFoundException
- EndpointNotFoundException
- IncorrectCidrStateException
- InternalServiceErrorException
- InvalidArgumentException
- InvalidNextTokenException
- InvalidPortRangeException
- LimitExceededException
- ListenerNotFoundException
- TransactionInProgressException
- Waiters
- Operations
- AddCustomRoutingEndpoints
- AddEndpoints
- AdvertiseByoipCidr
- AllowCustomRoutingTraffic
- CreateAccelerator
- CreateCustomRoutingAccelerator
- CreateCustomRoutingEndpointGroup
- CreateCustomRoutingListener
- CreateEndpointGroup
- CreateListener
- DeleteAccelerator
- DeleteCustomRoutingAccelerator
- DeleteCustomRoutingEndpointGroup
- DeleteCustomRoutingListener
- DeleteEndpointGroup
- DeleteListener
- DenyCustomRoutingTraffic
- DeprovisionByoipCidr
- DescribeAccelerator
- DescribeAcceleratorAttributes
- DescribeCustomRoutingAccelerator
- DescribeCustomRoutingAcceleratorAttributes
- DescribeCustomRoutingEndpointGroup
- DescribeCustomRoutingListener
- DescribeEndpointGroup
- DescribeListener
- ListAccelerators (Paginated)
- ListByoipCidrs (Paginated)
- ListCustomRoutingAccelerators (Paginated)
- ListCustomRoutingEndpointGroups
- ListCustomRoutingListeners (Paginated)
- ListCustomRoutingPortMappings (Paginated)
- ListCustomRoutingPortMappingsByDestination (Paginated)
- ListEndpointGroups (Paginated)
- ListListeners (Paginated)
- ListTagsForResource
- ProvisionByoipCidr
- RemoveCustomRoutingEndpoints
- RemoveEndpoints
- TagResource
- UntagResource
- UpdateAccelerator
- UpdateAcceleratorAttributes
- UpdateCustomRoutingAccelerator
- UpdateCustomRoutingAcceleratorAttributes
- UpdateCustomRoutingListener
- UpdateEndpointGroup
- UpdateListener
- WithdrawByoipCidr
- Types
- AcceleratorStatus
- ByoipCidrState
- ClientAffinity
- CustomRoutingAcceleratorStatus
- CustomRoutingDestinationTrafficState
- CustomRoutingProtocol
- HealthCheckProtocol
- HealthState
- IpAddressFamily
- IpAddressType
- Protocol
- Accelerator
- AcceleratorAttributes
- AcceleratorEvent
- ByoipCidr
- ByoipCidrEvent
- CidrAuthorizationContext
- CustomRoutingAccelerator
- CustomRoutingAcceleratorAttributes
- CustomRoutingDestinationConfiguration
- CustomRoutingDestinationDescription
- CustomRoutingEndpointConfiguration
- CustomRoutingEndpointDescription
- CustomRoutingEndpointGroup
- CustomRoutingListener
- DestinationPortMapping
- EndpointConfiguration
- EndpointDescription
- EndpointGroup
- EndpointIdentifier
- IpSet
- Listener
- PortMapping
- PortOverride
- PortRange
- SocketAddress
- Tag
Derived from API version 2018-08-08
of the AWS service descriptions, licensed under Apache 2.0.
Global Accelerator
This is the Global Accelerator API Reference. This guide is for developers who need detailed information about Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the Global Accelerator Developer Guide.
Global Accelerator is a service in which you create accelerators to improve the performance of your applications for local and global users. Depending on the type of accelerator you choose, you can gain additional benefits.
- By using a standard accelerator, you can improve availability of your internet applications that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services global network.
- For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you can use application logic to directly map one or more users to a specific endpoint among many endpoints.
Global Accelerator is a global service that supports endpoints in
multiple Amazon Web Services Regions but you must specify the US West
(Oregon) Region to create, update, or otherwise work with accelerators.
That is, for example, specify --region us-west-2
on AWS CLI commands.
By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack, Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP).
For a standard accelerator, they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that are virtual private cloud (VPC) subnets.
The static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. You can use IAM policies like tag-based permissions with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Tag-based policies.
For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is always directed to healthy endpoints.
For more information about understanding and using Global Accelerator, see the Global Accelerator Developer Guide.
Synopsis
- defaultService :: Service
- _AcceleratorNotDisabledException :: AsError a => Fold a ServiceError
- _AcceleratorNotFoundException :: AsError a => Fold a ServiceError
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _AssociatedEndpointGroupFoundException :: AsError a => Fold a ServiceError
- _AssociatedListenerFoundException :: AsError a => Fold a ServiceError
- _ByoipCidrNotFoundException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _EndpointAlreadyExistsException :: AsError a => Fold a ServiceError
- _EndpointGroupAlreadyExistsException :: AsError a => Fold a ServiceError
- _EndpointGroupNotFoundException :: AsError a => Fold a ServiceError
- _EndpointNotFoundException :: AsError a => Fold a ServiceError
- _IncorrectCidrStateException :: AsError a => Fold a ServiceError
- _InternalServiceErrorException :: AsError a => Fold a ServiceError
- _InvalidArgumentException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidPortRangeException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ListenerNotFoundException :: AsError a => Fold a ServiceError
- _TransactionInProgressException :: AsError a => Fold a ServiceError
- data AddCustomRoutingEndpoints = AddCustomRoutingEndpoints' (NonEmpty CustomRoutingEndpointConfiguration) Text
- newAddCustomRoutingEndpoints :: NonEmpty CustomRoutingEndpointConfiguration -> Text -> AddCustomRoutingEndpoints
- data AddCustomRoutingEndpointsResponse = AddCustomRoutingEndpointsResponse' (Maybe [CustomRoutingEndpointDescription]) (Maybe Text) Int
- newAddCustomRoutingEndpointsResponse :: Int -> AddCustomRoutingEndpointsResponse
- data AddEndpoints = AddEndpoints' [EndpointConfiguration] Text
- newAddEndpoints :: Text -> AddEndpoints
- data AddEndpointsResponse = AddEndpointsResponse' (Maybe [EndpointDescription]) (Maybe Text) Int
- newAddEndpointsResponse :: Int -> AddEndpointsResponse
- data AdvertiseByoipCidr = AdvertiseByoipCidr' Text
- newAdvertiseByoipCidr :: Text -> AdvertiseByoipCidr
- data AdvertiseByoipCidrResponse = AdvertiseByoipCidrResponse' (Maybe ByoipCidr) Int
- newAdvertiseByoipCidrResponse :: Int -> AdvertiseByoipCidrResponse
- data AllowCustomRoutingTraffic = AllowCustomRoutingTraffic' (Maybe Bool) (Maybe [Text]) (Maybe [Natural]) Text Text
- newAllowCustomRoutingTraffic :: Text -> Text -> AllowCustomRoutingTraffic
- data AllowCustomRoutingTrafficResponse = AllowCustomRoutingTrafficResponse' {
- newAllowCustomRoutingTrafficResponse :: AllowCustomRoutingTrafficResponse
- data CreateAccelerator = CreateAccelerator' (Maybe Bool) (Maybe IpAddressType) (Maybe [Text]) (Maybe [Tag]) Text Text
- newCreateAccelerator :: Text -> Text -> CreateAccelerator
- data CreateAcceleratorResponse = CreateAcceleratorResponse' (Maybe Accelerator) Int
- newCreateAcceleratorResponse :: Int -> CreateAcceleratorResponse
- data CreateCustomRoutingAccelerator = CreateCustomRoutingAccelerator' (Maybe Bool) (Maybe IpAddressType) (Maybe [Text]) (Maybe [Tag]) Text Text
- newCreateCustomRoutingAccelerator :: Text -> Text -> CreateCustomRoutingAccelerator
- data CreateCustomRoutingAcceleratorResponse = CreateCustomRoutingAcceleratorResponse' (Maybe CustomRoutingAccelerator) Int
- newCreateCustomRoutingAcceleratorResponse :: Int -> CreateCustomRoutingAcceleratorResponse
- data CreateCustomRoutingEndpointGroup = CreateCustomRoutingEndpointGroup' Text Text (NonEmpty CustomRoutingDestinationConfiguration) Text
- newCreateCustomRoutingEndpointGroup :: Text -> Text -> NonEmpty CustomRoutingDestinationConfiguration -> Text -> CreateCustomRoutingEndpointGroup
- data CreateCustomRoutingEndpointGroupResponse = CreateCustomRoutingEndpointGroupResponse' (Maybe CustomRoutingEndpointGroup) Int
- newCreateCustomRoutingEndpointGroupResponse :: Int -> CreateCustomRoutingEndpointGroupResponse
- data CreateCustomRoutingListener = CreateCustomRoutingListener' Text (NonEmpty PortRange) Text
- newCreateCustomRoutingListener :: Text -> NonEmpty PortRange -> Text -> CreateCustomRoutingListener
- data CreateCustomRoutingListenerResponse = CreateCustomRoutingListenerResponse' (Maybe CustomRoutingListener) Int
- newCreateCustomRoutingListenerResponse :: Int -> CreateCustomRoutingListenerResponse
- data CreateEndpointGroup = CreateEndpointGroup' (Maybe [EndpointConfiguration]) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe HealthCheckProtocol) (Maybe [PortOverride]) (Maybe Natural) (Maybe Double) Text Text Text
- newCreateEndpointGroup :: Text -> Text -> Text -> CreateEndpointGroup
- data CreateEndpointGroupResponse = CreateEndpointGroupResponse' (Maybe EndpointGroup) Int
- newCreateEndpointGroupResponse :: Int -> CreateEndpointGroupResponse
- data CreateListener = CreateListener' (Maybe ClientAffinity) Text (NonEmpty PortRange) Protocol Text
- newCreateListener :: Text -> NonEmpty PortRange -> Protocol -> Text -> CreateListener
- data CreateListenerResponse = CreateListenerResponse' (Maybe Listener) Int
- newCreateListenerResponse :: Int -> CreateListenerResponse
- data DeleteAccelerator = DeleteAccelerator' Text
- newDeleteAccelerator :: Text -> DeleteAccelerator
- data DeleteAcceleratorResponse = DeleteAcceleratorResponse' {
- newDeleteAcceleratorResponse :: DeleteAcceleratorResponse
- data DeleteCustomRoutingAccelerator = DeleteCustomRoutingAccelerator' Text
- newDeleteCustomRoutingAccelerator :: Text -> DeleteCustomRoutingAccelerator
- data DeleteCustomRoutingAcceleratorResponse = DeleteCustomRoutingAcceleratorResponse' {
- newDeleteCustomRoutingAcceleratorResponse :: DeleteCustomRoutingAcceleratorResponse
- data DeleteCustomRoutingEndpointGroup = DeleteCustomRoutingEndpointGroup' Text
- newDeleteCustomRoutingEndpointGroup :: Text -> DeleteCustomRoutingEndpointGroup
- data DeleteCustomRoutingEndpointGroupResponse = DeleteCustomRoutingEndpointGroupResponse' {
- newDeleteCustomRoutingEndpointGroupResponse :: DeleteCustomRoutingEndpointGroupResponse
- data DeleteCustomRoutingListener = DeleteCustomRoutingListener' Text
- newDeleteCustomRoutingListener :: Text -> DeleteCustomRoutingListener
- data DeleteCustomRoutingListenerResponse = DeleteCustomRoutingListenerResponse' {
- newDeleteCustomRoutingListenerResponse :: DeleteCustomRoutingListenerResponse
- data DeleteEndpointGroup = DeleteEndpointGroup' Text
- newDeleteEndpointGroup :: Text -> DeleteEndpointGroup
- data DeleteEndpointGroupResponse = DeleteEndpointGroupResponse' {
- newDeleteEndpointGroupResponse :: DeleteEndpointGroupResponse
- data DeleteListener = DeleteListener' Text
- newDeleteListener :: Text -> DeleteListener
- data DeleteListenerResponse = DeleteListenerResponse' {
- newDeleteListenerResponse :: DeleteListenerResponse
- data DenyCustomRoutingTraffic = DenyCustomRoutingTraffic' (Maybe Bool) (Maybe [Text]) (Maybe [Natural]) Text Text
- newDenyCustomRoutingTraffic :: Text -> Text -> DenyCustomRoutingTraffic
- data DenyCustomRoutingTrafficResponse = DenyCustomRoutingTrafficResponse' {
- newDenyCustomRoutingTrafficResponse :: DenyCustomRoutingTrafficResponse
- data DeprovisionByoipCidr = DeprovisionByoipCidr' Text
- newDeprovisionByoipCidr :: Text -> DeprovisionByoipCidr
- data DeprovisionByoipCidrResponse = DeprovisionByoipCidrResponse' (Maybe ByoipCidr) Int
- newDeprovisionByoipCidrResponse :: Int -> DeprovisionByoipCidrResponse
- data DescribeAccelerator = DescribeAccelerator' Text
- newDescribeAccelerator :: Text -> DescribeAccelerator
- data DescribeAcceleratorResponse = DescribeAcceleratorResponse' (Maybe Accelerator) Int
- newDescribeAcceleratorResponse :: Int -> DescribeAcceleratorResponse
- data DescribeAcceleratorAttributes = DescribeAcceleratorAttributes' Text
- newDescribeAcceleratorAttributes :: Text -> DescribeAcceleratorAttributes
- data DescribeAcceleratorAttributesResponse = DescribeAcceleratorAttributesResponse' (Maybe AcceleratorAttributes) Int
- newDescribeAcceleratorAttributesResponse :: Int -> DescribeAcceleratorAttributesResponse
- data DescribeCustomRoutingAccelerator = DescribeCustomRoutingAccelerator' Text
- newDescribeCustomRoutingAccelerator :: Text -> DescribeCustomRoutingAccelerator
- data DescribeCustomRoutingAcceleratorResponse = DescribeCustomRoutingAcceleratorResponse' (Maybe CustomRoutingAccelerator) Int
- newDescribeCustomRoutingAcceleratorResponse :: Int -> DescribeCustomRoutingAcceleratorResponse
- data DescribeCustomRoutingAcceleratorAttributes = DescribeCustomRoutingAcceleratorAttributes' Text
- newDescribeCustomRoutingAcceleratorAttributes :: Text -> DescribeCustomRoutingAcceleratorAttributes
- data DescribeCustomRoutingAcceleratorAttributesResponse = DescribeCustomRoutingAcceleratorAttributesResponse' (Maybe CustomRoutingAcceleratorAttributes) Int
- newDescribeCustomRoutingAcceleratorAttributesResponse :: Int -> DescribeCustomRoutingAcceleratorAttributesResponse
- data DescribeCustomRoutingEndpointGroup = DescribeCustomRoutingEndpointGroup' Text
- newDescribeCustomRoutingEndpointGroup :: Text -> DescribeCustomRoutingEndpointGroup
- data DescribeCustomRoutingEndpointGroupResponse = DescribeCustomRoutingEndpointGroupResponse' (Maybe CustomRoutingEndpointGroup) Int
- newDescribeCustomRoutingEndpointGroupResponse :: Int -> DescribeCustomRoutingEndpointGroupResponse
- data DescribeCustomRoutingListener = DescribeCustomRoutingListener' Text
- newDescribeCustomRoutingListener :: Text -> DescribeCustomRoutingListener
- data DescribeCustomRoutingListenerResponse = DescribeCustomRoutingListenerResponse' (Maybe CustomRoutingListener) Int
- newDescribeCustomRoutingListenerResponse :: Int -> DescribeCustomRoutingListenerResponse
- data DescribeEndpointGroup = DescribeEndpointGroup' Text
- newDescribeEndpointGroup :: Text -> DescribeEndpointGroup
- data DescribeEndpointGroupResponse = DescribeEndpointGroupResponse' (Maybe EndpointGroup) Int
- newDescribeEndpointGroupResponse :: Int -> DescribeEndpointGroupResponse
- data DescribeListener = DescribeListener' Text
- newDescribeListener :: Text -> DescribeListener
- data DescribeListenerResponse = DescribeListenerResponse' (Maybe Listener) Int
- newDescribeListenerResponse :: Int -> DescribeListenerResponse
- data ListAccelerators = ListAccelerators' (Maybe Natural) (Maybe Text)
- newListAccelerators :: ListAccelerators
- data ListAcceleratorsResponse = ListAcceleratorsResponse' (Maybe [Accelerator]) (Maybe Text) Int
- newListAcceleratorsResponse :: Int -> ListAcceleratorsResponse
- data ListByoipCidrs = ListByoipCidrs' (Maybe Natural) (Maybe Text)
- newListByoipCidrs :: ListByoipCidrs
- data ListByoipCidrsResponse = ListByoipCidrsResponse' (Maybe [ByoipCidr]) (Maybe Text) Int
- newListByoipCidrsResponse :: Int -> ListByoipCidrsResponse
- data ListCustomRoutingAccelerators = ListCustomRoutingAccelerators' (Maybe Natural) (Maybe Text)
- newListCustomRoutingAccelerators :: ListCustomRoutingAccelerators
- data ListCustomRoutingAcceleratorsResponse = ListCustomRoutingAcceleratorsResponse' (Maybe [CustomRoutingAccelerator]) (Maybe Text) Int
- newListCustomRoutingAcceleratorsResponse :: Int -> ListCustomRoutingAcceleratorsResponse
- data ListCustomRoutingEndpointGroups = ListCustomRoutingEndpointGroups' (Maybe Natural) (Maybe Text) Text
- newListCustomRoutingEndpointGroups :: Text -> ListCustomRoutingEndpointGroups
- data ListCustomRoutingEndpointGroupsResponse = ListCustomRoutingEndpointGroupsResponse' (Maybe [CustomRoutingEndpointGroup]) (Maybe Text) Int
- newListCustomRoutingEndpointGroupsResponse :: Int -> ListCustomRoutingEndpointGroupsResponse
- data ListCustomRoutingListeners = ListCustomRoutingListeners' (Maybe Natural) (Maybe Text) Text
- newListCustomRoutingListeners :: Text -> ListCustomRoutingListeners
- data ListCustomRoutingListenersResponse = ListCustomRoutingListenersResponse' (Maybe [CustomRoutingListener]) (Maybe Text) Int
- newListCustomRoutingListenersResponse :: Int -> ListCustomRoutingListenersResponse
- data ListCustomRoutingPortMappings = ListCustomRoutingPortMappings' (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newListCustomRoutingPortMappings :: Text -> ListCustomRoutingPortMappings
- data ListCustomRoutingPortMappingsResponse = ListCustomRoutingPortMappingsResponse' (Maybe Text) (Maybe [PortMapping]) Int
- newListCustomRoutingPortMappingsResponse :: Int -> ListCustomRoutingPortMappingsResponse
- data ListCustomRoutingPortMappingsByDestination = ListCustomRoutingPortMappingsByDestination' (Maybe Natural) (Maybe Text) Text Text
- newListCustomRoutingPortMappingsByDestination :: Text -> Text -> ListCustomRoutingPortMappingsByDestination
- data ListCustomRoutingPortMappingsByDestinationResponse = ListCustomRoutingPortMappingsByDestinationResponse' (Maybe [DestinationPortMapping]) (Maybe Text) Int
- newListCustomRoutingPortMappingsByDestinationResponse :: Int -> ListCustomRoutingPortMappingsByDestinationResponse
- data ListEndpointGroups = ListEndpointGroups' (Maybe Natural) (Maybe Text) Text
- newListEndpointGroups :: Text -> ListEndpointGroups
- data ListEndpointGroupsResponse = ListEndpointGroupsResponse' (Maybe [EndpointGroup]) (Maybe Text) Int
- newListEndpointGroupsResponse :: Int -> ListEndpointGroupsResponse
- data ListListeners = ListListeners' (Maybe Natural) (Maybe Text) Text
- newListListeners :: Text -> ListListeners
- data ListListenersResponse = ListListenersResponse' (Maybe [Listener]) (Maybe Text) Int
- newListListenersResponse :: Int -> ListListenersResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ProvisionByoipCidr = ProvisionByoipCidr' Text CidrAuthorizationContext
- newProvisionByoipCidr :: Text -> CidrAuthorizationContext -> ProvisionByoipCidr
- data ProvisionByoipCidrResponse = ProvisionByoipCidrResponse' (Maybe ByoipCidr) Int
- newProvisionByoipCidrResponse :: Int -> ProvisionByoipCidrResponse
- data RemoveCustomRoutingEndpoints = RemoveCustomRoutingEndpoints' [Text] Text
- newRemoveCustomRoutingEndpoints :: Text -> RemoveCustomRoutingEndpoints
- data RemoveCustomRoutingEndpointsResponse = RemoveCustomRoutingEndpointsResponse' {
- newRemoveCustomRoutingEndpointsResponse :: RemoveCustomRoutingEndpointsResponse
- data RemoveEndpoints = RemoveEndpoints' (NonEmpty EndpointIdentifier) Text
- newRemoveEndpoints :: NonEmpty EndpointIdentifier -> Text -> RemoveEndpoints
- data RemoveEndpointsResponse = RemoveEndpointsResponse' {
- newRemoveEndpointsResponse :: RemoveEndpointsResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateAccelerator = UpdateAccelerator' (Maybe Bool) (Maybe IpAddressType) (Maybe Text) Text
- newUpdateAccelerator :: Text -> UpdateAccelerator
- data UpdateAcceleratorResponse = UpdateAcceleratorResponse' (Maybe Accelerator) Int
- newUpdateAcceleratorResponse :: Int -> UpdateAcceleratorResponse
- data UpdateAcceleratorAttributes = UpdateAcceleratorAttributes' (Maybe Bool) (Maybe Text) (Maybe Text) Text
- newUpdateAcceleratorAttributes :: Text -> UpdateAcceleratorAttributes
- data UpdateAcceleratorAttributesResponse = UpdateAcceleratorAttributesResponse' (Maybe AcceleratorAttributes) Int
- newUpdateAcceleratorAttributesResponse :: Int -> UpdateAcceleratorAttributesResponse
- data UpdateCustomRoutingAccelerator = UpdateCustomRoutingAccelerator' (Maybe Bool) (Maybe IpAddressType) (Maybe Text) Text
- newUpdateCustomRoutingAccelerator :: Text -> UpdateCustomRoutingAccelerator
- data UpdateCustomRoutingAcceleratorResponse = UpdateCustomRoutingAcceleratorResponse' (Maybe CustomRoutingAccelerator) Int
- newUpdateCustomRoutingAcceleratorResponse :: Int -> UpdateCustomRoutingAcceleratorResponse
- data UpdateCustomRoutingAcceleratorAttributes = UpdateCustomRoutingAcceleratorAttributes' (Maybe Bool) (Maybe Text) (Maybe Text) Text
- newUpdateCustomRoutingAcceleratorAttributes :: Text -> UpdateCustomRoutingAcceleratorAttributes
- data UpdateCustomRoutingAcceleratorAttributesResponse = UpdateCustomRoutingAcceleratorAttributesResponse' (Maybe CustomRoutingAcceleratorAttributes) Int
- newUpdateCustomRoutingAcceleratorAttributesResponse :: Int -> UpdateCustomRoutingAcceleratorAttributesResponse
- data UpdateCustomRoutingListener = UpdateCustomRoutingListener' Text (NonEmpty PortRange)
- newUpdateCustomRoutingListener :: Text -> NonEmpty PortRange -> UpdateCustomRoutingListener
- data UpdateCustomRoutingListenerResponse = UpdateCustomRoutingListenerResponse' (Maybe CustomRoutingListener) Int
- newUpdateCustomRoutingListenerResponse :: Int -> UpdateCustomRoutingListenerResponse
- data UpdateEndpointGroup = UpdateEndpointGroup' (Maybe [EndpointConfiguration]) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe HealthCheckProtocol) (Maybe [PortOverride]) (Maybe Natural) (Maybe Double) Text
- newUpdateEndpointGroup :: Text -> UpdateEndpointGroup
- data UpdateEndpointGroupResponse = UpdateEndpointGroupResponse' (Maybe EndpointGroup) Int
- newUpdateEndpointGroupResponse :: Int -> UpdateEndpointGroupResponse
- data UpdateListener = UpdateListener' (Maybe ClientAffinity) (Maybe (NonEmpty PortRange)) (Maybe Protocol) Text
- newUpdateListener :: Text -> UpdateListener
- data UpdateListenerResponse = UpdateListenerResponse' (Maybe Listener) Int
- newUpdateListenerResponse :: Int -> UpdateListenerResponse
- data WithdrawByoipCidr = WithdrawByoipCidr' Text
- newWithdrawByoipCidr :: Text -> WithdrawByoipCidr
- data WithdrawByoipCidrResponse = WithdrawByoipCidrResponse' (Maybe ByoipCidr) Int
- newWithdrawByoipCidrResponse :: Int -> WithdrawByoipCidrResponse
- newtype AcceleratorStatus where
- AcceleratorStatus' { }
- pattern AcceleratorStatus_DEPLOYED :: AcceleratorStatus
- pattern AcceleratorStatus_IN_PROGRESS :: AcceleratorStatus
- newtype ByoipCidrState where
- ByoipCidrState' { }
- pattern ByoipCidrState_ADVERTISING :: ByoipCidrState
- pattern ByoipCidrState_DEPROVISIONED :: ByoipCidrState
- pattern ByoipCidrState_FAILED_ADVERTISING :: ByoipCidrState
- pattern ByoipCidrState_FAILED_DEPROVISION :: ByoipCidrState
- pattern ByoipCidrState_FAILED_PROVISION :: ByoipCidrState
- pattern ByoipCidrState_FAILED_WITHDRAW :: ByoipCidrState
- pattern ByoipCidrState_PENDING_ADVERTISING :: ByoipCidrState
- pattern ByoipCidrState_PENDING_DEPROVISIONING :: ByoipCidrState
- pattern ByoipCidrState_PENDING_PROVISIONING :: ByoipCidrState
- pattern ByoipCidrState_PENDING_WITHDRAWING :: ByoipCidrState
- pattern ByoipCidrState_READY :: ByoipCidrState
- newtype ClientAffinity where
- ClientAffinity' { }
- pattern ClientAffinity_NONE :: ClientAffinity
- pattern ClientAffinity_SOURCE_IP :: ClientAffinity
- newtype CustomRoutingAcceleratorStatus where
- newtype CustomRoutingDestinationTrafficState where
- newtype CustomRoutingProtocol where
- newtype HealthCheckProtocol where
- HealthCheckProtocol' { }
- pattern HealthCheckProtocol_HTTP :: HealthCheckProtocol
- pattern HealthCheckProtocol_HTTPS :: HealthCheckProtocol
- pattern HealthCheckProtocol_TCP :: HealthCheckProtocol
- newtype HealthState where
- HealthState' { }
- pattern HealthState_HEALTHY :: HealthState
- pattern HealthState_INITIAL :: HealthState
- pattern HealthState_UNHEALTHY :: HealthState
- newtype IpAddressFamily where
- IpAddressFamily' { }
- pattern IpAddressFamily_IPv4 :: IpAddressFamily
- pattern IpAddressFamily_IPv6 :: IpAddressFamily
- newtype IpAddressType where
- IpAddressType' { }
- pattern IpAddressType_DUAL_STACK :: IpAddressType
- pattern IpAddressType_IPV4 :: IpAddressType
- newtype Protocol where
- Protocol' {
- fromProtocol :: Text
- pattern Protocol_TCP :: Protocol
- pattern Protocol_UDP :: Protocol
- Protocol' {
- data Accelerator = Accelerator' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [AcceleratorEvent]) (Maybe IpAddressType) (Maybe [IpSet]) (Maybe POSIX) (Maybe Text) (Maybe AcceleratorStatus)
- newAccelerator :: Accelerator
- data AcceleratorAttributes = AcceleratorAttributes' (Maybe Bool) (Maybe Text) (Maybe Text)
- newAcceleratorAttributes :: AcceleratorAttributes
- data AcceleratorEvent = AcceleratorEvent' (Maybe Text) (Maybe POSIX)
- newAcceleratorEvent :: AcceleratorEvent
- data ByoipCidr = ByoipCidr' (Maybe Text) (Maybe [ByoipCidrEvent]) (Maybe ByoipCidrState)
- newByoipCidr :: ByoipCidr
- data ByoipCidrEvent = ByoipCidrEvent' (Maybe Text) (Maybe POSIX)
- newByoipCidrEvent :: ByoipCidrEvent
- data CidrAuthorizationContext = CidrAuthorizationContext' Text Text
- newCidrAuthorizationContext :: Text -> Text -> CidrAuthorizationContext
- data CustomRoutingAccelerator = CustomRoutingAccelerator' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe IpAddressType) (Maybe [IpSet]) (Maybe POSIX) (Maybe Text) (Maybe CustomRoutingAcceleratorStatus)
- newCustomRoutingAccelerator :: CustomRoutingAccelerator
- data CustomRoutingAcceleratorAttributes = CustomRoutingAcceleratorAttributes' (Maybe Bool) (Maybe Text) (Maybe Text)
- newCustomRoutingAcceleratorAttributes :: CustomRoutingAcceleratorAttributes
- data CustomRoutingDestinationConfiguration = CustomRoutingDestinationConfiguration' Natural Natural (NonEmpty CustomRoutingProtocol)
- newCustomRoutingDestinationConfiguration :: Natural -> Natural -> NonEmpty CustomRoutingProtocol -> CustomRoutingDestinationConfiguration
- data CustomRoutingDestinationDescription = CustomRoutingDestinationDescription' (Maybe Natural) (Maybe [Protocol]) (Maybe Natural)
- newCustomRoutingDestinationDescription :: CustomRoutingDestinationDescription
- data CustomRoutingEndpointConfiguration = CustomRoutingEndpointConfiguration' (Maybe Text)
- newCustomRoutingEndpointConfiguration :: CustomRoutingEndpointConfiguration
- data CustomRoutingEndpointDescription = CustomRoutingEndpointDescription' (Maybe Text)
- newCustomRoutingEndpointDescription :: CustomRoutingEndpointDescription
- data CustomRoutingEndpointGroup = CustomRoutingEndpointGroup' (Maybe [CustomRoutingDestinationDescription]) (Maybe [CustomRoutingEndpointDescription]) (Maybe Text) (Maybe Text)
- newCustomRoutingEndpointGroup :: CustomRoutingEndpointGroup
- data CustomRoutingListener = CustomRoutingListener' (Maybe Text) (Maybe (NonEmpty PortRange))
- newCustomRoutingListener :: CustomRoutingListener
- data DestinationPortMapping = DestinationPortMapping' (Maybe Text) (Maybe [SocketAddress]) (Maybe SocketAddress) (Maybe CustomRoutingDestinationTrafficState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IpAddressType)
- newDestinationPortMapping :: DestinationPortMapping
- data EndpointConfiguration = EndpointConfiguration' (Maybe Bool) (Maybe Text) (Maybe Natural)
- newEndpointConfiguration :: EndpointConfiguration
- data EndpointDescription = EndpointDescription' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe HealthState) (Maybe Natural)
- newEndpointDescription :: EndpointDescription
- data EndpointGroup = EndpointGroup' (Maybe [EndpointDescription]) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe HealthCheckProtocol) (Maybe [PortOverride]) (Maybe Natural) (Maybe Double)
- newEndpointGroup :: EndpointGroup
- data EndpointIdentifier = EndpointIdentifier' (Maybe Bool) Text
- newEndpointIdentifier :: Text -> EndpointIdentifier
- data IpSet = IpSet' (Maybe IpAddressFamily) (Maybe [Text]) (Maybe Text)
- newIpSet :: IpSet
- data Listener = Listener' (Maybe ClientAffinity) (Maybe Text) (Maybe (NonEmpty PortRange)) (Maybe Protocol)
- newListener :: Listener
- data PortMapping = PortMapping' (Maybe Natural) (Maybe SocketAddress) (Maybe CustomRoutingDestinationTrafficState) (Maybe Text) (Maybe Text) (Maybe (NonEmpty CustomRoutingProtocol))
- newPortMapping :: PortMapping
- data PortOverride = PortOverride' (Maybe Natural) (Maybe Natural)
- newPortOverride :: PortOverride
- data PortRange = PortRange' (Maybe Natural) (Maybe Natural)
- newPortRange :: PortRange
- data SocketAddress = SocketAddress' (Maybe Text) (Maybe Natural)
- newSocketAddress :: SocketAddress
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2018-08-08
of the Amazon Global Accelerator SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by GlobalAccelerator
.
AcceleratorNotDisabledException
_AcceleratorNotDisabledException :: AsError a => Fold a ServiceError Source #
The accelerator that you specified could not be disabled.
AcceleratorNotFoundException
_AcceleratorNotFoundException :: AsError a => Fold a ServiceError Source #
The accelerator that you specified doesn't exist.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have access permission.
AssociatedEndpointGroupFoundException
_AssociatedEndpointGroupFoundException :: AsError a => Fold a ServiceError Source #
The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.
AssociatedListenerFoundException
_AssociatedListenerFoundException :: AsError a => Fold a ServiceError Source #
The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.
ByoipCidrNotFoundException
_ByoipCidrNotFoundException :: AsError a => Fold a ServiceError Source #
The CIDR that you specified was not found or is incorrect.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
You can't use both of those options.
EndpointAlreadyExistsException
_EndpointAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The endpoint that you specified doesn't exist.
EndpointGroupAlreadyExistsException
_EndpointGroupAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The endpoint group that you specified already exists.
EndpointGroupNotFoundException
_EndpointGroupNotFoundException :: AsError a => Fold a ServiceError Source #
The endpoint group that you specified doesn't exist.
EndpointNotFoundException
_EndpointNotFoundException :: AsError a => Fold a ServiceError Source #
The endpoint that you specified doesn't exist.
IncorrectCidrStateException
_IncorrectCidrStateException :: AsError a => Fold a ServiceError Source #
The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.
InternalServiceErrorException
_InternalServiceErrorException :: AsError a => Fold a ServiceError Source #
There was an internal error for Global Accelerator.
InvalidArgumentException
_InvalidArgumentException :: AsError a => Fold a ServiceError Source #
An argument that you specified is invalid.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
There isn't another item to return.
InvalidPortRangeException
_InvalidPortRangeException :: AsError a => Fold a ServiceError Source #
The port numbers that you specified are not valid numbers or are not unique for this accelerator.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
Processing your request would cause you to exceed an Global Accelerator limit.
ListenerNotFoundException
_ListenerNotFoundException :: AsError a => Fold a ServiceError Source #
The listener that you specified doesn't exist.
TransactionInProgressException
_TransactionInProgressException :: AsError a => Fold a ServiceError Source #
There's already a transaction in progress. Another transaction can't be processed.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AddCustomRoutingEndpoints
data AddCustomRoutingEndpoints Source #
See: newAddCustomRoutingEndpoints
smart constructor.
Instances
newAddCustomRoutingEndpoints Source #
Create a value of AddCustomRoutingEndpoints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointConfigurations:AddCustomRoutingEndpoints'
, addCustomRoutingEndpoints_endpointConfigurations
- The list of endpoint objects to add to a custom routing accelerator.
AddCustomRoutingEndpoints
, addCustomRoutingEndpoints_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group for the custom
routing endpoint.
data AddCustomRoutingEndpointsResponse Source #
See: newAddCustomRoutingEndpointsResponse
smart constructor.
Instances
newAddCustomRoutingEndpointsResponse Source #
Create a value of AddCustomRoutingEndpointsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AddCustomRoutingEndpointsResponse
, addCustomRoutingEndpointsResponse_endpointDescriptions
- The endpoint objects added to the custom routing accelerator.
AddCustomRoutingEndpoints
, addCustomRoutingEndpointsResponse_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group for the custom
routing endpoint.
$sel:httpStatus:AddCustomRoutingEndpointsResponse'
, addCustomRoutingEndpointsResponse_httpStatus
- The response's http status code.
AddEndpoints
data AddEndpoints Source #
See: newAddEndpoints
smart constructor.
Instances
Create a value of AddEndpoints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointConfigurations:AddEndpoints'
, addEndpoints_endpointConfigurations
- The list of endpoint objects.
AddEndpoints
, addEndpoints_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group.
data AddEndpointsResponse Source #
See: newAddEndpointsResponse
smart constructor.
Instances
newAddEndpointsResponse Source #
Create a value of AddEndpointsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AddEndpointsResponse
, addEndpointsResponse_endpointDescriptions
- The list of endpoint objects.
AddEndpoints
, addEndpointsResponse_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group.
$sel:httpStatus:AddEndpointsResponse'
, addEndpointsResponse_httpStatus
- The response's http status code.
AdvertiseByoipCidr
data AdvertiseByoipCidr Source #
See: newAdvertiseByoipCidr
smart constructor.
Instances
newAdvertiseByoipCidr Source #
Create a value of AdvertiseByoipCidr
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AdvertiseByoipCidr
, advertiseByoipCidr_cidr
- The address range, in CIDR notation. This must be the exact range that
you provisioned. You can't advertise only a portion of the provisioned
range.
data AdvertiseByoipCidrResponse Source #
See: newAdvertiseByoipCidrResponse
smart constructor.
Instances
newAdvertiseByoipCidrResponse Source #
Create a value of AdvertiseByoipCidrResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byoipCidr:AdvertiseByoipCidrResponse'
, advertiseByoipCidrResponse_byoipCidr
- Information about the address range.
$sel:httpStatus:AdvertiseByoipCidrResponse'
, advertiseByoipCidrResponse_httpStatus
- The response's http status code.
AllowCustomRoutingTraffic
data AllowCustomRoutingTraffic Source #
See: newAllowCustomRoutingTraffic
smart constructor.
Instances
newAllowCustomRoutingTraffic Source #
Create a value of AllowCustomRoutingTraffic
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowAllTrafficToEndpoint:AllowCustomRoutingTraffic'
, allowCustomRoutingTraffic_allowAllTrafficToEndpoint
- Indicates whether all destination IP addresses and ports for a specified
VPC subnet endpoint can receive traffic from a custom routing
accelerator. The value is TRUE or FALSE.
When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.
When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.
The default value is FALSE.
$sel:destinationAddresses:AllowCustomRoutingTraffic'
, allowCustomRoutingTraffic_destinationAddresses
- A list of specific Amazon EC2 instance IP addresses (destination
addresses) in a subnet that you want to allow to receive traffic. The IP
addresses must be a subset of the IP addresses that you specified for
the endpoint group.
DestinationAddresses
is required if AllowAllTrafficToEndpoint
is
FALSE
or is not specified.
$sel:destinationPorts:AllowCustomRoutingTraffic'
, allowCustomRoutingTraffic_destinationPorts
- A list of specific Amazon EC2 instance ports (destination ports) that
you want to allow to receive traffic.
AllowCustomRoutingTraffic
, allowCustomRoutingTraffic_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group.
AllowCustomRoutingTraffic
, allowCustomRoutingTraffic_endpointId
- An ID for the endpoint. For custom routing accelerators, this is the
virtual private cloud (VPC) subnet ID.
data AllowCustomRoutingTrafficResponse Source #
See: newAllowCustomRoutingTrafficResponse
smart constructor.
Instances
Generic AllowCustomRoutingTrafficResponse Source # | |
Read AllowCustomRoutingTrafficResponse Source # | |
Show AllowCustomRoutingTrafficResponse Source # | |
NFData AllowCustomRoutingTrafficResponse Source # | |
Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic rnf :: AllowCustomRoutingTrafficResponse -> () # | |
Eq AllowCustomRoutingTrafficResponse Source # | |
type Rep AllowCustomRoutingTrafficResponse Source # | |
Defined in Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic type Rep AllowCustomRoutingTrafficResponse = D1 ('MetaData "AllowCustomRoutingTrafficResponse" "Amazonka.GlobalAccelerator.AllowCustomRoutingTraffic" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "AllowCustomRoutingTrafficResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newAllowCustomRoutingTrafficResponse :: AllowCustomRoutingTrafficResponse Source #
Create a value of AllowCustomRoutingTrafficResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateAccelerator
data CreateAccelerator Source #
See: newCreateAccelerator
smart constructor.
Instances
Create a value of CreateAccelerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAccelerator
, createAccelerator_enabled
- Indicates whether an accelerator is enabled. The value is true or false.
The default value is true.
If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
CreateAccelerator
, createAccelerator_ipAddressType
- The IP address type that an accelerator supports. For a standard
accelerator, the value can be IPV4 or DUAL_STACK.
CreateAccelerator
, createAccelerator_ipAddresses
- Optionally, if you've added your own IP address pool to Global
Accelerator (BYOIP), you can choose an IPv4 address from your own pool
to use for the accelerator's static IPv4 address when you create an
accelerator.
After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.
You can specify one or two addresses, separated by a space. Do not include the /32 suffix.
Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
$sel:tags:CreateAccelerator'
, createAccelerator_tags
- Create tags for an accelerator.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
CreateAccelerator
, createAccelerator_name
- The name of the accelerator. The name can have a maximum of 64
characters, must contain only alphanumeric characters, periods (.), or
hyphens (-), and must not begin or end with a hyphen or period.
$sel:idempotencyToken:CreateAccelerator'
, createAccelerator_idempotencyToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of an accelerator.
data CreateAcceleratorResponse Source #
See: newCreateAcceleratorResponse
smart constructor.
Instances
newCreateAcceleratorResponse Source #
Create a value of CreateAcceleratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accelerator:CreateAcceleratorResponse'
, createAcceleratorResponse_accelerator
- The accelerator that is created by specifying a listener and the
supported IP address types.
$sel:httpStatus:CreateAcceleratorResponse'
, createAcceleratorResponse_httpStatus
- The response's http status code.
CreateCustomRoutingAccelerator
data CreateCustomRoutingAccelerator Source #
See: newCreateCustomRoutingAccelerator
smart constructor.
CreateCustomRoutingAccelerator' (Maybe Bool) (Maybe IpAddressType) (Maybe [Text]) (Maybe [Tag]) Text Text |
Instances
newCreateCustomRoutingAccelerator Source #
Create a value of CreateCustomRoutingAccelerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateCustomRoutingAccelerator
, createCustomRoutingAccelerator_enabled
- Indicates whether an accelerator is enabled. The value is true or false.
The default value is true.
If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
CreateCustomRoutingAccelerator
, createCustomRoutingAccelerator_ipAddressType
- The IP address type that an accelerator supports. For a custom routing
accelerator, the value must be IPV4.
CreateCustomRoutingAccelerator
, createCustomRoutingAccelerator_ipAddresses
- Optionally, if you've added your own IP address pool to Global
Accelerator (BYOIP), you can choose an IPv4 address from your own pool
to use for the accelerator's static IPv4 address when you create an
accelerator.
After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.
You can specify one or two addresses, separated by a space. Do not include the /32 suffix.
Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
$sel:tags:CreateCustomRoutingAccelerator'
, createCustomRoutingAccelerator_tags
- Create tags for an accelerator.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
CreateCustomRoutingAccelerator
, createCustomRoutingAccelerator_name
- The name of a custom routing accelerator. The name can have a maximum of
64 characters, must contain only alphanumeric characters or hyphens (-),
and must not begin or end with a hyphen.
$sel:idempotencyToken:CreateCustomRoutingAccelerator'
, createCustomRoutingAccelerator_idempotencyToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of the request.
data CreateCustomRoutingAcceleratorResponse Source #
See: newCreateCustomRoutingAcceleratorResponse
smart constructor.
Instances
newCreateCustomRoutingAcceleratorResponse Source #
Create a value of CreateCustomRoutingAcceleratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accelerator:CreateCustomRoutingAcceleratorResponse'
, createCustomRoutingAcceleratorResponse_accelerator
- The accelerator that is created.
$sel:httpStatus:CreateCustomRoutingAcceleratorResponse'
, createCustomRoutingAcceleratorResponse_httpStatus
- The response's http status code.
CreateCustomRoutingEndpointGroup
data CreateCustomRoutingEndpointGroup Source #
See: newCreateCustomRoutingEndpointGroup
smart constructor.
Instances
newCreateCustomRoutingEndpointGroup Source #
:: Text | |
-> Text | |
-> NonEmpty CustomRoutingDestinationConfiguration |
|
-> Text | |
-> CreateCustomRoutingEndpointGroup |
Create a value of CreateCustomRoutingEndpointGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateCustomRoutingEndpointGroup
, createCustomRoutingEndpointGroup_listenerArn
- The Amazon Resource Name (ARN) of the listener for a custom routing
endpoint.
CreateCustomRoutingEndpointGroup
, createCustomRoutingEndpointGroup_endpointGroupRegion
- The Amazon Web Services Region where the endpoint group is located. A
listener can have only one endpoint group in a specific Region.
$sel:destinationConfigurations:CreateCustomRoutingEndpointGroup'
, createCustomRoutingEndpointGroup_destinationConfigurations
- Sets the port range and protocol for all endpoints (virtual private
cloud subnets) in a custom routing endpoint group to accept client
traffic on.
$sel:idempotencyToken:CreateCustomRoutingEndpointGroup'
, createCustomRoutingEndpointGroup_idempotencyToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of the request.
data CreateCustomRoutingEndpointGroupResponse Source #
See: newCreateCustomRoutingEndpointGroupResponse
smart constructor.
Instances
Generic CreateCustomRoutingEndpointGroupResponse Source # | |
Read CreateCustomRoutingEndpointGroupResponse Source # | |
Show CreateCustomRoutingEndpointGroupResponse Source # | |
NFData CreateCustomRoutingEndpointGroupResponse Source # | |
Eq CreateCustomRoutingEndpointGroupResponse Source # | |
type Rep CreateCustomRoutingEndpointGroupResponse Source # | |
Defined in Amazonka.GlobalAccelerator.CreateCustomRoutingEndpointGroup type Rep CreateCustomRoutingEndpointGroupResponse = D1 ('MetaData "CreateCustomRoutingEndpointGroupResponse" "Amazonka.GlobalAccelerator.CreateCustomRoutingEndpointGroup" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "CreateCustomRoutingEndpointGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomRoutingEndpointGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateCustomRoutingEndpointGroupResponse Source #
Create a value of CreateCustomRoutingEndpointGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointGroup:CreateCustomRoutingEndpointGroupResponse'
, createCustomRoutingEndpointGroupResponse_endpointGroup
- The information about the endpoint group created for a custom routing
accelerator.
$sel:httpStatus:CreateCustomRoutingEndpointGroupResponse'
, createCustomRoutingEndpointGroupResponse_httpStatus
- The response's http status code.
CreateCustomRoutingListener
data CreateCustomRoutingListener Source #
See: newCreateCustomRoutingListener
smart constructor.
Instances
newCreateCustomRoutingListener Source #
:: Text | |
-> NonEmpty PortRange | |
-> Text | |
-> CreateCustomRoutingListener |
Create a value of CreateCustomRoutingListener
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateCustomRoutingListener
, createCustomRoutingListener_acceleratorArn
- The Amazon Resource Name (ARN) of the accelerator for a custom routing
listener.
CreateCustomRoutingListener
, createCustomRoutingListener_portRanges
- The port range to support for connections from clients to your
accelerator.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
$sel:idempotencyToken:CreateCustomRoutingListener'
, createCustomRoutingListener_idempotencyToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of the request.
data CreateCustomRoutingListenerResponse Source #
See: newCreateCustomRoutingListenerResponse
smart constructor.
Instances
newCreateCustomRoutingListenerResponse Source #
Create a value of CreateCustomRoutingListenerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:listener:CreateCustomRoutingListenerResponse'
, createCustomRoutingListenerResponse_listener
- The listener that you've created for a custom routing accelerator.
$sel:httpStatus:CreateCustomRoutingListenerResponse'
, createCustomRoutingListenerResponse_httpStatus
- The response's http status code.
CreateEndpointGroup
data CreateEndpointGroup Source #
See: newCreateEndpointGroup
smart constructor.
CreateEndpointGroup' (Maybe [EndpointConfiguration]) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe HealthCheckProtocol) (Maybe [PortOverride]) (Maybe Natural) (Maybe Double) Text Text Text |
Instances
newCreateEndpointGroup Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateEndpointGroup |
Create a value of CreateEndpointGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointConfigurations:CreateEndpointGroup'
, createEndpointGroup_endpointConfigurations
- The list of endpoint objects.
CreateEndpointGroup
, createEndpointGroup_healthCheckIntervalSeconds
- The time—10 seconds or 30 seconds—between each health check for an
endpoint. The default value is 30.
CreateEndpointGroup
, createEndpointGroup_healthCheckPath
- If the protocol is HTTP/S, then this specifies the path that is the
destination for health check targets. The default value is slash (/).
CreateEndpointGroup
, createEndpointGroup_healthCheckPort
- The port that Global Accelerator uses to check the health of endpoints
that are part of this endpoint group. The default port is the listener
port that this endpoint group is associated with. If listener port is a
list of ports, Global Accelerator uses the first port in the list.
CreateEndpointGroup
, createEndpointGroup_healthCheckProtocol
- The protocol that Global Accelerator uses to check the health of
endpoints that are part of this endpoint group. The default value is
TCP.
CreateEndpointGroup
, createEndpointGroup_portOverrides
- Override specific listener ports used to route traffic to endpoints that
are part of this endpoint group. For example, you can create a port
override in which the listener receives user traffic on ports 80 and
443, but your accelerator routes that traffic to ports 1080 and 1443,
respectively, on the endpoints.
For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
CreateEndpointGroup
, createEndpointGroup_thresholdCount
- The number of consecutive health checks required to set the state of a
healthy endpoint to unhealthy, or to set an unhealthy endpoint to
healthy. The default value is 3.
CreateEndpointGroup
, createEndpointGroup_trafficDialPercentage
- The percentage of traffic to send to an Amazon Web Services Region.
Additional traffic is distributed to other endpoint groups for this
listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
CreateEndpointGroup
, createEndpointGroup_listenerArn
- The Amazon Resource Name (ARN) of the listener.
CreateEndpointGroup
, createEndpointGroup_endpointGroupRegion
- The Amazon Web Services Region where the endpoint group is located. A
listener can have only one endpoint group in a specific Region.
$sel:idempotencyToken:CreateEndpointGroup'
, createEndpointGroup_idempotencyToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of the request.
data CreateEndpointGroupResponse Source #
See: newCreateEndpointGroupResponse
smart constructor.
Instances
newCreateEndpointGroupResponse Source #
Create a value of CreateEndpointGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointGroup:CreateEndpointGroupResponse'
, createEndpointGroupResponse_endpointGroup
- The information about the endpoint group that was created.
$sel:httpStatus:CreateEndpointGroupResponse'
, createEndpointGroupResponse_httpStatus
- The response's http status code.
CreateListener
data CreateListener Source #
See: newCreateListener
smart constructor.
Instances
Create a value of CreateListener
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateListener
, createListener_clientAffinity
- Client affinity lets you direct all requests from a user to the same
endpoint, if you have stateful applications, regardless of the port and
protocol of the client request. Client affinity gives you control over
whether to always route each client to the same specific endpoint.
Global Accelerator uses a consistent-flow hashing algorithm to choose
the optimal endpoint for a connection. If client affinity is NONE
,
Global Accelerator uses the "five-tuple" (5-tuple) properties—source
IP address, source port, destination IP address, destination port, and
protocol—to select the hash value, and then chooses the best endpoint.
However, with this setting, if someone uses different ports to connect
to Global Accelerator, their connections might not be always routed to
the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set
client affinity to SOURCE_IP
instead. When you use the SOURCE_IP
setting, Global Accelerator uses the "two-tuple" (2-tuple) properties—
source (client) IP address and destination IP address—to select the hash
value.
The default value is NONE
.
CreateListener
, createListener_acceleratorArn
- The Amazon Resource Name (ARN) of your accelerator.
CreateListener
, createListener_portRanges
- The list of port ranges to support for connections from clients to your
accelerator.
CreateListener
, createListener_protocol
- The protocol for connections from clients to your accelerator.
$sel:idempotencyToken:CreateListener'
, createListener_idempotencyToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of the request.
data CreateListenerResponse Source #
See: newCreateListenerResponse
smart constructor.
Instances
newCreateListenerResponse Source #
Create a value of CreateListenerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:listener:CreateListenerResponse'
, createListenerResponse_listener
- The listener that you've created.
$sel:httpStatus:CreateListenerResponse'
, createListenerResponse_httpStatus
- The response's http status code.
DeleteAccelerator
data DeleteAccelerator Source #
See: newDeleteAccelerator
smart constructor.
Instances
Create a value of DeleteAccelerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteAccelerator
, deleteAccelerator_acceleratorArn
- The Amazon Resource Name (ARN) of an accelerator.
data DeleteAcceleratorResponse Source #
See: newDeleteAcceleratorResponse
smart constructor.
Instances
newDeleteAcceleratorResponse :: DeleteAcceleratorResponse Source #
Create a value of DeleteAcceleratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteCustomRoutingAccelerator
data DeleteCustomRoutingAccelerator Source #
See: newDeleteCustomRoutingAccelerator
smart constructor.
Instances
newDeleteCustomRoutingAccelerator Source #
Create a value of DeleteCustomRoutingAccelerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteCustomRoutingAccelerator
, deleteCustomRoutingAccelerator_acceleratorArn
- The Amazon Resource Name (ARN) of the custom routing accelerator to
delete.
data DeleteCustomRoutingAcceleratorResponse Source #
See: newDeleteCustomRoutingAcceleratorResponse
smart constructor.
Instances
Generic DeleteCustomRoutingAcceleratorResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DeleteCustomRoutingAccelerator type Rep DeleteCustomRoutingAcceleratorResponse :: Type -> Type # | |
Read DeleteCustomRoutingAcceleratorResponse Source # | |
Show DeleteCustomRoutingAcceleratorResponse Source # | |
NFData DeleteCustomRoutingAcceleratorResponse Source # | |
Eq DeleteCustomRoutingAcceleratorResponse Source # | |
type Rep DeleteCustomRoutingAcceleratorResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DeleteCustomRoutingAccelerator type Rep DeleteCustomRoutingAcceleratorResponse = D1 ('MetaData "DeleteCustomRoutingAcceleratorResponse" "Amazonka.GlobalAccelerator.DeleteCustomRoutingAccelerator" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "DeleteCustomRoutingAcceleratorResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeleteCustomRoutingAcceleratorResponse :: DeleteCustomRoutingAcceleratorResponse Source #
Create a value of DeleteCustomRoutingAcceleratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteCustomRoutingEndpointGroup
data DeleteCustomRoutingEndpointGroup Source #
See: newDeleteCustomRoutingEndpointGroup
smart constructor.
Instances
newDeleteCustomRoutingEndpointGroup Source #
Create a value of DeleteCustomRoutingEndpointGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteCustomRoutingEndpointGroup
, deleteCustomRoutingEndpointGroup_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group to delete.
data DeleteCustomRoutingEndpointGroupResponse Source #
See: newDeleteCustomRoutingEndpointGroupResponse
smart constructor.
Instances
Generic DeleteCustomRoutingEndpointGroupResponse Source # | |
Read DeleteCustomRoutingEndpointGroupResponse Source # | |
Show DeleteCustomRoutingEndpointGroupResponse Source # | |
NFData DeleteCustomRoutingEndpointGroupResponse Source # | |
Eq DeleteCustomRoutingEndpointGroupResponse Source # | |
type Rep DeleteCustomRoutingEndpointGroupResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DeleteCustomRoutingEndpointGroup type Rep DeleteCustomRoutingEndpointGroupResponse = D1 ('MetaData "DeleteCustomRoutingEndpointGroupResponse" "Amazonka.GlobalAccelerator.DeleteCustomRoutingEndpointGroup" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "DeleteCustomRoutingEndpointGroupResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeleteCustomRoutingEndpointGroupResponse :: DeleteCustomRoutingEndpointGroupResponse Source #
Create a value of DeleteCustomRoutingEndpointGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteCustomRoutingListener
data DeleteCustomRoutingListener Source #
See: newDeleteCustomRoutingListener
smart constructor.
Instances
newDeleteCustomRoutingListener Source #
Create a value of DeleteCustomRoutingListener
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteCustomRoutingListener
, deleteCustomRoutingListener_listenerArn
- The Amazon Resource Name (ARN) of the listener to delete.
data DeleteCustomRoutingListenerResponse Source #
See: newDeleteCustomRoutingListenerResponse
smart constructor.
Instances
Generic DeleteCustomRoutingListenerResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DeleteCustomRoutingListener type Rep DeleteCustomRoutingListenerResponse :: Type -> Type # | |
Read DeleteCustomRoutingListenerResponse Source # | |
Show DeleteCustomRoutingListenerResponse Source # | |
NFData DeleteCustomRoutingListenerResponse Source # | |
Eq DeleteCustomRoutingListenerResponse Source # | |
type Rep DeleteCustomRoutingListenerResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DeleteCustomRoutingListener type Rep DeleteCustomRoutingListenerResponse = D1 ('MetaData "DeleteCustomRoutingListenerResponse" "Amazonka.GlobalAccelerator.DeleteCustomRoutingListener" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "DeleteCustomRoutingListenerResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeleteCustomRoutingListenerResponse :: DeleteCustomRoutingListenerResponse Source #
Create a value of DeleteCustomRoutingListenerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteEndpointGroup
data DeleteEndpointGroup Source #
See: newDeleteEndpointGroup
smart constructor.
Instances
newDeleteEndpointGroup Source #
Create a value of DeleteEndpointGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEndpointGroup
, deleteEndpointGroup_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group to delete.
data DeleteEndpointGroupResponse Source #
See: newDeleteEndpointGroupResponse
smart constructor.
Instances
newDeleteEndpointGroupResponse :: DeleteEndpointGroupResponse Source #
Create a value of DeleteEndpointGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteListener
data DeleteListener Source #
See: newDeleteListener
smart constructor.
Instances
Create a value of DeleteListener
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteListener
, deleteListener_listenerArn
- The Amazon Resource Name (ARN) of the listener.
data DeleteListenerResponse Source #
See: newDeleteListenerResponse
smart constructor.
Instances
Generic DeleteListenerResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DeleteListener type Rep DeleteListenerResponse :: Type -> Type # | |
Read DeleteListenerResponse Source # | |
Show DeleteListenerResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DeleteListener showsPrec :: Int -> DeleteListenerResponse -> ShowS # show :: DeleteListenerResponse -> String # showList :: [DeleteListenerResponse] -> ShowS # | |
NFData DeleteListenerResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DeleteListener rnf :: DeleteListenerResponse -> () # | |
Eq DeleteListenerResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DeleteListener | |
type Rep DeleteListenerResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DeleteListener |
newDeleteListenerResponse :: DeleteListenerResponse Source #
Create a value of DeleteListenerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DenyCustomRoutingTraffic
data DenyCustomRoutingTraffic Source #
See: newDenyCustomRoutingTraffic
smart constructor.
Instances
newDenyCustomRoutingTraffic Source #
Create a value of DenyCustomRoutingTraffic
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:denyAllTrafficToEndpoint:DenyCustomRoutingTraffic'
, denyCustomRoutingTraffic_denyAllTrafficToEndpoint
- Indicates whether all destination IP addresses and ports for a specified
VPC subnet endpoint cannot receive traffic from a custom routing
accelerator. The value is TRUE or FALSE.
When set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.
When set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.
The default value is FALSE.
$sel:destinationAddresses:DenyCustomRoutingTraffic'
, denyCustomRoutingTraffic_destinationAddresses
- A list of specific Amazon EC2 instance IP addresses (destination
addresses) in a subnet that you want to prevent from receiving traffic.
The IP addresses must be a subset of the IP addresses allowed for the
VPC subnet associated with the endpoint group.
$sel:destinationPorts:DenyCustomRoutingTraffic'
, denyCustomRoutingTraffic_destinationPorts
- A list of specific Amazon EC2 instance ports (destination ports) in a
subnet endpoint that you want to prevent from receiving traffic.
DenyCustomRoutingTraffic
, denyCustomRoutingTraffic_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group.
DenyCustomRoutingTraffic
, denyCustomRoutingTraffic_endpointId
- An ID for the endpoint. For custom routing accelerators, this is the
virtual private cloud (VPC) subnet ID.
data DenyCustomRoutingTrafficResponse Source #
See: newDenyCustomRoutingTrafficResponse
smart constructor.
Instances
Generic DenyCustomRoutingTrafficResponse Source # | |
Read DenyCustomRoutingTrafficResponse Source # | |
Show DenyCustomRoutingTrafficResponse Source # | |
NFData DenyCustomRoutingTrafficResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DenyCustomRoutingTraffic rnf :: DenyCustomRoutingTrafficResponse -> () # | |
Eq DenyCustomRoutingTrafficResponse Source # | |
type Rep DenyCustomRoutingTrafficResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DenyCustomRoutingTraffic type Rep DenyCustomRoutingTrafficResponse = D1 ('MetaData "DenyCustomRoutingTrafficResponse" "Amazonka.GlobalAccelerator.DenyCustomRoutingTraffic" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "DenyCustomRoutingTrafficResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDenyCustomRoutingTrafficResponse :: DenyCustomRoutingTrafficResponse Source #
Create a value of DenyCustomRoutingTrafficResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeprovisionByoipCidr
data DeprovisionByoipCidr Source #
See: newDeprovisionByoipCidr
smart constructor.
Instances
newDeprovisionByoipCidr Source #
Create a value of DeprovisionByoipCidr
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeprovisionByoipCidr
, deprovisionByoipCidr_cidr
- The address range, in CIDR notation. The prefix must be the same prefix
that you specified when you provisioned the address range.
data DeprovisionByoipCidrResponse Source #
See: newDeprovisionByoipCidrResponse
smart constructor.
Instances
newDeprovisionByoipCidrResponse Source #
Create a value of DeprovisionByoipCidrResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byoipCidr:DeprovisionByoipCidrResponse'
, deprovisionByoipCidrResponse_byoipCidr
- Information about the address range.
$sel:httpStatus:DeprovisionByoipCidrResponse'
, deprovisionByoipCidrResponse_httpStatus
- The response's http status code.
DescribeAccelerator
data DescribeAccelerator Source #
See: newDescribeAccelerator
smart constructor.
Instances
newDescribeAccelerator Source #
Create a value of DescribeAccelerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeAccelerator
, describeAccelerator_acceleratorArn
- The Amazon Resource Name (ARN) of the accelerator to describe.
data DescribeAcceleratorResponse Source #
See: newDescribeAcceleratorResponse
smart constructor.
Instances
newDescribeAcceleratorResponse Source #
Create a value of DescribeAcceleratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accelerator:DescribeAcceleratorResponse'
, describeAcceleratorResponse_accelerator
- The description of the accelerator.
$sel:httpStatus:DescribeAcceleratorResponse'
, describeAcceleratorResponse_httpStatus
- The response's http status code.
DescribeAcceleratorAttributes
data DescribeAcceleratorAttributes Source #
See: newDescribeAcceleratorAttributes
smart constructor.
Instances
newDescribeAcceleratorAttributes Source #
Create a value of DescribeAcceleratorAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeAcceleratorAttributes
, describeAcceleratorAttributes_acceleratorArn
- The Amazon Resource Name (ARN) of the accelerator with the attributes
that you want to describe.
data DescribeAcceleratorAttributesResponse Source #
See: newDescribeAcceleratorAttributesResponse
smart constructor.
Instances
newDescribeAcceleratorAttributesResponse Source #
Create a value of DescribeAcceleratorAttributesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceleratorAttributes:DescribeAcceleratorAttributesResponse'
, describeAcceleratorAttributesResponse_acceleratorAttributes
- The attributes of the accelerator.
$sel:httpStatus:DescribeAcceleratorAttributesResponse'
, describeAcceleratorAttributesResponse_httpStatus
- The response's http status code.
DescribeCustomRoutingAccelerator
data DescribeCustomRoutingAccelerator Source #
See: newDescribeCustomRoutingAccelerator
smart constructor.
Instances
newDescribeCustomRoutingAccelerator Source #
Create a value of DescribeCustomRoutingAccelerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeCustomRoutingAccelerator
, describeCustomRoutingAccelerator_acceleratorArn
- The Amazon Resource Name (ARN) of the accelerator to describe.
data DescribeCustomRoutingAcceleratorResponse Source #
See: newDescribeCustomRoutingAcceleratorResponse
smart constructor.
Instances
Generic DescribeCustomRoutingAcceleratorResponse Source # | |
Read DescribeCustomRoutingAcceleratorResponse Source # | |
Show DescribeCustomRoutingAcceleratorResponse Source # | |
NFData DescribeCustomRoutingAcceleratorResponse Source # | |
Eq DescribeCustomRoutingAcceleratorResponse Source # | |
type Rep DescribeCustomRoutingAcceleratorResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DescribeCustomRoutingAccelerator type Rep DescribeCustomRoutingAcceleratorResponse = D1 ('MetaData "DescribeCustomRoutingAcceleratorResponse" "Amazonka.GlobalAccelerator.DescribeCustomRoutingAccelerator" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "DescribeCustomRoutingAcceleratorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accelerator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomRoutingAccelerator)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDescribeCustomRoutingAcceleratorResponse Source #
Create a value of DescribeCustomRoutingAcceleratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accelerator:DescribeCustomRoutingAcceleratorResponse'
, describeCustomRoutingAcceleratorResponse_accelerator
- The description of the custom routing accelerator.
$sel:httpStatus:DescribeCustomRoutingAcceleratorResponse'
, describeCustomRoutingAcceleratorResponse_httpStatus
- The response's http status code.
DescribeCustomRoutingAcceleratorAttributes
data DescribeCustomRoutingAcceleratorAttributes Source #
See: newDescribeCustomRoutingAcceleratorAttributes
smart constructor.
Instances
newDescribeCustomRoutingAcceleratorAttributes Source #
Create a value of DescribeCustomRoutingAcceleratorAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeCustomRoutingAcceleratorAttributes
, describeCustomRoutingAcceleratorAttributes_acceleratorArn
- The Amazon Resource Name (ARN) of the custom routing accelerator to
describe the attributes for.
data DescribeCustomRoutingAcceleratorAttributesResponse Source #
See: newDescribeCustomRoutingAcceleratorAttributesResponse
smart constructor.
Instances
newDescribeCustomRoutingAcceleratorAttributesResponse Source #
:: Int |
|
-> DescribeCustomRoutingAcceleratorAttributesResponse |
Create a value of DescribeCustomRoutingAcceleratorAttributesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceleratorAttributes:DescribeCustomRoutingAcceleratorAttributesResponse'
, describeCustomRoutingAcceleratorAttributesResponse_acceleratorAttributes
- The attributes of the custom routing accelerator.
$sel:httpStatus:DescribeCustomRoutingAcceleratorAttributesResponse'
, describeCustomRoutingAcceleratorAttributesResponse_httpStatus
- The response's http status code.
DescribeCustomRoutingEndpointGroup
data DescribeCustomRoutingEndpointGroup Source #
See: newDescribeCustomRoutingEndpointGroup
smart constructor.
Instances
newDescribeCustomRoutingEndpointGroup Source #
Create a value of DescribeCustomRoutingEndpointGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeCustomRoutingEndpointGroup
, describeCustomRoutingEndpointGroup_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group to describe.
data DescribeCustomRoutingEndpointGroupResponse Source #
See: newDescribeCustomRoutingEndpointGroupResponse
smart constructor.
Instances
Generic DescribeCustomRoutingEndpointGroupResponse Source # | |
Read DescribeCustomRoutingEndpointGroupResponse Source # | |
Show DescribeCustomRoutingEndpointGroupResponse Source # | |
NFData DescribeCustomRoutingEndpointGroupResponse Source # | |
Eq DescribeCustomRoutingEndpointGroupResponse Source # | |
type Rep DescribeCustomRoutingEndpointGroupResponse Source # | |
Defined in Amazonka.GlobalAccelerator.DescribeCustomRoutingEndpointGroup type Rep DescribeCustomRoutingEndpointGroupResponse = D1 ('MetaData "DescribeCustomRoutingEndpointGroupResponse" "Amazonka.GlobalAccelerator.DescribeCustomRoutingEndpointGroup" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "DescribeCustomRoutingEndpointGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomRoutingEndpointGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDescribeCustomRoutingEndpointGroupResponse Source #
Create a value of DescribeCustomRoutingEndpointGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointGroup:DescribeCustomRoutingEndpointGroupResponse'
, describeCustomRoutingEndpointGroupResponse_endpointGroup
- The description of an endpoint group for a custom routing accelerator.
$sel:httpStatus:DescribeCustomRoutingEndpointGroupResponse'
, describeCustomRoutingEndpointGroupResponse_httpStatus
- The response's http status code.
DescribeCustomRoutingListener
data DescribeCustomRoutingListener Source #
See: newDescribeCustomRoutingListener
smart constructor.
Instances
newDescribeCustomRoutingListener Source #
Create a value of DescribeCustomRoutingListener
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeCustomRoutingListener
, describeCustomRoutingListener_listenerArn
- The Amazon Resource Name (ARN) of the listener to describe.
data DescribeCustomRoutingListenerResponse Source #
See: newDescribeCustomRoutingListenerResponse
smart constructor.
Instances
newDescribeCustomRoutingListenerResponse Source #
Create a value of DescribeCustomRoutingListenerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:listener:DescribeCustomRoutingListenerResponse'
, describeCustomRoutingListenerResponse_listener
- The description of a listener for a custom routing accelerator.
$sel:httpStatus:DescribeCustomRoutingListenerResponse'
, describeCustomRoutingListenerResponse_httpStatus
- The response's http status code.
DescribeEndpointGroup
data DescribeEndpointGroup Source #
See: newDescribeEndpointGroup
smart constructor.
Instances
newDescribeEndpointGroup Source #
Create a value of DescribeEndpointGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeEndpointGroup
, describeEndpointGroup_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group to describe.
data DescribeEndpointGroupResponse Source #
See: newDescribeEndpointGroupResponse
smart constructor.
Instances
newDescribeEndpointGroupResponse Source #
Create a value of DescribeEndpointGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointGroup:DescribeEndpointGroupResponse'
, describeEndpointGroupResponse_endpointGroup
- The description of an endpoint group.
$sel:httpStatus:DescribeEndpointGroupResponse'
, describeEndpointGroupResponse_httpStatus
- The response's http status code.
DescribeListener
data DescribeListener Source #
See: newDescribeListener
smart constructor.
Instances
Create a value of DescribeListener
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeListener
, describeListener_listenerArn
- The Amazon Resource Name (ARN) of the listener to describe.
data DescribeListenerResponse Source #
See: newDescribeListenerResponse
smart constructor.
Instances
newDescribeListenerResponse Source #
Create a value of DescribeListenerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:listener:DescribeListenerResponse'
, describeListenerResponse_listener
- The description of a listener.
$sel:httpStatus:DescribeListenerResponse'
, describeListenerResponse_httpStatus
- The response's http status code.
ListAccelerators (Paginated)
data ListAccelerators Source #
See: newListAccelerators
smart constructor.
Instances
newListAccelerators :: ListAccelerators Source #
Create a value of ListAccelerators
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListAccelerators'
, listAccelerators_maxResults
- The number of Global Accelerator objects that you want to return with
this call. The default value is 10.
ListAccelerators
, listAccelerators_nextToken
- The token for the next set of results. You receive this token from a
previous call.
data ListAcceleratorsResponse Source #
See: newListAcceleratorsResponse
smart constructor.
Instances
newListAcceleratorsResponse Source #
Create a value of ListAcceleratorsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accelerators:ListAcceleratorsResponse'
, listAcceleratorsResponse_accelerators
- The list of accelerators for a customer account.
ListAccelerators
, listAcceleratorsResponse_nextToken
- The token for the next set of results. You receive this token from a
previous call.
$sel:httpStatus:ListAcceleratorsResponse'
, listAcceleratorsResponse_httpStatus
- The response's http status code.
ListByoipCidrs (Paginated)
data ListByoipCidrs Source #
See: newListByoipCidrs
smart constructor.
Instances
newListByoipCidrs :: ListByoipCidrs Source #
Create a value of ListByoipCidrs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListByoipCidrs'
, listByoipCidrs_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
ListByoipCidrs
, listByoipCidrs_nextToken
- The token for the next page of results.
data ListByoipCidrsResponse Source #
See: newListByoipCidrsResponse
smart constructor.
Instances
newListByoipCidrsResponse Source #
Create a value of ListByoipCidrsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byoipCidrs:ListByoipCidrsResponse'
, listByoipCidrsResponse_byoipCidrs
- Information about your address ranges.
ListByoipCidrs
, listByoipCidrsResponse_nextToken
- The token for the next page of results.
$sel:httpStatus:ListByoipCidrsResponse'
, listByoipCidrsResponse_httpStatus
- The response's http status code.
ListCustomRoutingAccelerators (Paginated)
data ListCustomRoutingAccelerators Source #
See: newListCustomRoutingAccelerators
smart constructor.
Instances
newListCustomRoutingAccelerators :: ListCustomRoutingAccelerators Source #
Create a value of ListCustomRoutingAccelerators
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListCustomRoutingAccelerators'
, listCustomRoutingAccelerators_maxResults
- The number of custom routing Global Accelerator objects that you want to
return with this call. The default value is 10.
ListCustomRoutingAccelerators
, listCustomRoutingAccelerators_nextToken
- The token for the next set of results. You receive this token from a
previous call.
data ListCustomRoutingAcceleratorsResponse Source #
See: newListCustomRoutingAcceleratorsResponse
smart constructor.
Instances
newListCustomRoutingAcceleratorsResponse Source #
Create a value of ListCustomRoutingAcceleratorsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accelerators:ListCustomRoutingAcceleratorsResponse'
, listCustomRoutingAcceleratorsResponse_accelerators
- The list of custom routing accelerators for a customer account.
ListCustomRoutingAccelerators
, listCustomRoutingAcceleratorsResponse_nextToken
- The token for the next set of results. You receive this token from a
previous call.
$sel:httpStatus:ListCustomRoutingAcceleratorsResponse'
, listCustomRoutingAcceleratorsResponse_httpStatus
- The response's http status code.
ListCustomRoutingEndpointGroups
data ListCustomRoutingEndpointGroups Source #
See: newListCustomRoutingEndpointGroups
smart constructor.
Instances
newListCustomRoutingEndpointGroups Source #
Create a value of ListCustomRoutingEndpointGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListCustomRoutingEndpointGroups'
, listCustomRoutingEndpointGroups_maxResults
- The number of endpoint group objects that you want to return with this
call. The default value is 10.
ListCustomRoutingEndpointGroups
, listCustomRoutingEndpointGroups_nextToken
- The token for the next set of results. You receive this token from a
previous call.
ListCustomRoutingEndpointGroups
, listCustomRoutingEndpointGroups_listenerArn
- The Amazon Resource Name (ARN) of the listener to list endpoint groups
for.
data ListCustomRoutingEndpointGroupsResponse Source #
See: newListCustomRoutingEndpointGroupsResponse
smart constructor.
Instances
newListCustomRoutingEndpointGroupsResponse Source #
Create a value of ListCustomRoutingEndpointGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointGroups:ListCustomRoutingEndpointGroupsResponse'
, listCustomRoutingEndpointGroupsResponse_endpointGroups
- The list of the endpoint groups associated with a listener for a custom
routing accelerator.
ListCustomRoutingEndpointGroups
, listCustomRoutingEndpointGroupsResponse_nextToken
- The token for the next set of results. You receive this token from a
previous call.
$sel:httpStatus:ListCustomRoutingEndpointGroupsResponse'
, listCustomRoutingEndpointGroupsResponse_httpStatus
- The response's http status code.
ListCustomRoutingListeners (Paginated)
data ListCustomRoutingListeners Source #
See: newListCustomRoutingListeners
smart constructor.
Instances
newListCustomRoutingListeners Source #
Create a value of ListCustomRoutingListeners
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListCustomRoutingListeners'
, listCustomRoutingListeners_maxResults
- The number of listener objects that you want to return with this call.
The default value is 10.
ListCustomRoutingListeners
, listCustomRoutingListeners_nextToken
- The token for the next set of results. You receive this token from a
previous call.
ListCustomRoutingListeners
, listCustomRoutingListeners_acceleratorArn
- The Amazon Resource Name (ARN) of the accelerator to list listeners for.
data ListCustomRoutingListenersResponse Source #
See: newListCustomRoutingListenersResponse
smart constructor.
Instances
newListCustomRoutingListenersResponse Source #
Create a value of ListCustomRoutingListenersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:listeners:ListCustomRoutingListenersResponse'
, listCustomRoutingListenersResponse_listeners
- The list of listeners for a custom routing accelerator.
ListCustomRoutingListeners
, listCustomRoutingListenersResponse_nextToken
- The token for the next set of results. You receive this token from a
previous call.
$sel:httpStatus:ListCustomRoutingListenersResponse'
, listCustomRoutingListenersResponse_httpStatus
- The response's http status code.
ListCustomRoutingPortMappings (Paginated)
data ListCustomRoutingPortMappings Source #
See: newListCustomRoutingPortMappings
smart constructor.
Instances
newListCustomRoutingPortMappings Source #
Create a value of ListCustomRoutingPortMappings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListCustomRoutingPortMappings
, listCustomRoutingPortMappings_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group to list the custom
routing port mappings for.
$sel:maxResults:ListCustomRoutingPortMappings'
, listCustomRoutingPortMappings_maxResults
- The number of destination port mappings that you want to return with
this call. The default value is 10.
ListCustomRoutingPortMappings
, listCustomRoutingPortMappings_nextToken
- The token for the next set of results. You receive this token from a
previous call.
ListCustomRoutingPortMappings
, listCustomRoutingPortMappings_acceleratorArn
- The Amazon Resource Name (ARN) of the accelerator to list the custom
routing port mappings for.
data ListCustomRoutingPortMappingsResponse Source #
See: newListCustomRoutingPortMappingsResponse
smart constructor.
Instances
newListCustomRoutingPortMappingsResponse Source #
Create a value of ListCustomRoutingPortMappingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListCustomRoutingPortMappings
, listCustomRoutingPortMappingsResponse_nextToken
- The token for the next set of results. You receive this token from a
previous call.
$sel:portMappings:ListCustomRoutingPortMappingsResponse'
, listCustomRoutingPortMappingsResponse_portMappings
- The port mappings for a custom routing accelerator.
$sel:httpStatus:ListCustomRoutingPortMappingsResponse'
, listCustomRoutingPortMappingsResponse_httpStatus
- The response's http status code.
ListCustomRoutingPortMappingsByDestination (Paginated)
data ListCustomRoutingPortMappingsByDestination Source #
See: newListCustomRoutingPortMappingsByDestination
smart constructor.
Instances
newListCustomRoutingPortMappingsByDestination Source #
:: Text | |
-> Text |
|
-> ListCustomRoutingPortMappingsByDestination |
Create a value of ListCustomRoutingPortMappingsByDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListCustomRoutingPortMappingsByDestination'
, listCustomRoutingPortMappingsByDestination_maxResults
- The number of destination port mappings that you want to return with
this call. The default value is 10.
ListCustomRoutingPortMappingsByDestination
, listCustomRoutingPortMappingsByDestination_nextToken
- The token for the next set of results. You receive this token from a
previous call.
ListCustomRoutingPortMappingsByDestination
, listCustomRoutingPortMappingsByDestination_endpointId
- The ID for the virtual private cloud (VPC) subnet.
$sel:destinationAddress:ListCustomRoutingPortMappingsByDestination'
, listCustomRoutingPortMappingsByDestination_destinationAddress
- The endpoint IP address in a virtual private cloud (VPC) subnet for
which you want to receive back port mappings.
data ListCustomRoutingPortMappingsByDestinationResponse Source #
See: newListCustomRoutingPortMappingsByDestinationResponse
smart constructor.
ListCustomRoutingPortMappingsByDestinationResponse' (Maybe [DestinationPortMapping]) (Maybe Text) Int |
Instances
newListCustomRoutingPortMappingsByDestinationResponse Source #
:: Int |
|
-> ListCustomRoutingPortMappingsByDestinationResponse |
Create a value of ListCustomRoutingPortMappingsByDestinationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinationPortMappings:ListCustomRoutingPortMappingsByDestinationResponse'
, listCustomRoutingPortMappingsByDestinationResponse_destinationPortMappings
- The port mappings for the endpoint IP address that you specified in the
request.
ListCustomRoutingPortMappingsByDestination
, listCustomRoutingPortMappingsByDestinationResponse_nextToken
- The token for the next set of results. You receive this token from a
previous call.
$sel:httpStatus:ListCustomRoutingPortMappingsByDestinationResponse'
, listCustomRoutingPortMappingsByDestinationResponse_httpStatus
- The response's http status code.
ListEndpointGroups (Paginated)
data ListEndpointGroups Source #
See: newListEndpointGroups
smart constructor.
Instances
newListEndpointGroups Source #
Create a value of ListEndpointGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListEndpointGroups'
, listEndpointGroups_maxResults
- The number of endpoint group objects that you want to return with this
call. The default value is 10.
ListEndpointGroups
, listEndpointGroups_nextToken
- The token for the next set of results. You receive this token from a
previous call.
ListEndpointGroups
, listEndpointGroups_listenerArn
- The Amazon Resource Name (ARN) of the listener.
data ListEndpointGroupsResponse Source #
See: newListEndpointGroupsResponse
smart constructor.
Instances
newListEndpointGroupsResponse Source #
Create a value of ListEndpointGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointGroups:ListEndpointGroupsResponse'
, listEndpointGroupsResponse_endpointGroups
- The list of the endpoint groups associated with a listener.
ListEndpointGroups
, listEndpointGroupsResponse_nextToken
- The token for the next set of results. You receive this token from a
previous call.
$sel:httpStatus:ListEndpointGroupsResponse'
, listEndpointGroupsResponse_httpStatus
- The response's http status code.
ListListeners (Paginated)
data ListListeners Source #
See: newListListeners
smart constructor.
Instances
Create a value of ListListeners
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListListeners'
, listListeners_maxResults
- The number of listener objects that you want to return with this call.
The default value is 10.
ListListeners
, listListeners_nextToken
- The token for the next set of results. You receive this token from a
previous call.
ListListeners
, listListeners_acceleratorArn
- The Amazon Resource Name (ARN) of the accelerator for which you want to
list listener objects.
data ListListenersResponse Source #
See: newListListenersResponse
smart constructor.
Instances
newListListenersResponse Source #
Create a value of ListListenersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:listeners:ListListenersResponse'
, listListenersResponse_listeners
- The list of listeners for an accelerator.
ListListeners
, listListenersResponse_nextToken
- The token for the next set of results. You receive this token from a
previous call.
$sel:httpStatus:ListListenersResponse'
, listListenersResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) of the accelerator to list tags for. An
ARN uniquely identifies an accelerator.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- Root level tag for the Tags parameters.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ProvisionByoipCidr
data ProvisionByoipCidr Source #
See: newProvisionByoipCidr
smart constructor.
Instances
newProvisionByoipCidr Source #
Create a value of ProvisionByoipCidr
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ProvisionByoipCidr
, provisionByoipCidr_cidr
- The public IPv4 address range, in CIDR notation. The most specific IP
prefix that you can specify is /24. The address range cannot overlap
with another address range that you've brought to this or another
Region.
$sel:cidrAuthorizationContext:ProvisionByoipCidr'
, provisionByoipCidr_cidrAuthorizationContext
- A signed document that proves that you are authorized to bring the
specified IP address range to Amazon using BYOIP.
data ProvisionByoipCidrResponse Source #
See: newProvisionByoipCidrResponse
smart constructor.
Instances
newProvisionByoipCidrResponse Source #
Create a value of ProvisionByoipCidrResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byoipCidr:ProvisionByoipCidrResponse'
, provisionByoipCidrResponse_byoipCidr
- Information about the address range.
$sel:httpStatus:ProvisionByoipCidrResponse'
, provisionByoipCidrResponse_httpStatus
- The response's http status code.
RemoveCustomRoutingEndpoints
data RemoveCustomRoutingEndpoints Source #
See: newRemoveCustomRoutingEndpoints
smart constructor.
Instances
newRemoveCustomRoutingEndpoints Source #
Create a value of RemoveCustomRoutingEndpoints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointIds:RemoveCustomRoutingEndpoints'
, removeCustomRoutingEndpoints_endpointIds
- The IDs for the endpoints. For custom routing accelerators, endpoint IDs
are the virtual private cloud (VPC) subnet IDs.
RemoveCustomRoutingEndpoints
, removeCustomRoutingEndpoints_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group to remove endpoints
from.
data RemoveCustomRoutingEndpointsResponse Source #
See: newRemoveCustomRoutingEndpointsResponse
smart constructor.
Instances
Generic RemoveCustomRoutingEndpointsResponse Source # | |
Defined in Amazonka.GlobalAccelerator.RemoveCustomRoutingEndpoints type Rep RemoveCustomRoutingEndpointsResponse :: Type -> Type # | |
Read RemoveCustomRoutingEndpointsResponse Source # | |
Show RemoveCustomRoutingEndpointsResponse Source # | |
NFData RemoveCustomRoutingEndpointsResponse Source # | |
Eq RemoveCustomRoutingEndpointsResponse Source # | |
type Rep RemoveCustomRoutingEndpointsResponse Source # | |
Defined in Amazonka.GlobalAccelerator.RemoveCustomRoutingEndpoints type Rep RemoveCustomRoutingEndpointsResponse = D1 ('MetaData "RemoveCustomRoutingEndpointsResponse" "Amazonka.GlobalAccelerator.RemoveCustomRoutingEndpoints" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "RemoveCustomRoutingEndpointsResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newRemoveCustomRoutingEndpointsResponse :: RemoveCustomRoutingEndpointsResponse Source #
Create a value of RemoveCustomRoutingEndpointsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RemoveEndpoints
data RemoveEndpoints Source #
See: newRemoveEndpoints
smart constructor.
Instances
Create a value of RemoveEndpoints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointIdentifiers:RemoveEndpoints'
, removeEndpoints_endpointIdentifiers
- The identifiers of the endpoints that you want to remove.
RemoveEndpoints
, removeEndpoints_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group.
data RemoveEndpointsResponse Source #
See: newRemoveEndpointsResponse
smart constructor.
Instances
Generic RemoveEndpointsResponse Source # | |
Defined in Amazonka.GlobalAccelerator.RemoveEndpoints type Rep RemoveEndpointsResponse :: Type -> Type # | |
Read RemoveEndpointsResponse Source # | |
Show RemoveEndpointsResponse Source # | |
Defined in Amazonka.GlobalAccelerator.RemoveEndpoints showsPrec :: Int -> RemoveEndpointsResponse -> ShowS # show :: RemoveEndpointsResponse -> String # showList :: [RemoveEndpointsResponse] -> ShowS # | |
NFData RemoveEndpointsResponse Source # | |
Defined in Amazonka.GlobalAccelerator.RemoveEndpoints rnf :: RemoveEndpointsResponse -> () # | |
Eq RemoveEndpointsResponse Source # | |
Defined in Amazonka.GlobalAccelerator.RemoveEndpoints | |
type Rep RemoveEndpointsResponse Source # | |
Defined in Amazonka.GlobalAccelerator.RemoveEndpoints |
newRemoveEndpointsResponse :: RemoveEndpointsResponse Source #
Create a value of RemoveEndpointsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) of the Global Accelerator resource to add
tags to. An ARN uniquely identifies a resource.
$sel:tags:TagResource'
, tagResource_tags
- The tags to add to a resource. A tag consists of a key and a value that
you define.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) of the Global Accelerator resource to
remove tags from. An ARN uniquely identifies a resource.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The tag key pairs that you want to remove from the specified resources.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateAccelerator
data UpdateAccelerator Source #
See: newUpdateAccelerator
smart constructor.
Instances
Create a value of UpdateAccelerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateAccelerator
, updateAccelerator_enabled
- Indicates whether an accelerator is enabled. The value is true or false.
The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
UpdateAccelerator
, updateAccelerator_ipAddressType
- The IP address type that an accelerator supports. For a standard
accelerator, the value can be IPV4 or DUAL_STACK.
UpdateAccelerator
, updateAccelerator_name
- The name of the accelerator. The name can have a maximum of 64
characters, must contain only alphanumeric characters, periods (.), or
hyphens (-), and must not begin or end with a hyphen or period.
UpdateAccelerator
, updateAccelerator_acceleratorArn
- The Amazon Resource Name (ARN) of the accelerator to update.
data UpdateAcceleratorResponse Source #
See: newUpdateAcceleratorResponse
smart constructor.
Instances
newUpdateAcceleratorResponse Source #
Create a value of UpdateAcceleratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accelerator:UpdateAcceleratorResponse'
, updateAcceleratorResponse_accelerator
- Information about the updated accelerator.
$sel:httpStatus:UpdateAcceleratorResponse'
, updateAcceleratorResponse_httpStatus
- The response's http status code.
UpdateAcceleratorAttributes
data UpdateAcceleratorAttributes Source #
See: newUpdateAcceleratorAttributes
smart constructor.
Instances
newUpdateAcceleratorAttributes Source #
Create a value of UpdateAcceleratorAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateAcceleratorAttributes
, updateAcceleratorAttributes_flowLogsEnabled
- Update whether flow logs are enabled. The default value is false. If the
value is true, FlowLogsS3Bucket
and FlowLogsS3Prefix
must be
specified.
For more information, see Flow Logs in the Global Accelerator Developer Guide.
UpdateAcceleratorAttributes
, updateAcceleratorAttributes_flowLogsS3Bucket
- The name of the Amazon S3 bucket for the flow logs. Attribute is
required if FlowLogsEnabled
is true
. The bucket must exist and have
a bucket policy that grants Global Accelerator permission to write to
the bucket.
UpdateAcceleratorAttributes
, updateAcceleratorAttributes_flowLogsS3Prefix
- Update the prefix for the location in the Amazon S3 bucket for the flow
logs. Attribute is required if FlowLogsEnabled
is true
.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
s3-bucket_name//AWSLogs/aws_account_id
UpdateAcceleratorAttributes
, updateAcceleratorAttributes_acceleratorArn
- The Amazon Resource Name (ARN) of the accelerator that you want to
update.
data UpdateAcceleratorAttributesResponse Source #
See: newUpdateAcceleratorAttributesResponse
smart constructor.
Instances
newUpdateAcceleratorAttributesResponse Source #
Create a value of UpdateAcceleratorAttributesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceleratorAttributes:UpdateAcceleratorAttributesResponse'
, updateAcceleratorAttributesResponse_acceleratorAttributes
- Updated attributes for the accelerator.
$sel:httpStatus:UpdateAcceleratorAttributesResponse'
, updateAcceleratorAttributesResponse_httpStatus
- The response's http status code.
UpdateCustomRoutingAccelerator
data UpdateCustomRoutingAccelerator Source #
See: newUpdateCustomRoutingAccelerator
smart constructor.
Instances
newUpdateCustomRoutingAccelerator Source #
Create a value of UpdateCustomRoutingAccelerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateCustomRoutingAccelerator
, updateCustomRoutingAccelerator_enabled
- Indicates whether an accelerator is enabled. The value is true or false.
The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
UpdateCustomRoutingAccelerator
, updateCustomRoutingAccelerator_ipAddressType
- The IP address type that an accelerator supports. For a custom routing
accelerator, the value must be IPV4.
UpdateCustomRoutingAccelerator
, updateCustomRoutingAccelerator_name
- The name of the accelerator. The name can have a maximum of 64
characters, must contain only alphanumeric characters, periods (.), or
hyphens (-), and must not begin or end with a hyphen or period.
UpdateCustomRoutingAccelerator
, updateCustomRoutingAccelerator_acceleratorArn
- The Amazon Resource Name (ARN) of the accelerator to update.
data UpdateCustomRoutingAcceleratorResponse Source #
See: newUpdateCustomRoutingAcceleratorResponse
smart constructor.
Instances
newUpdateCustomRoutingAcceleratorResponse Source #
Create a value of UpdateCustomRoutingAcceleratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accelerator:UpdateCustomRoutingAcceleratorResponse'
, updateCustomRoutingAcceleratorResponse_accelerator
- Information about the updated custom routing accelerator.
$sel:httpStatus:UpdateCustomRoutingAcceleratorResponse'
, updateCustomRoutingAcceleratorResponse_httpStatus
- The response's http status code.
UpdateCustomRoutingAcceleratorAttributes
data UpdateCustomRoutingAcceleratorAttributes Source #
See: newUpdateCustomRoutingAcceleratorAttributes
smart constructor.
Instances
newUpdateCustomRoutingAcceleratorAttributes Source #
Create a value of UpdateCustomRoutingAcceleratorAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateCustomRoutingAcceleratorAttributes
, updateCustomRoutingAcceleratorAttributes_flowLogsEnabled
- Update whether flow logs are enabled. The default value is false. If the
value is true, FlowLogsS3Bucket
and FlowLogsS3Prefix
must be
specified.
For more information, see Flow logs in the Global Accelerator Developer Guide.
UpdateCustomRoutingAcceleratorAttributes
, updateCustomRoutingAcceleratorAttributes_flowLogsS3Bucket
- The name of the Amazon S3 bucket for the flow logs. Attribute is
required if FlowLogsEnabled
is true
. The bucket must exist and have
a bucket policy that grants Global Accelerator permission to write to
the bucket.
UpdateCustomRoutingAcceleratorAttributes
, updateCustomRoutingAcceleratorAttributes_flowLogsS3Prefix
- Update the prefix for the location in the Amazon S3 bucket for the flow
logs. Attribute is required if FlowLogsEnabled
is true
.
If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
UpdateCustomRoutingAcceleratorAttributes
, updateCustomRoutingAcceleratorAttributes_acceleratorArn
- The Amazon Resource Name (ARN) of the custom routing accelerator to
update attributes for.
data UpdateCustomRoutingAcceleratorAttributesResponse Source #
See: newUpdateCustomRoutingAcceleratorAttributesResponse
smart constructor.
Instances
newUpdateCustomRoutingAcceleratorAttributesResponse Source #
:: Int |
|
-> UpdateCustomRoutingAcceleratorAttributesResponse |
Create a value of UpdateCustomRoutingAcceleratorAttributesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceleratorAttributes:UpdateCustomRoutingAcceleratorAttributesResponse'
, updateCustomRoutingAcceleratorAttributesResponse_acceleratorAttributes
- Updated custom routing accelerator.
$sel:httpStatus:UpdateCustomRoutingAcceleratorAttributesResponse'
, updateCustomRoutingAcceleratorAttributesResponse_httpStatus
- The response's http status code.
UpdateCustomRoutingListener
data UpdateCustomRoutingListener Source #
See: newUpdateCustomRoutingListener
smart constructor.
Instances
newUpdateCustomRoutingListener Source #
Create a value of UpdateCustomRoutingListener
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateCustomRoutingListener
, updateCustomRoutingListener_listenerArn
- The Amazon Resource Name (ARN) of the listener to update.
UpdateCustomRoutingListener
, updateCustomRoutingListener_portRanges
- The updated port range to support for connections from clients to your
accelerator. If you remove ports that are currently being used by a
subnet endpoint, the call fails.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
data UpdateCustomRoutingListenerResponse Source #
See: newUpdateCustomRoutingListenerResponse
smart constructor.
Instances
newUpdateCustomRoutingListenerResponse Source #
Create a value of UpdateCustomRoutingListenerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:listener:UpdateCustomRoutingListenerResponse'
, updateCustomRoutingListenerResponse_listener
- Information for the updated listener for a custom routing accelerator.
$sel:httpStatus:UpdateCustomRoutingListenerResponse'
, updateCustomRoutingListenerResponse_httpStatus
- The response's http status code.
UpdateEndpointGroup
data UpdateEndpointGroup Source #
See: newUpdateEndpointGroup
smart constructor.
UpdateEndpointGroup' (Maybe [EndpointConfiguration]) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe HealthCheckProtocol) (Maybe [PortOverride]) (Maybe Natural) (Maybe Double) Text |
Instances
newUpdateEndpointGroup Source #
Create a value of UpdateEndpointGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointConfigurations:UpdateEndpointGroup'
, updateEndpointGroup_endpointConfigurations
- The list of endpoint objects. A resource must be valid and active when
you add it as an endpoint.
UpdateEndpointGroup
, updateEndpointGroup_healthCheckIntervalSeconds
- The time—10 seconds or 30 seconds—between each health check for an
endpoint. The default value is 30.
UpdateEndpointGroup
, updateEndpointGroup_healthCheckPath
- If the protocol is HTTP/S, then this specifies the path that is the
destination for health check targets. The default value is slash (/).
UpdateEndpointGroup
, updateEndpointGroup_healthCheckPort
- The port that Global Accelerator uses to check the health of endpoints
that are part of this endpoint group. The default port is the listener
port that this endpoint group is associated with. If the listener port
is a list of ports, Global Accelerator uses the first port in the list.
UpdateEndpointGroup
, updateEndpointGroup_healthCheckProtocol
- The protocol that Global Accelerator uses to check the health of
endpoints that are part of this endpoint group. The default value is
TCP.
UpdateEndpointGroup
, updateEndpointGroup_portOverrides
- Override specific listener ports used to route traffic to endpoints that
are part of this endpoint group. For example, you can create a port
override in which the listener receives user traffic on ports 80 and
443, but your accelerator routes that traffic to ports 1080 and 1443,
respectively, on the endpoints.
For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
UpdateEndpointGroup
, updateEndpointGroup_thresholdCount
- The number of consecutive health checks required to set the state of a
healthy endpoint to unhealthy, or to set an unhealthy endpoint to
healthy. The default value is 3.
UpdateEndpointGroup
, updateEndpointGroup_trafficDialPercentage
- The percentage of traffic to send to an Amazon Web Services Region.
Additional traffic is distributed to other endpoint groups for this
listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
UpdateEndpointGroup
, updateEndpointGroup_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group.
data UpdateEndpointGroupResponse Source #
See: newUpdateEndpointGroupResponse
smart constructor.
Instances
newUpdateEndpointGroupResponse Source #
Create a value of UpdateEndpointGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointGroup:UpdateEndpointGroupResponse'
, updateEndpointGroupResponse_endpointGroup
- The information about the endpoint group that was updated.
$sel:httpStatus:UpdateEndpointGroupResponse'
, updateEndpointGroupResponse_httpStatus
- The response's http status code.
UpdateListener
data UpdateListener Source #
See: newUpdateListener
smart constructor.
Instances
Create a value of UpdateListener
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateListener
, updateListener_clientAffinity
- Client affinity lets you direct all requests from a user to the same
endpoint, if you have stateful applications, regardless of the port and
protocol of the client request. Client affinity gives you control over
whether to always route each client to the same specific endpoint.
Global Accelerator uses a consistent-flow hashing algorithm to choose
the optimal endpoint for a connection. If client affinity is NONE
,
Global Accelerator uses the "five-tuple" (5-tuple) properties—source
IP address, source port, destination IP address, destination port, and
protocol—to select the hash value, and then chooses the best endpoint.
However, with this setting, if someone uses different ports to connect
to Global Accelerator, their connections might not be always routed to
the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set
client affinity to SOURCE_IP
instead. When you use the SOURCE_IP
setting, Global Accelerator uses the "two-tuple" (2-tuple) properties—
source (client) IP address and destination IP address—to select the hash
value.
The default value is NONE
.
UpdateListener
, updateListener_portRanges
- The updated list of port ranges for the connections from clients to the
accelerator.
UpdateListener
, updateListener_protocol
- The updated protocol for the connections from clients to the
accelerator.
UpdateListener
, updateListener_listenerArn
- The Amazon Resource Name (ARN) of the listener to update.
data UpdateListenerResponse Source #
See: newUpdateListenerResponse
smart constructor.
Instances
newUpdateListenerResponse Source #
Create a value of UpdateListenerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:listener:UpdateListenerResponse'
, updateListenerResponse_listener
- Information for the updated listener.
$sel:httpStatus:UpdateListenerResponse'
, updateListenerResponse_httpStatus
- The response's http status code.
WithdrawByoipCidr
data WithdrawByoipCidr Source #
See: newWithdrawByoipCidr
smart constructor.
Instances
Create a value of WithdrawByoipCidr
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
WithdrawByoipCidr
, withdrawByoipCidr_cidr
- The address range, in CIDR notation.
data WithdrawByoipCidrResponse Source #
See: newWithdrawByoipCidrResponse
smart constructor.
Instances
newWithdrawByoipCidrResponse Source #
Create a value of WithdrawByoipCidrResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byoipCidr:WithdrawByoipCidrResponse'
, withdrawByoipCidrResponse_byoipCidr
- Information about the address pool.
$sel:httpStatus:WithdrawByoipCidrResponse'
, withdrawByoipCidrResponse_httpStatus
- The response's http status code.
Types
AcceleratorStatus
newtype AcceleratorStatus Source #
pattern AcceleratorStatus_DEPLOYED :: AcceleratorStatus | |
pattern AcceleratorStatus_IN_PROGRESS :: AcceleratorStatus |
Instances
ByoipCidrState
newtype ByoipCidrState Source #
pattern ByoipCidrState_ADVERTISING :: ByoipCidrState | |
pattern ByoipCidrState_DEPROVISIONED :: ByoipCidrState | |
pattern ByoipCidrState_FAILED_ADVERTISING :: ByoipCidrState | |
pattern ByoipCidrState_FAILED_DEPROVISION :: ByoipCidrState | |
pattern ByoipCidrState_FAILED_PROVISION :: ByoipCidrState | |
pattern ByoipCidrState_FAILED_WITHDRAW :: ByoipCidrState | |
pattern ByoipCidrState_PENDING_ADVERTISING :: ByoipCidrState | |
pattern ByoipCidrState_PENDING_DEPROVISIONING :: ByoipCidrState | |
pattern ByoipCidrState_PENDING_PROVISIONING :: ByoipCidrState | |
pattern ByoipCidrState_PENDING_WITHDRAWING :: ByoipCidrState | |
pattern ByoipCidrState_READY :: ByoipCidrState |
Instances
ClientAffinity
newtype ClientAffinity Source #
pattern ClientAffinity_NONE :: ClientAffinity | |
pattern ClientAffinity_SOURCE_IP :: ClientAffinity |
Instances
CustomRoutingAcceleratorStatus
newtype CustomRoutingAcceleratorStatus Source #
pattern CustomRoutingAcceleratorStatus_DEPLOYED :: CustomRoutingAcceleratorStatus | |
pattern CustomRoutingAcceleratorStatus_IN_PROGRESS :: CustomRoutingAcceleratorStatus |
Instances
CustomRoutingDestinationTrafficState
newtype CustomRoutingDestinationTrafficState Source #
pattern CustomRoutingDestinationTrafficState_ALLOW :: CustomRoutingDestinationTrafficState | |
pattern CustomRoutingDestinationTrafficState_DENY :: CustomRoutingDestinationTrafficState |
Instances
CustomRoutingProtocol
newtype CustomRoutingProtocol Source #
pattern CustomRoutingProtocol_TCP :: CustomRoutingProtocol | |
pattern CustomRoutingProtocol_UDP :: CustomRoutingProtocol |
Instances
HealthCheckProtocol
newtype HealthCheckProtocol Source #
pattern HealthCheckProtocol_HTTP :: HealthCheckProtocol | |
pattern HealthCheckProtocol_HTTPS :: HealthCheckProtocol | |
pattern HealthCheckProtocol_TCP :: HealthCheckProtocol |
Instances
HealthState
newtype HealthState Source #
pattern HealthState_HEALTHY :: HealthState | |
pattern HealthState_INITIAL :: HealthState | |
pattern HealthState_UNHEALTHY :: HealthState |
Instances
IpAddressFamily
newtype IpAddressFamily Source #
pattern IpAddressFamily_IPv4 :: IpAddressFamily | |
pattern IpAddressFamily_IPv6 :: IpAddressFamily |
Instances
IpAddressType
newtype IpAddressType Source #
pattern IpAddressType_DUAL_STACK :: IpAddressType | |
pattern IpAddressType_IPV4 :: IpAddressType |
Instances
Protocol
pattern Protocol_TCP :: Protocol | |
pattern Protocol_UDP :: Protocol |
Instances
Accelerator
data Accelerator Source #
An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.
See: newAccelerator
smart constructor.
Accelerator' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [AcceleratorEvent]) (Maybe IpAddressType) (Maybe [IpSet]) (Maybe POSIX) (Maybe Text) (Maybe AcceleratorStatus) |
Instances
newAccelerator :: Accelerator Source #
Create a value of Accelerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceleratorArn:Accelerator'
, accelerator_acceleratorArn
- The Amazon Resource Name (ARN) of the accelerator.
$sel:createdTime:Accelerator'
, accelerator_createdTime
- The date and time that the accelerator was created.
$sel:dnsName:Accelerator'
, accelerator_dnsName
- The Domain Name System (DNS) name that Global Accelerator creates that
points to an accelerator's static IPv4 addresses.
The naming convention for the DNS name for an accelerator is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.
If you have a dual-stack accelerator, you also have a second DNS name,
DualStackDnsName
, that points to both the A record and the AAAA record
for all four static addresses for the accelerator: two IPv4 addresses
and two IPv6 addresses.
For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
$sel:dualStackDnsName:Accelerator'
, accelerator_dualStackDnsName
- The Domain Name System (DNS) name that Global Accelerator creates that
points to a dual-stack accelerator's four static IP addresses: two IPv4
addresses and two IPv6 addresses.
The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com.
Note: Global Accelerator also assigns a default DNS name, DnsName
, to
your accelerator that points just to the static IPv4 addresses.
For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
$sel:enabled:Accelerator'
, accelerator_enabled
- Indicates whether the accelerator is enabled. The value is true or
false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
$sel:events:Accelerator'
, accelerator_events
- A history of changes that you make to an accelerator in Global
Accelerator.
$sel:ipAddressType:Accelerator'
, accelerator_ipAddressType
- The IP address type that an accelerator supports. For a standard
accelerator, the value can be IPV4 or DUAL_STACK.
$sel:ipSets:Accelerator'
, accelerator_ipSets
- The static IP addresses that Global Accelerator associates with the
accelerator.
$sel:lastModifiedTime:Accelerator'
, accelerator_lastModifiedTime
- The date and time that the accelerator was last modified.
$sel:name:Accelerator'
, accelerator_name
- The name of the accelerator. The name must contain only alphanumeric
characters or hyphens (-), and must not begin or end with a hyphen.
$sel:status:Accelerator'
, accelerator_status
- Describes the deployment status of the accelerator.
AcceleratorAttributes
data AcceleratorAttributes Source #
Attributes of an accelerator.
See: newAcceleratorAttributes
smart constructor.
Instances
newAcceleratorAttributes :: AcceleratorAttributes Source #
Create a value of AcceleratorAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:flowLogsEnabled:AcceleratorAttributes'
, acceleratorAttributes_flowLogsEnabled
- Indicates whether flow logs are enabled. The default value is false. If
the value is true, FlowLogsS3Bucket
and FlowLogsS3Prefix
must be
specified.
For more information, see Flow logs in the Global Accelerator Developer Guide.
$sel:flowLogsS3Bucket:AcceleratorAttributes'
, acceleratorAttributes_flowLogsS3Bucket
- The name of the Amazon S3 bucket for the flow logs. Attribute is
required if FlowLogsEnabled
is true
. The bucket must exist and have
a bucket policy that grants Global Accelerator permission to write to
the bucket.
$sel:flowLogsS3Prefix:AcceleratorAttributes'
, acceleratorAttributes_flowLogsS3Prefix
- The prefix for the location in the Amazon S3 bucket for the flow logs.
Attribute is required if FlowLogsEnabled
is true
.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
s3-bucket_name//AWSLogs/aws_account_id
AcceleratorEvent
data AcceleratorEvent Source #
A complex type that contains a Timestamp
value and Message
for
changes that you make to an accelerator in Global Accelerator. Messages
stored here provide progress or error information when you update an
accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global
Accelerator stores a maximum of ten event messages.
See: newAcceleratorEvent
smart constructor.
Instances
newAcceleratorEvent :: AcceleratorEvent Source #
Create a value of AcceleratorEvent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:AcceleratorEvent'
, acceleratorEvent_message
- A string that contains an Event
message describing changes or errors
when you update an accelerator in Global Accelerator from IPv4 to
dual-stack, or dual-stack to IPv4.
$sel:timestamp:AcceleratorEvent'
, acceleratorEvent_timestamp
- A timestamp for when you update an accelerator in Global Accelerator
from IPv4 to dual-stack, or dual-stack to IPv4.
ByoipCidr
Information about an IP address range that is provisioned for use with your Amazon Web Services resources through bring your own IP address (BYOIP).
The following describes each BYOIP State
that your IP address range
can be in.
- PENDING_PROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with Global Accelerator.
- READY — The address range is provisioned with Global Accelerator and can be advertised.
- PENDING_ADVERTISING — You’ve submitted a request for Global Accelerator to advertise an address range but it is not yet being advertised.
- ADVERTISING — The address range is being advertised by Global Accelerator.
- PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by Global Accelerator.
- PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from Global Accelerator but it is still provisioned.
- DEPROVISIONED — The address range is deprovisioned from Global Accelerator.
- FAILED_PROVISION — The request to provision the address range from Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.
- FAILED_ADVERTISING — The request for Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.
- FAILED_WITHDRAW — The request to withdraw the address range from advertising by Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.
- FAILED_DEPROVISION — The request to deprovision the address range from Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.
See: newByoipCidr
smart constructor.
Instances
FromJSON ByoipCidr Source # | |
Generic ByoipCidr Source # | |
Read ByoipCidr Source # | |
Show ByoipCidr Source # | |
NFData ByoipCidr Source # | |
Defined in Amazonka.GlobalAccelerator.Types.ByoipCidr | |
Eq ByoipCidr Source # | |
Hashable ByoipCidr Source # | |
Defined in Amazonka.GlobalAccelerator.Types.ByoipCidr | |
type Rep ByoipCidr Source # | |
Defined in Amazonka.GlobalAccelerator.Types.ByoipCidr type Rep ByoipCidr = D1 ('MetaData "ByoipCidr" "Amazonka.GlobalAccelerator.Types.ByoipCidr" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "ByoipCidr'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cidr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ByoipCidrEvent])) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByoipCidrState))))) |
newByoipCidr :: ByoipCidr Source #
Create a value of ByoipCidr
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cidr:ByoipCidr'
, byoipCidr_cidr
- The address range, in CIDR notation.
$sel:events:ByoipCidr'
, byoipCidr_events
- A history of status changes for an IP address range that you bring to
Global Accelerator through bring your own IP address (BYOIP).
$sel:state:ByoipCidr'
, byoipCidr_state
- The state of the address pool.
ByoipCidrEvent
data ByoipCidrEvent Source #
A complex type that contains a Message
and a Timestamp
value for
changes that you make in the status of an IP address range that you
bring to Global Accelerator through bring your own IP address (BYOIP).
See: newByoipCidrEvent
smart constructor.
Instances
newByoipCidrEvent :: ByoipCidrEvent Source #
Create a value of ByoipCidrEvent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:ByoipCidrEvent'
, byoipCidrEvent_message
- A string that contains an Event
message describing changes that you
make in the status of an IP address range that you bring to Global
Accelerator through bring your own IP address (BYOIP).
$sel:timestamp:ByoipCidrEvent'
, byoipCidrEvent_timestamp
- A timestamp for when you make a status change for an IP address range
that you bring to Global Accelerator through bring your own IP address
(BYOIP).
CidrAuthorizationContext
data CidrAuthorizationContext Source #
Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services account using bring your own IP addresses (BYOIP).
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
See: newCidrAuthorizationContext
smart constructor.
Instances
newCidrAuthorizationContext Source #
:: Text | |
-> Text | |
-> CidrAuthorizationContext |
Create a value of CidrAuthorizationContext
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:CidrAuthorizationContext'
, cidrAuthorizationContext_message
- The plain-text authorization message for the prefix and account.
$sel:signature:CidrAuthorizationContext'
, cidrAuthorizationContext_signature
- The signed authorization message for the prefix and account.
CustomRoutingAccelerator
data CustomRoutingAccelerator Source #
Attributes of a custom routing accelerator.
See: newCustomRoutingAccelerator
smart constructor.
CustomRoutingAccelerator' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe IpAddressType) (Maybe [IpSet]) (Maybe POSIX) (Maybe Text) (Maybe CustomRoutingAcceleratorStatus) |
Instances
newCustomRoutingAccelerator :: CustomRoutingAccelerator Source #
Create a value of CustomRoutingAccelerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceleratorArn:CustomRoutingAccelerator'
, customRoutingAccelerator_acceleratorArn
- The Amazon Resource Name (ARN) of the custom routing accelerator.
$sel:createdTime:CustomRoutingAccelerator'
, customRoutingAccelerator_createdTime
- The date and time that the accelerator was created.
$sel:dnsName:CustomRoutingAccelerator'
, customRoutingAccelerator_dnsName
- The Domain Name System (DNS) name that Global Accelerator creates that
points to an accelerator's static IPv4 addresses.
The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.
If you have a dual-stack accelerator, you also have a second DNS name,
DualStackDnsName
, that points to both the A record and the AAAA record
for all four static addresses for the accelerator: two IPv4 addresses
and two IPv6 addresses.
For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
$sel:enabled:CustomRoutingAccelerator'
, customRoutingAccelerator_enabled
- Indicates whether the accelerator is enabled. The value is true or
false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
$sel:ipAddressType:CustomRoutingAccelerator'
, customRoutingAccelerator_ipAddressType
- The IP address type that an accelerator supports. For a custom routing
accelerator, the value must be IPV4.
$sel:ipSets:CustomRoutingAccelerator'
, customRoutingAccelerator_ipSets
- The static IP addresses that Global Accelerator associates with the
accelerator.
$sel:lastModifiedTime:CustomRoutingAccelerator'
, customRoutingAccelerator_lastModifiedTime
- The date and time that the accelerator was last modified.
$sel:name:CustomRoutingAccelerator'
, customRoutingAccelerator_name
- The name of the accelerator. The name must contain only alphanumeric
characters or hyphens (-), and must not begin or end with a hyphen.
$sel:status:CustomRoutingAccelerator'
, customRoutingAccelerator_status
- Describes the deployment status of the accelerator.
CustomRoutingAcceleratorAttributes
data CustomRoutingAcceleratorAttributes Source #
Attributes of a custom routing accelerator.
See: newCustomRoutingAcceleratorAttributes
smart constructor.
Instances
newCustomRoutingAcceleratorAttributes :: CustomRoutingAcceleratorAttributes Source #
Create a value of CustomRoutingAcceleratorAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:flowLogsEnabled:CustomRoutingAcceleratorAttributes'
, customRoutingAcceleratorAttributes_flowLogsEnabled
- Indicates whether flow logs are enabled. The default value is false. If
the value is true, FlowLogsS3Bucket
and FlowLogsS3Prefix
must be
specified.
For more information, see Flow logs in the Global Accelerator Developer Guide.
$sel:flowLogsS3Bucket:CustomRoutingAcceleratorAttributes'
, customRoutingAcceleratorAttributes_flowLogsS3Bucket
- The name of the Amazon S3 bucket for the flow logs. Attribute is
required if FlowLogsEnabled
is true
. The bucket must exist and have
a bucket policy that grants Global Accelerator permission to write to
the bucket.
$sel:flowLogsS3Prefix:CustomRoutingAcceleratorAttributes'
, customRoutingAcceleratorAttributes_flowLogsS3Prefix
- The prefix for the location in the Amazon S3 bucket for the flow logs.
Attribute is required if FlowLogsEnabled
is true
.
If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
CustomRoutingDestinationConfiguration
data CustomRoutingDestinationConfiguration Source #
For a custom routing accelerator, sets the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
See: newCustomRoutingDestinationConfiguration
smart constructor.
Instances
newCustomRoutingDestinationConfiguration Source #
Create a value of CustomRoutingDestinationConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fromPort:CustomRoutingDestinationConfiguration'
, customRoutingDestinationConfiguration_fromPort
- The first port, inclusive, in the range of ports for the endpoint group
that is associated with a custom routing accelerator.
$sel:toPort:CustomRoutingDestinationConfiguration'
, customRoutingDestinationConfiguration_toPort
- The last port, inclusive, in the range of ports for the endpoint group
that is associated with a custom routing accelerator.
$sel:protocols:CustomRoutingDestinationConfiguration'
, customRoutingDestinationConfiguration_protocols
- The protocol for the endpoint group that is associated with a custom
routing accelerator. The protocol can be either TCP or UDP.
CustomRoutingDestinationDescription
data CustomRoutingDestinationDescription Source #
For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
See: newCustomRoutingDestinationDescription
smart constructor.
Instances
newCustomRoutingDestinationDescription :: CustomRoutingDestinationDescription Source #
Create a value of CustomRoutingDestinationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fromPort:CustomRoutingDestinationDescription'
, customRoutingDestinationDescription_fromPort
- The first port, inclusive, in the range of ports for the endpoint group
that is associated with a custom routing accelerator.
$sel:protocols:CustomRoutingDestinationDescription'
, customRoutingDestinationDescription_protocols
- The protocol for the endpoint group that is associated with a custom
routing accelerator. The protocol can be either TCP or UDP.
$sel:toPort:CustomRoutingDestinationDescription'
, customRoutingDestinationDescription_toPort
- The last port, inclusive, in the range of ports for the endpoint group
that is associated with a custom routing accelerator.
CustomRoutingEndpointConfiguration
data CustomRoutingEndpointConfiguration Source #
The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs.
See: newCustomRoutingEndpointConfiguration
smart constructor.
Instances
ToJSON CustomRoutingEndpointConfiguration Source # | |
Generic CustomRoutingEndpointConfiguration Source # | |
Read CustomRoutingEndpointConfiguration Source # | |
Show CustomRoutingEndpointConfiguration Source # | |
NFData CustomRoutingEndpointConfiguration Source # | |
Eq CustomRoutingEndpointConfiguration Source # | |
Hashable CustomRoutingEndpointConfiguration Source # | |
type Rep CustomRoutingEndpointConfiguration Source # | |
Defined in Amazonka.GlobalAccelerator.Types.CustomRoutingEndpointConfiguration type Rep CustomRoutingEndpointConfiguration = D1 ('MetaData "CustomRoutingEndpointConfiguration" "Amazonka.GlobalAccelerator.Types.CustomRoutingEndpointConfiguration" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "CustomRoutingEndpointConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newCustomRoutingEndpointConfiguration :: CustomRoutingEndpointConfiguration Source #
Create a value of CustomRoutingEndpointConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointId:CustomRoutingEndpointConfiguration'
, customRoutingEndpointConfiguration_endpointId
- An ID for the endpoint. For custom routing accelerators, this is the
virtual private cloud (VPC) subnet ID.
CustomRoutingEndpointDescription
data CustomRoutingEndpointDescription Source #
A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.
See: newCustomRoutingEndpointDescription
smart constructor.
Instances
FromJSON CustomRoutingEndpointDescription Source # | |
Generic CustomRoutingEndpointDescription Source # | |
Read CustomRoutingEndpointDescription Source # | |
Show CustomRoutingEndpointDescription Source # | |
NFData CustomRoutingEndpointDescription Source # | |
Eq CustomRoutingEndpointDescription Source # | |
Hashable CustomRoutingEndpointDescription Source # | |
type Rep CustomRoutingEndpointDescription Source # | |
Defined in Amazonka.GlobalAccelerator.Types.CustomRoutingEndpointDescription type Rep CustomRoutingEndpointDescription = D1 ('MetaData "CustomRoutingEndpointDescription" "Amazonka.GlobalAccelerator.Types.CustomRoutingEndpointDescription" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "CustomRoutingEndpointDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newCustomRoutingEndpointDescription :: CustomRoutingEndpointDescription Source #
Create a value of CustomRoutingEndpointDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointId:CustomRoutingEndpointDescription'
, customRoutingEndpointDescription_endpointId
- An ID for the endpoint. For custom routing accelerators, this is the
virtual private cloud (VPC) subnet ID.
CustomRoutingEndpointGroup
data CustomRoutingEndpointGroup Source #
A complex type for the endpoint group for a custom routing accelerator. An Amazon Web Services Region can have only one endpoint group for a specific listener.
See: newCustomRoutingEndpointGroup
smart constructor.
CustomRoutingEndpointGroup' (Maybe [CustomRoutingDestinationDescription]) (Maybe [CustomRoutingEndpointDescription]) (Maybe Text) (Maybe Text) |
Instances
newCustomRoutingEndpointGroup :: CustomRoutingEndpointGroup Source #
Create a value of CustomRoutingEndpointGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinationDescriptions:CustomRoutingEndpointGroup'
, customRoutingEndpointGroup_destinationDescriptions
- For a custom routing accelerator, describes the port range and protocol
for all endpoints (virtual private cloud subnets) in an endpoint group
to accept client traffic on.
$sel:endpointDescriptions:CustomRoutingEndpointGroup'
, customRoutingEndpointGroup_endpointDescriptions
- For a custom routing accelerator, describes the endpoints (virtual
private cloud subnets) in an endpoint group to accept client traffic on.
$sel:endpointGroupArn:CustomRoutingEndpointGroup'
, customRoutingEndpointGroup_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group.
$sel:endpointGroupRegion:CustomRoutingEndpointGroup'
, customRoutingEndpointGroup_endpointGroupRegion
- The Amazon Web Services Region where the endpoint group is located.
CustomRoutingListener
data CustomRoutingListener Source #
A complex type for a listener for a custom routing accelerator.
See: newCustomRoutingListener
smart constructor.
Instances
newCustomRoutingListener :: CustomRoutingListener Source #
Create a value of CustomRoutingListener
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:listenerArn:CustomRoutingListener'
, customRoutingListener_listenerArn
- The Amazon Resource Name (ARN) of the listener.
$sel:portRanges:CustomRoutingListener'
, customRoutingListener_portRanges
- The port range to support for connections from clients to your
accelerator.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
DestinationPortMapping
data DestinationPortMapping Source #
The port mappings for a specified endpoint IP address (destination).
See: newDestinationPortMapping
smart constructor.
DestinationPortMapping' (Maybe Text) (Maybe [SocketAddress]) (Maybe SocketAddress) (Maybe CustomRoutingDestinationTrafficState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IpAddressType) |
Instances
newDestinationPortMapping :: DestinationPortMapping Source #
Create a value of DestinationPortMapping
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceleratorArn:DestinationPortMapping'
, destinationPortMapping_acceleratorArn
- The Amazon Resource Name (ARN) of the custom routing accelerator that
you have port mappings for.
$sel:acceleratorSocketAddresses:DestinationPortMapping'
, destinationPortMapping_acceleratorSocketAddresses
- The IP address/port combinations (sockets) that map to a given
destination socket address.
$sel:destinationSocketAddress:DestinationPortMapping'
, destinationPortMapping_destinationSocketAddress
- The endpoint IP address/port combination for traffic received on the
accelerator socket address.
$sel:destinationTrafficState:DestinationPortMapping'
, destinationPortMapping_destinationTrafficState
- Indicates whether or not a port mapping destination can receive traffic.
The value is either ALLOW, if traffic is allowed to the destination, or
DENY, if traffic is not allowed to the destination.
$sel:endpointGroupArn:DestinationPortMapping'
, destinationPortMapping_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group.
$sel:endpointGroupRegion:DestinationPortMapping'
, destinationPortMapping_endpointGroupRegion
- The Amazon Web Services Region for the endpoint group.
$sel:endpointId:DestinationPortMapping'
, destinationPortMapping_endpointId
- The ID for the virtual private cloud (VPC) subnet.
$sel:ipAddressType:DestinationPortMapping'
, destinationPortMapping_ipAddressType
- The IP address type that an accelerator supports. For a custom routing
accelerator, the value must be IPV4.
EndpointConfiguration
data EndpointConfiguration Source #
A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.
See: newEndpointConfiguration
smart constructor.
Instances
newEndpointConfiguration :: EndpointConfiguration Source #
Create a value of EndpointConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientIPPreservationEnabled:EndpointConfiguration'
, endpointConfiguration_clientIPPreservationEnabled
- Indicates whether client IP address preservation is enabled for an
endpoint. The value is true or false. The default value is true for new
accelerators.
If the value is set to true, the client's IP address is preserved in
the X-Forwarded-For
request header as traffic travels to applications
on the endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
$sel:endpointId:EndpointConfiguration'
, endpointConfiguration_endpointId
- An ID for the endpoint. If the endpoint is a Network Load Balancer or
Application Load Balancer, this is the Amazon Resource Name (ARN) of the
resource. If the endpoint is an Elastic IP address, this is the Elastic
IP address allocation ID. For Amazon EC2 instances, this is the EC2
instance ID. A resource must be valid and active when you add it as an
endpoint.
An Application Load Balancer can be either internal or internet-facing.
$sel:weight:EndpointConfiguration'
, endpointConfiguration_weight
- The weight associated with the endpoint. When you add weights to
endpoints, you configure Global Accelerator to route traffic based on
proportions that you specify. For example, you might specify endpoint
weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your
traffic, on average, is routed to the first endpoint, 5/20 is routed
both to the second and third endpoints, and 6/20 is routed to the last
endpoint. For more information, see
Endpoint weights
in the Global Accelerator Developer Guide.
EndpointDescription
data EndpointDescription Source #
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
See: newEndpointDescription
smart constructor.
Instances
newEndpointDescription :: EndpointDescription Source #
Create a value of EndpointDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientIPPreservationEnabled:EndpointDescription'
, endpointDescription_clientIPPreservationEnabled
- Indicates whether client IP address preservation is enabled for an
endpoint. The value is true or false. The default value is true for new
accelerators.
If the value is set to true, the client's IP address is preserved in
the X-Forwarded-For
request header as traffic travels to applications
on the endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.
For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
$sel:endpointId:EndpointDescription'
, endpointDescription_endpointId
- An ID for the endpoint. If the endpoint is a Network Load Balancer or
Application Load Balancer, this is the Amazon Resource Name (ARN) of the
resource. If the endpoint is an Elastic IP address, this is the Elastic
IP address allocation ID. For Amazon EC2 instances, this is the EC2
instance ID.
An Application Load Balancer can be either internal or internet-facing.
$sel:healthReason:EndpointDescription'
, endpointDescription_healthReason
- Returns a null result.
$sel:healthState:EndpointDescription'
, endpointDescription_healthState
- The health status of the endpoint.
$sel:weight:EndpointDescription'
, endpointDescription_weight
- The weight associated with the endpoint. When you add weights to
endpoints, you configure Global Accelerator to route traffic based on
proportions that you specify. For example, you might specify endpoint
weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your
traffic, on average, is routed to the first endpoint, 5/20 is routed
both to the second and third endpoints, and 6/20 is routed to the last
endpoint. For more information, see
Endpoint weights
in the Global Accelerator Developer Guide.
EndpointGroup
data EndpointGroup Source #
A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener.
See: newEndpointGroup
smart constructor.
EndpointGroup' (Maybe [EndpointDescription]) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe HealthCheckProtocol) (Maybe [PortOverride]) (Maybe Natural) (Maybe Double) |
Instances
newEndpointGroup :: EndpointGroup Source #
Create a value of EndpointGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointDescriptions:EndpointGroup'
, endpointGroup_endpointDescriptions
- The list of endpoint objects.
$sel:endpointGroupArn:EndpointGroup'
, endpointGroup_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group.
$sel:endpointGroupRegion:EndpointGroup'
, endpointGroup_endpointGroupRegion
- The Amazon Web Services Region where the endpoint group is located.
$sel:healthCheckIntervalSeconds:EndpointGroup'
, endpointGroup_healthCheckIntervalSeconds
- The time—10 seconds or 30 seconds—between health checks for each
endpoint. The default value is 30.
$sel:healthCheckPath:EndpointGroup'
, endpointGroup_healthCheckPath
- If the protocol is HTTP/S, then this value provides the ping path that
Global Accelerator uses for the destination on the endpoints for health
checks. The default is slash (/).
$sel:healthCheckPort:EndpointGroup'
, endpointGroup_healthCheckPort
- The port that Global Accelerator uses to perform health checks on
endpoints that are part of this endpoint group.
The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
$sel:healthCheckProtocol:EndpointGroup'
, endpointGroup_healthCheckProtocol
- The protocol that Global Accelerator uses to perform health checks on
endpoints that are part of this endpoint group. The default value is
TCP.
$sel:portOverrides:EndpointGroup'
, endpointGroup_portOverrides
- Allows you to override the destination ports used to route traffic to an
endpoint. Using a port override lets you map a list of external
destination ports (that your users send traffic to) to a list of
internal destination ports that you want an application endpoint to
receive traffic on.
$sel:thresholdCount:EndpointGroup'
, endpointGroup_thresholdCount
- The number of consecutive health checks required to set the state of a
healthy endpoint to unhealthy, or to set an unhealthy endpoint to
healthy. The default value is 3.
$sel:trafficDialPercentage:EndpointGroup'
, endpointGroup_trafficDialPercentage
- The percentage of traffic to send to an Amazon Web Services Region.
Additional traffic is distributed to other endpoint groups for this
listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
EndpointIdentifier
data EndpointIdentifier Source #
A complex type for an endpoint. Specifies information about the endpoint to remove from the endpoint group.
See: newEndpointIdentifier
smart constructor.
Instances
newEndpointIdentifier Source #
Create a value of EndpointIdentifier
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientIPPreservationEnabled:EndpointIdentifier'
, endpointIdentifier_clientIPPreservationEnabled
- Indicates whether client IP address preservation is enabled for an
endpoint. The value is true or false.
If the value is set to true, the client's IP address is preserved in
the X-Forwarded-For
request header as traffic travels to applications
on the endpoint fronted by the accelerator.
$sel:endpointId:EndpointIdentifier'
, endpointIdentifier_endpointId
- An ID for the endpoint. If the endpoint is a Network Load Balancer or
Application Load Balancer, this is the Amazon Resource Name (ARN) of the
resource. If the endpoint is an Elastic IP address, this is the Elastic
IP address allocation ID. For Amazon EC2 instances, this is the EC2
instance ID.
An Application Load Balancer can be either internal or internet-facing.
IpSet
A complex type for the set of IP addresses for an accelerator.
See: newIpSet
smart constructor.
Instances
FromJSON IpSet Source # | |
Generic IpSet Source # | |
Read IpSet Source # | |
Show IpSet Source # | |
NFData IpSet Source # | |
Defined in Amazonka.GlobalAccelerator.Types.IpSet | |
Eq IpSet Source # | |
Hashable IpSet Source # | |
Defined in Amazonka.GlobalAccelerator.Types.IpSet | |
type Rep IpSet Source # | |
Defined in Amazonka.GlobalAccelerator.Types.IpSet type Rep IpSet = D1 ('MetaData "IpSet" "Amazonka.GlobalAccelerator.Types.IpSet" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "IpSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipAddressFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpAddressFamily)) :*: (S1 ('MetaSel ('Just "ipAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "ipFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
Create a value of IpSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ipAddressFamily:IpSet'
, ipSet_ipAddressFamily
- The types of IP addresses included in this IP set.
$sel:ipAddresses:IpSet'
, ipSet_ipAddresses
- The array of IP addresses in the IP address set. An IP address set can
have a maximum of two IP addresses.
$sel:ipFamily:IpSet'
, ipSet_ipFamily
- IpFamily is deprecated and has been replaced by IpAddressFamily.
Listener
A complex type for a listener.
See: newListener
smart constructor.
Instances
newListener :: Listener Source #
Create a value of Listener
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientAffinity:Listener'
, listener_clientAffinity
- Client affinity lets you direct all requests from a user to the same
endpoint, if you have stateful applications, regardless of the port and
protocol of the client request. Client affinity gives you control over
whether to always route each client to the same specific endpoint.
Global Accelerator uses a consistent-flow hashing algorithm to choose
the optimal endpoint for a connection. If client affinity is NONE
,
Global Accelerator uses the "five-tuple" (5-tuple) properties—source
IP address, source port, destination IP address, destination port, and
protocol—to select the hash value, and then chooses the best endpoint.
However, with this setting, if someone uses different ports to connect
to Global Accelerator, their connections might not be always routed to
the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set
client affinity to SOURCE_IP
instead. When you use the SOURCE_IP
setting, Global Accelerator uses the "two-tuple" (2-tuple) properties—
source (client) IP address and destination IP address—to select the hash
value.
The default value is NONE
.
$sel:listenerArn:Listener'
, listener_listenerArn
- The Amazon Resource Name (ARN) of the listener.
$sel:portRanges:Listener'
, listener_portRanges
- The list of port ranges for the connections from clients to the
accelerator.
$sel:protocol:Listener'
, listener_protocol
- The protocol for the connections from clients to the accelerator.
PortMapping
data PortMapping Source #
Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual private cloud (VPC) subnets. Custom routing is a port mapping protocol in Global Accelerator that statically associates port ranges with VPC subnets, which allows Global Accelerator to route to specific instances and ports within one or more subnets.
See: newPortMapping
smart constructor.
PortMapping' (Maybe Natural) (Maybe SocketAddress) (Maybe CustomRoutingDestinationTrafficState) (Maybe Text) (Maybe Text) (Maybe (NonEmpty CustomRoutingProtocol)) |
Instances
newPortMapping :: PortMapping Source #
Create a value of PortMapping
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceleratorPort:PortMapping'
, portMapping_acceleratorPort
- The accelerator port.
$sel:destinationSocketAddress:PortMapping'
, portMapping_destinationSocketAddress
- The EC2 instance IP address and port number in the virtual private cloud
(VPC) subnet.
$sel:destinationTrafficState:PortMapping'
, portMapping_destinationTrafficState
- Indicates whether or not a port mapping destination can receive traffic.
The value is either ALLOW, if traffic is allowed to the destination, or
DENY, if traffic is not allowed to the destination.
$sel:endpointGroupArn:PortMapping'
, portMapping_endpointGroupArn
- The Amazon Resource Name (ARN) of the endpoint group.
$sel:endpointId:PortMapping'
, portMapping_endpointId
- The IP address of the VPC subnet (the subnet ID).
$sel:protocols:PortMapping'
, portMapping_protocols
- The protocols supported by the endpoint group.
PortOverride
data PortOverride Source #
Override specific listener ports used to route traffic to endpoints that are part of an endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
See: newPortOverride
smart constructor.
Instances
newPortOverride :: PortOverride Source #
Create a value of PortOverride
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointPort:PortOverride'
, portOverride_endpointPort
- The endpoint port that you want a listener port to be mapped to. This is
the port on the endpoint, such as the Application Load Balancer or
Amazon EC2 instance.
$sel:listenerPort:PortOverride'
, portOverride_listenerPort
- The listener port that you want to map to a specific endpoint port. This
is the port that user traffic arrives to the Global Accelerator on.
PortRange
A complex type for a range of ports for a listener.
See: newPortRange
smart constructor.
Instances
FromJSON PortRange Source # | |
ToJSON PortRange Source # | |
Defined in Amazonka.GlobalAccelerator.Types.PortRange | |
Generic PortRange Source # | |
Read PortRange Source # | |
Show PortRange Source # | |
NFData PortRange Source # | |
Defined in Amazonka.GlobalAccelerator.Types.PortRange | |
Eq PortRange Source # | |
Hashable PortRange Source # | |
Defined in Amazonka.GlobalAccelerator.Types.PortRange | |
type Rep PortRange Source # | |
Defined in Amazonka.GlobalAccelerator.Types.PortRange type Rep PortRange = D1 ('MetaData "PortRange" "Amazonka.GlobalAccelerator.Types.PortRange" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "PortRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "toPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) |
newPortRange :: PortRange Source #
Create a value of PortRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fromPort:PortRange'
, portRange_fromPort
- The first port in the range of ports, inclusive.
$sel:toPort:PortRange'
, portRange_toPort
- The last port in the range of ports, inclusive.
SocketAddress
data SocketAddress Source #
An IP address/port combination.
See: newSocketAddress
smart constructor.
Instances
newSocketAddress :: SocketAddress Source #
Create a value of SocketAddress
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ipAddress:SocketAddress'
, socketAddress_ipAddress
- The IP address for the socket address.
$sel:port:SocketAddress'
, socketAddress_port
- The port for the socket address.
Tag
A complex type that contains a Tag
key and Tag
value.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.GlobalAccelerator.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.GlobalAccelerator.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.GlobalAccelerator.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.GlobalAccelerator.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.GlobalAccelerator.Types.Tag" "amazonka-globalaccelerator-2.0-5CEURNOKFgU1mORtBGQfFs" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- A string that contains a Tag
key.
$sel:value:Tag'
, tag_value
- A string that contains a Tag
value.