github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/networkfirewall/getFirewallPolicy.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package networkfirewall

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Retrieve information about a firewall policy.
//
// ## Example Usage
//
// ### Find firewall policy by name
//
// <!--Start PulumiCodeChooser -->
// ```go
// 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
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ### Find firewall policy by ARN
//
// <!--Start PulumiCodeChooser -->
// ```go
// 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
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ### Find firewall policy by name and ARN
//
// <!--Start PulumiCodeChooser -->
// ```go
// 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
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// 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 [Resource Access Manager (RAM) share][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.
func LookupFirewallPolicy(ctx *pulumi.Context, args *LookupFirewallPolicyArgs, opts ...pulumi.InvokeOption) (*LookupFirewallPolicyResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv LookupFirewallPolicyResult
	err := ctx.Invoke("aws:networkfirewall/getFirewallPolicy:getFirewallPolicy", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getFirewallPolicy.
type LookupFirewallPolicyArgs struct {
	// ARN of the firewall policy.
	Arn *string `pulumi:"arn"`
	// Descriptive name of the firewall policy.
	Name *string `pulumi:"name"`
	// Key-value tags for the firewall policy.
	Tags map[string]string `pulumi:"tags"`
}

// A collection of values returned by getFirewallPolicy.
type LookupFirewallPolicyResult struct {
	Arn *string `pulumi:"arn"`
	// Description of the firewall policy.
	Description string `pulumi:"description"`
	// The [policy][2] for the specified firewall policy.
	FirewallPolicies []GetFirewallPolicyFirewallPolicy `pulumi:"firewallPolicies"`
	// The provider-assigned unique ID for this managed resource.
	Id   string  `pulumi:"id"`
	Name *string `pulumi:"name"`
	// Key-value tags for the firewall policy.
	Tags map[string]string `pulumi:"tags"`
	// Token used for optimistic locking.
	UpdateToken string `pulumi:"updateToken"`
}

func LookupFirewallPolicyOutput(ctx *pulumi.Context, args LookupFirewallPolicyOutputArgs, opts ...pulumi.InvokeOption) LookupFirewallPolicyResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (LookupFirewallPolicyResult, error) {
			args := v.(LookupFirewallPolicyArgs)
			r, err := LookupFirewallPolicy(ctx, &args, opts...)
			var s LookupFirewallPolicyResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(LookupFirewallPolicyResultOutput)
}

// A collection of arguments for invoking getFirewallPolicy.
type LookupFirewallPolicyOutputArgs struct {
	// ARN of the firewall policy.
	Arn pulumi.StringPtrInput `pulumi:"arn"`
	// Descriptive name of the firewall policy.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Key-value tags for the firewall policy.
	Tags pulumi.StringMapInput `pulumi:"tags"`
}

func (LookupFirewallPolicyOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupFirewallPolicyArgs)(nil)).Elem()
}

// A collection of values returned by getFirewallPolicy.
type LookupFirewallPolicyResultOutput struct{ *pulumi.OutputState }

func (LookupFirewallPolicyResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupFirewallPolicyResult)(nil)).Elem()
}

func (o LookupFirewallPolicyResultOutput) ToLookupFirewallPolicyResultOutput() LookupFirewallPolicyResultOutput {
	return o
}

func (o LookupFirewallPolicyResultOutput) ToLookupFirewallPolicyResultOutputWithContext(ctx context.Context) LookupFirewallPolicyResultOutput {
	return o
}

func (o LookupFirewallPolicyResultOutput) Arn() pulumi.StringPtrOutput {
	return o.ApplyT(func(v LookupFirewallPolicyResult) *string { return v.Arn }).(pulumi.StringPtrOutput)
}

// Description of the firewall policy.
func (o LookupFirewallPolicyResultOutput) Description() pulumi.StringOutput {
	return o.ApplyT(func(v LookupFirewallPolicyResult) string { return v.Description }).(pulumi.StringOutput)
}

// The [policy][2] for the specified firewall policy.
func (o LookupFirewallPolicyResultOutput) FirewallPolicies() GetFirewallPolicyFirewallPolicyArrayOutput {
	return o.ApplyT(func(v LookupFirewallPolicyResult) []GetFirewallPolicyFirewallPolicy { return v.FirewallPolicies }).(GetFirewallPolicyFirewallPolicyArrayOutput)
}

// The provider-assigned unique ID for this managed resource.
func (o LookupFirewallPolicyResultOutput) Id() pulumi.StringOutput {
	return o.ApplyT(func(v LookupFirewallPolicyResult) string { return v.Id }).(pulumi.StringOutput)
}

func (o LookupFirewallPolicyResultOutput) Name() pulumi.StringPtrOutput {
	return o.ApplyT(func(v LookupFirewallPolicyResult) *string { return v.Name }).(pulumi.StringPtrOutput)
}

// Key-value tags for the firewall policy.
func (o LookupFirewallPolicyResultOutput) Tags() pulumi.StringMapOutput {
	return o.ApplyT(func(v LookupFirewallPolicyResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
}

// Token used for optimistic locking.
func (o LookupFirewallPolicyResultOutput) UpdateToken() pulumi.StringOutput {
	return o.ApplyT(func(v LookupFirewallPolicyResult) string { return v.UpdateToken }).(pulumi.StringOutput)
}

func init() {
	pulumi.RegisterOutputType(LookupFirewallPolicyResultOutput{})
}