High-level information for a managed rule group.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.wafv2.getManagedRuleGroup({
name: "AWSManagedRulesCommonRuleSet",
scope: "REGIONAL",
vendorName: "AWS",
});
import pulumi
import pulumi_aws as aws
example = aws.wafv2.get_managed_rule_group(name="AWSManagedRulesCommonRuleSet",
scope="REGIONAL",
vendor_name="AWS")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/wafv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := wafv2.GetManagedRuleGroup(ctx, &wafv2.GetManagedRuleGroupArgs{
Name: "AWSManagedRulesCommonRuleSet",
Scope: "REGIONAL",
VendorName: "AWS",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.WafV2.GetManagedRuleGroup.Invoke(new()
{
Name = "AWSManagedRulesCommonRuleSet",
Scope = "REGIONAL",
VendorName = "AWS",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.wafv2.Wafv2Functions;
import com.pulumi.aws.wafv2.inputs.GetManagedRuleGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = Wafv2Functions.getManagedRuleGroup(GetManagedRuleGroupArgs.builder()
.name("AWSManagedRulesCommonRuleSet")
.scope("REGIONAL")
.vendorName("AWS")
.build());
}
}
variables:
example:
fn::invoke:
function: aws:wafv2:getManagedRuleGroup
arguments:
name: AWSManagedRulesCommonRuleSet
scope: REGIONAL
vendorName: AWS
Using getManagedRuleGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getManagedRuleGroup(args: GetManagedRuleGroupArgs, opts?: InvokeOptions): Promise<GetManagedRuleGroupResult>
function getManagedRuleGroupOutput(args: GetManagedRuleGroupOutputArgs, opts?: InvokeOptions): Output<GetManagedRuleGroupResult>def get_managed_rule_group(name: Optional[str] = None,
region: Optional[str] = None,
scope: Optional[str] = None,
vendor_name: Optional[str] = None,
version_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetManagedRuleGroupResult
def get_managed_rule_group_output(name: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
scope: Optional[pulumi.Input[str]] = None,
vendor_name: Optional[pulumi.Input[str]] = None,
version_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetManagedRuleGroupResult]func GetManagedRuleGroup(ctx *Context, args *GetManagedRuleGroupArgs, opts ...InvokeOption) (*GetManagedRuleGroupResult, error)
func GetManagedRuleGroupOutput(ctx *Context, args *GetManagedRuleGroupOutputArgs, opts ...InvokeOption) GetManagedRuleGroupResultOutput> Note: This function is named GetManagedRuleGroup in the Go SDK.
public static class GetManagedRuleGroup
{
public static Task<GetManagedRuleGroupResult> InvokeAsync(GetManagedRuleGroupArgs args, InvokeOptions? opts = null)
public static Output<GetManagedRuleGroupResult> Invoke(GetManagedRuleGroupInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetManagedRuleGroupResult> getManagedRuleGroup(GetManagedRuleGroupArgs args, InvokeOptions options)
public static Output<GetManagedRuleGroupResult> getManagedRuleGroup(GetManagedRuleGroupArgs args, InvokeOptions options)
fn::invoke:
function: aws:wafv2/getManagedRuleGroup:getManagedRuleGroup
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
- Managed rule group name.
- Scope string
- Whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use
CLOUDFRONT. Valid values:CLOUDFRONT,REGIONAL. - Vendor
Name string - Managed rule group vendor name.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Version
Name string - Version of the rule group.
- Name string
- Managed rule group name.
- Scope string
- Whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use
CLOUDFRONT. Valid values:CLOUDFRONT,REGIONAL. - Vendor
Name string - Managed rule group vendor name.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Version
Name string - Version of the rule group.
- name String
- Managed rule group name.
- scope String
- Whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use
CLOUDFRONT. Valid values:CLOUDFRONT,REGIONAL. - vendor
Name String - Managed rule group vendor name.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- version
Name String - Version of the rule group.
- name string
- Managed rule group name.
- scope string
- Whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use
CLOUDFRONT. Valid values:CLOUDFRONT,REGIONAL. - vendor
Name string - Managed rule group vendor name.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- version
Name string - Version of the rule group.
- name str
- Managed rule group name.
- scope str
- Whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use
CLOUDFRONT. Valid values:CLOUDFRONT,REGIONAL. - vendor_
name str - Managed rule group vendor name.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- version_
name str - Version of the rule group.
- name String
- Managed rule group name.
- scope String
- Whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use
CLOUDFRONT. Valid values:CLOUDFRONT,REGIONAL. - vendor
Name String - Managed rule group vendor name.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- version
Name String - Version of the rule group.
getManagedRuleGroup Result
The following output properties are available:
- Available
Labels List<GetManaged Rule Group Available Label> - Labels that one or more rules in this rule group add to matching web requests. See Labels below for details.
- Capacity int
- WCUs required for this rule group.
- Consumed
Labels List<GetManaged Rule Group Consumed Label> - Labels that one or more rules in this rule group match against in label match statements. See Labels below for details.
- Id string
- The provider-assigned unique ID for this managed resource.
- Label
Namespace string - Label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
- Name string
- Name of the rule.
- Region string
- Rules
List<Get
Managed Rule Group Rule> - High-level information about the rules. See Rules below for details.
- Scope string
- Sns
Topic stringArn - ARN of the SNS topic that's used to provide notification of changes to the managed rule group.
- Vendor
Name string - Version
Name string
- Available
Labels []GetManaged Rule Group Available Label - Labels that one or more rules in this rule group add to matching web requests. See Labels below for details.
- Capacity int
- WCUs required for this rule group.
- Consumed
Labels []GetManaged Rule Group Consumed Label - Labels that one or more rules in this rule group match against in label match statements. See Labels below for details.
- Id string
- The provider-assigned unique ID for this managed resource.
- Label
Namespace string - Label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
- Name string
- Name of the rule.
- Region string
- Rules
[]Get
Managed Rule Group Rule - High-level information about the rules. See Rules below for details.
- Scope string
- Sns
Topic stringArn - ARN of the SNS topic that's used to provide notification of changes to the managed rule group.
- Vendor
Name string - Version
Name string
- available
Labels List<GetManaged Rule Group Available Label> - Labels that one or more rules in this rule group add to matching web requests. See Labels below for details.
- capacity Integer
- WCUs required for this rule group.
- consumed
Labels List<GetManaged Rule Group Consumed Label> - Labels that one or more rules in this rule group match against in label match statements. See Labels below for details.
- id String
- The provider-assigned unique ID for this managed resource.
- label
Namespace String - Label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
- name String
- Name of the rule.
- region String
- rules
List<Get
Managed Rule Group Rule> - High-level information about the rules. See Rules below for details.
- scope String
- sns
Topic StringArn - ARN of the SNS topic that's used to provide notification of changes to the managed rule group.
- vendor
Name String - version
Name String
- available
Labels GetManaged Rule Group Available Label[] - Labels that one or more rules in this rule group add to matching web requests. See Labels below for details.
- capacity number
- WCUs required for this rule group.
- consumed
Labels GetManaged Rule Group Consumed Label[] - Labels that one or more rules in this rule group match against in label match statements. See Labels below for details.
- id string
- The provider-assigned unique ID for this managed resource.
- label
Namespace string - Label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
- name string
- Name of the rule.
- region string
- rules
Get
Managed Rule Group Rule[] - High-level information about the rules. See Rules below for details.
- scope string
- sns
Topic stringArn - ARN of the SNS topic that's used to provide notification of changes to the managed rule group.
- vendor
Name string - version
Name string
- available_
labels Sequence[GetManaged Rule Group Available Label] - Labels that one or more rules in this rule group add to matching web requests. See Labels below for details.
- capacity int
- WCUs required for this rule group.
- consumed_
labels Sequence[GetManaged Rule Group Consumed Label] - Labels that one or more rules in this rule group match against in label match statements. See Labels below for details.
- id str
- The provider-assigned unique ID for this managed resource.
- label_
namespace str - Label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
- name str
- Name of the rule.
- region str
- rules
Sequence[Get
Managed Rule Group Rule] - High-level information about the rules. See Rules below for details.
- scope str
- sns_
topic_ strarn - ARN of the SNS topic that's used to provide notification of changes to the managed rule group.
- vendor_
name str - version_
name str
- available
Labels List<Property Map> - Labels that one or more rules in this rule group add to matching web requests. See Labels below for details.
- capacity Number
- WCUs required for this rule group.
- consumed
Labels List<Property Map> - Labels that one or more rules in this rule group match against in label match statements. See Labels below for details.
- id String
- The provider-assigned unique ID for this managed resource.
- label
Namespace String - Label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
- name String
- Name of the rule.
- region String
- rules List<Property Map>
- High-level information about the rules. See Rules below for details.
- scope String
- sns
Topic StringArn - ARN of the SNS topic that's used to provide notification of changes to the managed rule group.
- vendor
Name String - version
Name String
Supporting Types
GetManagedRuleGroupAvailableLabel
- Name string
- Managed rule group name.
- Name string
- Managed rule group name.
- name String
- Managed rule group name.
- name string
- Managed rule group name.
- name str
- Managed rule group name.
- name String
- Managed rule group name.
GetManagedRuleGroupConsumedLabel
- Name string
- Managed rule group name.
- Name string
- Managed rule group name.
- name String
- Managed rule group name.
- name string
- Managed rule group name.
- name str
- Managed rule group name.
- name String
- Managed rule group name.
GetManagedRuleGroupRule
- Actions
List<Get
Managed Rule Group Rule Action> - Action taken on a web request when it matches a rule's statement. See
action_to_usefor details. - Name string
- Managed rule group name.
- Actions
[]Get
Managed Rule Group Rule Action - Action taken on a web request when it matches a rule's statement. See
action_to_usefor details. - Name string
- Managed rule group name.
- actions
List<Get
Managed Rule Group Rule Action> - Action taken on a web request when it matches a rule's statement. See
action_to_usefor details. - name String
- Managed rule group name.
- actions
Get
Managed Rule Group Rule Action[] - Action taken on a web request when it matches a rule's statement. See
action_to_usefor details. - name string
- Managed rule group name.
- actions
Sequence[Get
Managed Rule Group Rule Action] - Action taken on a web request when it matches a rule's statement. See
action_to_usefor details. - name str
- Managed rule group name.
- actions List<Property Map>
- Action taken on a web request when it matches a rule's statement. See
action_to_usefor details. - name String
- Managed rule group name.
GetManagedRuleGroupRuleAction
GetManagedRuleGroupRuleActionAllow
GetManagedRuleGroupRuleActionAllowCustomRequestHandling
GetManagedRuleGroupRuleActionAllowCustomRequestHandlingInsertHeader
GetManagedRuleGroupRuleActionBlock
GetManagedRuleGroupRuleActionBlockCustomResponse
GetManagedRuleGroupRuleActionBlockCustomResponseResponseHeader
GetManagedRuleGroupRuleActionCaptcha
GetManagedRuleGroupRuleActionCaptchaCustomRequestHandling
GetManagedRuleGroupRuleActionCaptchaCustomRequestHandlingInsertHeader
GetManagedRuleGroupRuleActionChallenge
GetManagedRuleGroupRuleActionChallengeCustomRequestHandling
GetManagedRuleGroupRuleActionChallengeCustomRequestHandlingInsertHeader
GetManagedRuleGroupRuleActionCount
GetManagedRuleGroupRuleActionCountCustomRequestHandling
GetManagedRuleGroupRuleActionCountCustomRequestHandlingInsertHeader
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
