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 |
Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.
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
.
Synopsis
- data UpdateManagedRuleSetVersionExpiryDate = UpdateManagedRuleSetVersionExpiryDate' {}
- newUpdateManagedRuleSetVersionExpiryDate :: Text -> Scope -> Text -> Text -> Text -> UTCTime -> UpdateManagedRuleSetVersionExpiryDate
- updateManagedRuleSetVersionExpiryDate_name :: Lens' UpdateManagedRuleSetVersionExpiryDate Text
- updateManagedRuleSetVersionExpiryDate_scope :: Lens' UpdateManagedRuleSetVersionExpiryDate Scope
- updateManagedRuleSetVersionExpiryDate_id :: Lens' UpdateManagedRuleSetVersionExpiryDate Text
- updateManagedRuleSetVersionExpiryDate_lockToken :: Lens' UpdateManagedRuleSetVersionExpiryDate Text
- updateManagedRuleSetVersionExpiryDate_versionToExpire :: Lens' UpdateManagedRuleSetVersionExpiryDate Text
- updateManagedRuleSetVersionExpiryDate_expiryTimestamp :: Lens' UpdateManagedRuleSetVersionExpiryDate UTCTime
- data UpdateManagedRuleSetVersionExpiryDateResponse = UpdateManagedRuleSetVersionExpiryDateResponse' {}
- newUpdateManagedRuleSetVersionExpiryDateResponse :: Int -> UpdateManagedRuleSetVersionExpiryDateResponse
- updateManagedRuleSetVersionExpiryDateResponse_expiringVersion :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (Maybe Text)
- updateManagedRuleSetVersionExpiryDateResponse_expiryTimestamp :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (Maybe UTCTime)
- updateManagedRuleSetVersionExpiryDateResponse_nextLockToken :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (Maybe Text)
- updateManagedRuleSetVersionExpiryDateResponse_httpStatus :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse Int
Creating a Request
data UpdateManagedRuleSetVersionExpiryDate Source #
See: newUpdateManagedRuleSetVersionExpiryDate
smart constructor.
UpdateManagedRuleSetVersionExpiryDate' | |
|
Instances
newUpdateManagedRuleSetVersionExpiryDate Source #
Create a value of UpdateManagedRuleSetVersionExpiryDate
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:
UpdateManagedRuleSetVersionExpiryDate
, updateManagedRuleSetVersionExpiryDate_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.
UpdateManagedRuleSetVersionExpiryDate
, updateManagedRuleSetVersionExpiryDate_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.
UpdateManagedRuleSetVersionExpiryDate
, updateManagedRuleSetVersionExpiryDate_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
.
UpdateManagedRuleSetVersionExpiryDate
, updateManagedRuleSetVersionExpiryDate_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.
$sel:versionToExpire:UpdateManagedRuleSetVersionExpiryDate'
, updateManagedRuleSetVersionExpiryDate_versionToExpire
- The version that you want to remove from your list of offerings for the
named managed rule group.
UpdateManagedRuleSetVersionExpiryDate
, updateManagedRuleSetVersionExpiryDate_expiryTimestamp
- The time that you want the version to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
Request Lenses
updateManagedRuleSetVersionExpiryDate_name :: Lens' UpdateManagedRuleSetVersionExpiryDate 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.
updateManagedRuleSetVersionExpiryDate_scope :: Lens' UpdateManagedRuleSetVersionExpiryDate 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.
updateManagedRuleSetVersionExpiryDate_id :: Lens' UpdateManagedRuleSetVersionExpiryDate 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
.
updateManagedRuleSetVersionExpiryDate_lockToken :: Lens' UpdateManagedRuleSetVersionExpiryDate 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.
updateManagedRuleSetVersionExpiryDate_versionToExpire :: Lens' UpdateManagedRuleSetVersionExpiryDate Text Source #
The version that you want to remove from your list of offerings for the named managed rule group.
updateManagedRuleSetVersionExpiryDate_expiryTimestamp :: Lens' UpdateManagedRuleSetVersionExpiryDate UTCTime Source #
The time that you want the version to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
Destructuring the Response
data UpdateManagedRuleSetVersionExpiryDateResponse Source #
See: newUpdateManagedRuleSetVersionExpiryDateResponse
smart constructor.
UpdateManagedRuleSetVersionExpiryDateResponse' | |
|
Instances
newUpdateManagedRuleSetVersionExpiryDateResponse Source #
:: Int |
|
-> UpdateManagedRuleSetVersionExpiryDateResponse |
Create a value of UpdateManagedRuleSetVersionExpiryDateResponse
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:expiringVersion:UpdateManagedRuleSetVersionExpiryDateResponse'
, updateManagedRuleSetVersionExpiryDateResponse_expiringVersion
- The version that is set to expire.
UpdateManagedRuleSetVersionExpiryDate
, updateManagedRuleSetVersionExpiryDateResponse_expiryTimestamp
- The time that the version will expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
$sel:nextLockToken:UpdateManagedRuleSetVersionExpiryDateResponse'
, updateManagedRuleSetVersionExpiryDateResponse_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:UpdateManagedRuleSetVersionExpiryDateResponse'
, updateManagedRuleSetVersionExpiryDateResponse_httpStatus
- The response's http status code.
Response Lenses
updateManagedRuleSetVersionExpiryDateResponse_expiringVersion :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (Maybe Text) Source #
The version that is set to expire.
updateManagedRuleSetVersionExpiryDateResponse_expiryTimestamp :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (Maybe UTCTime) Source #
The time that the version will expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
updateManagedRuleSetVersionExpiryDateResponse_nextLockToken :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (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.
updateManagedRuleSetVersionExpiryDateResponse_httpStatus :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse Int Source #
The response's http status code.