| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.WAFV2.PutManagedRuleSetVersions
Description
Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled
rollout of your versioned managed rule group offerings for your
customers. The APIs are ListManagedRuleSets, GetManagedRuleSet,
PutManagedRuleSetVersions, and
UpdateManagedRuleSetVersionExpiryDate.
Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.
To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.
Synopsis
- data PutManagedRuleSetVersions = PutManagedRuleSetVersions' {}
- newPutManagedRuleSetVersions :: Text -> Scope -> Text -> Text -> PutManagedRuleSetVersions
- putManagedRuleSetVersions_recommendedVersion :: Lens' PutManagedRuleSetVersions (Maybe Text)
- putManagedRuleSetVersions_versionsToPublish :: Lens' PutManagedRuleSetVersions (Maybe (HashMap Text VersionToPublish))
- putManagedRuleSetVersions_name :: Lens' PutManagedRuleSetVersions Text
- putManagedRuleSetVersions_scope :: Lens' PutManagedRuleSetVersions Scope
- putManagedRuleSetVersions_id :: Lens' PutManagedRuleSetVersions Text
- putManagedRuleSetVersions_lockToken :: Lens' PutManagedRuleSetVersions Text
- data PutManagedRuleSetVersionsResponse = PutManagedRuleSetVersionsResponse' {
- nextLockToken :: Maybe Text
- httpStatus :: Int
- newPutManagedRuleSetVersionsResponse :: Int -> PutManagedRuleSetVersionsResponse
- putManagedRuleSetVersionsResponse_nextLockToken :: Lens' PutManagedRuleSetVersionsResponse (Maybe Text)
- putManagedRuleSetVersionsResponse_httpStatus :: Lens' PutManagedRuleSetVersionsResponse Int
Creating a Request
data PutManagedRuleSetVersions Source #
See: newPutManagedRuleSetVersions smart constructor.
Constructors
| PutManagedRuleSetVersions' | |
Fields
| |
Instances
newPutManagedRuleSetVersions Source #
Arguments
| :: Text | |
| -> Scope | |
| -> Text | |
| -> Text | |
| -> PutManagedRuleSetVersions |
Create a value of PutManagedRuleSetVersions 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:
PutManagedRuleSetVersions, putManagedRuleSetVersions_recommendedVersion - The version of the named managed rule group that you'd like your
customers to choose, from among your version offerings.
$sel:versionsToPublish:PutManagedRuleSetVersions', putManagedRuleSetVersions_versionsToPublish - The versions of the named managed rule group that you want to offer to
your customers.
PutManagedRuleSetVersions, putManagedRuleSetVersions_name - The name of the managed rule set. You use this, along with the rule set
ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
PutManagedRuleSetVersions, putManagedRuleSetVersions_scope - Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load
Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API,
or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1. - API and SDKs - For all calls, use the Region endpoint us-east-1.
PutManagedRuleSetVersions, putManagedRuleSetVersions_id - A unique identifier for the managed rule set. The ID is returned in the
responses to commands like list. You provide it to operations like
get and update.
PutManagedRuleSetVersions, putManagedRuleSetVersions_lockToken - A token used for optimistic locking. WAF returns a token to your get
and list requests, to mark the state of the entity at the time of the
request. To make changes to the entity associated with the token, you
provide the token to operations like update and delete. WAF uses the
token to ensure that no changes have been made to the entity since you
last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get,
and use the new token returned by that operation.
Request Lenses
putManagedRuleSetVersions_recommendedVersion :: Lens' PutManagedRuleSetVersions (Maybe Text) Source #
The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.
putManagedRuleSetVersions_versionsToPublish :: Lens' PutManagedRuleSetVersions (Maybe (HashMap Text VersionToPublish)) Source #
The versions of the named managed rule group that you want to offer to your customers.
putManagedRuleSetVersions_name :: Lens' PutManagedRuleSetVersions Text Source #
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
putManagedRuleSetVersions_scope :: Lens' PutManagedRuleSetVersions Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1. - API and SDKs - For all calls, use the Region endpoint us-east-1.
putManagedRuleSetVersions_id :: Lens' PutManagedRuleSetVersions Text Source #
A unique identifier for the managed rule set. The ID is returned in the
responses to commands like list. You provide it to operations like
get and update.
putManagedRuleSetVersions_lockToken :: Lens' PutManagedRuleSetVersions Text Source #
A token used for optimistic locking. WAF returns a token to your get
and list requests, to mark the state of the entity at the time of the
request. To make changes to the entity associated with the token, you
provide the token to operations like update and delete. WAF uses the
token to ensure that no changes have been made to the entity since you
last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get,
and use the new token returned by that operation.
Destructuring the Response
data PutManagedRuleSetVersionsResponse Source #
See: newPutManagedRuleSetVersionsResponse smart constructor.
Constructors
| PutManagedRuleSetVersionsResponse' | |
Fields
| |
Instances
newPutManagedRuleSetVersionsResponse Source #
Arguments
| :: Int | |
| -> PutManagedRuleSetVersionsResponse |
Create a value of PutManagedRuleSetVersionsResponse 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:nextLockToken:PutManagedRuleSetVersionsResponse', putManagedRuleSetVersionsResponse_nextLockToken - A token used for optimistic locking. WAF returns a token to your get
and list requests, to mark the state of the entity at the time of the
request. To make changes to the entity associated with the token, you
provide the token to operations like update and delete. WAF uses the
token to ensure that no changes have been made to the entity since you
last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get,
and use the new token returned by that operation.
$sel:httpStatus:PutManagedRuleSetVersionsResponse', putManagedRuleSetVersionsResponse_httpStatus - The response's http status code.
Response Lenses
putManagedRuleSetVersionsResponse_nextLockToken :: Lens' PutManagedRuleSetVersionsResponse (Maybe Text) Source #
A token used for optimistic locking. WAF returns a token to your get
and list requests, to mark the state of the entity at the time of the
request. To make changes to the entity associated with the token, you
provide the token to operations like update and delete. WAF uses the
token to ensure that no changes have been made to the entity since you
last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get,
and use the new token returned by that operation.
putManagedRuleSetVersionsResponse_httpStatus :: Lens' PutManagedRuleSetVersionsResponse Int Source #
The response's http status code.