amazonka-shield-2.0: Amazon Shield SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Shield.AssociateHealthCheck

Description

Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.

You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.

Synopsis

Creating a Request

data AssociateHealthCheck Source #

See: newAssociateHealthCheck smart constructor.

Constructors

AssociateHealthCheck' 

Fields

  • protectionId :: Text

    The unique identifier (ID) for the Protection object to add the health check association to.

  • healthCheckArn :: Text

    The Amazon Resource Name (ARN) of the health check to associate with the protection.

Instances

Instances details
ToJSON AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

toJSON :: AssociateHealthCheck -> Value #

toEncoding :: AssociateHealthCheck -> Encoding #

toJSONList :: [AssociateHealthCheck] -> Value #

toEncodingList :: [AssociateHealthCheck] -> Encoding #

ToHeaders AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

toHeaders :: AssociateHealthCheck -> [Header] #

ToPath AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

toPath :: AssociateHealthCheck -> ByteString #

ToQuery AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

toQuery :: AssociateHealthCheck -> QueryString #

AWSRequest AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Associated Types

type AWSResponse AssociateHealthCheck #

Methods

request :: (Service -> Service) -> AssociateHealthCheck -> Request AssociateHealthCheck #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateHealthCheck -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateHealthCheck))) #

Generic AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Associated Types

type Rep AssociateHealthCheck :: Type -> Type #

Methods

from :: AssociateHealthCheck -> Rep AssociateHealthCheck x #

to :: Rep AssociateHealthCheck x -> AssociateHealthCheck #

Read AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

readsPrec :: Int -> ReadS AssociateHealthCheck #

readList :: ReadS [AssociateHealthCheck] #

readPrec :: ReadPrec AssociateHealthCheck #

readListPrec :: ReadPrec [AssociateHealthCheck] #

Show AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

showsPrec :: Int -> AssociateHealthCheck -> ShowS #

show :: AssociateHealthCheck -> String #

showList :: [AssociateHealthCheck] -> ShowS #

NFData AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

rnf :: AssociateHealthCheck -> () #

Eq AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

(==) :: AssociateHealthCheck -> AssociateHealthCheck -> Bool #

(/=) :: AssociateHealthCheck -> AssociateHealthCheck -> Bool #

Hashable AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

hashWithSalt :: Int -> AssociateHealthCheck -> Int #

hash :: AssociateHealthCheck -> Int #

type AWSResponse AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

type AWSResponse AssociateHealthCheck = AssociateHealthCheckResponse
type Rep AssociateHealthCheck Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

type Rep AssociateHealthCheck = D1 ('MetaData "AssociateHealthCheck" "Amazonka.Shield.AssociateHealthCheck" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "AssociateHealthCheck'" 'PrefixI 'True) (S1 ('MetaSel ('Just "protectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "healthCheckArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAssociateHealthCheck Source #

Arguments

:: Text

$sel:protectionId:AssociateHealthCheck'

-> Text

$sel:healthCheckArn:AssociateHealthCheck'

-> AssociateHealthCheck 

Create a value of AssociateHealthCheck 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:protectionId:AssociateHealthCheck', associateHealthCheck_protectionId - The unique identifier (ID) for the Protection object to add the health check association to.

$sel:healthCheckArn:AssociateHealthCheck', associateHealthCheck_healthCheckArn - The Amazon Resource Name (ARN) of the health check to associate with the protection.

Request Lenses

associateHealthCheck_protectionId :: Lens' AssociateHealthCheck Text Source #

The unique identifier (ID) for the Protection object to add the health check association to.

associateHealthCheck_healthCheckArn :: Lens' AssociateHealthCheck Text Source #

The Amazon Resource Name (ARN) of the health check to associate with the protection.

Destructuring the Response

data AssociateHealthCheckResponse Source #

See: newAssociateHealthCheckResponse smart constructor.

Constructors

AssociateHealthCheckResponse' 

Fields

Instances

Instances details
Generic AssociateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Associated Types

type Rep AssociateHealthCheckResponse :: Type -> Type #

Methods

from :: AssociateHealthCheckResponse -> Rep AssociateHealthCheckResponse x #

to :: Rep AssociateHealthCheckResponse x -> AssociateHealthCheckResponse #

Read AssociateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

readsPrec :: Int -> ReadS AssociateHealthCheckResponse #

readList :: ReadS [AssociateHealthCheckResponse] #

readPrec :: ReadPrec AssociateHealthCheckResponse #

readListPrec :: ReadPrec [AssociateHealthCheckResponse] #

Show AssociateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

showsPrec :: Int -> AssociateHealthCheckResponse -> ShowS #

show :: AssociateHealthCheckResponse -> String #

showList :: [AssociateHealthCheckResponse] -> ShowS #

NFData AssociateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

rnf :: AssociateHealthCheckResponse -> () #

Eq AssociateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

Methods

(==) :: AssociateHealthCheckResponse -> AssociateHealthCheckResponse -> Bool #

(/=) :: AssociateHealthCheckResponse -> AssociateHealthCheckResponse -> Bool #

type Rep AssociateHealthCheckResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateHealthCheck

type Rep AssociateHealthCheckResponse = D1 ('MetaData "AssociateHealthCheckResponse" "Amazonka.Shield.AssociateHealthCheck" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "AssociateHealthCheckResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAssociateHealthCheckResponse Source #

Arguments

:: Int

$sel:httpStatus:AssociateHealthCheckResponse'

-> AssociateHealthCheckResponse 

Create a value of AssociateHealthCheckResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:AssociateHealthCheckResponse', associateHealthCheckResponse_httpStatus - The response's http status code.

Response Lenses

associateHealthCheckResponse_httpStatus :: Lens' AssociateHealthCheckResponse Int Source #

The response's http status code.