Package com.pulumi.aws.wafv2

Class RuleGroup

  • public class RuleGroup
extends com.pulumi.resources.CustomResource

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      RuleGroup​(java.lang.String name)  
      RuleGroup​(java.lang.String name, RuleGroupArgs args)  
      RuleGroup​(java.lang.String name, RuleGroupArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.Integer> capacity()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<RuleGroupCustomResponseBody>>> customResponseBodies()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static RuleGroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RuleGroupState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> lockToken()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> namePrefix()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<RuleGroupRule>>> rules()  
      com.pulumi.core.Output<java.lang.String> scope()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<RuleGroupVisibilityConfig> visibilityConfig()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RuleGroup

        public RuleGroup​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • RuleGroup

        public RuleGroup​(java.lang.String name,
                 RuleGroupArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • RuleGroup

        public RuleGroup​(java.lang.String name,
                 RuleGroupArgs args,
                 @Nullable
                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the WAF rule group.

      • capacity

        public com.pulumi.core.Output<java.lang.Integer> capacity()
        Returns:
        The web ACL capacity units (WCUs) required for this rule group. See [here](https://docs.aws.amazon.com/waf/latest/APIReference/API_CreateRuleGroup.html#API_CreateRuleGroup_RequestSyntax) for general information and [here](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statements-list.html) for capacity specific information.

      • customResponseBodies

        public com.pulumi.core.Output<java.util.Optional<java.util.List<RuleGroupCustomResponseBody>>> customResponseBodies()
        Returns:
        Defines custom response bodies that can be referenced by `custom_response` actions. See Custom Response Body below for details.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        A friendly description of the rule group.

      • lockToken

        public com.pulumi.core.Output<java.lang.String> lockToken()

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        A friendly name of the rule group.

      • namePrefix

        public com.pulumi.core.Output<java.lang.String> namePrefix()

      • rules

        public com.pulumi.core.Output<java.util.Optional<java.util.List<RuleGroupRule>>> rules()
        Returns:
        The rule blocks used to identify the web requests that you want to `allow`, `block`, or `count`. See Rules below for details.

      • scope

        public com.pulumi.core.Output<java.lang.String> scope()
        Returns:
        Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        An array of key:value pairs to associate with the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • visibilityConfig

        public com.pulumi.core.Output<RuleGroupVisibilityConfig> visibilityConfig()
        Returns:
        Defines and enables Amazon CloudWatch metrics and web request sample collection. See Visibility Configuration below for details.

      • get

        public static RuleGroup get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            RuleGroupState state,
                            @Nullable
                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.