aws.wafv2.RuleGroup

Create RuleGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new RuleGroup(name: string, args: RuleGroupArgs, opts?: CustomResourceOptions);

@overload
def RuleGroup(resource_name: str,
              args: RuleGroupArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def RuleGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              capacity: Optional[int] = None,
              custom_response_bodies: Optional[Sequence[RuleGroupCustomResponseBodyArgs]] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              name_prefix: Optional[str] = None,
              rules: Optional[Sequence[RuleGroupRuleArgs]] = None,
              scope: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              visibility_config: Optional[RuleGroupVisibilityConfigArgs] = None)

func NewRuleGroup(ctx *Context, name string, args RuleGroupArgs, opts ...ResourceOption) (*RuleGroup, error)

public RuleGroup(string name, RuleGroupArgs args, CustomResourceOptions? opts = null)

public RuleGroup(String name, RuleGroupArgs args)
public RuleGroup(String name, RuleGroupArgs args, CustomResourceOptions options)

type: aws:wafv2:RuleGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

RuleGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The RuleGroup resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the RuleGroup resource produces the following output properties:

Look up Existing RuleGroup Resource

Get an existing RuleGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RuleGroupState, opts?: CustomResourceOptions): RuleGroup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        capacity: Optional[int] = None,
        custom_response_bodies: Optional[Sequence[RuleGroupCustomResponseBodyArgs]] = None,
        description: Optional[str] = None,
        lock_token: Optional[str] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        rules: Optional[Sequence[RuleGroupRuleArgs]] = None,
        scope: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        visibility_config: Optional[RuleGroupVisibilityConfigArgs] = None) -> RuleGroup

func GetRuleGroup(ctx *Context, name string, id IDInput, state *RuleGroupState, opts ...ResourceOption) (*RuleGroup, error)

public static RuleGroup Get(string name, Input<string> id, RuleGroupState? state, CustomResourceOptions? opts = null)

public static RuleGroup get(String name, Output<String> id, RuleGroupState state, CustomResourceOptions options)

resources:  _:    type: aws:wafv2:RuleGroup    get:      id: ${id}

Supporting Types

Note: There are over 200 nested types for this resource. Only the first 200 types are included in this documentation.

RuleGroupCustomResponseBody, RuleGroupCustomResponseBodyArgs

RuleGroupRule, RuleGroupRuleArgs

RuleGroupRuleAction, RuleGroupRuleActionArgs

RuleGroupRuleActionAllow, RuleGroupRuleActionAllowArgs

RuleGroupRuleActionAllowCustomRequestHandling, RuleGroupRuleActionAllowCustomRequestHandlingArgs

RuleGroupRuleActionAllowCustomRequestHandlingInsertHeader, RuleGroupRuleActionAllowCustomRequestHandlingInsertHeaderArgs

RuleGroupRuleActionBlock, RuleGroupRuleActionBlockArgs

RuleGroupRuleActionBlockCustomResponse, RuleGroupRuleActionBlockCustomResponseArgs

RuleGroupRuleActionBlockCustomResponseResponseHeader, RuleGroupRuleActionBlockCustomResponseResponseHeaderArgs

RuleGroupRuleActionCaptcha, RuleGroupRuleActionCaptchaArgs

RuleGroupRuleActionCaptchaCustomRequestHandling, RuleGroupRuleActionCaptchaCustomRequestHandlingArgs

RuleGroupRuleActionCaptchaCustomRequestHandlingInsertHeader, RuleGroupRuleActionCaptchaCustomRequestHandlingInsertHeaderArgs

RuleGroupRuleActionChallenge, RuleGroupRuleActionChallengeArgs

RuleGroupRuleActionChallengeCustomRequestHandling, RuleGroupRuleActionChallengeCustomRequestHandlingArgs

RuleGroupRuleActionChallengeCustomRequestHandlingInsertHeader, RuleGroupRuleActionChallengeCustomRequestHandlingInsertHeaderArgs

RuleGroupRuleActionCount, RuleGroupRuleActionCountArgs

RuleGroupRuleActionCountCustomRequestHandling, RuleGroupRuleActionCountCustomRequestHandlingArgs

RuleGroupRuleActionCountCustomRequestHandlingInsertHeader, RuleGroupRuleActionCountCustomRequestHandlingInsertHeaderArgs

RuleGroupRuleCaptchaConfig, RuleGroupRuleCaptchaConfigArgs

RuleGroupRuleCaptchaConfigImmunityTimeProperty, RuleGroupRuleCaptchaConfigImmunityTimePropertyArgs

RuleGroupRuleRuleLabel, RuleGroupRuleRuleLabelArgs

RuleGroupRuleStatement, RuleGroupRuleStatementArgs

RuleGroupRuleStatementAndStatement, RuleGroupRuleStatementAndStatementArgs

RuleGroupRuleStatementByteMatchStatement, RuleGroupRuleStatementByteMatchStatementArgs

RuleGroupRuleStatementByteMatchStatementFieldToMatch, RuleGroupRuleStatementByteMatchStatementFieldToMatchArgs