AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

getRuleGroup

Retrieves the summary of a WAFv2 Rule Group.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.WafV2.GetRuleGroup.InvokeAsync(new Aws.WafV2.GetRuleGroupArgs
        {
            Name = "some-rule-group",
            Scope = "REGIONAL",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/wafv2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := wafv2.LookupRuleGroup(ctx, &wafv2.LookupRuleGroupArgs{
			Name:  "some-rule-group",
			Scope: "REGIONAL",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Output.of(Wafv2Functions.getRuleGroup(GetRuleGroupArgs.builder()
            .name("some-rule-group")
            .scope("REGIONAL")
            .build()));

        }
}
import pulumi
import pulumi_aws as aws

example = aws.wafv2.get_rule_group(name="some-rule-group",
    scope="REGIONAL")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.wafv2.getRuleGroup({
    name: "some-rule-group",
    scope: "REGIONAL",
}));
variables:
  example:
    Fn::Invoke:
      Function: aws:wafv2:getRuleGroup
      Arguments:
        name: some-rule-group
        scope: REGIONAL

Using getRuleGroup

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 getRuleGroup(args: GetRuleGroupArgs, opts?: InvokeOptions): Promise<GetRuleGroupResult>
function getRuleGroupOutput(args: GetRuleGroupOutputArgs, opts?: InvokeOptions): Output<GetRuleGroupResult>
def get_rule_group(name: Optional[str] = None,
                   scope: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetRuleGroupResult
def get_rule_group_output(name: Optional[pulumi.Input[str]] = None,
                   scope: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetRuleGroupResult]
func LookupRuleGroup(ctx *Context, args *LookupRuleGroupArgs, opts ...InvokeOption) (*LookupRuleGroupResult, error)
func LookupRuleGroupOutput(ctx *Context, args *LookupRuleGroupOutputArgs, opts ...InvokeOption) LookupRuleGroupResultOutput

> Note: This function is named LookupRuleGroup in the Go SDK.

public static class GetRuleGroup 
{
    public static Task<GetRuleGroupResult> InvokeAsync(GetRuleGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleGroupResult> Invoke(GetRuleGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetRuleGroupResult> getRuleGroup(GetRuleGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:wafv2/getRuleGroup:getRuleGroup
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string

The name of the WAFv2 Rule Group.

Scope string

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.

Name string

The name of the WAFv2 Rule Group.

Scope string

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.

name String

The name of the WAFv2 Rule Group.

scope String

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.

name string

The name of the WAFv2 Rule Group.

scope string

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.

name str

The name of the WAFv2 Rule Group.

scope str

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.

name String

The name of the WAFv2 Rule Group.

scope String

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.

getRuleGroup Result

The following output properties are available:

Arn string

The Amazon Resource Name (ARN) of the entity.

Description string

The description of the rule group that helps with identification.

Id string

The provider-assigned unique ID for this managed resource.

Name string
Scope string
Arn string

The Amazon Resource Name (ARN) of the entity.

Description string

The description of the rule group that helps with identification.

Id string

The provider-assigned unique ID for this managed resource.

Name string
Scope string
arn String

The Amazon Resource Name (ARN) of the entity.

description String

The description of the rule group that helps with identification.

id String

The provider-assigned unique ID for this managed resource.

name String
scope String
arn string

The Amazon Resource Name (ARN) of the entity.

description string

The description of the rule group that helps with identification.

id string

The provider-assigned unique ID for this managed resource.

name string
scope string
arn str

The Amazon Resource Name (ARN) of the entity.

description str

The description of the rule group that helps with identification.

id str

The provider-assigned unique ID for this managed resource.

name str
scope str
arn String

The Amazon Resource Name (ARN) of the entity.

description String

The description of the rule group that helps with identification.

id String

The provider-assigned unique ID for this managed resource.

name String
scope String

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.