Amazonka.Shield.CreateProtection

Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.

You can add protection to only a single resource with each CreateProtection request. You can add protection to multiple resources at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information see Getting Started with Shield Advanced and Adding Shield Advanced protection to Amazon Web Services resources.

Creating a Request

data CreateProtection

See: newCreateProtection smart constructor.

Constructors

CreateProtection'

Fields

• tags :: Maybe [Tag]

  One or more tag key-value pairs for the Protection object that is created.

• name :: Text

  Friendly name for the Protection you are creating.

• resourceArn :: Text

  The ARN (Amazon Resource Name) of the resource to be protected.

  The ARN should be in one of the following formats:

  • For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
  • For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
  • For an Amazon CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id
  • For an Global Accelerator standard accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
  • For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
  • For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id

Instances

ToJSON CreateProtection

Defined in Amazonka.Shield.CreateProtection

Methods

toJSON :: CreateProtection -> Value

toEncoding :: CreateProtection -> Encoding

toJSONList :: [CreateProtection] -> Value

toEncodingList :: [CreateProtection] -> Encoding

ToHeaders CreateProtection

Defined in Amazonka.Shield.CreateProtection

Methods

toHeaders :: CreateProtection -> [Header]

ToPath CreateProtection

Defined in Amazonka.Shield.CreateProtection

Methods

toPath :: CreateProtection -> ByteString

ToQuery CreateProtection

Defined in Amazonka.Shield.CreateProtection

Methods

toQuery :: CreateProtection -> QueryString

AWSRequest CreateProtection

Defined in Amazonka.Shield.CreateProtection

Associated Types

type AWSResponse CreateProtection

Methods

request :: (Service -> Service) -> CreateProtection -> Request CreateProtection

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

Generic CreateProtection

Defined in Amazonka.Shield.CreateProtection

Associated Types

type Rep CreateProtection :: Type -> Type

Methods

from :: CreateProtection -> Rep CreateProtection x

to :: Rep CreateProtection x -> CreateProtection

Read CreateProtection

Defined in Amazonka.Shield.CreateProtection

Methods

readsPrec :: Int -> ReadS CreateProtection

readList :: ReadS [CreateProtection]

readPrec :: ReadPrec CreateProtection

readListPrec :: ReadPrec [CreateProtection]

Show CreateProtection

Defined in Amazonka.Shield.CreateProtection

Methods

showsPrec :: Int -> CreateProtection -> ShowS

show :: CreateProtection -> String

showList :: [CreateProtection] -> ShowS

NFData CreateProtection

Defined in Amazonka.Shield.CreateProtection

Methods

rnf :: CreateProtection -> ()

Eq CreateProtection

Defined in Amazonka.Shield.CreateProtection

Methods

(==) :: CreateProtection -> CreateProtection -> Bool

(/=) :: CreateProtection -> CreateProtection -> Bool

Hashable CreateProtection

Defined in Amazonka.Shield.CreateProtection

Methods

hashWithSalt :: Int -> CreateProtection -> Int

hash :: CreateProtection -> Int

type AWSResponse CreateProtection

Defined in Amazonka.Shield.CreateProtection

type AWSResponse CreateProtection = CreateProtectionResponse

type Rep CreateProtection

Defined in Amazonka.Shield.CreateProtection

type Rep CreateProtection = D1 ('MetaData "CreateProtection" "Amazonka.Shield.CreateProtection" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "CreateProtection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateProtection

Arguments

:: Text

CreateProtection

-> Text

CreateProtection

-> CreateProtection

Create a value of CreateProtection with all optional fields omitted.

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

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

$sel:tags:CreateProtection', createProtection_tags - One or more tag key-value pairs for the Protection object that is created.

CreateProtection, createProtection_name - Friendly name for the Protection you are creating.

CreateProtection, createProtection_resourceArn - The ARN (Amazon Resource Name) of the resource to be protected.

The ARN should be in one of the following formats:

• For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
• For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
• For an Amazon CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id
• For an Global Accelerator standard accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
• For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
• For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id

Request Lenses

createProtection_tags :: Lens' CreateProtection (Maybe [Tag])

One or more tag key-value pairs for the Protection object that is created.

createProtection_name :: Lens' CreateProtection Text

Friendly name for the Protection you are creating.

createProtection_resourceArn :: Lens' CreateProtection Text

The ARN (Amazon Resource Name) of the resource to be protected.

The ARN should be in one of the following formats:

• For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
• For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
• For an Amazon CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id
• For an Global Accelerator standard accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
• For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
• For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id

Destructuring the Response

data CreateProtectionResponse

See: newCreateProtectionResponse smart constructor.

Constructors

CreateProtectionResponse'

Fields

• protectionId :: Maybe Text

  The unique identifier (ID) for the Protection object that is created.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateProtectionResponse

Defined in Amazonka.Shield.CreateProtection

Associated Types

type Rep CreateProtectionResponse :: Type -> Type

Methods

from :: CreateProtectionResponse -> Rep CreateProtectionResponse x

to :: Rep CreateProtectionResponse x -> CreateProtectionResponse

Read CreateProtectionResponse

Defined in Amazonka.Shield.CreateProtection

Methods

readsPrec :: Int -> ReadS CreateProtectionResponse

readList :: ReadS [CreateProtectionResponse]

readPrec :: ReadPrec CreateProtectionResponse

readListPrec :: ReadPrec [CreateProtectionResponse]

Show CreateProtectionResponse

Defined in Amazonka.Shield.CreateProtection

Methods

showsPrec :: Int -> CreateProtectionResponse -> ShowS

show :: CreateProtectionResponse -> String

showList :: [CreateProtectionResponse] -> ShowS

NFData CreateProtectionResponse

Defined in Amazonka.Shield.CreateProtection

Methods

rnf :: CreateProtectionResponse -> ()

Eq CreateProtectionResponse

Defined in Amazonka.Shield.CreateProtection

Methods

(==) :: CreateProtectionResponse -> CreateProtectionResponse -> Bool

(/=) :: CreateProtectionResponse -> CreateProtectionResponse -> Bool

type Rep CreateProtectionResponse

Defined in Amazonka.Shield.CreateProtection

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

newCreateProtectionResponse

Arguments

:: Int

$sel:httpStatus:CreateProtectionResponse'

-> CreateProtectionResponse

Create a value of CreateProtectionResponse 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:CreateProtectionResponse', createProtectionResponse_protectionId - The unique identifier (ID) for the Protection object that is created.

$sel:httpStatus:CreateProtectionResponse', createProtectionResponse_httpStatus - The response's http status code.

Response Lenses

createProtectionResponse_protectionId :: Lens' CreateProtectionResponse (Maybe Text)

The unique identifier (ID) for the Protection object that is created.

createProtectionResponse_httpStatus :: Lens' CreateProtectionResponse Int

The response's http status code.