Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- ActionTypeEnum
- AuthenticateCognitoActionConditionalBehaviorEnum
- AuthenticateOidcActionConditionalBehaviorEnum
- IpAddressType
- LoadBalancerSchemeEnum
- LoadBalancerStateEnum
- LoadBalancerTypeEnum
- ProtocolEnum
- RedirectActionStatusCodeEnum
- TargetGroupIpAddressTypeEnum
- TargetHealthReasonEnum
- TargetHealthStateEnum
- TargetTypeEnum
- Action
- AuthenticateCognitoActionConfig
- AuthenticateOidcActionConfig
- AvailabilityZone
- Certificate
- Cipher
- FixedResponseActionConfig
- ForwardActionConfig
- HostHeaderConditionConfig
- HttpHeaderConditionConfig
- HttpRequestMethodConditionConfig
- Limit
- Listener
- LoadBalancer
- LoadBalancerAddress
- LoadBalancerAttribute
- LoadBalancerState
- Matcher
- PathPatternConditionConfig
- QueryStringConditionConfig
- QueryStringKeyValuePair
- RedirectActionConfig
- Rule
- RuleCondition
- RulePriorityPair
- SourceIpConditionConfig
- SslPolicy
- SubnetMapping
- Tag
- TagDescription
- TargetDescription
- TargetGroup
- TargetGroupAttribute
- TargetGroupStickinessConfig
- TargetGroupTuple
- TargetHealth
- TargetHealthDescription
Synopsis
- defaultService :: Service
- _InvalidConfigurationRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTargetsException :: AsError a => Getting (First ServiceError) a ServiceError
- _RuleNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSubnetException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRulesException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTargetGroupsException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyActionsException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateLoadBalancerNameException :: AsError a => Getting (First ServiceError) a ServiceError
- _IncompatibleProtocolsException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyCertificatesException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateTagKeysException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateListenerException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateTargetGroupNameException :: AsError a => Getting (First ServiceError) a ServiceError
- _HealthUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _AllocationIdNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _PriorityInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyLoadBalancersException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedProtocolException :: AsError a => Getting (First ServiceError) a ServiceError
- _ALPNPolicyNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTargetException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSecurityGroupException :: AsError a => Getting (First ServiceError) a ServiceError
- _TargetGroupNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ListenerNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidLoadBalancerActionException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRegistrationsForTargetIdException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyListenersException :: AsError a => Getting (First ServiceError) a ServiceError
- _TargetGroupAssociationLimitException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError
- _SSLPolicyNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSchemeException :: AsError a => Getting (First ServiceError) a ServiceError
- _AvailabilityZoneNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyUniqueTargetGroupsPerLoadBalancerException :: AsError a => Getting (First ServiceError) a ServiceError
- _LoadBalancerNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _CertificateNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype ActionTypeEnum where
- ActionTypeEnum' { }
- pattern ActionTypeEnum_Authenticate_cognito :: ActionTypeEnum
- pattern ActionTypeEnum_Authenticate_oidc :: ActionTypeEnum
- pattern ActionTypeEnum_Fixed_response :: ActionTypeEnum
- pattern ActionTypeEnum_Forward :: ActionTypeEnum
- pattern ActionTypeEnum_Redirect :: ActionTypeEnum
- newtype AuthenticateCognitoActionConditionalBehaviorEnum where
- AuthenticateCognitoActionConditionalBehaviorEnum' { }
- pattern AuthenticateCognitoActionConditionalBehaviorEnum_Allow :: AuthenticateCognitoActionConditionalBehaviorEnum
- pattern AuthenticateCognitoActionConditionalBehaviorEnum_Authenticate :: AuthenticateCognitoActionConditionalBehaviorEnum
- pattern AuthenticateCognitoActionConditionalBehaviorEnum_Deny :: AuthenticateCognitoActionConditionalBehaviorEnum
- newtype AuthenticateOidcActionConditionalBehaviorEnum where
- AuthenticateOidcActionConditionalBehaviorEnum' { }
- pattern AuthenticateOidcActionConditionalBehaviorEnum_Allow :: AuthenticateOidcActionConditionalBehaviorEnum
- pattern AuthenticateOidcActionConditionalBehaviorEnum_Authenticate :: AuthenticateOidcActionConditionalBehaviorEnum
- pattern AuthenticateOidcActionConditionalBehaviorEnum_Deny :: AuthenticateOidcActionConditionalBehaviorEnum
- newtype IpAddressType where
- IpAddressType' { }
- pattern IpAddressType_Dualstack :: IpAddressType
- pattern IpAddressType_Ipv4 :: IpAddressType
- newtype LoadBalancerSchemeEnum where
- newtype LoadBalancerStateEnum where
- newtype LoadBalancerTypeEnum where
- newtype ProtocolEnum where
- ProtocolEnum' { }
- pattern ProtocolEnum_GENEVE :: ProtocolEnum
- pattern ProtocolEnum_HTTP :: ProtocolEnum
- pattern ProtocolEnum_HTTPS :: ProtocolEnum
- pattern ProtocolEnum_TCP :: ProtocolEnum
- pattern ProtocolEnum_TCP_UDP :: ProtocolEnum
- pattern ProtocolEnum_TLS :: ProtocolEnum
- pattern ProtocolEnum_UDP :: ProtocolEnum
- newtype RedirectActionStatusCodeEnum where
- newtype TargetGroupIpAddressTypeEnum where
- newtype TargetHealthReasonEnum where
- TargetHealthReasonEnum' { }
- pattern TargetHealthReasonEnum_Elb_InitialHealthChecking :: TargetHealthReasonEnum
- pattern TargetHealthReasonEnum_Elb_InternalError :: TargetHealthReasonEnum
- pattern TargetHealthReasonEnum_Elb_RegistrationInProgress :: TargetHealthReasonEnum
- pattern TargetHealthReasonEnum_Target_DeregistrationInProgress :: TargetHealthReasonEnum
- pattern TargetHealthReasonEnum_Target_FailedHealthChecks :: TargetHealthReasonEnum
- pattern TargetHealthReasonEnum_Target_HealthCheckDisabled :: TargetHealthReasonEnum
- pattern TargetHealthReasonEnum_Target_InvalidState :: TargetHealthReasonEnum
- pattern TargetHealthReasonEnum_Target_IpUnusable :: TargetHealthReasonEnum
- pattern TargetHealthReasonEnum_Target_NotInUse :: TargetHealthReasonEnum
- pattern TargetHealthReasonEnum_Target_NotRegistered :: TargetHealthReasonEnum
- pattern TargetHealthReasonEnum_Target_ResponseCodeMismatch :: TargetHealthReasonEnum
- pattern TargetHealthReasonEnum_Target_Timeout :: TargetHealthReasonEnum
- newtype TargetHealthStateEnum where
- TargetHealthStateEnum' { }
- pattern TargetHealthStateEnum_Draining :: TargetHealthStateEnum
- pattern TargetHealthStateEnum_Healthy :: TargetHealthStateEnum
- pattern TargetHealthStateEnum_Initial :: TargetHealthStateEnum
- pattern TargetHealthStateEnum_Unavailable :: TargetHealthStateEnum
- pattern TargetHealthStateEnum_Unhealthy :: TargetHealthStateEnum
- pattern TargetHealthStateEnum_Unused :: TargetHealthStateEnum
- newtype TargetTypeEnum where
- TargetTypeEnum' { }
- pattern TargetTypeEnum_Alb :: TargetTypeEnum
- pattern TargetTypeEnum_Instance :: TargetTypeEnum
- pattern TargetTypeEnum_Ip :: TargetTypeEnum
- pattern TargetTypeEnum_Lambda :: TargetTypeEnum
- data Action = Action' {
- fixedResponseConfig :: Maybe FixedResponseActionConfig
- targetGroupArn :: Maybe Text
- forwardConfig :: Maybe ForwardActionConfig
- redirectConfig :: Maybe RedirectActionConfig
- authenticateCognitoConfig :: Maybe AuthenticateCognitoActionConfig
- order :: Maybe Natural
- authenticateOidcConfig :: Maybe AuthenticateOidcActionConfig
- type' :: ActionTypeEnum
- newAction :: ActionTypeEnum -> Action
- action_fixedResponseConfig :: Lens' Action (Maybe FixedResponseActionConfig)
- action_targetGroupArn :: Lens' Action (Maybe Text)
- action_forwardConfig :: Lens' Action (Maybe ForwardActionConfig)
- action_redirectConfig :: Lens' Action (Maybe RedirectActionConfig)
- action_authenticateCognitoConfig :: Lens' Action (Maybe AuthenticateCognitoActionConfig)
- action_order :: Lens' Action (Maybe Natural)
- action_authenticateOidcConfig :: Lens' Action (Maybe AuthenticateOidcActionConfig)
- action_type :: Lens' Action ActionTypeEnum
- data AuthenticateCognitoActionConfig = AuthenticateCognitoActionConfig' {}
- newAuthenticateCognitoActionConfig :: Text -> Text -> Text -> AuthenticateCognitoActionConfig
- authenticateCognitoActionConfig_authenticationRequestExtraParams :: Lens' AuthenticateCognitoActionConfig (Maybe (HashMap Text Text))
- authenticateCognitoActionConfig_scope :: Lens' AuthenticateCognitoActionConfig (Maybe Text)
- authenticateCognitoActionConfig_onUnauthenticatedRequest :: Lens' AuthenticateCognitoActionConfig (Maybe AuthenticateCognitoActionConditionalBehaviorEnum)
- authenticateCognitoActionConfig_sessionCookieName :: Lens' AuthenticateCognitoActionConfig (Maybe Text)
- authenticateCognitoActionConfig_sessionTimeout :: Lens' AuthenticateCognitoActionConfig (Maybe Integer)
- authenticateCognitoActionConfig_userPoolArn :: Lens' AuthenticateCognitoActionConfig Text
- authenticateCognitoActionConfig_userPoolClientId :: Lens' AuthenticateCognitoActionConfig Text
- authenticateCognitoActionConfig_userPoolDomain :: Lens' AuthenticateCognitoActionConfig Text
- data AuthenticateOidcActionConfig = AuthenticateOidcActionConfig' {
- clientSecret :: Maybe Text
- useExistingClientSecret :: Maybe Bool
- authenticationRequestExtraParams :: Maybe (HashMap Text Text)
- scope :: Maybe Text
- onUnauthenticatedRequest :: Maybe AuthenticateOidcActionConditionalBehaviorEnum
- sessionCookieName :: Maybe Text
- sessionTimeout :: Maybe Integer
- issuer :: Text
- authorizationEndpoint :: Text
- tokenEndpoint :: Text
- userInfoEndpoint :: Text
- clientId :: Text
- newAuthenticateOidcActionConfig :: Text -> Text -> Text -> Text -> Text -> AuthenticateOidcActionConfig
- authenticateOidcActionConfig_clientSecret :: Lens' AuthenticateOidcActionConfig (Maybe Text)
- authenticateOidcActionConfig_useExistingClientSecret :: Lens' AuthenticateOidcActionConfig (Maybe Bool)
- authenticateOidcActionConfig_authenticationRequestExtraParams :: Lens' AuthenticateOidcActionConfig (Maybe (HashMap Text Text))
- authenticateOidcActionConfig_scope :: Lens' AuthenticateOidcActionConfig (Maybe Text)
- authenticateOidcActionConfig_onUnauthenticatedRequest :: Lens' AuthenticateOidcActionConfig (Maybe AuthenticateOidcActionConditionalBehaviorEnum)
- authenticateOidcActionConfig_sessionCookieName :: Lens' AuthenticateOidcActionConfig (Maybe Text)
- authenticateOidcActionConfig_sessionTimeout :: Lens' AuthenticateOidcActionConfig (Maybe Integer)
- authenticateOidcActionConfig_issuer :: Lens' AuthenticateOidcActionConfig Text
- authenticateOidcActionConfig_authorizationEndpoint :: Lens' AuthenticateOidcActionConfig Text
- authenticateOidcActionConfig_tokenEndpoint :: Lens' AuthenticateOidcActionConfig Text
- authenticateOidcActionConfig_userInfoEndpoint :: Lens' AuthenticateOidcActionConfig Text
- authenticateOidcActionConfig_clientId :: Lens' AuthenticateOidcActionConfig Text
- data AvailabilityZone = AvailabilityZone' {}
- newAvailabilityZone :: AvailabilityZone
- availabilityZone_subnetId :: Lens' AvailabilityZone (Maybe Text)
- availabilityZone_zoneName :: Lens' AvailabilityZone (Maybe Text)
- availabilityZone_loadBalancerAddresses :: Lens' AvailabilityZone (Maybe [LoadBalancerAddress])
- availabilityZone_outpostId :: Lens' AvailabilityZone (Maybe Text)
- data Certificate = Certificate' {}
- newCertificate :: Certificate
- certificate_certificateArn :: Lens' Certificate (Maybe Text)
- certificate_isDefault :: Lens' Certificate (Maybe Bool)
- data Cipher = Cipher' {}
- newCipher :: Cipher
- cipher_priority :: Lens' Cipher (Maybe Int)
- cipher_name :: Lens' Cipher (Maybe Text)
- data FixedResponseActionConfig = FixedResponseActionConfig' {
- messageBody :: Maybe Text
- contentType :: Maybe Text
- statusCode :: Text
- newFixedResponseActionConfig :: Text -> FixedResponseActionConfig
- fixedResponseActionConfig_messageBody :: Lens' FixedResponseActionConfig (Maybe Text)
- fixedResponseActionConfig_contentType :: Lens' FixedResponseActionConfig (Maybe Text)
- fixedResponseActionConfig_statusCode :: Lens' FixedResponseActionConfig Text
- data ForwardActionConfig = ForwardActionConfig' {}
- newForwardActionConfig :: ForwardActionConfig
- forwardActionConfig_targetGroups :: Lens' ForwardActionConfig (Maybe [TargetGroupTuple])
- forwardActionConfig_targetGroupStickinessConfig :: Lens' ForwardActionConfig (Maybe TargetGroupStickinessConfig)
- data HostHeaderConditionConfig = HostHeaderConditionConfig' {}
- newHostHeaderConditionConfig :: HostHeaderConditionConfig
- hostHeaderConditionConfig_values :: Lens' HostHeaderConditionConfig (Maybe [Text])
- data HttpHeaderConditionConfig = HttpHeaderConditionConfig' {}
- newHttpHeaderConditionConfig :: HttpHeaderConditionConfig
- httpHeaderConditionConfig_values :: Lens' HttpHeaderConditionConfig (Maybe [Text])
- httpHeaderConditionConfig_httpHeaderName :: Lens' HttpHeaderConditionConfig (Maybe Text)
- data HttpRequestMethodConditionConfig = HttpRequestMethodConditionConfig' {}
- newHttpRequestMethodConditionConfig :: HttpRequestMethodConditionConfig
- httpRequestMethodConditionConfig_values :: Lens' HttpRequestMethodConditionConfig (Maybe [Text])
- data Limit = Limit' {}
- newLimit :: Limit
- limit_max :: Lens' Limit (Maybe Text)
- limit_name :: Lens' Limit (Maybe Text)
- data Listener = Listener' {
- sslPolicy :: Maybe Text
- listenerArn :: Maybe Text
- protocol :: Maybe ProtocolEnum
- defaultActions :: Maybe [Action]
- certificates :: Maybe [Certificate]
- loadBalancerArn :: Maybe Text
- alpnPolicy :: Maybe [Text]
- port :: Maybe Natural
- newListener :: Listener
- listener_sslPolicy :: Lens' Listener (Maybe Text)
- listener_listenerArn :: Lens' Listener (Maybe Text)
- listener_protocol :: Lens' Listener (Maybe ProtocolEnum)
- listener_defaultActions :: Lens' Listener (Maybe [Action])
- listener_certificates :: Lens' Listener (Maybe [Certificate])
- listener_loadBalancerArn :: Lens' Listener (Maybe Text)
- listener_alpnPolicy :: Lens' Listener (Maybe [Text])
- listener_port :: Lens' Listener (Maybe Natural)
- data LoadBalancer = LoadBalancer' {
- state :: Maybe LoadBalancerState
- securityGroups :: Maybe [Text]
- loadBalancerName :: Maybe Text
- createdTime :: Maybe ISO8601
- vpcId :: Maybe Text
- canonicalHostedZoneId :: Maybe Text
- availabilityZones :: Maybe [AvailabilityZone]
- customerOwnedIpv4Pool :: Maybe Text
- loadBalancerArn :: Maybe Text
- ipAddressType :: Maybe IpAddressType
- scheme :: Maybe LoadBalancerSchemeEnum
- type' :: Maybe LoadBalancerTypeEnum
- dNSName :: Maybe Text
- newLoadBalancer :: LoadBalancer
- loadBalancer_state :: Lens' LoadBalancer (Maybe LoadBalancerState)
- loadBalancer_securityGroups :: Lens' LoadBalancer (Maybe [Text])
- loadBalancer_loadBalancerName :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_createdTime :: Lens' LoadBalancer (Maybe UTCTime)
- loadBalancer_vpcId :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_canonicalHostedZoneId :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_availabilityZones :: Lens' LoadBalancer (Maybe [AvailabilityZone])
- loadBalancer_customerOwnedIpv4Pool :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_loadBalancerArn :: Lens' LoadBalancer (Maybe Text)
- loadBalancer_ipAddressType :: Lens' LoadBalancer (Maybe IpAddressType)
- loadBalancer_scheme :: Lens' LoadBalancer (Maybe LoadBalancerSchemeEnum)
- loadBalancer_type :: Lens' LoadBalancer (Maybe LoadBalancerTypeEnum)
- loadBalancer_dNSName :: Lens' LoadBalancer (Maybe Text)
- data LoadBalancerAddress = LoadBalancerAddress' {}
- newLoadBalancerAddress :: LoadBalancerAddress
- loadBalancerAddress_iPv6Address :: Lens' LoadBalancerAddress (Maybe Text)
- loadBalancerAddress_ipAddress :: Lens' LoadBalancerAddress (Maybe Text)
- loadBalancerAddress_allocationId :: Lens' LoadBalancerAddress (Maybe Text)
- loadBalancerAddress_privateIPv4Address :: Lens' LoadBalancerAddress (Maybe Text)
- data LoadBalancerAttribute = LoadBalancerAttribute' {}
- newLoadBalancerAttribute :: LoadBalancerAttribute
- loadBalancerAttribute_value :: Lens' LoadBalancerAttribute (Maybe Text)
- loadBalancerAttribute_key :: Lens' LoadBalancerAttribute (Maybe Text)
- data LoadBalancerState = LoadBalancerState' {}
- newLoadBalancerState :: LoadBalancerState
- loadBalancerState_reason :: Lens' LoadBalancerState (Maybe Text)
- loadBalancerState_code :: Lens' LoadBalancerState (Maybe LoadBalancerStateEnum)
- data Matcher = Matcher' {}
- newMatcher :: Matcher
- matcher_httpCode :: Lens' Matcher (Maybe Text)
- matcher_grpcCode :: Lens' Matcher (Maybe Text)
- data PathPatternConditionConfig = PathPatternConditionConfig' {}
- newPathPatternConditionConfig :: PathPatternConditionConfig
- pathPatternConditionConfig_values :: Lens' PathPatternConditionConfig (Maybe [Text])
- data QueryStringConditionConfig = QueryStringConditionConfig' {}
- newQueryStringConditionConfig :: QueryStringConditionConfig
- queryStringConditionConfig_values :: Lens' QueryStringConditionConfig (Maybe [QueryStringKeyValuePair])
- data QueryStringKeyValuePair = QueryStringKeyValuePair' {}
- newQueryStringKeyValuePair :: QueryStringKeyValuePair
- queryStringKeyValuePair_value :: Lens' QueryStringKeyValuePair (Maybe Text)
- queryStringKeyValuePair_key :: Lens' QueryStringKeyValuePair (Maybe Text)
- data RedirectActionConfig = RedirectActionConfig' {}
- newRedirectActionConfig :: RedirectActionStatusCodeEnum -> RedirectActionConfig
- redirectActionConfig_path :: Lens' RedirectActionConfig (Maybe Text)
- redirectActionConfig_protocol :: Lens' RedirectActionConfig (Maybe Text)
- redirectActionConfig_query :: Lens' RedirectActionConfig (Maybe Text)
- redirectActionConfig_host :: Lens' RedirectActionConfig (Maybe Text)
- redirectActionConfig_port :: Lens' RedirectActionConfig (Maybe Text)
- redirectActionConfig_statusCode :: Lens' RedirectActionConfig RedirectActionStatusCodeEnum
- data Rule = Rule' {}
- newRule :: Rule
- rule_priority :: Lens' Rule (Maybe Text)
- rule_actions :: Lens' Rule (Maybe [Action])
- rule_conditions :: Lens' Rule (Maybe [RuleCondition])
- rule_ruleArn :: Lens' Rule (Maybe Text)
- rule_isDefault :: Lens' Rule (Maybe Bool)
- data RuleCondition = RuleCondition' {
- field :: Maybe Text
- httpHeaderConfig :: Maybe HttpHeaderConditionConfig
- hostHeaderConfig :: Maybe HostHeaderConditionConfig
- values :: Maybe [Text]
- sourceIpConfig :: Maybe SourceIpConditionConfig
- httpRequestMethodConfig :: Maybe HttpRequestMethodConditionConfig
- pathPatternConfig :: Maybe PathPatternConditionConfig
- queryStringConfig :: Maybe QueryStringConditionConfig
- newRuleCondition :: RuleCondition
- ruleCondition_field :: Lens' RuleCondition (Maybe Text)
- ruleCondition_httpHeaderConfig :: Lens' RuleCondition (Maybe HttpHeaderConditionConfig)
- ruleCondition_hostHeaderConfig :: Lens' RuleCondition (Maybe HostHeaderConditionConfig)
- ruleCondition_values :: Lens' RuleCondition (Maybe [Text])
- ruleCondition_sourceIpConfig :: Lens' RuleCondition (Maybe SourceIpConditionConfig)
- ruleCondition_httpRequestMethodConfig :: Lens' RuleCondition (Maybe HttpRequestMethodConditionConfig)
- ruleCondition_pathPatternConfig :: Lens' RuleCondition (Maybe PathPatternConditionConfig)
- ruleCondition_queryStringConfig :: Lens' RuleCondition (Maybe QueryStringConditionConfig)
- data RulePriorityPair = RulePriorityPair' {}
- newRulePriorityPair :: RulePriorityPair
- rulePriorityPair_priority :: Lens' RulePriorityPair (Maybe Natural)
- rulePriorityPair_ruleArn :: Lens' RulePriorityPair (Maybe Text)
- data SourceIpConditionConfig = SourceIpConditionConfig' {}
- newSourceIpConditionConfig :: SourceIpConditionConfig
- sourceIpConditionConfig_values :: Lens' SourceIpConditionConfig (Maybe [Text])
- data SslPolicy = SslPolicy' {}
- newSslPolicy :: SslPolicy
- sslPolicy_supportedLoadBalancerTypes :: Lens' SslPolicy (Maybe [Text])
- sslPolicy_ciphers :: Lens' SslPolicy (Maybe [Cipher])
- sslPolicy_name :: Lens' SslPolicy (Maybe Text)
- sslPolicy_sslProtocols :: Lens' SslPolicy (Maybe [Text])
- data SubnetMapping = SubnetMapping' {}
- newSubnetMapping :: SubnetMapping
- subnetMapping_iPv6Address :: Lens' SubnetMapping (Maybe Text)
- subnetMapping_allocationId :: Lens' SubnetMapping (Maybe Text)
- subnetMapping_privateIPv4Address :: Lens' SubnetMapping (Maybe Text)
- subnetMapping_subnetId :: Lens' SubnetMapping (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
- data TagDescription = TagDescription' {}
- newTagDescription :: TagDescription
- tagDescription_resourceArn :: Lens' TagDescription (Maybe Text)
- tagDescription_tags :: Lens' TagDescription (Maybe (NonEmpty Tag))
- data TargetDescription = TargetDescription' {}
- newTargetDescription :: Text -> TargetDescription
- targetDescription_availabilityZone :: Lens' TargetDescription (Maybe Text)
- targetDescription_port :: Lens' TargetDescription (Maybe Natural)
- targetDescription_id :: Lens' TargetDescription Text
- data TargetGroup = TargetGroup' {
- protocolVersion :: Maybe Text
- matcher :: Maybe Matcher
- healthCheckPath :: Maybe Text
- healthCheckEnabled :: Maybe Bool
- unhealthyThresholdCount :: Maybe Natural
- vpcId :: Maybe Text
- targetGroupArn :: Maybe Text
- protocol :: Maybe ProtocolEnum
- healthCheckIntervalSeconds :: Maybe Natural
- targetType :: Maybe TargetTypeEnum
- healthyThresholdCount :: Maybe Natural
- healthCheckProtocol :: Maybe ProtocolEnum
- loadBalancerArns :: Maybe [Text]
- ipAddressType :: Maybe TargetGroupIpAddressTypeEnum
- healthCheckTimeoutSeconds :: Maybe Natural
- healthCheckPort :: Maybe Text
- targetGroupName :: Maybe Text
- port :: Maybe Natural
- newTargetGroup :: TargetGroup
- targetGroup_protocolVersion :: Lens' TargetGroup (Maybe Text)
- targetGroup_matcher :: Lens' TargetGroup (Maybe Matcher)
- targetGroup_healthCheckPath :: Lens' TargetGroup (Maybe Text)
- targetGroup_healthCheckEnabled :: Lens' TargetGroup (Maybe Bool)
- targetGroup_unhealthyThresholdCount :: Lens' TargetGroup (Maybe Natural)
- targetGroup_vpcId :: Lens' TargetGroup (Maybe Text)
- targetGroup_targetGroupArn :: Lens' TargetGroup (Maybe Text)
- targetGroup_protocol :: Lens' TargetGroup (Maybe ProtocolEnum)
- targetGroup_healthCheckIntervalSeconds :: Lens' TargetGroup (Maybe Natural)
- targetGroup_targetType :: Lens' TargetGroup (Maybe TargetTypeEnum)
- targetGroup_healthyThresholdCount :: Lens' TargetGroup (Maybe Natural)
- targetGroup_healthCheckProtocol :: Lens' TargetGroup (Maybe ProtocolEnum)
- targetGroup_loadBalancerArns :: Lens' TargetGroup (Maybe [Text])
- targetGroup_ipAddressType :: Lens' TargetGroup (Maybe TargetGroupIpAddressTypeEnum)
- targetGroup_healthCheckTimeoutSeconds :: Lens' TargetGroup (Maybe Natural)
- targetGroup_healthCheckPort :: Lens' TargetGroup (Maybe Text)
- targetGroup_targetGroupName :: Lens' TargetGroup (Maybe Text)
- targetGroup_port :: Lens' TargetGroup (Maybe Natural)
- data TargetGroupAttribute = TargetGroupAttribute' {}
- newTargetGroupAttribute :: TargetGroupAttribute
- targetGroupAttribute_value :: Lens' TargetGroupAttribute (Maybe Text)
- targetGroupAttribute_key :: Lens' TargetGroupAttribute (Maybe Text)
- data TargetGroupStickinessConfig = TargetGroupStickinessConfig' {}
- newTargetGroupStickinessConfig :: TargetGroupStickinessConfig
- targetGroupStickinessConfig_enabled :: Lens' TargetGroupStickinessConfig (Maybe Bool)
- targetGroupStickinessConfig_durationSeconds :: Lens' TargetGroupStickinessConfig (Maybe Int)
- data TargetGroupTuple = TargetGroupTuple' {}
- newTargetGroupTuple :: TargetGroupTuple
- targetGroupTuple_weight :: Lens' TargetGroupTuple (Maybe Int)
- targetGroupTuple_targetGroupArn :: Lens' TargetGroupTuple (Maybe Text)
- data TargetHealth = TargetHealth' {}
- newTargetHealth :: TargetHealth
- targetHealth_state :: Lens' TargetHealth (Maybe TargetHealthStateEnum)
- targetHealth_reason :: Lens' TargetHealth (Maybe TargetHealthReasonEnum)
- targetHealth_description :: Lens' TargetHealth (Maybe Text)
- data TargetHealthDescription = TargetHealthDescription' {}
- newTargetHealthDescription :: TargetHealthDescription
- targetHealthDescription_targetHealth :: Lens' TargetHealthDescription (Maybe TargetHealth)
- targetHealthDescription_healthCheckPort :: Lens' TargetHealthDescription (Maybe Text)
- targetHealthDescription_target :: Lens' TargetHealthDescription (Maybe TargetDescription)
Service Configuration
defaultService :: Service Source #
API version 2015-12-01
of the Amazon Elastic Load Balancing SDK configuration.
Errors
_InvalidConfigurationRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested configuration is not valid.
_SubnetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified subnet does not exist.
_TooManyTargetsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of targets.
_RuleNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified rule does not exist.
_InvalidSubnetException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified subnet is out of available addresses.
_TooManyRulesException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of rules per load balancer.
_TooManyTargetGroupsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of target groups for your Amazon Web Services account.
_TooManyActionsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of actions per rule.
_DuplicateLoadBalancerNameException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A load balancer with the specified name already exists.
_IncompatibleProtocolsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified configuration is not valid with this protocol.
_TooManyCertificatesException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of certificates per load balancer.
_DuplicateTagKeysException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A tag key was specified more than once.
_DuplicateListenerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A listener with the specified port already exists.
_TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of tags per load balancer.
_DuplicateTargetGroupNameException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A target group with the specified name already exists.
_HealthUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The health of the specified targets could not be retrieved due to an internal error.
_AllocationIdNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified allocation ID does not exist.
_PriorityInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified priority is in use.
_TooManyLoadBalancersException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of load balancers for your Amazon Web Services account.
_UnsupportedProtocolException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified protocol is not supported.
_ALPNPolicyNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified ALPN policy is not supported.
_InvalidTargetException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified target does not exist, is not in the same VPC as the target group, or has an unsupported instance type.
_InvalidSecurityGroupException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified security group does not exist.
_TargetGroupNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified target group does not exist.
_ListenerNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified listener does not exist.
_InvalidLoadBalancerActionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested action is not valid.
_TooManyRegistrationsForTargetIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of times a target can be registered with a load balancer.
_TooManyListenersException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of listeners per load balancer.
_TargetGroupAssociationLimitException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of load balancers per target group.
_OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This operation is not allowed.
_SSLPolicyNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified SSL policy does not exist.
_InvalidSchemeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested scheme is not valid.
_AvailabilityZoneNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified Availability Zone is not supported.
_TooManyUniqueTargetGroupsPerLoadBalancerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit on the number of unique target groups per load balancer across all listeners. If a target group is used by multiple actions for a load balancer, it is counted as only one use.
_LoadBalancerNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified load balancer does not exist.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A specified resource is in use.
_CertificateNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified certificate does not exist.
ActionTypeEnum
newtype ActionTypeEnum Source #
pattern ActionTypeEnum_Authenticate_cognito :: ActionTypeEnum | |
pattern ActionTypeEnum_Authenticate_oidc :: ActionTypeEnum | |
pattern ActionTypeEnum_Fixed_response :: ActionTypeEnum | |
pattern ActionTypeEnum_Forward :: ActionTypeEnum | |
pattern ActionTypeEnum_Redirect :: ActionTypeEnum |
Instances
AuthenticateCognitoActionConditionalBehaviorEnum
newtype AuthenticateCognitoActionConditionalBehaviorEnum Source #
Instances
AuthenticateOidcActionConditionalBehaviorEnum
newtype AuthenticateOidcActionConditionalBehaviorEnum Source #
Instances
IpAddressType
newtype IpAddressType Source #
pattern IpAddressType_Dualstack :: IpAddressType | |
pattern IpAddressType_Ipv4 :: IpAddressType |
Instances
LoadBalancerSchemeEnum
newtype LoadBalancerSchemeEnum Source #
pattern LoadBalancerSchemeEnum_Internal :: LoadBalancerSchemeEnum | |
pattern LoadBalancerSchemeEnum_Internet_facing :: LoadBalancerSchemeEnum |
Instances
LoadBalancerStateEnum
newtype LoadBalancerStateEnum Source #
Instances
LoadBalancerTypeEnum
newtype LoadBalancerTypeEnum Source #
pattern LoadBalancerTypeEnum_Application :: LoadBalancerTypeEnum | |
pattern LoadBalancerTypeEnum_Gateway :: LoadBalancerTypeEnum | |
pattern LoadBalancerTypeEnum_Network :: LoadBalancerTypeEnum |
Instances
ProtocolEnum
newtype ProtocolEnum Source #
pattern ProtocolEnum_GENEVE :: ProtocolEnum | |
pattern ProtocolEnum_HTTP :: ProtocolEnum | |
pattern ProtocolEnum_HTTPS :: ProtocolEnum | |
pattern ProtocolEnum_TCP :: ProtocolEnum | |
pattern ProtocolEnum_TCP_UDP :: ProtocolEnum | |
pattern ProtocolEnum_TLS :: ProtocolEnum | |
pattern ProtocolEnum_UDP :: ProtocolEnum |
Instances
RedirectActionStatusCodeEnum
newtype RedirectActionStatusCodeEnum Source #
pattern RedirectActionStatusCodeEnum_HTTP_301 :: RedirectActionStatusCodeEnum | |
pattern RedirectActionStatusCodeEnum_HTTP_302 :: RedirectActionStatusCodeEnum |
Instances
TargetGroupIpAddressTypeEnum
newtype TargetGroupIpAddressTypeEnum Source #
pattern TargetGroupIpAddressTypeEnum_Ipv4 :: TargetGroupIpAddressTypeEnum | |
pattern TargetGroupIpAddressTypeEnum_Ipv6 :: TargetGroupIpAddressTypeEnum |
Instances
TargetHealthReasonEnum
newtype TargetHealthReasonEnum Source #
Instances
TargetHealthStateEnum
newtype TargetHealthStateEnum Source #
pattern TargetHealthStateEnum_Draining :: TargetHealthStateEnum | |
pattern TargetHealthStateEnum_Healthy :: TargetHealthStateEnum | |
pattern TargetHealthStateEnum_Initial :: TargetHealthStateEnum | |
pattern TargetHealthStateEnum_Unavailable :: TargetHealthStateEnum | |
pattern TargetHealthStateEnum_Unhealthy :: TargetHealthStateEnum | |
pattern TargetHealthStateEnum_Unused :: TargetHealthStateEnum |
Instances
TargetTypeEnum
newtype TargetTypeEnum Source #
pattern TargetTypeEnum_Alb :: TargetTypeEnum | |
pattern TargetTypeEnum_Instance :: TargetTypeEnum | |
pattern TargetTypeEnum_Ip :: TargetTypeEnum | |
pattern TargetTypeEnum_Lambda :: TargetTypeEnum |
Instances
Action
Information about an action.
Each rule must include exactly one of the following types of actions:
forward
, fixed-response
, or redirect
, and it must be the last
action to be performed.
See: newAction
smart constructor.
Action' | |
|
Instances
Create a value of Action
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:fixedResponseConfig:Action'
, action_fixedResponseConfig
- [Application Load Balancer] Information for creating an action that
returns a custom HTTP response. Specify only when Type
is
fixed-response
.
$sel:targetGroupArn:Action'
, action_targetGroupArn
- The Amazon Resource Name (ARN) of the target group. Specify only when
Type
is forward
and you want to route to a single target group. To
route to one or more target groups, use ForwardConfig
instead.
$sel:forwardConfig:Action'
, action_forwardConfig
- Information for creating an action that distributes requests among one
or more target groups. For Network Load Balancers, you can specify a
single target group. Specify only when Type
is forward
. If you
specify both ForwardConfig
and TargetGroupArn
, you can specify only
one target group using ForwardConfig
and it must be the same target
group specified in TargetGroupArn
.
$sel:redirectConfig:Action'
, action_redirectConfig
- [Application Load Balancer] Information for creating a redirect action.
Specify only when Type
is redirect
.
$sel:authenticateCognitoConfig:Action'
, action_authenticateCognitoConfig
- [HTTPS listeners] Information for using Amazon Cognito to authenticate
users. Specify only when Type
is authenticate-cognito
.
$sel:order:Action'
, action_order
- The order for the action. This value is required for rules with multiple
actions. The action with the lowest value for order is performed first.
$sel:authenticateOidcConfig:Action'
, action_authenticateOidcConfig
- [HTTPS listeners] Information about an identity provider that is
compliant with OpenID Connect (OIDC). Specify only when Type
is
authenticate-oidc
.
$sel:type':Action'
, action_type
- The type of action.
action_fixedResponseConfig :: Lens' Action (Maybe FixedResponseActionConfig) Source #
- Application Load Balancer
- Information for creating an action that
returns a custom HTTP response. Specify only when
Type
isfixed-response
.
action_targetGroupArn :: Lens' Action (Maybe Text) Source #
The Amazon Resource Name (ARN) of the target group. Specify only when
Type
is forward
and you want to route to a single target group. To
route to one or more target groups, use ForwardConfig
instead.
action_forwardConfig :: Lens' Action (Maybe ForwardActionConfig) Source #
Information for creating an action that distributes requests among one
or more target groups. For Network Load Balancers, you can specify a
single target group. Specify only when Type
is forward
. If you
specify both ForwardConfig
and TargetGroupArn
, you can specify only
one target group using ForwardConfig
and it must be the same target
group specified in TargetGroupArn
.
action_redirectConfig :: Lens' Action (Maybe RedirectActionConfig) Source #
- Application Load Balancer
- Information for creating a redirect action.
Specify only when
Type
isredirect
.
action_authenticateCognitoConfig :: Lens' Action (Maybe AuthenticateCognitoActionConfig) Source #
- HTTPS listeners
- Information for using Amazon Cognito to authenticate
users. Specify only when
Type
isauthenticate-cognito
.
action_order :: Lens' Action (Maybe Natural) Source #
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
action_authenticateOidcConfig :: Lens' Action (Maybe AuthenticateOidcActionConfig) Source #
- HTTPS listeners
- Information about an identity provider that is
compliant with OpenID Connect (OIDC). Specify only when
Type
isauthenticate-oidc
.
action_type :: Lens' Action ActionTypeEnum Source #
The type of action.
AuthenticateCognitoActionConfig
data AuthenticateCognitoActionConfig Source #
Request parameters to use when integrating with Amazon Cognito to authenticate users.
See: newAuthenticateCognitoActionConfig
smart constructor.
AuthenticateCognitoActionConfig' | |
|
Instances
newAuthenticateCognitoActionConfig Source #
:: Text | |
-> Text | |
-> Text | |
-> AuthenticateCognitoActionConfig |
Create a value of AuthenticateCognitoActionConfig
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:authenticationRequestExtraParams:AuthenticateCognitoActionConfig'
, authenticateCognitoActionConfig_authenticationRequestExtraParams
- The query parameters (up to 10) to include in the redirect request to
the authorization endpoint.
$sel:scope:AuthenticateCognitoActionConfig'
, authenticateCognitoActionConfig_scope
- The set of user claims to be requested from the IdP. The default is
openid
.
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
$sel:onUnauthenticatedRequest:AuthenticateCognitoActionConfig'
, authenticateCognitoActionConfig_onUnauthenticatedRequest
- The behavior if the user is not authenticated. The following are
possible values:
- deny@@ - Return an HTTP 401 Unauthorized error.
- allow@@ - Allow the request to be forwarded to the target.
- authenticate@@ - Redirect the request to the IdP authorization endpoint. This is the default value.
$sel:sessionCookieName:AuthenticateCognitoActionConfig'
, authenticateCognitoActionConfig_sessionCookieName
- The name of the cookie used to maintain session information. The default
is AWSELBAuthSessionCookie.
$sel:sessionTimeout:AuthenticateCognitoActionConfig'
, authenticateCognitoActionConfig_sessionTimeout
- The maximum duration of the authentication session, in seconds. The
default is 604800 seconds (7 days).
$sel:userPoolArn:AuthenticateCognitoActionConfig'
, authenticateCognitoActionConfig_userPoolArn
- The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
$sel:userPoolClientId:AuthenticateCognitoActionConfig'
, authenticateCognitoActionConfig_userPoolClientId
- The ID of the Amazon Cognito user pool client.
$sel:userPoolDomain:AuthenticateCognitoActionConfig'
, authenticateCognitoActionConfig_userPoolDomain
- The domain prefix or fully-qualified domain name of the Amazon Cognito
user pool.
authenticateCognitoActionConfig_authenticationRequestExtraParams :: Lens' AuthenticateCognitoActionConfig (Maybe (HashMap Text Text)) Source #
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
authenticateCognitoActionConfig_scope :: Lens' AuthenticateCognitoActionConfig (Maybe Text) Source #
The set of user claims to be requested from the IdP. The default is
openid
.
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
authenticateCognitoActionConfig_onUnauthenticatedRequest :: Lens' AuthenticateCognitoActionConfig (Maybe AuthenticateCognitoActionConditionalBehaviorEnum) Source #
The behavior if the user is not authenticated. The following are possible values:
- deny@@ - Return an HTTP 401 Unauthorized error.
- allow@@ - Allow the request to be forwarded to the target.
- authenticate@@ - Redirect the request to the IdP authorization endpoint. This is the default value.
authenticateCognitoActionConfig_sessionCookieName :: Lens' AuthenticateCognitoActionConfig (Maybe Text) Source #
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
authenticateCognitoActionConfig_sessionTimeout :: Lens' AuthenticateCognitoActionConfig (Maybe Integer) Source #
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
authenticateCognitoActionConfig_userPoolArn :: Lens' AuthenticateCognitoActionConfig Text Source #
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
authenticateCognitoActionConfig_userPoolClientId :: Lens' AuthenticateCognitoActionConfig Text Source #
The ID of the Amazon Cognito user pool client.
authenticateCognitoActionConfig_userPoolDomain :: Lens' AuthenticateCognitoActionConfig Text Source #
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
AuthenticateOidcActionConfig
data AuthenticateOidcActionConfig Source #
Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.
See: newAuthenticateOidcActionConfig
smart constructor.
AuthenticateOidcActionConfig' | |
|
Instances
newAuthenticateOidcActionConfig Source #
Create a value of AuthenticateOidcActionConfig
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:clientSecret:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_clientSecret
- The OAuth 2.0 client secret. This parameter is required if you are
creating a rule. If you are modifying a rule, you can omit this
parameter if you set UseExistingClientSecret
to true.
$sel:useExistingClientSecret:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_useExistingClientSecret
- Indicates whether to use the existing client secret when modifying a
rule. If you are creating a rule, you can omit this parameter or set it
to false.
$sel:authenticationRequestExtraParams:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_authenticationRequestExtraParams
- The query parameters (up to 10) to include in the redirect request to
the authorization endpoint.
$sel:scope:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_scope
- The set of user claims to be requested from the IdP. The default is
openid
.
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
$sel:onUnauthenticatedRequest:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_onUnauthenticatedRequest
- The behavior if the user is not authenticated. The following are
possible values:
- deny@@ - Return an HTTP 401 Unauthorized error.
- allow@@ - Allow the request to be forwarded to the target.
- authenticate@@ - Redirect the request to the IdP authorization endpoint. This is the default value.
$sel:sessionCookieName:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_sessionCookieName
- The name of the cookie used to maintain session information. The default
is AWSELBAuthSessionCookie.
$sel:sessionTimeout:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_sessionTimeout
- The maximum duration of the authentication session, in seconds. The
default is 604800 seconds (7 days).
$sel:issuer:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_issuer
- The OIDC issuer identifier of the IdP. This must be a full URL,
including the HTTPS protocol, the domain, and the path.
$sel:authorizationEndpoint:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_authorizationEndpoint
- The authorization endpoint of the IdP. This must be a full URL,
including the HTTPS protocol, the domain, and the path.
$sel:tokenEndpoint:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_tokenEndpoint
- The token endpoint of the IdP. This must be a full URL, including the
HTTPS protocol, the domain, and the path.
$sel:userInfoEndpoint:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_userInfoEndpoint
- The user info endpoint of the IdP. This must be a full URL, including
the HTTPS protocol, the domain, and the path.
$sel:clientId:AuthenticateOidcActionConfig'
, authenticateOidcActionConfig_clientId
- The OAuth 2.0 client identifier.
authenticateOidcActionConfig_clientSecret :: Lens' AuthenticateOidcActionConfig (Maybe Text) Source #
The OAuth 2.0 client secret. This parameter is required if you are
creating a rule. If you are modifying a rule, you can omit this
parameter if you set UseExistingClientSecret
to true.
authenticateOidcActionConfig_useExistingClientSecret :: Lens' AuthenticateOidcActionConfig (Maybe Bool) Source #
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
authenticateOidcActionConfig_authenticationRequestExtraParams :: Lens' AuthenticateOidcActionConfig (Maybe (HashMap Text Text)) Source #
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
authenticateOidcActionConfig_scope :: Lens' AuthenticateOidcActionConfig (Maybe Text) Source #
The set of user claims to be requested from the IdP. The default is
openid
.
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
authenticateOidcActionConfig_onUnauthenticatedRequest :: Lens' AuthenticateOidcActionConfig (Maybe AuthenticateOidcActionConditionalBehaviorEnum) Source #
The behavior if the user is not authenticated. The following are possible values:
- deny@@ - Return an HTTP 401 Unauthorized error.
- allow@@ - Allow the request to be forwarded to the target.
- authenticate@@ - Redirect the request to the IdP authorization endpoint. This is the default value.
authenticateOidcActionConfig_sessionCookieName :: Lens' AuthenticateOidcActionConfig (Maybe Text) Source #
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
authenticateOidcActionConfig_sessionTimeout :: Lens' AuthenticateOidcActionConfig (Maybe Integer) Source #
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
authenticateOidcActionConfig_issuer :: Lens' AuthenticateOidcActionConfig Text Source #
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
authenticateOidcActionConfig_authorizationEndpoint :: Lens' AuthenticateOidcActionConfig Text Source #
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
authenticateOidcActionConfig_tokenEndpoint :: Lens' AuthenticateOidcActionConfig Text Source #
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
authenticateOidcActionConfig_userInfoEndpoint :: Lens' AuthenticateOidcActionConfig Text Source #
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
authenticateOidcActionConfig_clientId :: Lens' AuthenticateOidcActionConfig Text Source #
The OAuth 2.0 client identifier.
AvailabilityZone
data AvailabilityZone Source #
Information about an Availability Zone.
See: newAvailabilityZone
smart constructor.
AvailabilityZone' | |
|
Instances
newAvailabilityZone :: AvailabilityZone Source #
Create a value of AvailabilityZone
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:subnetId:AvailabilityZone'
, availabilityZone_subnetId
- The ID of the subnet. You can specify one subnet per Availability Zone.
$sel:zoneName:AvailabilityZone'
, availabilityZone_zoneName
- The name of the Availability Zone.
$sel:loadBalancerAddresses:AvailabilityZone'
, availabilityZone_loadBalancerAddresses
- [Network Load Balancers] If you need static IP addresses for your load
balancer, you can specify one Elastic IP address per Availability Zone
when you create an internal-facing load balancer. For internal load
balancers, you can specify a private IP address from the IPv4 range of
the subnet.
$sel:outpostId:AvailabilityZone'
, availabilityZone_outpostId
- [Application Load Balancers on Outposts] The ID of the Outpost.
availabilityZone_subnetId :: Lens' AvailabilityZone (Maybe Text) Source #
The ID of the subnet. You can specify one subnet per Availability Zone.
availabilityZone_zoneName :: Lens' AvailabilityZone (Maybe Text) Source #
The name of the Availability Zone.
availabilityZone_loadBalancerAddresses :: Lens' AvailabilityZone (Maybe [LoadBalancerAddress]) Source #
- Network Load Balancers
- If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.
availabilityZone_outpostId :: Lens' AvailabilityZone (Maybe Text) Source #
- Application Load Balancers on Outposts
- The ID of the Outpost.
Certificate
data Certificate Source #
Information about an SSL server certificate.
See: newCertificate
smart constructor.
Certificate' | |
|
Instances
newCertificate :: Certificate Source #
Create a value of Certificate
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:certificateArn:Certificate'
, certificate_certificateArn
- The Amazon Resource Name (ARN) of the certificate.
$sel:isDefault:Certificate'
, certificate_isDefault
- Indicates whether the certificate is the default certificate. Do not set
this value when specifying a certificate as an input. This value is not
included in the output when describing a listener, but is included when
describing listener certificates.
certificate_certificateArn :: Lens' Certificate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the certificate.
certificate_isDefault :: Lens' Certificate (Maybe Bool) Source #
Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
Cipher
Information about a cipher used in a policy.
See: newCipher
smart constructor.
Instances
Eq Cipher Source # | |
Read Cipher Source # | |
Show Cipher Source # | |
Generic Cipher Source # | |
NFData Cipher Source # | |
Defined in Amazonka.ELBV2.Types.Cipher | |
Hashable Cipher Source # | |
Defined in Amazonka.ELBV2.Types.Cipher | |
FromXML Cipher Source # | |
type Rep Cipher Source # | |
Defined in Amazonka.ELBV2.Types.Cipher type Rep Cipher = D1 ('MetaData "Cipher" "Amazonka.ELBV2.Types.Cipher" "libZSservicesZSamazonka-elbv2ZSamazonka-elbv2" 'False) (C1 ('MetaCons "Cipher'" 'PrefixI 'True) (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Cipher
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:priority:Cipher'
, cipher_priority
- The priority of the cipher.
$sel:name:Cipher'
, cipher_name
- The name of the cipher.
FixedResponseActionConfig
data FixedResponseActionConfig Source #
Information about an action that returns a custom HTTP response.
See: newFixedResponseActionConfig
smart constructor.
FixedResponseActionConfig' | |
|
Instances
newFixedResponseActionConfig Source #
Create a value of FixedResponseActionConfig
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:messageBody:FixedResponseActionConfig'
, fixedResponseActionConfig_messageBody
- The message.
$sel:contentType:FixedResponseActionConfig'
, fixedResponseActionConfig_contentType
- The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
$sel:statusCode:FixedResponseActionConfig'
, fixedResponseActionConfig_statusCode
- The HTTP response code (2XX, 4XX, or 5XX).
fixedResponseActionConfig_messageBody :: Lens' FixedResponseActionConfig (Maybe Text) Source #
The message.
fixedResponseActionConfig_contentType :: Lens' FixedResponseActionConfig (Maybe Text) Source #
The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
fixedResponseActionConfig_statusCode :: Lens' FixedResponseActionConfig Text Source #
The HTTP response code (2XX, 4XX, or 5XX).
ForwardActionConfig
data ForwardActionConfig Source #
Information about a forward action.
See: newForwardActionConfig
smart constructor.
ForwardActionConfig' | |
|
Instances
newForwardActionConfig :: ForwardActionConfig Source #
Create a value of ForwardActionConfig
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:targetGroups:ForwardActionConfig'
, forwardActionConfig_targetGroups
- One or more target groups. For Network Load Balancers, you can specify a
single target group.
$sel:targetGroupStickinessConfig:ForwardActionConfig'
, forwardActionConfig_targetGroupStickinessConfig
- The target group stickiness for the rule.
forwardActionConfig_targetGroups :: Lens' ForwardActionConfig (Maybe [TargetGroupTuple]) Source #
One or more target groups. For Network Load Balancers, you can specify a single target group.
forwardActionConfig_targetGroupStickinessConfig :: Lens' ForwardActionConfig (Maybe TargetGroupStickinessConfig) Source #
The target group stickiness for the rule.
HostHeaderConditionConfig
data HostHeaderConditionConfig Source #
Information about a host header condition.
See: newHostHeaderConditionConfig
smart constructor.
HostHeaderConditionConfig' | |
|
Instances
newHostHeaderConditionConfig :: HostHeaderConditionConfig Source #
Create a value of HostHeaderConditionConfig
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:values:HostHeaderConditionConfig'
, hostHeaderConditionConfig_values
- One or more host names. The maximum size of each name is 128 characters.
The comparison is case insensitive. The following wildcard characters
are supported: * (matches 0 or more characters) and ? (matches exactly 1
character).
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
hostHeaderConditionConfig_values :: Lens' HostHeaderConditionConfig (Maybe [Text]) Source #
One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
HttpHeaderConditionConfig
data HttpHeaderConditionConfig Source #
Information about an HTTP header condition.
There is a set of standard HTTP header fields. You can also define custom HTTP header fields.
See: newHttpHeaderConditionConfig
smart constructor.
HttpHeaderConditionConfig' | |
|
Instances
newHttpHeaderConditionConfig :: HttpHeaderConditionConfig Source #
Create a value of HttpHeaderConditionConfig
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:values:HttpHeaderConditionConfig'
, httpHeaderConditionConfig_values
- One or more strings to compare against the value of the HTTP header. The
maximum size of each string is 128 characters. The comparison strings
are case insensitive. The following wildcard characters are supported: *
(matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
$sel:httpHeaderName:HttpHeaderConditionConfig'
, httpHeaderConditionConfig_httpHeaderName
- The name of the HTTP header field. The maximum size is 40 characters.
The header name is case insensitive. The allowed characters are
specified by RFC 7230. Wildcards are not supported.
You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.
httpHeaderConditionConfig_values :: Lens' HttpHeaderConditionConfig (Maybe [Text]) Source #
One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
httpHeaderConditionConfig_httpHeaderName :: Lens' HttpHeaderConditionConfig (Maybe Text) Source #
The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.
You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.
HttpRequestMethodConditionConfig
data HttpRequestMethodConditionConfig Source #
Information about an HTTP method condition.
HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the HTTP Method Registry. You can also define custom HTTP methods.
See: newHttpRequestMethodConditionConfig
smart constructor.
HttpRequestMethodConditionConfig' | |
|
Instances
newHttpRequestMethodConditionConfig :: HttpRequestMethodConditionConfig Source #
Create a value of HttpRequestMethodConditionConfig
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:values:HttpRequestMethodConditionConfig'
, httpRequestMethodConditionConfig_values
- The name of the request method. The maximum size is 40 characters. The
allowed characters are A-Z, hyphen (-), and underscore (_). The
comparison is case sensitive. Wildcards are not supported; therefore,
the method name must be an exact match.
If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
httpRequestMethodConditionConfig_values :: Lens' HttpRequestMethodConditionConfig (Maybe [Text]) Source #
The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.
If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
Limit
Information about an Elastic Load Balancing resource limit for your Amazon Web Services account.
See: newLimit
smart constructor.
Limit' | |
|
Instances
Eq Limit Source # | |
Read Limit Source # | |
Show Limit Source # | |
Generic Limit Source # | |
NFData Limit Source # | |
Defined in Amazonka.ELBV2.Types.Limit | |
Hashable Limit Source # | |
Defined in Amazonka.ELBV2.Types.Limit | |
FromXML Limit Source # | |
type Rep Limit Source # | |
Defined in Amazonka.ELBV2.Types.Limit type Rep Limit = D1 ('MetaData "Limit" "Amazonka.ELBV2.Types.Limit" "libZSservicesZSamazonka-elbv2ZSamazonka-elbv2" 'False) (C1 ('MetaCons "Limit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "max") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Limit
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:max:Limit'
, limit_max
- The maximum value of the limit.
$sel:name:Limit'
, limit_name
- The name of the limit. The possible values are:
- application-load-balancers
- condition-values-per-alb-rule
- condition-wildcards-per-alb-rule
- gateway-load-balancers
- gateway-load-balancers-per-vpc
- geneve-target-groups
- listeners-per-application-load-balancer
- listeners-per-network-load-balancer
- network-load-balancers
- rules-per-application-load-balancer
- target-groups
- target-groups-per-action-on-application-load-balancer
- target-groups-per-action-on-network-load-balancer
- target-groups-per-application-load-balancer
- targets-per-application-load-balancer
- targets-per-availability-zone-per-gateway-load-balancer
- targets-per-availability-zone-per-network-load-balancer
- targets-per-network-load-balancer
limit_name :: Lens' Limit (Maybe Text) Source #
The name of the limit. The possible values are:
- application-load-balancers
- condition-values-per-alb-rule
- condition-wildcards-per-alb-rule
- gateway-load-balancers
- gateway-load-balancers-per-vpc
- geneve-target-groups
- listeners-per-application-load-balancer
- listeners-per-network-load-balancer
- network-load-balancers
- rules-per-application-load-balancer
- target-groups
- target-groups-per-action-on-application-load-balancer
- target-groups-per-action-on-network-load-balancer
- target-groups-per-application-load-balancer
- targets-per-application-load-balancer
- targets-per-availability-zone-per-gateway-load-balancer
- targets-per-availability-zone-per-network-load-balancer
- targets-per-network-load-balancer
Listener
Information about a listener.
See: newListener
smart constructor.
Listener' | |
|
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:sslPolicy:Listener'
, listener_sslPolicy
- [HTTPS or TLS listener] The security policy that defines which protocols
and ciphers are supported.
$sel:listenerArn:Listener'
, listener_listenerArn
- The Amazon Resource Name (ARN) of the listener.
$sel:protocol:Listener'
, listener_protocol
- The protocol for connections from clients to the load balancer.
$sel:defaultActions:Listener'
, listener_defaultActions
- The default actions for the listener.
$sel:certificates:Listener'
, listener_certificates
- [HTTPS or TLS listener] The default certificate for the listener.
$sel:loadBalancerArn:Listener'
, listener_loadBalancerArn
- The Amazon Resource Name (ARN) of the load balancer.
$sel:alpnPolicy:Listener'
, listener_alpnPolicy
- [TLS listener] The name of the Application-Layer Protocol Negotiation
(ALPN) policy.
$sel:port:Listener'
, listener_port
- The port on which the load balancer is listening.
listener_sslPolicy :: Lens' Listener (Maybe Text) Source #
- HTTPS or TLS listener
- The security policy that defines which protocols and ciphers are supported.
listener_listenerArn :: Lens' Listener (Maybe Text) Source #
The Amazon Resource Name (ARN) of the listener.
listener_protocol :: Lens' Listener (Maybe ProtocolEnum) Source #
The protocol for connections from clients to the load balancer.
listener_defaultActions :: Lens' Listener (Maybe [Action]) Source #
The default actions for the listener.
listener_certificates :: Lens' Listener (Maybe [Certificate]) Source #
- HTTPS or TLS listener
- The default certificate for the listener.
listener_loadBalancerArn :: Lens' Listener (Maybe Text) Source #
The Amazon Resource Name (ARN) of the load balancer.
listener_alpnPolicy :: Lens' Listener (Maybe [Text]) Source #
- TLS listener
- The name of the Application-Layer Protocol Negotiation (ALPN) policy.
listener_port :: Lens' Listener (Maybe Natural) Source #
The port on which the load balancer is listening.
LoadBalancer
data LoadBalancer Source #
Information about a load balancer.
See: newLoadBalancer
smart constructor.
LoadBalancer' | |
|
Instances
newLoadBalancer :: LoadBalancer Source #
Create a value of LoadBalancer
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:state:LoadBalancer'
, loadBalancer_state
- The state of the load balancer.
$sel:securityGroups:LoadBalancer'
, loadBalancer_securityGroups
- The IDs of the security groups for the load balancer.
$sel:loadBalancerName:LoadBalancer'
, loadBalancer_loadBalancerName
- The name of the load balancer.
$sel:createdTime:LoadBalancer'
, loadBalancer_createdTime
- The date and time the load balancer was created.
$sel:vpcId:LoadBalancer'
, loadBalancer_vpcId
- The ID of the VPC for the load balancer.
$sel:canonicalHostedZoneId:LoadBalancer'
, loadBalancer_canonicalHostedZoneId
- The ID of the Amazon Route 53 hosted zone associated with the load
balancer.
$sel:availabilityZones:LoadBalancer'
, loadBalancer_availabilityZones
- The subnets for the load balancer.
$sel:customerOwnedIpv4Pool:LoadBalancer'
, loadBalancer_customerOwnedIpv4Pool
- [Application Load Balancers on Outposts] The ID of the customer-owned
address pool.
$sel:loadBalancerArn:LoadBalancer'
, loadBalancer_loadBalancerArn
- The Amazon Resource Name (ARN) of the load balancer.
$sel:ipAddressType:LoadBalancer'
, loadBalancer_ipAddressType
- The type of IP addresses used by the subnets for your load balancer. The
possible values are ipv4
(for IPv4 addresses) and dualstack
(for
IPv4 and IPv6 addresses).
$sel:scheme:LoadBalancer'
, loadBalancer_scheme
- The nodes of an Internet-facing load balancer have public IP addresses.
The DNS name of an Internet-facing load balancer is publicly resolvable
to the public IP addresses of the nodes. Therefore, Internet-facing load
balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
$sel:type':LoadBalancer'
, loadBalancer_type
- The type of load balancer.
$sel:dNSName:LoadBalancer'
, loadBalancer_dNSName
- The public DNS name of the load balancer.
loadBalancer_state :: Lens' LoadBalancer (Maybe LoadBalancerState) Source #
The state of the load balancer.
loadBalancer_securityGroups :: Lens' LoadBalancer (Maybe [Text]) Source #
The IDs of the security groups for the load balancer.
loadBalancer_loadBalancerName :: Lens' LoadBalancer (Maybe Text) Source #
The name of the load balancer.
loadBalancer_createdTime :: Lens' LoadBalancer (Maybe UTCTime) Source #
The date and time the load balancer was created.
loadBalancer_vpcId :: Lens' LoadBalancer (Maybe Text) Source #
The ID of the VPC for the load balancer.
loadBalancer_canonicalHostedZoneId :: Lens' LoadBalancer (Maybe Text) Source #
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
loadBalancer_availabilityZones :: Lens' LoadBalancer (Maybe [AvailabilityZone]) Source #
The subnets for the load balancer.
loadBalancer_customerOwnedIpv4Pool :: Lens' LoadBalancer (Maybe Text) Source #
- Application Load Balancers on Outposts
- The ID of the customer-owned address pool.
loadBalancer_loadBalancerArn :: Lens' LoadBalancer (Maybe Text) Source #
The Amazon Resource Name (ARN) of the load balancer.
loadBalancer_ipAddressType :: Lens' LoadBalancer (Maybe IpAddressType) Source #
The type of IP addresses used by the subnets for your load balancer. The
possible values are ipv4
(for IPv4 addresses) and dualstack
(for
IPv4 and IPv6 addresses).
loadBalancer_scheme :: Lens' LoadBalancer (Maybe LoadBalancerSchemeEnum) Source #
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
loadBalancer_type :: Lens' LoadBalancer (Maybe LoadBalancerTypeEnum) Source #
The type of load balancer.
loadBalancer_dNSName :: Lens' LoadBalancer (Maybe Text) Source #
The public DNS name of the load balancer.
LoadBalancerAddress
data LoadBalancerAddress Source #
Information about a static IP address for a load balancer.
See: newLoadBalancerAddress
smart constructor.
LoadBalancerAddress' | |
|
Instances
newLoadBalancerAddress :: LoadBalancerAddress Source #
Create a value of LoadBalancerAddress
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:iPv6Address:LoadBalancerAddress'
, loadBalancerAddress_iPv6Address
- [Network Load Balancers] The IPv6 address.
$sel:ipAddress:LoadBalancerAddress'
, loadBalancerAddress_ipAddress
- The static IP address.
$sel:allocationId:LoadBalancerAddress'
, loadBalancerAddress_allocationId
- [Network Load Balancers] The allocation ID of the Elastic IP address for
an internal-facing load balancer.
$sel:privateIPv4Address:LoadBalancerAddress'
, loadBalancerAddress_privateIPv4Address
- [Network Load Balancers] The private IPv4 address for an internal load
balancer.
loadBalancerAddress_iPv6Address :: Lens' LoadBalancerAddress (Maybe Text) Source #
- Network Load Balancers
- The IPv6 address.
loadBalancerAddress_ipAddress :: Lens' LoadBalancerAddress (Maybe Text) Source #
The static IP address.
loadBalancerAddress_allocationId :: Lens' LoadBalancerAddress (Maybe Text) Source #
- Network Load Balancers
- The allocation ID of the Elastic IP address for an internal-facing load balancer.
loadBalancerAddress_privateIPv4Address :: Lens' LoadBalancerAddress (Maybe Text) Source #
- Network Load Balancers
- The private IPv4 address for an internal load balancer.
LoadBalancerAttribute
data LoadBalancerAttribute Source #
Information about a load balancer attribute.
See: newLoadBalancerAttribute
smart constructor.
LoadBalancerAttribute' | |
|
Instances
newLoadBalancerAttribute :: LoadBalancerAttribute Source #
Create a value of LoadBalancerAttribute
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:value:LoadBalancerAttribute'
, loadBalancerAttribute_value
- The value of the attribute.
$sel:key:LoadBalancerAttribute'
, loadBalancerAttribute_key
- The name of the attribute.
The following attribute is supported by all load balancers:
deletion_protection.enabled
- Indicates whether deletion protection is enabled. The value istrue
orfalse
. The default isfalse
.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
access_logs.s3.enabled
- Indicates whether access logs are enabled. The value istrue
orfalse
. The default isfalse
.access_logs.s3.bucket
- The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.access_logs.s3.prefix
- The prefix for the location in the S3 bucket for the access logs.
The following attributes are supported by only Application Load Balancers:
idle_timeout.timeout_seconds
- The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.routing.http.desync_mitigation_mode
- Determines how the load balancer handles requests that might pose a security risk to your application. The possible values aremonitor
,defensive
, andstrictest
. The default isdefensive
.routing.http.drop_invalid_header_fields.enabled
- Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true
) or routed to targets (false
). The default isfalse
.routing.http.x_amzn_tls_version_and_cipher_suite.enabled
- Indicates whether the two headers (x-amzn-tls-version
andx-amzn-tls-cipher-suite
), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. Thex-amzn-tls-version
header has information about the TLS protocol version negotiated with the client, and thex-amzn-tls-cipher-suite
header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute aretrue
andfalse
. The default isfalse
.routing.http.xff_client_port.enabled
- Indicates whether theX-Forwarded-For
header should preserve the source port that the client used to connect to the load balancer. The possible values aretrue
andfalse
. The default isfalse
.routing.http2.enabled
- Indicates whether HTTP/2 is enabled. The possible values aretrue
andfalse
. The default istrue
. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.waf.fail_open.enabled
- Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values aretrue
andfalse
. The default isfalse
.
The following attribute is supported by Network Load Balancers and Gateway Load Balancers:
load_balancing.cross_zone.enabled
- Indicates whether cross-zone load balancing is enabled. The possible values aretrue
andfalse
. The default isfalse
.
loadBalancerAttribute_value :: Lens' LoadBalancerAttribute (Maybe Text) Source #
The value of the attribute.
loadBalancerAttribute_key :: Lens' LoadBalancerAttribute (Maybe Text) Source #
The name of the attribute.
The following attribute is supported by all load balancers:
deletion_protection.enabled
- Indicates whether deletion protection is enabled. The value istrue
orfalse
. The default isfalse
.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
access_logs.s3.enabled
- Indicates whether access logs are enabled. The value istrue
orfalse
. The default isfalse
.access_logs.s3.bucket
- The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.access_logs.s3.prefix
- The prefix for the location in the S3 bucket for the access logs.
The following attributes are supported by only Application Load Balancers:
idle_timeout.timeout_seconds
- The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.routing.http.desync_mitigation_mode
- Determines how the load balancer handles requests that might pose a security risk to your application. The possible values aremonitor
,defensive
, andstrictest
. The default isdefensive
.routing.http.drop_invalid_header_fields.enabled
- Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true
) or routed to targets (false
). The default isfalse
.routing.http.x_amzn_tls_version_and_cipher_suite.enabled
- Indicates whether the two headers (x-amzn-tls-version
andx-amzn-tls-cipher-suite
), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. Thex-amzn-tls-version
header has information about the TLS protocol version negotiated with the client, and thex-amzn-tls-cipher-suite
header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute aretrue
andfalse
. The default isfalse
.routing.http.xff_client_port.enabled
- Indicates whether theX-Forwarded-For
header should preserve the source port that the client used to connect to the load balancer. The possible values aretrue
andfalse
. The default isfalse
.routing.http2.enabled
- Indicates whether HTTP/2 is enabled. The possible values aretrue
andfalse
. The default istrue
. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.waf.fail_open.enabled
- Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values aretrue
andfalse
. The default isfalse
.
The following attribute is supported by Network Load Balancers and Gateway Load Balancers:
load_balancing.cross_zone.enabled
- Indicates whether cross-zone load balancing is enabled. The possible values aretrue
andfalse
. The default isfalse
.
LoadBalancerState
data LoadBalancerState Source #
Information about the state of the load balancer.
See: newLoadBalancerState
smart constructor.
LoadBalancerState' | |
|
Instances
newLoadBalancerState :: LoadBalancerState Source #
Create a value of LoadBalancerState
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:reason:LoadBalancerState'
, loadBalancerState_reason
- A description of the state.
$sel:code:LoadBalancerState'
, loadBalancerState_code
- The state code. The initial state of the load balancer is
provisioning
. After the load balancer is fully set up and ready to
route traffic, its state is active
. If load balancer is routing
traffic but does not have the resources it needs to scale, its state
isactive_impaired
. If the load balancer could not be set up, its state
is failed
.
loadBalancerState_reason :: Lens' LoadBalancerState (Maybe Text) Source #
A description of the state.
loadBalancerState_code :: Lens' LoadBalancerState (Maybe LoadBalancerStateEnum) Source #
The state code. The initial state of the load balancer is
provisioning
. After the load balancer is fully set up and ready to
route traffic, its state is active
. If load balancer is routing
traffic but does not have the resources it needs to scale, its state
isactive_impaired
. If the load balancer could not be set up, its state
is failed
.
Matcher
The codes to use when checking for a successful response from a target. If the protocol version is gRPC, these are gRPC codes. Otherwise, these are HTTP codes.
See: newMatcher
smart constructor.
Matcher' | |
|
Instances
Eq Matcher Source # | |
Read Matcher Source # | |
Show Matcher Source # | |
Generic Matcher Source # | |
NFData Matcher Source # | |
Defined in Amazonka.ELBV2.Types.Matcher | |
Hashable Matcher Source # | |
Defined in Amazonka.ELBV2.Types.Matcher | |
ToQuery Matcher Source # | |
Defined in Amazonka.ELBV2.Types.Matcher toQuery :: Matcher -> QueryString # | |
FromXML Matcher Source # | |
type Rep Matcher Source # | |
Defined in Amazonka.ELBV2.Types.Matcher type Rep Matcher = D1 ('MetaData "Matcher" "Amazonka.ELBV2.Types.Matcher" "libZSservicesZSamazonka-elbv2ZSamazonka-elbv2" 'False) (C1 ('MetaCons "Matcher'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "grpcCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newMatcher :: Matcher Source #
Create a value of Matcher
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:httpCode:Matcher'
, matcher_httpCode
- For Application Load Balancers, you can specify values between 200 and
499, and the default value is 200. You can specify multiple values (for
example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers and Gateway Load Balancers, this must be "200–399".
Note that when using shorthand syntax, some values such as commas need to be escaped.
$sel:grpcCode:Matcher'
, matcher_grpcCode
- You can specify values between 0 and 99. You can specify multiple values
(for example, "0,1") or a range of values (for example, "0-5"). The
default value is 12.
matcher_httpCode :: Lens' Matcher (Maybe Text) Source #
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers and Gateway Load Balancers, this must be "200–399".
Note that when using shorthand syntax, some values such as commas need to be escaped.
matcher_grpcCode :: Lens' Matcher (Maybe Text) Source #
You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.
PathPatternConditionConfig
data PathPatternConditionConfig Source #
Information about a path pattern condition.
See: newPathPatternConditionConfig
smart constructor.
PathPatternConditionConfig' | |
|
Instances
newPathPatternConditionConfig :: PathPatternConditionConfig Source #
Create a value of PathPatternConditionConfig
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:values:PathPatternConditionConfig'
, pathPatternConditionConfig_values
- One or more path patterns to compare against the request URL. The
maximum size of each string is 128 characters. The comparison is case
sensitive. The following wildcard characters are supported: * (matches 0
or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig.
pathPatternConditionConfig_values :: Lens' PathPatternConditionConfig (Maybe [Text]) Source #
One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig.
QueryStringConditionConfig
data QueryStringConditionConfig Source #
Information about a query string condition.
The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.
See: newQueryStringConditionConfig
smart constructor.
QueryStringConditionConfig' | |
|
Instances
newQueryStringConditionConfig :: QueryStringConditionConfig Source #
Create a value of QueryStringConditionConfig
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:values:QueryStringConditionConfig'
, queryStringConditionConfig_values
- One or more key/value pairs or values to find in the query string. The
maximum size of each string is 128 characters. The comparison is case
insensitive. The following wildcard characters are supported: * (matches
0 or more characters) and ? (matches exactly 1 character). To search for
a literal '*' or '?' character in a query string, you must escape
these characters in Values
using a '\' character.
If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
queryStringConditionConfig_values :: Lens' QueryStringConditionConfig (Maybe [QueryStringKeyValuePair]) Source #
One or more key/value pairs or values to find in the query string. The
maximum size of each string is 128 characters. The comparison is case
insensitive. The following wildcard characters are supported: * (matches
0 or more characters) and ? (matches exactly 1 character). To search for
a literal '*' or '?' character in a query string, you must escape
these characters in Values
using a '\' character.
If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
QueryStringKeyValuePair
data QueryStringKeyValuePair Source #
Information about a key/value pair.
See: newQueryStringKeyValuePair
smart constructor.
Instances
newQueryStringKeyValuePair :: QueryStringKeyValuePair Source #
Create a value of QueryStringKeyValuePair
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:value:QueryStringKeyValuePair'
, queryStringKeyValuePair_value
- The value.
$sel:key:QueryStringKeyValuePair'
, queryStringKeyValuePair_key
- The key. You can omit the key.
queryStringKeyValuePair_value :: Lens' QueryStringKeyValuePair (Maybe Text) Source #
The value.
queryStringKeyValuePair_key :: Lens' QueryStringKeyValuePair (Maybe Text) Source #
The key. You can omit the key.
RedirectActionConfig
data RedirectActionConfig Source #
Information about a redirect action.
A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.
You can reuse URI components using the following reserved keywords:
- #{protocol}
- #{host}
- #{port}
- #{path} (the leading "/" is removed)
- #{query}
For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".
See: newRedirectActionConfig
smart constructor.
RedirectActionConfig' | |
|
Instances
newRedirectActionConfig Source #
Create a value of RedirectActionConfig
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:path:RedirectActionConfig'
, redirectActionConfig_path
- The absolute path, starting with the leading "/". This component is
not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
$sel:protocol:RedirectActionConfig'
, redirectActionConfig_protocol
- The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can
redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot
redirect HTTPS to HTTP.
$sel:query:RedirectActionConfig'
, redirectActionConfig_query
- The query parameters, URL-encoded when necessary, but not
percent-encoded. Do not include the leading "?", as it is
automatically added. You can specify any of the reserved keywords.
$sel:host:RedirectActionConfig'
, redirectActionConfig_host
- The hostname. This component is not percent-encoded. The hostname can
contain #{host}.
$sel:port:RedirectActionConfig'
, redirectActionConfig_port
- The port. You can specify a value from 1 to 65535 or #{port}.
$sel:statusCode:RedirectActionConfig'
, redirectActionConfig_statusCode
- The HTTP redirect code. The redirect is either permanent (HTTP 301) or
temporary (HTTP 302).
redirectActionConfig_path :: Lens' RedirectActionConfig (Maybe Text) Source #
The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
redirectActionConfig_protocol :: Lens' RedirectActionConfig (Maybe Text) Source #
The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
redirectActionConfig_query :: Lens' RedirectActionConfig (Maybe Text) Source #
The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
redirectActionConfig_host :: Lens' RedirectActionConfig (Maybe Text) Source #
The hostname. This component is not percent-encoded. The hostname can contain #{host}.
redirectActionConfig_port :: Lens' RedirectActionConfig (Maybe Text) Source #
The port. You can specify a value from 1 to 65535 or #{port}.
redirectActionConfig_statusCode :: Lens' RedirectActionConfig RedirectActionStatusCodeEnum Source #
The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
Rule
Information about a rule.
See: newRule
smart constructor.
Rule' | |
|
Instances
Create a value of Rule
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:priority:Rule'
, rule_priority
- The priority.
$sel:actions:Rule'
, rule_actions
- The actions. Each rule must include exactly one of the following types
of actions: forward
, redirect
, or fixed-response
, and it must be
the last action to be performed.
$sel:conditions:Rule'
, rule_conditions
- The conditions. Each rule can include zero or one of the following
conditions: http-request-method
, host-header
, path-pattern
, and
source-ip
, and zero or more of the following conditions: http-header
and query-string
.
$sel:ruleArn:Rule'
, rule_ruleArn
- The Amazon Resource Name (ARN) of the rule.
$sel:isDefault:Rule'
, rule_isDefault
- Indicates whether this is the default rule.
rule_actions :: Lens' Rule (Maybe [Action]) Source #
The actions. Each rule must include exactly one of the following types
of actions: forward
, redirect
, or fixed-response
, and it must be
the last action to be performed.
rule_conditions :: Lens' Rule (Maybe [RuleCondition]) Source #
The conditions. Each rule can include zero or one of the following
conditions: http-request-method
, host-header
, path-pattern
, and
source-ip
, and zero or more of the following conditions: http-header
and query-string
.
RuleCondition
data RuleCondition Source #
Information about a condition for a rule.
Each rule can optionally include up to one of each of the following
conditions: http-request-method
, host-header
, path-pattern
, and
source-ip
. Each rule can also optionally include one or more of each
of the following conditions: http-header
and query-string
.
See: newRuleCondition
smart constructor.
RuleCondition' | |
|
Instances
newRuleCondition :: RuleCondition Source #
Create a value of RuleCondition
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:field:RuleCondition'
, ruleCondition_field
- The field in the HTTP request. The following are the possible values:
http-header
http-request-method
host-header
path-pattern
query-string
source-ip
$sel:httpHeaderConfig:RuleCondition'
, ruleCondition_httpHeaderConfig
- Information for an HTTP header condition. Specify only when Field
is
http-header
.
$sel:hostHeaderConfig:RuleCondition'
, ruleCondition_hostHeaderConfig
- Information for a host header condition. Specify only when Field
is
host-header
.
$sel:values:RuleCondition'
, ruleCondition_values
- The condition value. Specify only when Field
is host-header
or
path-pattern
. Alternatively, to specify multiple host names or
multiple path patterns, use HostHeaderConfig
or PathPatternConfig
.
If Field
is host-header
and you are not using HostHeaderConfig
,
you can specify a single host name (for example, my.example.com) in
Values
. A host name is case insensitive, can be up to 128 characters
in length, and can contain any of the following characters.
- A-Z, a-z, 0-9
- - .
- * (matches 0 or more characters)
- ? (matches exactly 1 character)
If Field
is path-pattern
and you are not using PathPatternConfig
,
you can specify a single path pattern (for example, /img/*) in
Values
. A path pattern is case-sensitive, can be up to 128 characters
in length, and can contain any of the following characters.
- A-Z, a-z, 0-9
- _ - . $ / ~ " ' @ : +
- & (using &)
- * (matches 0 or more characters)
- ? (matches exactly 1 character)
$sel:sourceIpConfig:RuleCondition'
, ruleCondition_sourceIpConfig
- Information for a source IP condition. Specify only when Field
is
source-ip
.
$sel:httpRequestMethodConfig:RuleCondition'
, ruleCondition_httpRequestMethodConfig
- Information for an HTTP method condition. Specify only when Field
is
http-request-method
.
$sel:pathPatternConfig:RuleCondition'
, ruleCondition_pathPatternConfig
- Information for a path pattern condition. Specify only when Field
is
path-pattern
.
$sel:queryStringConfig:RuleCondition'
, ruleCondition_queryStringConfig
- Information for a query string condition. Specify only when Field
is
query-string
.
ruleCondition_field :: Lens' RuleCondition (Maybe Text) Source #
The field in the HTTP request. The following are the possible values:
http-header
http-request-method
host-header
path-pattern
query-string
source-ip
ruleCondition_httpHeaderConfig :: Lens' RuleCondition (Maybe HttpHeaderConditionConfig) Source #
Information for an HTTP header condition. Specify only when Field
is
http-header
.
ruleCondition_hostHeaderConfig :: Lens' RuleCondition (Maybe HostHeaderConditionConfig) Source #
Information for a host header condition. Specify only when Field
is
host-header
.
ruleCondition_values :: Lens' RuleCondition (Maybe [Text]) Source #
The condition value. Specify only when Field
is host-header
or
path-pattern
. Alternatively, to specify multiple host names or
multiple path patterns, use HostHeaderConfig
or PathPatternConfig
.
If Field
is host-header
and you are not using HostHeaderConfig
,
you can specify a single host name (for example, my.example.com) in
Values
. A host name is case insensitive, can be up to 128 characters
in length, and can contain any of the following characters.
- A-Z, a-z, 0-9
- - .
- * (matches 0 or more characters)
- ? (matches exactly 1 character)
If Field
is path-pattern
and you are not using PathPatternConfig
,
you can specify a single path pattern (for example, /img/*) in
Values
. A path pattern is case-sensitive, can be up to 128 characters
in length, and can contain any of the following characters.
- A-Z, a-z, 0-9
- _ - . $ / ~ " ' @ : +
- & (using &)
- * (matches 0 or more characters)
- ? (matches exactly 1 character)
ruleCondition_sourceIpConfig :: Lens' RuleCondition (Maybe SourceIpConditionConfig) Source #
Information for a source IP condition. Specify only when Field
is
source-ip
.
ruleCondition_httpRequestMethodConfig :: Lens' RuleCondition (Maybe HttpRequestMethodConditionConfig) Source #
Information for an HTTP method condition. Specify only when Field
is
http-request-method
.
ruleCondition_pathPatternConfig :: Lens' RuleCondition (Maybe PathPatternConditionConfig) Source #
Information for a path pattern condition. Specify only when Field
is
path-pattern
.
ruleCondition_queryStringConfig :: Lens' RuleCondition (Maybe QueryStringConditionConfig) Source #
Information for a query string condition. Specify only when Field
is
query-string
.
RulePriorityPair
data RulePriorityPair Source #
Information about the priorities for the rules for a listener.
See: newRulePriorityPair
smart constructor.
Instances
newRulePriorityPair :: RulePriorityPair Source #
Create a value of RulePriorityPair
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:priority:RulePriorityPair'
, rulePriorityPair_priority
- The rule priority.
$sel:ruleArn:RulePriorityPair'
, rulePriorityPair_ruleArn
- The Amazon Resource Name (ARN) of the rule.
rulePriorityPair_priority :: Lens' RulePriorityPair (Maybe Natural) Source #
The rule priority.
rulePriorityPair_ruleArn :: Lens' RulePriorityPair (Maybe Text) Source #
The Amazon Resource Name (ARN) of the rule.
SourceIpConditionConfig
data SourceIpConditionConfig Source #
Information about a source IP condition.
You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.
See: newSourceIpConditionConfig
smart constructor.
SourceIpConditionConfig' | |
|
Instances
newSourceIpConditionConfig :: SourceIpConditionConfig Source #
Create a value of SourceIpConditionConfig
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:values:SourceIpConditionConfig'
, sourceIpConditionConfig_values
- One or more source IP addresses, in CIDR format. You can use both IPv4
and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.
sourceIpConditionConfig_values :: Lens' SourceIpConditionConfig (Maybe [Text]) Source #
One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.
SslPolicy
Information about a policy used for SSL negotiation.
See: newSslPolicy
smart constructor.
Instances
Eq SslPolicy Source # | |
Read SslPolicy Source # | |
Show SslPolicy Source # | |
Generic SslPolicy Source # | |
NFData SslPolicy Source # | |
Defined in Amazonka.ELBV2.Types.SslPolicy | |
Hashable SslPolicy Source # | |
Defined in Amazonka.ELBV2.Types.SslPolicy | |
FromXML SslPolicy Source # | |
type Rep SslPolicy Source # | |
Defined in Amazonka.ELBV2.Types.SslPolicy type Rep SslPolicy = D1 ('MetaData "SslPolicy" "Amazonka.ELBV2.Types.SslPolicy" "libZSservicesZSamazonka-elbv2ZSamazonka-elbv2" 'False) (C1 ('MetaCons "SslPolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "supportedLoadBalancerTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "ciphers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Cipher]))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sslProtocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) |
newSslPolicy :: SslPolicy Source #
Create a value of SslPolicy
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:supportedLoadBalancerTypes:SslPolicy'
, sslPolicy_supportedLoadBalancerTypes
- The supported load balancers.
$sel:ciphers:SslPolicy'
, sslPolicy_ciphers
- The ciphers.
$sel:name:SslPolicy'
, sslPolicy_name
- The name of the policy.
$sel:sslProtocols:SslPolicy'
, sslPolicy_sslProtocols
- The protocols.
sslPolicy_supportedLoadBalancerTypes :: Lens' SslPolicy (Maybe [Text]) Source #
The supported load balancers.
SubnetMapping
data SubnetMapping Source #
Information about a subnet mapping.
See: newSubnetMapping
smart constructor.
SubnetMapping' | |
|
Instances
newSubnetMapping :: SubnetMapping Source #
Create a value of SubnetMapping
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:iPv6Address:SubnetMapping'
, subnetMapping_iPv6Address
- [Network Load Balancers] The IPv6 address.
$sel:allocationId:SubnetMapping'
, subnetMapping_allocationId
- [Network Load Balancers] The allocation ID of the Elastic IP address for
an internet-facing load balancer.
$sel:privateIPv4Address:SubnetMapping'
, subnetMapping_privateIPv4Address
- [Network Load Balancers] The private IPv4 address for an internal load
balancer.
$sel:subnetId:SubnetMapping'
, subnetMapping_subnetId
- The ID of the subnet.
subnetMapping_iPv6Address :: Lens' SubnetMapping (Maybe Text) Source #
- Network Load Balancers
- The IPv6 address.
subnetMapping_allocationId :: Lens' SubnetMapping (Maybe Text) Source #
- Network Load Balancers
- The allocation ID of the Elastic IP address for an internet-facing load balancer.
subnetMapping_privateIPv4Address :: Lens' SubnetMapping (Maybe Text) Source #
- Network Load Balancers
- The private IPv4 address for an internal load balancer.
subnetMapping_subnetId :: Lens' SubnetMapping (Maybe Text) Source #
The ID of the subnet.
Tag
Information about a tag.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.ELBV2.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.ELBV2.Types.Tag | |
ToQuery Tag Source # | |
Defined in Amazonka.ELBV2.Types.Tag toQuery :: Tag -> QueryString # | |
FromXML Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.ELBV2.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.ELBV2.Types.Tag" "libZSservicesZSamazonka-elbv2ZSamazonka-elbv2" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") '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:value:Tag'
, tag_value
- The value of the tag.
$sel:key:Tag'
, tag_key
- The key of the tag.
TagDescription
data TagDescription Source #
The tags associated with a resource.
See: newTagDescription
smart constructor.
Instances
newTagDescription :: TagDescription Source #
Create a value of TagDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagDescription'
, tagDescription_resourceArn
- The Amazon Resource Name (ARN) of the resource.
$sel:tags:TagDescription'
, tagDescription_tags
- Information about the tags.
tagDescription_resourceArn :: Lens' TagDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) of the resource.
tagDescription_tags :: Lens' TagDescription (Maybe (NonEmpty Tag)) Source #
Information about the tags.
TargetDescription
data TargetDescription Source #
Information about a target.
See: newTargetDescription
smart constructor.
TargetDescription' | |
|
Instances
Create a value of TargetDescription
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:availabilityZone:TargetDescription'
, targetDescription_availabilityZone
- An Availability Zone or all
. This determines whether the target
receives traffic from the load balancer nodes in the specified
Availability Zone or from all enabled Availability Zones for the load
balancer.
This parameter is not supported if the target type of the target group
is instance
or alb
.
If the target type is ip
and the IP address is in a subnet of the VPC
for the target group, the Availability Zone is automatically detected
and this parameter is optional. If the IP address is outside the VPC,
this parameter is required.
With an Application Load Balancer, if the target type is ip
and the IP
address is outside the VPC for the target group, the only supported
value is all
.
If the target type is lambda
, this parameter is optional and the only
supported value is all
.
$sel:port:TargetDescription'
, targetDescription_port
- The port on which the target is listening. If the target group protocol
is GENEVE, the supported port is 6081. If the target type is alb
, the
targeted Application Load Balancer must have at least one listener whose
port matches the target group port. Not used if the target is a Lambda
function.
$sel:id:TargetDescription'
, targetDescription_id
- The ID of the target. If the target type of the target group is
instance
, specify an instance ID. If the target type is ip
, specify
an IP address. If the target type is lambda
, specify the ARN of the
Lambda function. If the target type is alb
, specify the ARN of the
Application Load Balancer target.
targetDescription_availabilityZone :: Lens' TargetDescription (Maybe Text) Source #
An Availability Zone or all
. This determines whether the target
receives traffic from the load balancer nodes in the specified
Availability Zone or from all enabled Availability Zones for the load
balancer.
This parameter is not supported if the target type of the target group
is instance
or alb
.
If the target type is ip
and the IP address is in a subnet of the VPC
for the target group, the Availability Zone is automatically detected
and this parameter is optional. If the IP address is outside the VPC,
this parameter is required.
With an Application Load Balancer, if the target type is ip
and the IP
address is outside the VPC for the target group, the only supported
value is all
.
If the target type is lambda
, this parameter is optional and the only
supported value is all
.
targetDescription_port :: Lens' TargetDescription (Maybe Natural) Source #
The port on which the target is listening. If the target group protocol
is GENEVE, the supported port is 6081. If the target type is alb
, the
targeted Application Load Balancer must have at least one listener whose
port matches the target group port. Not used if the target is a Lambda
function.
targetDescription_id :: Lens' TargetDescription Text Source #
The ID of the target. If the target type of the target group is
instance
, specify an instance ID. If the target type is ip
, specify
an IP address. If the target type is lambda
, specify the ARN of the
Lambda function. If the target type is alb
, specify the ARN of the
Application Load Balancer target.
TargetGroup
data TargetGroup Source #
Information about a target group.
See: newTargetGroup
smart constructor.
TargetGroup' | |
|
Instances
newTargetGroup :: TargetGroup Source #
Create a value of TargetGroup
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:protocolVersion:TargetGroup'
, targetGroup_protocolVersion
- [HTTP/HTTPS protocol] The protocol version. The possible values are
GRPC
, HTTP1
, and HTTP2
.
$sel:matcher:TargetGroup'
, targetGroup_matcher
- The HTTP or gRPC codes to use when checking for a successful response
from a target.
$sel:healthCheckPath:TargetGroup'
, targetGroup_healthCheckPath
- The destination for health checks on the targets.
$sel:healthCheckEnabled:TargetGroup'
, targetGroup_healthCheckEnabled
- Indicates whether health checks are enabled.
$sel:unhealthyThresholdCount:TargetGroup'
, targetGroup_unhealthyThresholdCount
- The number of consecutive health check failures required before
considering the target unhealthy.
$sel:vpcId:TargetGroup'
, targetGroup_vpcId
- The ID of the VPC for the targets.
$sel:targetGroupArn:TargetGroup'
, targetGroup_targetGroupArn
- The Amazon Resource Name (ARN) of the target group.
$sel:protocol:TargetGroup'
, targetGroup_protocol
- The protocol to use for routing traffic to the targets.
$sel:healthCheckIntervalSeconds:TargetGroup'
, targetGroup_healthCheckIntervalSeconds
- The approximate amount of time, in seconds, between health checks of an
individual target.
$sel:targetType:TargetGroup'
, targetGroup_targetType
- The type of target that you must specify when registering targets with
this target group. The possible values are instance
(register targets
by instance ID), ip
(register targets by IP address), lambda
(register a single Lambda function as a target), or alb
(register a
single Application Load Balancer as a target).
$sel:healthyThresholdCount:TargetGroup'
, targetGroup_healthyThresholdCount
- The number of consecutive health checks successes required before
considering an unhealthy target healthy.
$sel:healthCheckProtocol:TargetGroup'
, targetGroup_healthCheckProtocol
- The protocol to use to connect with the target. The GENEVE, TLS, UDP,
and TCP_UDP protocols are not supported for health checks.
$sel:loadBalancerArns:TargetGroup'
, targetGroup_loadBalancerArns
- The Amazon Resource Names (ARN) of the load balancers that route traffic
to this target group.
$sel:ipAddressType:TargetGroup'
, targetGroup_ipAddressType
- The type of IP address used for this target group. The possible values
are ipv4
and ipv6
. This is an optional parameter. If not specified,
the IP address type defaults to ipv4
.
$sel:healthCheckTimeoutSeconds:TargetGroup'
, targetGroup_healthCheckTimeoutSeconds
- The amount of time, in seconds, during which no response means a failed
health check.
$sel:healthCheckPort:TargetGroup'
, targetGroup_healthCheckPort
- The port to use to connect with the target.
$sel:targetGroupName:TargetGroup'
, targetGroup_targetGroupName
- The name of the target group.
$sel:port:TargetGroup'
, targetGroup_port
- The port on which the targets are listening. Not used if the target is a
Lambda function.
targetGroup_protocolVersion :: Lens' TargetGroup (Maybe Text) Source #
- HTTP/HTTPS protocol
- The protocol version. The possible values are
GRPC
,HTTP1
, andHTTP2
.
targetGroup_matcher :: Lens' TargetGroup (Maybe Matcher) Source #
The HTTP or gRPC codes to use when checking for a successful response from a target.
targetGroup_healthCheckPath :: Lens' TargetGroup (Maybe Text) Source #
The destination for health checks on the targets.
targetGroup_healthCheckEnabled :: Lens' TargetGroup (Maybe Bool) Source #
Indicates whether health checks are enabled.
targetGroup_unhealthyThresholdCount :: Lens' TargetGroup (Maybe Natural) Source #
The number of consecutive health check failures required before considering the target unhealthy.
targetGroup_vpcId :: Lens' TargetGroup (Maybe Text) Source #
The ID of the VPC for the targets.
targetGroup_targetGroupArn :: Lens' TargetGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of the target group.
targetGroup_protocol :: Lens' TargetGroup (Maybe ProtocolEnum) Source #
The protocol to use for routing traffic to the targets.
targetGroup_healthCheckIntervalSeconds :: Lens' TargetGroup (Maybe Natural) Source #
The approximate amount of time, in seconds, between health checks of an individual target.
targetGroup_targetType :: Lens' TargetGroup (Maybe TargetTypeEnum) Source #
The type of target that you must specify when registering targets with
this target group. The possible values are instance
(register targets
by instance ID), ip
(register targets by IP address), lambda
(register a single Lambda function as a target), or alb
(register a
single Application Load Balancer as a target).
targetGroup_healthyThresholdCount :: Lens' TargetGroup (Maybe Natural) Source #
The number of consecutive health checks successes required before considering an unhealthy target healthy.
targetGroup_healthCheckProtocol :: Lens' TargetGroup (Maybe ProtocolEnum) Source #
The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
targetGroup_loadBalancerArns :: Lens' TargetGroup (Maybe [Text]) Source #
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
targetGroup_ipAddressType :: Lens' TargetGroup (Maybe TargetGroupIpAddressTypeEnum) Source #
The type of IP address used for this target group. The possible values
are ipv4
and ipv6
. This is an optional parameter. If not specified,
the IP address type defaults to ipv4
.
targetGroup_healthCheckTimeoutSeconds :: Lens' TargetGroup (Maybe Natural) Source #
The amount of time, in seconds, during which no response means a failed health check.
targetGroup_healthCheckPort :: Lens' TargetGroup (Maybe Text) Source #
The port to use to connect with the target.
targetGroup_targetGroupName :: Lens' TargetGroup (Maybe Text) Source #
The name of the target group.
targetGroup_port :: Lens' TargetGroup (Maybe Natural) Source #
The port on which the targets are listening. Not used if the target is a Lambda function.
TargetGroupAttribute
data TargetGroupAttribute Source #
Information about a target group attribute.
See: newTargetGroupAttribute
smart constructor.
TargetGroupAttribute' | |
|
Instances
newTargetGroupAttribute :: TargetGroupAttribute Source #
Create a value of TargetGroupAttribute
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:value:TargetGroupAttribute'
, targetGroupAttribute_value
- The value of the attribute.
$sel:key:TargetGroupAttribute'
, targetGroupAttribute_key
- The name of the attribute.
The following attribute is supported by all load balancers:
deregistration_delay.timeout_seconds
- The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target fromdraining
tounused
. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
stickiness.enabled
- Indicates whether sticky sessions are enabled. The value istrue
orfalse
. The default isfalse
.stickiness.type
- The type of sticky sessions. The possible values arelb_cookie
andapp_cookie
for Application Load Balancers orsource_ip
for Network Load Balancers.
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
load_balancing.algorithm.type
- The load balancing algorithm determines how the load balancer selects targets when routing requests. The value isround_robin
orleast_outstanding_requests
. The default isround_robin
.slow_start.duration_seconds
- The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).stickiness.app_cookie.cookie_name
- Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed:AWSALB
,AWSALBAPP
, andAWSALBTG
; they're reserved for use by the load balancer.stickiness.app_cookie.duration_seconds
- The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).stickiness.lb_cookie.duration_seconds
- The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
lambda.multi_value_headers.enabled
- Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value istrue
orfalse
. The default isfalse
. If the value isfalse
and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.
The following attributes are supported only by Network Load Balancers:
deregistration_delay.connection_termination.enabled
- Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value istrue
orfalse
. The default isfalse
.preserve_client_ip.enabled
- Indicates whether client IP preservation is enabled. The value istrue
orfalse
. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups.proxy_protocol_v2.enabled
- Indicates whether Proxy Protocol version 2 is enabled. The value istrue
orfalse
. The default isfalse
.
targetGroupAttribute_value :: Lens' TargetGroupAttribute (Maybe Text) Source #
The value of the attribute.
targetGroupAttribute_key :: Lens' TargetGroupAttribute (Maybe Text) Source #
The name of the attribute.
The following attribute is supported by all load balancers:
deregistration_delay.timeout_seconds
- The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target fromdraining
tounused
. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
stickiness.enabled
- Indicates whether sticky sessions are enabled. The value istrue
orfalse
. The default isfalse
.stickiness.type
- The type of sticky sessions. The possible values arelb_cookie
andapp_cookie
for Application Load Balancers orsource_ip
for Network Load Balancers.
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
load_balancing.algorithm.type
- The load balancing algorithm determines how the load balancer selects targets when routing requests. The value isround_robin
orleast_outstanding_requests
. The default isround_robin
.slow_start.duration_seconds
- The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).stickiness.app_cookie.cookie_name
- Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed:AWSALB
,AWSALBAPP
, andAWSALBTG
; they're reserved for use by the load balancer.stickiness.app_cookie.duration_seconds
- The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).stickiness.lb_cookie.duration_seconds
- The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
lambda.multi_value_headers.enabled
- Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value istrue
orfalse
. The default isfalse
. If the value isfalse
and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.
The following attributes are supported only by Network Load Balancers:
deregistration_delay.connection_termination.enabled
- Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value istrue
orfalse
. The default isfalse
.preserve_client_ip.enabled
- Indicates whether client IP preservation is enabled. The value istrue
orfalse
. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups.proxy_protocol_v2.enabled
- Indicates whether Proxy Protocol version 2 is enabled. The value istrue
orfalse
. The default isfalse
.
TargetGroupStickinessConfig
data TargetGroupStickinessConfig Source #
Information about the target group stickiness for a rule.
See: newTargetGroupStickinessConfig
smart constructor.
Instances
newTargetGroupStickinessConfig :: TargetGroupStickinessConfig Source #
Create a value of TargetGroupStickinessConfig
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:enabled:TargetGroupStickinessConfig'
, targetGroupStickinessConfig_enabled
- Indicates whether target group stickiness is enabled.
$sel:durationSeconds:TargetGroupStickinessConfig'
, targetGroupStickinessConfig_durationSeconds
- The time period, in seconds, during which requests from a client should
be routed to the same target group. The range is 1-604800 seconds (7
days).
targetGroupStickinessConfig_enabled :: Lens' TargetGroupStickinessConfig (Maybe Bool) Source #
Indicates whether target group stickiness is enabled.
targetGroupStickinessConfig_durationSeconds :: Lens' TargetGroupStickinessConfig (Maybe Int) Source #
The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).
TargetGroupTuple
data TargetGroupTuple Source #
Information about how traffic will be distributed between multiple target groups in a forward rule.
See: newTargetGroupTuple
smart constructor.
Instances
newTargetGroupTuple :: TargetGroupTuple Source #
Create a value of TargetGroupTuple
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:weight:TargetGroupTuple'
, targetGroupTuple_weight
- The weight. The range is 0 to 999.
$sel:targetGroupArn:TargetGroupTuple'
, targetGroupTuple_targetGroupArn
- The Amazon Resource Name (ARN) of the target group.
targetGroupTuple_weight :: Lens' TargetGroupTuple (Maybe Int) Source #
The weight. The range is 0 to 999.
targetGroupTuple_targetGroupArn :: Lens' TargetGroupTuple (Maybe Text) Source #
The Amazon Resource Name (ARN) of the target group.
TargetHealth
data TargetHealth Source #
Information about the current health of a target.
See: newTargetHealth
smart constructor.
TargetHealth' | |
|
Instances
newTargetHealth :: TargetHealth Source #
Create a value of TargetHealth
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:state:TargetHealth'
, targetHealth_state
- The state of the target.
$sel:reason:TargetHealth'
, targetHealth_reason
- The reason code.
If the target state is healthy
, a reason code is not provided.
If the target state is initial
, the reason code can be one of the
following values:
Elb.RegistrationInProgress
- The target is in the process of being registered with the load balancer.Elb.InitialHealthChecking
- The load balancer is still sending the target the minimum number of health checks required to determine its health status.
If the target state is unhealthy
, the reason code can be one of the
following values:
Target.ResponseCodeMismatch
- The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.Target.Timeout
- The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.Target.FailedHealthChecks
- The load balancer received an error while establishing a connection to the target or the target response was malformed.Elb.InternalError
- The health checks failed due to an internal error. Applies only to Application Load Balancers.
If the target state is unused
, the reason code can be one of the
following values:
Target.NotRegistered
- The target is not registered with the target group.Target.NotInUse
- The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.Target.InvalidState
- The target is in the stopped or terminated state.Target.IpUnusable
- The target IP address is reserved for use by a load balancer.
If the target state is draining
, the reason code can be the following
value:
Target.DeregistrationInProgress
- The target is in the process of being deregistered and the deregistration delay period has not expired.
If the target state is unavailable
, the reason code can be the
following value:
Target.HealthCheckDisabled
- Health checks are disabled for the target group. Applies only to Application Load Balancers.Elb.InternalError
- Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
$sel:description:TargetHealth'
, targetHealth_description
- A description of the target health that provides additional details. If
the state is healthy
, a description is not provided.
targetHealth_state :: Lens' TargetHealth (Maybe TargetHealthStateEnum) Source #
The state of the target.
targetHealth_reason :: Lens' TargetHealth (Maybe TargetHealthReasonEnum) Source #
The reason code.
If the target state is healthy
, a reason code is not provided.
If the target state is initial
, the reason code can be one of the
following values:
Elb.RegistrationInProgress
- The target is in the process of being registered with the load balancer.Elb.InitialHealthChecking
- The load balancer is still sending the target the minimum number of health checks required to determine its health status.
If the target state is unhealthy
, the reason code can be one of the
following values:
Target.ResponseCodeMismatch
- The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.Target.Timeout
- The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.Target.FailedHealthChecks
- The load balancer received an error while establishing a connection to the target or the target response was malformed.Elb.InternalError
- The health checks failed due to an internal error. Applies only to Application Load Balancers.
If the target state is unused
, the reason code can be one of the
following values:
Target.NotRegistered
- The target is not registered with the target group.Target.NotInUse
- The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.Target.InvalidState
- The target is in the stopped or terminated state.Target.IpUnusable
- The target IP address is reserved for use by a load balancer.
If the target state is draining
, the reason code can be the following
value:
Target.DeregistrationInProgress
- The target is in the process of being deregistered and the deregistration delay period has not expired.
If the target state is unavailable
, the reason code can be the
following value:
Target.HealthCheckDisabled
- Health checks are disabled for the target group. Applies only to Application Load Balancers.Elb.InternalError
- Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
targetHealth_description :: Lens' TargetHealth (Maybe Text) Source #
A description of the target health that provides additional details. If
the state is healthy
, a description is not provided.
TargetHealthDescription
data TargetHealthDescription Source #
Information about the health of a target.
See: newTargetHealthDescription
smart constructor.
TargetHealthDescription' | |
|
Instances
newTargetHealthDescription :: TargetHealthDescription Source #
Create a value of TargetHealthDescription
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:targetHealth:TargetHealthDescription'
, targetHealthDescription_targetHealth
- The health information for the target.
$sel:healthCheckPort:TargetHealthDescription'
, targetHealthDescription_healthCheckPort
- The port to use to connect with the target.
$sel:target:TargetHealthDescription'
, targetHealthDescription_target
- The description of the target.
targetHealthDescription_targetHealth :: Lens' TargetHealthDescription (Maybe TargetHealth) Source #
The health information for the target.
targetHealthDescription_healthCheckPort :: Lens' TargetHealthDescription (Maybe Text) Source #
The port to use to connect with the target.
targetHealthDescription_target :: Lens' TargetHealthDescription (Maybe TargetDescription) Source #
The description of the target.