Struct aws_sdk_wafv2::client::fluent_builders::PutManagedRuleSetVersions

pub struct PutManagedRuleSetVersions { /* private fields */ }

Fluent builder constructing a request to PutManagedRuleSetVersions.

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.

Implementations

impl PutManagedRuleSetVersions

pub async fn send(
    self
) -> Result<PutManagedRuleSetVersionsOutput, SdkError<PutManagedRuleSetVersionsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

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.

pub fn set_name(self, input: Option<String>) -> Self

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.

pub fn scope(self, input: Scope) -> Self

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, or an AppSync GraphQL API.

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.

pub fn set_scope(self, input: Option<Scope>) -> Self

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, or an AppSync GraphQL API.

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.

pub fn id(self, input: impl Into<String>) -> Self

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.

pub fn set_id(self, input: Option<String>) -> Self

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.

pub fn lock_token(self, input: impl Into<String>) -> Self

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.

pub fn set_lock_token(self, input: Option<String>) -> Self

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.

pub fn recommended_version(self, input: impl Into<String>) -> Self

The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.

pub fn set_recommended_version(self, input: Option<String>) -> Self

The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.

pub fn versions_to_publish(
    self,
    k: impl Into<String>,
    v: VersionToPublish
) -> Self

Adds a key-value pair to VersionsToPublish.

To override the contents of this collection use set_versions_to_publish.

The versions of the named managed rule group that you want to offer to your customers.

pub fn set_versions_to_publish(
    self,
    input: Option<HashMap<String, VersionToPublish>>
) -> Self

The versions of the named managed rule group that you want to offer to your customers.

Trait Implementations

impl Clone for PutManagedRuleSetVersions

fn clone(&self) -> PutManagedRuleSetVersions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PutManagedRuleSetVersions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.