pulumi-aws-kotlin/com.pulumi.aws.networkfirewall.kotlin/NetworkfirewallFunctions/getFirewallPolicy

getFirewallPolicy

suspend fun getFirewallPolicy(argument: GetFirewallPolicyPlainArgs): GetFirewallPolicyResult

Retrieve information about a firewall policy.

Example Usage

Find firewall policy by name

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.networkfirewall.getFirewallPolicy({
    name: firewallPolicyName,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.networkfirewall.get_firewall_policy(name=firewall_policy_name)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = Aws.NetworkFirewall.GetFirewallPolicy.Invoke(new()
    {
        Name = firewallPolicyName,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/networkfirewall"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkfirewall.LookupFirewallPolicy(ctx, &networkfirewall.LookupFirewallPolicyArgs{
			Name: pulumi.StringRef(firewallPolicyName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkfirewall.NetworkfirewallFunctions;
import com.pulumi.aws.networkfirewall.inputs.GetFirewallPolicyArgs;
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 = NetworkfirewallFunctions.getFirewallPolicy(GetFirewallPolicyArgs.builder()
            .name(firewallPolicyName)
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:networkfirewall:getFirewallPolicy
      arguments:
        name: ${firewallPolicyName}
Content copied to clipboard

Find firewall policy by ARN

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.networkfirewall.getFirewallPolicy({
    arn: firewallPolicyArn,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.networkfirewall.get_firewall_policy(arn=firewall_policy_arn)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = Aws.NetworkFirewall.GetFirewallPolicy.Invoke(new()
    {
        Arn = firewallPolicyArn,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/networkfirewall"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkfirewall.LookupFirewallPolicy(ctx, &networkfirewall.LookupFirewallPolicyArgs{
			Arn: pulumi.StringRef(firewallPolicyArn),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkfirewall.NetworkfirewallFunctions;
import com.pulumi.aws.networkfirewall.inputs.GetFirewallPolicyArgs;
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 = NetworkfirewallFunctions.getFirewallPolicy(GetFirewallPolicyArgs.builder()
            .arn(firewallPolicyArn)
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:networkfirewall:getFirewallPolicy
      arguments:
        arn: ${firewallPolicyArn}
Content copied to clipboard

Find firewall policy by name and ARN

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.networkfirewall.getFirewallPolicy({
    arn: firewallPolicyArn,
    name: firewallPolicyName,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.networkfirewall.get_firewall_policy(arn=firewall_policy_arn,
    name=firewall_policy_name)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = Aws.NetworkFirewall.GetFirewallPolicy.Invoke(new()
    {
        Arn = firewallPolicyArn,
        Name = firewallPolicyName,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/networkfirewall"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkfirewall.LookupFirewallPolicy(ctx, &networkfirewall.LookupFirewallPolicyArgs{
			Arn:  pulumi.StringRef(firewallPolicyArn),
			Name: pulumi.StringRef(firewallPolicyName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkfirewall.NetworkfirewallFunctions;
import com.pulumi.aws.networkfirewall.inputs.GetFirewallPolicyArgs;
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 = NetworkfirewallFunctions.getFirewallPolicy(GetFirewallPolicyArgs.builder()
            .arn(firewallPolicyArn)
            .name(firewallPolicyName)
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:networkfirewall:getFirewallPolicy
      arguments:
        arn: ${firewallPolicyArn}
        name: ${firewallPolicyName}
Content copied to clipboard

AWS Network Firewall does not allow multiple firewall policies with the same name to be created in an account. It is possible, however, to have multiple firewall policies available in a single account with identical name values but distinct arn values, e.g. firewall policies shared via a 1. In that case specifying arn, or name and arn, is recommended.

Note: If there are multiple firewall policies in an account with the same name, and arn is not specified, the default behavior will return the firewall policy with name that was created in the account.

Return

A collection of values returned by getFirewallPolicy.

Parameters

argument

A collection of arguments for invoking getFirewallPolicy.

suspend fun getFirewallPolicy(arn: String? = null, name: String? = null, tags: Map<String, String>? = null): GetFirewallPolicyResult

Return

A collection of values returned by getFirewallPolicy.

Parameters

arn

ARN of the firewall policy.

name

Descriptive name of the firewall policy. One or more of these arguments is required.

tags

Key-value tags for the firewall policy.

See also

.

suspend fun getFirewallPolicy(argument: suspend GetFirewallPolicyPlainArgsBuilder.() -> Unit): GetFirewallPolicyResult

Return

A collection of values returned by getFirewallPolicy.

Parameters

argument

Builder for com.pulumi.aws.networkfirewall.kotlin.inputs.GetFirewallPolicyPlainArgs.

See also

.