amazonka-waf-2.0: gen/Amazonka/WAF/TagResource.hs
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Amazonka.WAF.TagResource
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- This is __AWS WAF Classic__ documentation. For more information, see
-- <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html AWS WAF Classic>
-- in the developer guide.
--
-- __For the latest version of AWS WAF__, use the AWS WAFV2 API and see the
-- <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html AWS WAF Developer Guide>.
-- With the latest version, AWS WAF has a single set of endpoints for
-- regional and global use.
--
-- Associates tags with the specified AWS resource. Tags are key:value
-- pairs that you can use to categorize and manage your resources, for
-- purposes like billing. For example, you might set the tag key to
-- \"customer\" and the value to the customer name or ID. You can specify
-- one or more tags to add to each AWS resource, up to 50 tags for a
-- resource.
--
-- Tagging is only available through the API, SDKs, and CLI. You can\'t
-- manage or view tags through the AWS WAF Classic console. You can use
-- this action to tag the AWS resources that you manage through AWS WAF
-- Classic: web ACLs, rule groups, and rules.
module Amazonka.WAF.TagResource
( -- * Creating a Request
TagResource (..),
newTagResource,
-- * Request Lenses
tagResource_resourceARN,
tagResource_tags,
-- * Destructuring the Response
TagResourceResponse (..),
newTagResourceResponse,
-- * Response Lenses
tagResourceResponse_httpStatus,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.WAF.Types
-- | /See:/ 'newTagResource' smart constructor.
data TagResource = TagResource'
{ resourceARN :: Prelude.Text,
tags :: Prelude.NonEmpty Tag
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'TagResource' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'resourceARN', 'tagResource_resourceARN' -
--
-- 'tags', 'tagResource_tags' -
newTagResource ::
-- | 'resourceARN'
Prelude.Text ->
-- | 'tags'
Prelude.NonEmpty Tag ->
TagResource
newTagResource pResourceARN_ pTags_ =
TagResource'
{ resourceARN = pResourceARN_,
tags = Lens.coerced Lens.# pTags_
}
tagResource_resourceARN :: Lens.Lens' TagResource Prelude.Text
tagResource_resourceARN = Lens.lens (\TagResource' {resourceARN} -> resourceARN) (\s@TagResource' {} a -> s {resourceARN = a} :: TagResource)
tagResource_tags :: Lens.Lens' TagResource (Prelude.NonEmpty Tag)
tagResource_tags = Lens.lens (\TagResource' {tags} -> tags) (\s@TagResource' {} a -> s {tags = a} :: TagResource) Prelude.. Lens.coerced
instance Core.AWSRequest TagResource where
type AWSResponse TagResource = TagResourceResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveEmpty
( \s h x ->
TagResourceResponse'
Prelude.<$> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable TagResource where
hashWithSalt _salt TagResource' {..} =
_salt
`Prelude.hashWithSalt` resourceARN
`Prelude.hashWithSalt` tags
instance Prelude.NFData TagResource where
rnf TagResource' {..} =
Prelude.rnf resourceARN
`Prelude.seq` Prelude.rnf tags
instance Data.ToHeaders TagResource where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "X-Amz-Target"
Data.=# ( "AWSWAF_20150824.TagResource" ::
Prelude.ByteString
),
"Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON TagResource where
toJSON TagResource' {..} =
Data.object
( Prelude.catMaybes
[ Prelude.Just ("ResourceARN" Data..= resourceARN),
Prelude.Just ("Tags" Data..= tags)
]
)
instance Data.ToPath TagResource where
toPath = Prelude.const "/"
instance Data.ToQuery TagResource where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newTagResourceResponse' smart constructor.
data TagResourceResponse = TagResourceResponse'
{ -- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'TagResourceResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'httpStatus', 'tagResourceResponse_httpStatus' - The response's http status code.
newTagResourceResponse ::
-- | 'httpStatus'
Prelude.Int ->
TagResourceResponse
newTagResourceResponse pHttpStatus_ =
TagResourceResponse' {httpStatus = pHttpStatus_}
-- | The response's http status code.
tagResourceResponse_httpStatus :: Lens.Lens' TagResourceResponse Prelude.Int
tagResourceResponse_httpStatus = Lens.lens (\TagResourceResponse' {httpStatus} -> httpStatus) (\s@TagResourceResponse' {} a -> s {httpStatus = a} :: TagResourceResponse)
instance Prelude.NFData TagResourceResponse where
rnf TagResourceResponse' {..} = Prelude.rnf httpStatus