Put Managed Rule Set Versions
wafv2_put_managed_rule_set_versions | R Documentation |
Defines the versions of your managed rule set that you are offering to the customers¶
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 list_managed_rule_sets
,
get_managed_rule_set
, put_managed_rule_set_versions
, and
update_managed_rule_set_version_expiry_date
.
Customers retrieve their managed rule group list by calling
list_available_managed_rule_groups
. 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
list_available_managed_rule_group_versions
. 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
update_managed_rule_set_version_expiry_date
.
Usage¶
wafv2_put_managed_rule_set_versions(Name, Scope, Id, LockToken,
RecommendedVersion, VersionsToPublish)
Arguments¶
Name |
[required] 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. |
Scope |
[required] Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
|
Id |
[required] A unique identifier for the managed rule set. The ID
is returned in the responses to commands like |
LockToken |
[required] A token used for optimistic locking. WAF returns a
token to your |
RecommendedVersion |
The version of the named managed rule group that you'd like your customers to choose, from among your version offerings. |
VersionsToPublish |
The versions of the named managed rule group that you want to offer to your customers. |
Value¶
A list with the following syntax:
list(
NextLockToken = "string"
)
Request syntax¶
svc$put_managed_rule_set_versions(
Name = "string",
Scope = "CLOUDFRONT"|"REGIONAL",
Id = "string",
LockToken = "string",
RecommendedVersion = "string",
VersionsToPublish = list(
list(
AssociatedRuleGroupArn = "string",
ForecastedLifetime = 123
)
)
)