AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
aws.wafv2.getRuleGroup
Explore with Pulumi AI
Retrieves the summary of a WAFv2 Rule Group.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.wafv2.getRuleGroup({
name: "some-rule-group",
scope: "REGIONAL",
});
import pulumi
import pulumi_aws as aws
example = aws.wafv2.get_rule_group(name="some-rule-group",
scope="REGIONAL")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/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
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.WafV2.GetRuleGroup.Invoke(new()
{
Name = "some-rule-group",
Scope = "REGIONAL",
});
});
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.GetRuleGroupArgs;
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.getRuleGroup(GetRuleGroupArgs.builder()
.name("some-rule-group")
.scope("REGIONAL")
.build());
}
}
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:
getRuleGroup Result
The following output properties are available:
- Arn string
- ARN of the entity.
- Description string
- 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
- ARN of the entity.
- Description string
- 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
- ARN of the entity.
- description String
- 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
- ARN of the entity.
- description string
- 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
- ARN of the entity.
- description str
- 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
- ARN of the entity.
- description String
- 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
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.