#[non_exhaustive]pub struct UpdateRuleGroupInputBuilder { /* private fields */ }
Expand description
A builder for UpdateRuleGroupInput
.
Implementations§
source§impl UpdateRuleGroupInputBuilder
impl UpdateRuleGroupInputBuilder
sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the rule group. You cannot change the name of a rule group after you create it.
This field is required.sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the rule group. You cannot change the name of a rule group after you create it.
sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of the rule group. You cannot change the name of a rule group after you create it.
sourcepub fn scope(self, input: Scope) -> Self
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, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
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.
sourcepub fn set_scope(self, input: Option<Scope>) -> Self
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, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
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.
sourcepub fn get_scope(&self) -> &Option<Scope>
pub fn get_scope(&self) -> &Option<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, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
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.
sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
This field is required.sourcepub fn set_id(self, input: Option<String>) -> Self
pub fn set_id(self, input: Option<String>) -> Self
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
sourcepub fn get_id(&self) -> &Option<String>
pub fn get_id(&self) -> &Option<String>
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the rule group that helps with identification.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the rule group that helps with identification.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the rule group that helps with identification.
sourcepub fn rules(self, input: Rule) -> Self
pub fn rules(self, input: Rule) -> Self
Appends an item to rules
.
To override the contents of this collection use set_rules
.
The Rule
statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
sourcepub fn set_rules(self, input: Option<Vec<Rule>>) -> Self
pub fn set_rules(self, input: Option<Vec<Rule>>) -> Self
The Rule
statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
sourcepub fn get_rules(&self) -> &Option<Vec<Rule>>
pub fn get_rules(&self) -> &Option<Vec<Rule>>
The Rule
statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
sourcepub fn visibility_config(self, input: VisibilityConfig) -> Self
pub fn visibility_config(self, input: VisibilityConfig) -> Self
Defines and enables Amazon CloudWatch metrics and web request sample collection.
This field is required.sourcepub fn set_visibility_config(self, input: Option<VisibilityConfig>) -> Self
pub fn set_visibility_config(self, input: Option<VisibilityConfig>) -> Self
Defines and enables Amazon CloudWatch metrics and web request sample collection.
sourcepub fn get_visibility_config(&self) -> &Option<VisibilityConfig>
pub fn get_visibility_config(&self) -> &Option<VisibilityConfig>
Defines and enables Amazon CloudWatch metrics and web request sample collection.
sourcepub fn lock_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_lock_token(self, input: Option<String>) -> Self
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.
sourcepub fn get_lock_token(&self) -> &Option<String>
pub fn get_lock_token(&self) -> &Option<String>
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.
sourcepub fn custom_response_bodies(
self,
k: impl Into<String>,
v: CustomResponseBody
) -> Self
pub fn custom_response_bodies( self, k: impl Into<String>, v: CustomResponseBody ) -> Self
Adds a key-value pair to custom_response_bodies
.
To override the contents of this collection use set_custom_response_bodies
.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
sourcepub fn set_custom_response_bodies(
self,
input: Option<HashMap<String, CustomResponseBody>>
) -> Self
pub fn set_custom_response_bodies( self, input: Option<HashMap<String, CustomResponseBody>> ) -> Self
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
sourcepub fn get_custom_response_bodies(
&self
) -> &Option<HashMap<String, CustomResponseBody>>
pub fn get_custom_response_bodies( &self ) -> &Option<HashMap<String, CustomResponseBody>>
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
sourcepub fn build(self) -> Result<UpdateRuleGroupInput, BuildError>
pub fn build(self) -> Result<UpdateRuleGroupInput, BuildError>
Consumes the builder and constructs a UpdateRuleGroupInput
.
source§impl UpdateRuleGroupInputBuilder
impl UpdateRuleGroupInputBuilder
sourcepub async fn send_with(
self,
client: &Client
) -> Result<UpdateRuleGroupOutput, SdkError<UpdateRuleGroupError, HttpResponse>>
pub async fn send_with( self, client: &Client ) -> Result<UpdateRuleGroupOutput, SdkError<UpdateRuleGroupError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for UpdateRuleGroupInputBuilder
impl Clone for UpdateRuleGroupInputBuilder
source§fn clone(&self) -> UpdateRuleGroupInputBuilder
fn clone(&self) -> UpdateRuleGroupInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UpdateRuleGroupInputBuilder
impl Debug for UpdateRuleGroupInputBuilder
source§impl Default for UpdateRuleGroupInputBuilder
impl Default for UpdateRuleGroupInputBuilder
source§fn default() -> UpdateRuleGroupInputBuilder
fn default() -> UpdateRuleGroupInputBuilder
source§impl PartialEq for UpdateRuleGroupInputBuilder
impl PartialEq for UpdateRuleGroupInputBuilder
source§fn eq(&self, other: &UpdateRuleGroupInputBuilder) -> bool
fn eq(&self, other: &UpdateRuleGroupInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.