Struct aws_sdk_wafv2::operation::create_rule_group::builders::CreateRuleGroupInputBuilder

#[non_exhaustive]
pub struct CreateRuleGroupInputBuilder { /* private fields */ }

A builder for CreateRuleGroupInput.

Implementations

impl CreateRuleGroupInputBuilder

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.

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.

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.

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.

This field is required.

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.

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.

pub fn capacity(self, input: i64) -> Self

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

This field is required.

pub fn set_capacity(self, input: Option<i64>) -> Self

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

pub fn get_capacity(&self) -> &Option<i64>

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

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

A description of the rule group that helps with identification.

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

A description of the rule group that helps with identification.

pub fn get_description(&self) -> &Option<String>

A description of the rule group that helps with identification.

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.

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.

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.

pub fn visibility_config(self, input: VisibilityConfig) -> Self

Defines and enables Amazon CloudWatch metrics and web request sample collection.

This field is required.

pub fn set_visibility_config(self, input: Option<VisibilityConfig>) -> Self

Defines and enables Amazon CloudWatch metrics and web request sample collection.

pub fn get_visibility_config(&self) -> &Option<VisibilityConfig>

Defines and enables Amazon CloudWatch metrics and web request sample collection.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

An array of key:value pairs to associate with the resource.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

An array of key:value pairs to associate with the resource.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

An array of key:value pairs to associate with the resource.

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.

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.

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.

pub fn build(self) -> Result<CreateRuleGroupInput, BuildError>

Consumes the builder and constructs a CreateRuleGroupInput.

impl CreateRuleGroupInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreateRuleGroupOutput, SdkError<CreateRuleGroupError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateRuleGroupInputBuilder

fn clone(&self) -> CreateRuleGroupInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateRuleGroupInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateRuleGroupInputBuilder

fn default() -> CreateRuleGroupInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateRuleGroupInputBuilder

fn eq(&self, other: &CreateRuleGroupInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateRuleGroupInputBuilder