| 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 |
Amazonka.GlobalAccelerator.Types
Contents
- Service Configuration
- Errors
- 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
Description
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
- 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' {
- acceleratorArn :: Maybe Text
- createdTime :: Maybe POSIX
- dnsName :: Maybe Text
- dualStackDnsName :: Maybe Text
- enabled :: Maybe Bool
- events :: Maybe [AcceleratorEvent]
- ipAddressType :: Maybe IpAddressType
- ipSets :: Maybe [IpSet]
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- status :: Maybe AcceleratorStatus
- newAccelerator :: Accelerator
- accelerator_acceleratorArn :: Lens' Accelerator (Maybe Text)
- accelerator_createdTime :: Lens' Accelerator (Maybe UTCTime)
- accelerator_dnsName :: Lens' Accelerator (Maybe Text)
- accelerator_dualStackDnsName :: Lens' Accelerator (Maybe Text)
- accelerator_enabled :: Lens' Accelerator (Maybe Bool)
- accelerator_events :: Lens' Accelerator (Maybe [AcceleratorEvent])
- accelerator_ipAddressType :: Lens' Accelerator (Maybe IpAddressType)
- accelerator_ipSets :: Lens' Accelerator (Maybe [IpSet])
- accelerator_lastModifiedTime :: Lens' Accelerator (Maybe UTCTime)
- accelerator_name :: Lens' Accelerator (Maybe Text)
- accelerator_status :: Lens' Accelerator (Maybe AcceleratorStatus)
- data AcceleratorAttributes = AcceleratorAttributes' {}
- newAcceleratorAttributes :: AcceleratorAttributes
- acceleratorAttributes_flowLogsEnabled :: Lens' AcceleratorAttributes (Maybe Bool)
- acceleratorAttributes_flowLogsS3Bucket :: Lens' AcceleratorAttributes (Maybe Text)
- acceleratorAttributes_flowLogsS3Prefix :: Lens' AcceleratorAttributes (Maybe Text)
- data AcceleratorEvent = AcceleratorEvent' {}
- newAcceleratorEvent :: AcceleratorEvent
- acceleratorEvent_message :: Lens' AcceleratorEvent (Maybe Text)
- acceleratorEvent_timestamp :: Lens' AcceleratorEvent (Maybe UTCTime)
- data ByoipCidr = ByoipCidr' {
- cidr :: Maybe Text
- events :: Maybe [ByoipCidrEvent]
- state :: Maybe ByoipCidrState
- newByoipCidr :: ByoipCidr
- byoipCidr_cidr :: Lens' ByoipCidr (Maybe Text)
- byoipCidr_events :: Lens' ByoipCidr (Maybe [ByoipCidrEvent])
- byoipCidr_state :: Lens' ByoipCidr (Maybe ByoipCidrState)
- data ByoipCidrEvent = ByoipCidrEvent' {}
- newByoipCidrEvent :: ByoipCidrEvent
- byoipCidrEvent_message :: Lens' ByoipCidrEvent (Maybe Text)
- byoipCidrEvent_timestamp :: Lens' ByoipCidrEvent (Maybe UTCTime)
- data CidrAuthorizationContext = CidrAuthorizationContext' {}
- newCidrAuthorizationContext :: Text -> Text -> CidrAuthorizationContext
- cidrAuthorizationContext_message :: Lens' CidrAuthorizationContext Text
- cidrAuthorizationContext_signature :: Lens' CidrAuthorizationContext Text
- data CustomRoutingAccelerator = CustomRoutingAccelerator' {}
- newCustomRoutingAccelerator :: CustomRoutingAccelerator
- customRoutingAccelerator_acceleratorArn :: Lens' CustomRoutingAccelerator (Maybe Text)
- customRoutingAccelerator_createdTime :: Lens' CustomRoutingAccelerator (Maybe UTCTime)
- customRoutingAccelerator_dnsName :: Lens' CustomRoutingAccelerator (Maybe Text)
- customRoutingAccelerator_enabled :: Lens' CustomRoutingAccelerator (Maybe Bool)
- customRoutingAccelerator_ipAddressType :: Lens' CustomRoutingAccelerator (Maybe IpAddressType)
- customRoutingAccelerator_ipSets :: Lens' CustomRoutingAccelerator (Maybe [IpSet])
- customRoutingAccelerator_lastModifiedTime :: Lens' CustomRoutingAccelerator (Maybe UTCTime)
- customRoutingAccelerator_name :: Lens' CustomRoutingAccelerator (Maybe Text)
- customRoutingAccelerator_status :: Lens' CustomRoutingAccelerator (Maybe CustomRoutingAcceleratorStatus)
- data CustomRoutingAcceleratorAttributes = CustomRoutingAcceleratorAttributes' {}
- newCustomRoutingAcceleratorAttributes :: CustomRoutingAcceleratorAttributes
- customRoutingAcceleratorAttributes_flowLogsEnabled :: Lens' CustomRoutingAcceleratorAttributes (Maybe Bool)
- customRoutingAcceleratorAttributes_flowLogsS3Bucket :: Lens' CustomRoutingAcceleratorAttributes (Maybe Text)
- customRoutingAcceleratorAttributes_flowLogsS3Prefix :: Lens' CustomRoutingAcceleratorAttributes (Maybe Text)
- data CustomRoutingDestinationConfiguration = CustomRoutingDestinationConfiguration' {}
- newCustomRoutingDestinationConfiguration :: Natural -> Natural -> NonEmpty CustomRoutingProtocol -> CustomRoutingDestinationConfiguration
- customRoutingDestinationConfiguration_fromPort :: Lens' CustomRoutingDestinationConfiguration Natural
- customRoutingDestinationConfiguration_toPort :: Lens' CustomRoutingDestinationConfiguration Natural
- customRoutingDestinationConfiguration_protocols :: Lens' CustomRoutingDestinationConfiguration (NonEmpty CustomRoutingProtocol)
- data CustomRoutingDestinationDescription = CustomRoutingDestinationDescription' {}
- newCustomRoutingDestinationDescription :: CustomRoutingDestinationDescription
- customRoutingDestinationDescription_fromPort :: Lens' CustomRoutingDestinationDescription (Maybe Natural)
- customRoutingDestinationDescription_protocols :: Lens' CustomRoutingDestinationDescription (Maybe [Protocol])
- customRoutingDestinationDescription_toPort :: Lens' CustomRoutingDestinationDescription (Maybe Natural)
- data CustomRoutingEndpointConfiguration = CustomRoutingEndpointConfiguration' {
- endpointId :: Maybe Text
- newCustomRoutingEndpointConfiguration :: CustomRoutingEndpointConfiguration
- customRoutingEndpointConfiguration_endpointId :: Lens' CustomRoutingEndpointConfiguration (Maybe Text)
- data CustomRoutingEndpointDescription = CustomRoutingEndpointDescription' {
- endpointId :: Maybe Text
- newCustomRoutingEndpointDescription :: CustomRoutingEndpointDescription
- customRoutingEndpointDescription_endpointId :: Lens' CustomRoutingEndpointDescription (Maybe Text)
- data CustomRoutingEndpointGroup = CustomRoutingEndpointGroup' {}
- newCustomRoutingEndpointGroup :: CustomRoutingEndpointGroup
- customRoutingEndpointGroup_destinationDescriptions :: Lens' CustomRoutingEndpointGroup (Maybe [CustomRoutingDestinationDescription])
- customRoutingEndpointGroup_endpointDescriptions :: Lens' CustomRoutingEndpointGroup (Maybe [CustomRoutingEndpointDescription])
- customRoutingEndpointGroup_endpointGroupArn :: Lens' CustomRoutingEndpointGroup (Maybe Text)
- customRoutingEndpointGroup_endpointGroupRegion :: Lens' CustomRoutingEndpointGroup (Maybe Text)
- data CustomRoutingListener = CustomRoutingListener' {
- listenerArn :: Maybe Text
- portRanges :: Maybe (NonEmpty PortRange)
- newCustomRoutingListener :: CustomRoutingListener
- customRoutingListener_listenerArn :: Lens' CustomRoutingListener (Maybe Text)
- customRoutingListener_portRanges :: Lens' CustomRoutingListener (Maybe (NonEmpty PortRange))
- data DestinationPortMapping = DestinationPortMapping' {
- acceleratorArn :: Maybe Text
- acceleratorSocketAddresses :: Maybe [SocketAddress]
- destinationSocketAddress :: Maybe SocketAddress
- destinationTrafficState :: Maybe CustomRoutingDestinationTrafficState
- endpointGroupArn :: Maybe Text
- endpointGroupRegion :: Maybe Text
- endpointId :: Maybe Text
- ipAddressType :: Maybe IpAddressType
- newDestinationPortMapping :: DestinationPortMapping
- destinationPortMapping_acceleratorArn :: Lens' DestinationPortMapping (Maybe Text)
- destinationPortMapping_acceleratorSocketAddresses :: Lens' DestinationPortMapping (Maybe [SocketAddress])
- destinationPortMapping_destinationSocketAddress :: Lens' DestinationPortMapping (Maybe SocketAddress)
- destinationPortMapping_destinationTrafficState :: Lens' DestinationPortMapping (Maybe CustomRoutingDestinationTrafficState)
- destinationPortMapping_endpointGroupArn :: Lens' DestinationPortMapping (Maybe Text)
- destinationPortMapping_endpointGroupRegion :: Lens' DestinationPortMapping (Maybe Text)
- destinationPortMapping_endpointId :: Lens' DestinationPortMapping (Maybe Text)
- destinationPortMapping_ipAddressType :: Lens' DestinationPortMapping (Maybe IpAddressType)
- data EndpointConfiguration = EndpointConfiguration' {}
- newEndpointConfiguration :: EndpointConfiguration
- endpointConfiguration_clientIPPreservationEnabled :: Lens' EndpointConfiguration (Maybe Bool)
- endpointConfiguration_endpointId :: Lens' EndpointConfiguration (Maybe Text)
- endpointConfiguration_weight :: Lens' EndpointConfiguration (Maybe Natural)
- data EndpointDescription = EndpointDescription' {}
- newEndpointDescription :: EndpointDescription
- endpointDescription_clientIPPreservationEnabled :: Lens' EndpointDescription (Maybe Bool)
- endpointDescription_endpointId :: Lens' EndpointDescription (Maybe Text)
- endpointDescription_healthReason :: Lens' EndpointDescription (Maybe Text)
- endpointDescription_healthState :: Lens' EndpointDescription (Maybe HealthState)
- endpointDescription_weight :: Lens' EndpointDescription (Maybe Natural)
- data EndpointGroup = EndpointGroup' {
- endpointDescriptions :: Maybe [EndpointDescription]
- endpointGroupArn :: Maybe Text
- endpointGroupRegion :: Maybe Text
- healthCheckIntervalSeconds :: Maybe Natural
- healthCheckPath :: Maybe Text
- healthCheckPort :: Maybe Natural
- healthCheckProtocol :: Maybe HealthCheckProtocol
- portOverrides :: Maybe [PortOverride]
- thresholdCount :: Maybe Natural
- trafficDialPercentage :: Maybe Double
- newEndpointGroup :: EndpointGroup
- endpointGroup_endpointDescriptions :: Lens' EndpointGroup (Maybe [EndpointDescription])
- endpointGroup_endpointGroupArn :: Lens' EndpointGroup (Maybe Text)
- endpointGroup_endpointGroupRegion :: Lens' EndpointGroup (Maybe Text)
- endpointGroup_healthCheckIntervalSeconds :: Lens' EndpointGroup (Maybe Natural)
- endpointGroup_healthCheckPath :: Lens' EndpointGroup (Maybe Text)
- endpointGroup_healthCheckPort :: Lens' EndpointGroup (Maybe Natural)
- endpointGroup_healthCheckProtocol :: Lens' EndpointGroup (Maybe HealthCheckProtocol)
- endpointGroup_portOverrides :: Lens' EndpointGroup (Maybe [PortOverride])
- endpointGroup_thresholdCount :: Lens' EndpointGroup (Maybe Natural)
- endpointGroup_trafficDialPercentage :: Lens' EndpointGroup (Maybe Double)
- data EndpointIdentifier = EndpointIdentifier' {}
- newEndpointIdentifier :: Text -> EndpointIdentifier
- endpointIdentifier_clientIPPreservationEnabled :: Lens' EndpointIdentifier (Maybe Bool)
- endpointIdentifier_endpointId :: Lens' EndpointIdentifier Text
- data IpSet = IpSet' {}
- newIpSet :: IpSet
- ipSet_ipAddressFamily :: Lens' IpSet (Maybe IpAddressFamily)
- ipSet_ipAddresses :: Lens' IpSet (Maybe [Text])
- ipSet_ipFamily :: Lens' IpSet (Maybe Text)
- data Listener = Listener' {}
- newListener :: Listener
- listener_clientAffinity :: Lens' Listener (Maybe ClientAffinity)
- listener_listenerArn :: Lens' Listener (Maybe Text)
- listener_portRanges :: Lens' Listener (Maybe (NonEmpty PortRange))
- listener_protocol :: Lens' Listener (Maybe Protocol)
- data PortMapping = PortMapping' {}
- newPortMapping :: PortMapping
- portMapping_acceleratorPort :: Lens' PortMapping (Maybe Natural)
- portMapping_destinationSocketAddress :: Lens' PortMapping (Maybe SocketAddress)
- portMapping_destinationTrafficState :: Lens' PortMapping (Maybe CustomRoutingDestinationTrafficState)
- portMapping_endpointGroupArn :: Lens' PortMapping (Maybe Text)
- portMapping_endpointId :: Lens' PortMapping (Maybe Text)
- portMapping_protocols :: Lens' PortMapping (Maybe (NonEmpty CustomRoutingProtocol))
- data PortOverride = PortOverride' {}
- newPortOverride :: PortOverride
- portOverride_endpointPort :: Lens' PortOverride (Maybe Natural)
- portOverride_listenerPort :: Lens' PortOverride (Maybe Natural)
- data PortRange = PortRange' {}
- newPortRange :: PortRange
- portRange_fromPort :: Lens' PortRange (Maybe Natural)
- portRange_toPort :: Lens' PortRange (Maybe Natural)
- data SocketAddress = SocketAddress' {}
- newSocketAddress :: SocketAddress
- socketAddress_ipAddress :: Lens' SocketAddress (Maybe Text)
- socketAddress_port :: Lens' SocketAddress (Maybe Natural)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2018-08-08 of the Amazon Global Accelerator SDK configuration.
Errors
_AcceleratorNotDisabledException :: AsError a => Fold a ServiceError Source #
The accelerator that you specified could not be disabled.
_AcceleratorNotFoundException :: AsError a => Fold a ServiceError Source #
The accelerator that you specified doesn't exist.
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have access permission.
_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 :: 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 :: AsError a => Fold a ServiceError Source #
The CIDR that you specified was not found or is incorrect.
_ConflictException :: AsError a => Fold a ServiceError Source #
You can't use both of those options.
_EndpointAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The endpoint that you specified doesn't exist.
_EndpointGroupAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The endpoint group that you specified already exists.
_EndpointGroupNotFoundException :: AsError a => Fold a ServiceError Source #
The endpoint group that you specified doesn't exist.
_EndpointNotFoundException :: AsError a => Fold a ServiceError Source #
The endpoint that you specified doesn't exist.
_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 :: AsError a => Fold a ServiceError Source #
There was an internal error for Global Accelerator.
_InvalidArgumentException :: AsError a => Fold a ServiceError Source #
An argument that you specified is invalid.
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
There isn't another item to return.
_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 :: AsError a => Fold a ServiceError Source #
Processing your request would cause you to exceed an Global Accelerator limit.
_ListenerNotFoundException :: AsError a => Fold a ServiceError Source #
The listener that you specified doesn't exist.
_TransactionInProgressException :: AsError a => Fold a ServiceError Source #
There's already a transaction in progress. Another transaction can't be processed.
AcceleratorStatus
newtype AcceleratorStatus Source #
Constructors
| AcceleratorStatus' | |
Fields | |
Bundled Patterns
| pattern AcceleratorStatus_DEPLOYED :: AcceleratorStatus | |
| pattern AcceleratorStatus_IN_PROGRESS :: AcceleratorStatus |
Instances
ByoipCidrState
newtype ByoipCidrState Source #
Constructors
| ByoipCidrState' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| ClientAffinity' | |
Fields | |
Bundled Patterns
| pattern ClientAffinity_NONE :: ClientAffinity | |
| pattern ClientAffinity_SOURCE_IP :: ClientAffinity |
Instances
CustomRoutingAcceleratorStatus
newtype CustomRoutingAcceleratorStatus Source #
Constructors
| CustomRoutingAcceleratorStatus' | |
Fields | |
Bundled Patterns
| pattern CustomRoutingAcceleratorStatus_DEPLOYED :: CustomRoutingAcceleratorStatus | |
| pattern CustomRoutingAcceleratorStatus_IN_PROGRESS :: CustomRoutingAcceleratorStatus |
Instances
CustomRoutingDestinationTrafficState
newtype CustomRoutingDestinationTrafficState Source #
Constructors
| CustomRoutingDestinationTrafficState' | |
Bundled Patterns
| pattern CustomRoutingDestinationTrafficState_ALLOW :: CustomRoutingDestinationTrafficState | |
| pattern CustomRoutingDestinationTrafficState_DENY :: CustomRoutingDestinationTrafficState |
Instances
CustomRoutingProtocol
newtype CustomRoutingProtocol Source #
Constructors
| CustomRoutingProtocol' | |
Fields | |
Bundled Patterns
| pattern CustomRoutingProtocol_TCP :: CustomRoutingProtocol | |
| pattern CustomRoutingProtocol_UDP :: CustomRoutingProtocol |
Instances
HealthCheckProtocol
newtype HealthCheckProtocol Source #
Constructors
| HealthCheckProtocol' | |
Fields | |
Bundled Patterns
| pattern HealthCheckProtocol_HTTP :: HealthCheckProtocol | |
| pattern HealthCheckProtocol_HTTPS :: HealthCheckProtocol | |
| pattern HealthCheckProtocol_TCP :: HealthCheckProtocol |
Instances
HealthState
newtype HealthState Source #
Constructors
| HealthState' | |
Fields | |
Bundled Patterns
| pattern HealthState_HEALTHY :: HealthState | |
| pattern HealthState_INITIAL :: HealthState | |
| pattern HealthState_UNHEALTHY :: HealthState |
Instances
IpAddressFamily
newtype IpAddressFamily Source #
Constructors
| IpAddressFamily' | |
Fields | |
Bundled Patterns
| pattern IpAddressFamily_IPv4 :: IpAddressFamily | |
| pattern IpAddressFamily_IPv6 :: IpAddressFamily |
Instances
IpAddressType
newtype IpAddressType Source #
Constructors
| IpAddressType' | |
Fields | |
Bundled Patterns
| pattern IpAddressType_DUAL_STACK :: IpAddressType | |
| pattern IpAddressType_IPV4 :: IpAddressType |
Instances
Protocol
Constructors
| Protocol' | |
Fields
| |
Bundled Patterns
| 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.
Constructors
| Accelerator' | |
Fields
| |
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.
accelerator_acceleratorArn :: Lens' Accelerator (Maybe Text) Source #
The Amazon Resource Name (ARN) of the accelerator.
accelerator_createdTime :: Lens' Accelerator (Maybe UTCTime) Source #
The date and time that the accelerator was created.
accelerator_dnsName :: Lens' Accelerator (Maybe Text) Source #
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.
accelerator_dualStackDnsName :: Lens' Accelerator (Maybe Text) Source #
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.
accelerator_enabled :: Lens' Accelerator (Maybe Bool) Source #
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.
accelerator_events :: Lens' Accelerator (Maybe [AcceleratorEvent]) Source #
A history of changes that you make to an accelerator in Global Accelerator.
accelerator_ipAddressType :: Lens' Accelerator (Maybe IpAddressType) Source #
The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
accelerator_ipSets :: Lens' Accelerator (Maybe [IpSet]) Source #
The static IP addresses that Global Accelerator associates with the accelerator.
accelerator_lastModifiedTime :: Lens' Accelerator (Maybe UTCTime) Source #
The date and time that the accelerator was last modified.
accelerator_name :: Lens' Accelerator (Maybe Text) Source #
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
accelerator_status :: Lens' Accelerator (Maybe AcceleratorStatus) Source #
Describes the deployment status of the accelerator.
AcceleratorAttributes
data AcceleratorAttributes Source #
Attributes of an accelerator.
See: newAcceleratorAttributes smart constructor.
Constructors
| AcceleratorAttributes' | |
Fields
| |
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
acceleratorAttributes_flowLogsEnabled :: Lens' AcceleratorAttributes (Maybe Bool) Source #
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.
acceleratorAttributes_flowLogsS3Bucket :: Lens' AcceleratorAttributes (Maybe Text) Source #
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.
acceleratorAttributes_flowLogsS3Prefix :: Lens' AcceleratorAttributes (Maybe Text) Source #
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.
Constructors
| AcceleratorEvent' | |
Fields
| |
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.
acceleratorEvent_message :: Lens' AcceleratorEvent (Maybe Text) Source #
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.
acceleratorEvent_timestamp :: Lens' AcceleratorEvent (Maybe UTCTime) Source #
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.
Constructors
| ByoipCidr' | |
Fields
| |
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.
byoipCidr_events :: Lens' ByoipCidr (Maybe [ByoipCidrEvent]) Source #
A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).
byoipCidr_state :: Lens' ByoipCidr (Maybe ByoipCidrState) Source #
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.
Constructors
| ByoipCidrEvent' | |
Fields
| |
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).
byoipCidrEvent_message :: Lens' ByoipCidrEvent (Maybe Text) Source #
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).
byoipCidrEvent_timestamp :: Lens' ByoipCidrEvent (Maybe UTCTime) Source #
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.
Constructors
| CidrAuthorizationContext' | |
Instances
newCidrAuthorizationContext Source #
Arguments
| :: 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.
cidrAuthorizationContext_message :: Lens' CidrAuthorizationContext Text Source #
The plain-text authorization message for the prefix and account.
cidrAuthorizationContext_signature :: Lens' CidrAuthorizationContext Text Source #
The signed authorization message for the prefix and account.
CustomRoutingAccelerator
data CustomRoutingAccelerator Source #
Attributes of a custom routing accelerator.
See: newCustomRoutingAccelerator smart constructor.
Constructors
| CustomRoutingAccelerator' | |
Fields
| |
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.
customRoutingAccelerator_acceleratorArn :: Lens' CustomRoutingAccelerator (Maybe Text) Source #
The Amazon Resource Name (ARN) of the custom routing accelerator.
customRoutingAccelerator_createdTime :: Lens' CustomRoutingAccelerator (Maybe UTCTime) Source #
The date and time that the accelerator was created.
customRoutingAccelerator_dnsName :: Lens' CustomRoutingAccelerator (Maybe Text) Source #
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.
customRoutingAccelerator_enabled :: Lens' CustomRoutingAccelerator (Maybe Bool) Source #
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.
customRoutingAccelerator_ipAddressType :: Lens' CustomRoutingAccelerator (Maybe IpAddressType) Source #
The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
customRoutingAccelerator_ipSets :: Lens' CustomRoutingAccelerator (Maybe [IpSet]) Source #
The static IP addresses that Global Accelerator associates with the accelerator.
customRoutingAccelerator_lastModifiedTime :: Lens' CustomRoutingAccelerator (Maybe UTCTime) Source #
The date and time that the accelerator was last modified.
customRoutingAccelerator_name :: Lens' CustomRoutingAccelerator (Maybe Text) Source #
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
customRoutingAccelerator_status :: Lens' CustomRoutingAccelerator (Maybe CustomRoutingAcceleratorStatus) Source #
Describes the deployment status of the accelerator.
CustomRoutingAcceleratorAttributes
data CustomRoutingAcceleratorAttributes Source #
Attributes of a custom routing accelerator.
See: newCustomRoutingAcceleratorAttributes smart constructor.
Constructors
| CustomRoutingAcceleratorAttributes' | |
Fields
| |
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
customRoutingAcceleratorAttributes_flowLogsEnabled :: Lens' CustomRoutingAcceleratorAttributes (Maybe Bool) Source #
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.
customRoutingAcceleratorAttributes_flowLogsS3Bucket :: Lens' CustomRoutingAcceleratorAttributes (Maybe Text) Source #
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.
customRoutingAcceleratorAttributes_flowLogsS3Prefix :: Lens' CustomRoutingAcceleratorAttributes (Maybe Text) Source #
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.
Constructors
| CustomRoutingDestinationConfiguration' | |
Fields
| |
Instances
newCustomRoutingDestinationConfiguration Source #
Arguments
| :: Natural | |
| -> Natural | |
| -> NonEmpty CustomRoutingProtocol | |
| -> CustomRoutingDestinationConfiguration |
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.
customRoutingDestinationConfiguration_fromPort :: Lens' CustomRoutingDestinationConfiguration Natural Source #
The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
customRoutingDestinationConfiguration_toPort :: Lens' CustomRoutingDestinationConfiguration Natural Source #
The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
customRoutingDestinationConfiguration_protocols :: Lens' CustomRoutingDestinationConfiguration (NonEmpty CustomRoutingProtocol) Source #
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.
Constructors
| CustomRoutingDestinationDescription' | |
Fields
| |
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.
customRoutingDestinationDescription_fromPort :: Lens' CustomRoutingDestinationDescription (Maybe Natural) Source #
The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
customRoutingDestinationDescription_protocols :: Lens' CustomRoutingDestinationDescription (Maybe [Protocol]) Source #
The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.
customRoutingDestinationDescription_toPort :: Lens' CustomRoutingDestinationDescription (Maybe Natural) Source #
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.
Constructors
| CustomRoutingEndpointConfiguration' | |
Fields
| |
Instances
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.
customRoutingEndpointConfiguration_endpointId :: Lens' CustomRoutingEndpointConfiguration (Maybe Text) Source #
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.
Constructors
| CustomRoutingEndpointDescription' | |
Fields
| |
Instances
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.
customRoutingEndpointDescription_endpointId :: Lens' CustomRoutingEndpointDescription (Maybe Text) Source #
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.
Constructors
| CustomRoutingEndpointGroup' | |
Fields
| |
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.
customRoutingEndpointGroup_destinationDescriptions :: Lens' CustomRoutingEndpointGroup (Maybe [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.
customRoutingEndpointGroup_endpointDescriptions :: Lens' CustomRoutingEndpointGroup (Maybe [CustomRoutingEndpointDescription]) Source #
For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
customRoutingEndpointGroup_endpointGroupArn :: Lens' CustomRoutingEndpointGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of the endpoint group.
customRoutingEndpointGroup_endpointGroupRegion :: Lens' CustomRoutingEndpointGroup (Maybe Text) Source #
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.
Constructors
| CustomRoutingListener' | |
Fields
| |
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.
customRoutingListener_listenerArn :: Lens' CustomRoutingListener (Maybe Text) Source #
The Amazon Resource Name (ARN) of the listener.
customRoutingListener_portRanges :: Lens' CustomRoutingListener (Maybe (NonEmpty PortRange)) Source #
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.
Constructors
| DestinationPortMapping' | |
Fields
| |
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.
destinationPortMapping_acceleratorArn :: Lens' DestinationPortMapping (Maybe Text) Source #
The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.
destinationPortMapping_acceleratorSocketAddresses :: Lens' DestinationPortMapping (Maybe [SocketAddress]) Source #
The IP address/port combinations (sockets) that map to a given destination socket address.
destinationPortMapping_destinationSocketAddress :: Lens' DestinationPortMapping (Maybe SocketAddress) Source #
The endpoint IP address/port combination for traffic received on the accelerator socket address.
destinationPortMapping_destinationTrafficState :: Lens' DestinationPortMapping (Maybe CustomRoutingDestinationTrafficState) Source #
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.
destinationPortMapping_endpointGroupArn :: Lens' DestinationPortMapping (Maybe Text) Source #
The Amazon Resource Name (ARN) of the endpoint group.
destinationPortMapping_endpointGroupRegion :: Lens' DestinationPortMapping (Maybe Text) Source #
The Amazon Web Services Region for the endpoint group.
destinationPortMapping_endpointId :: Lens' DestinationPortMapping (Maybe Text) Source #
The ID for the virtual private cloud (VPC) subnet.
destinationPortMapping_ipAddressType :: Lens' DestinationPortMapping (Maybe IpAddressType) Source #
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.
Constructors
| EndpointConfiguration' | |
Fields
| |
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.
endpointConfiguration_clientIPPreservationEnabled :: Lens' EndpointConfiguration (Maybe Bool) Source #
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.
endpointConfiguration_endpointId :: Lens' EndpointConfiguration (Maybe Text) Source #
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.
endpointConfiguration_weight :: Lens' EndpointConfiguration (Maybe Natural) Source #
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.
Constructors
| EndpointDescription' | |
Fields
| |
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.
endpointDescription_clientIPPreservationEnabled :: Lens' EndpointDescription (Maybe Bool) Source #
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.
endpointDescription_endpointId :: Lens' EndpointDescription (Maybe Text) Source #
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.
endpointDescription_healthReason :: Lens' EndpointDescription (Maybe Text) Source #
Returns a null result.
endpointDescription_healthState :: Lens' EndpointDescription (Maybe HealthState) Source #
The health status of the endpoint.
endpointDescription_weight :: Lens' EndpointDescription (Maybe Natural) Source #
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.
Constructors
| EndpointGroup' | |
Fields
| |
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.
endpointGroup_endpointDescriptions :: Lens' EndpointGroup (Maybe [EndpointDescription]) Source #
The list of endpoint objects.
endpointGroup_endpointGroupArn :: Lens' EndpointGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of the endpoint group.
endpointGroup_endpointGroupRegion :: Lens' EndpointGroup (Maybe Text) Source #
The Amazon Web Services Region where the endpoint group is located.
endpointGroup_healthCheckIntervalSeconds :: Lens' EndpointGroup (Maybe Natural) Source #
The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
endpointGroup_healthCheckPath :: Lens' EndpointGroup (Maybe Text) Source #
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 (/).
endpointGroup_healthCheckPort :: Lens' EndpointGroup (Maybe Natural) Source #
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.
endpointGroup_healthCheckProtocol :: Lens' EndpointGroup (Maybe HealthCheckProtocol) Source #
The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.
endpointGroup_portOverrides :: Lens' EndpointGroup (Maybe [PortOverride]) Source #
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.
endpointGroup_thresholdCount :: Lens' EndpointGroup (Maybe Natural) Source #
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.
endpointGroup_trafficDialPercentage :: Lens' EndpointGroup (Maybe Double) Source #
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.
Constructors
| EndpointIdentifier' | |
Fields
| |
Instances
newEndpointIdentifier Source #
Arguments
| :: Text | |
| -> EndpointIdentifier |
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.
endpointIdentifier_clientIPPreservationEnabled :: Lens' EndpointIdentifier (Maybe Bool) Source #
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.
endpointIdentifier_endpointId :: Lens' EndpointIdentifier Text Source #
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.
Constructors
| IpSet' | |
Fields
| |
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.
ipSet_ipAddressFamily :: Lens' IpSet (Maybe IpAddressFamily) Source #
The types of IP addresses included in this IP set.
ipSet_ipAddresses :: Lens' IpSet (Maybe [Text]) Source #
The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
ipSet_ipFamily :: Lens' IpSet (Maybe Text) Source #
IpFamily is deprecated and has been replaced by IpAddressFamily.
Listener
A complex type for a listener.
See: newListener smart constructor.
Constructors
| Listener' | |
Fields
| |
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.
listener_clientAffinity :: Lens' Listener (Maybe ClientAffinity) Source #
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.
listener_listenerArn :: Lens' Listener (Maybe Text) Source #
The Amazon Resource Name (ARN) of the listener.
listener_portRanges :: Lens' Listener (Maybe (NonEmpty PortRange)) Source #
The list of port ranges for the connections from clients to the accelerator.
listener_protocol :: Lens' Listener (Maybe Protocol) Source #
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.
Constructors
| PortMapping' | |
Fields
| |
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.
portMapping_acceleratorPort :: Lens' PortMapping (Maybe Natural) Source #
The accelerator port.
portMapping_destinationSocketAddress :: Lens' PortMapping (Maybe SocketAddress) Source #
The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.
portMapping_destinationTrafficState :: Lens' PortMapping (Maybe CustomRoutingDestinationTrafficState) Source #
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.
portMapping_endpointGroupArn :: Lens' PortMapping (Maybe Text) Source #
The Amazon Resource Name (ARN) of the endpoint group.
portMapping_endpointId :: Lens' PortMapping (Maybe Text) Source #
The IP address of the VPC subnet (the subnet ID).
portMapping_protocols :: Lens' PortMapping (Maybe (NonEmpty CustomRoutingProtocol)) Source #
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.
Constructors
| PortOverride' | |
Fields
| |
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.
portOverride_endpointPort :: Lens' PortOverride (Maybe Natural) Source #
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.
portOverride_listenerPort :: Lens' PortOverride (Maybe Natural) Source #
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.
Constructors
| PortRange' | |
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.
portRange_fromPort :: Lens' PortRange (Maybe Natural) Source #
The first port in the range of ports, inclusive.
portRange_toPort :: Lens' PortRange (Maybe Natural) Source #
The last port in the range of ports, inclusive.
SocketAddress
data SocketAddress Source #
An IP address/port combination.
See: newSocketAddress smart constructor.
Constructors
| SocketAddress' | |
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.
socketAddress_ipAddress :: Lens' SocketAddress (Maybe Text) Source #
The IP address for the socket address.
socketAddress_port :: Lens' SocketAddress (Maybe Natural) Source #
The port for the socket address.
Tag
A complex type that contains a Tag key and Tag value.
See: newTag smart constructor.
Constructors
| Tag' | |
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.