github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/networkfirewall/getFirewall.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.
//
// ## Example Usage
//
// ### 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.LookupFirewall(ctx, &networkfirewall.LookupFirewallArgs{
//				Arn: pulumi.StringRef(arn),
//			}, nil)
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ### 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.LookupFirewall(ctx, &networkfirewall.LookupFirewallArgs{
//				Name: pulumi.StringRef("Test"),
//			}, nil)
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ### Find firewall policy by ARN and 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.LookupFirewall(ctx, &networkfirewall.LookupFirewallArgs{
//				Arn:  pulumi.StringRef(arn),
//				Name: pulumi.StringRef("Test"),
//			}, nil)
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
func LookupFirewall(ctx *pulumi.Context, args *LookupFirewallArgs, opts ...pulumi.InvokeOption) (*LookupFirewallResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv LookupFirewallResult
	err := ctx.Invoke("aws:networkfirewall/getFirewall:getFirewall", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getFirewall.
type LookupFirewallArgs struct {
	// ARN of the firewall.
	Arn *string `pulumi:"arn"`
	// Descriptive name of the firewall.
	Name *string `pulumi:"name"`
	// Map of resource tags to associate with the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags map[string]string `pulumi:"tags"`
}

// A collection of values returned by getFirewall.
type LookupFirewallResult struct {
	// ARN of the firewall.
	Arn string `pulumi:"arn"`
	// A flag indicating whether the firewall is protected against deletion.
	DeleteProtection bool `pulumi:"deleteProtection"`
	// Description of the firewall.
	Description string `pulumi:"description"`
	// AWS Key Management Service (AWS KMS) encryption settings for the firewall.
	EncryptionConfigurations []GetFirewallEncryptionConfiguration `pulumi:"encryptionConfigurations"`
	// ARN of the VPC Firewall policy.
	FirewallPolicyArn string `pulumi:"firewallPolicyArn"`
	// A flag indicating whether the firewall is protected against a change to the firewall policy association.
	FirewallPolicyChangeProtection bool `pulumi:"firewallPolicyChangeProtection"`
	// Nested list of information about the current status of the firewall.
	FirewallStatuses []GetFirewallFirewallStatus `pulumi:"firewallStatuses"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Descriptive name of the firewall.
	Name string `pulumi:"name"`
	// A flag indicating whether the firewall is protected against changes to the subnet associations.
	SubnetChangeProtection bool `pulumi:"subnetChangeProtection"`
	// Set of configuration blocks describing the public subnets. Each subnet must belong to a different Availability Zone in the VPC. AWS Network Firewall creates a firewall endpoint in each subnet.
	SubnetMappings []GetFirewallSubnetMapping `pulumi:"subnetMappings"`
	// Map of resource tags to associate with the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags map[string]string `pulumi:"tags"`
	// String token used when updating a firewall.
	UpdateToken string `pulumi:"updateToken"`
	// Unique identifier of the VPC where AWS Network Firewall should create the firewall.
	VpcId string `pulumi:"vpcId"`
}

func LookupFirewallOutput(ctx *pulumi.Context, args LookupFirewallOutputArgs, opts ...pulumi.InvokeOption) LookupFirewallResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (LookupFirewallResult, error) {
			args := v.(LookupFirewallArgs)
			r, err := LookupFirewall(ctx, &args, opts...)
			var s LookupFirewallResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(LookupFirewallResultOutput)
}

// A collection of arguments for invoking getFirewall.
type LookupFirewallOutputArgs struct {
	// ARN of the firewall.
	Arn pulumi.StringPtrInput `pulumi:"arn"`
	// Descriptive name of the firewall.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Map of resource tags to associate with the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput `pulumi:"tags"`
}

func (LookupFirewallOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupFirewallArgs)(nil)).Elem()
}

// A collection of values returned by getFirewall.
type LookupFirewallResultOutput struct{ *pulumi.OutputState }

func (LookupFirewallResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupFirewallResult)(nil)).Elem()
}

func (o LookupFirewallResultOutput) ToLookupFirewallResultOutput() LookupFirewallResultOutput {
	return o
}

func (o LookupFirewallResultOutput) ToLookupFirewallResultOutputWithContext(ctx context.Context) LookupFirewallResultOutput {
	return o
}

// ARN of the firewall.
func (o LookupFirewallResultOutput) Arn() pulumi.StringOutput {
	return o.ApplyT(func(v LookupFirewallResult) string { return v.Arn }).(pulumi.StringOutput)
}

// A flag indicating whether the firewall is protected against deletion.
func (o LookupFirewallResultOutput) DeleteProtection() pulumi.BoolOutput {
	return o.ApplyT(func(v LookupFirewallResult) bool { return v.DeleteProtection }).(pulumi.BoolOutput)
}

// Description of the firewall.
func (o LookupFirewallResultOutput) Description() pulumi.StringOutput {
	return o.ApplyT(func(v LookupFirewallResult) string { return v.Description }).(pulumi.StringOutput)
}

// AWS Key Management Service (AWS KMS) encryption settings for the firewall.
func (o LookupFirewallResultOutput) EncryptionConfigurations() GetFirewallEncryptionConfigurationArrayOutput {
	return o.ApplyT(func(v LookupFirewallResult) []GetFirewallEncryptionConfiguration { return v.EncryptionConfigurations }).(GetFirewallEncryptionConfigurationArrayOutput)
}

// ARN of the VPC Firewall policy.
func (o LookupFirewallResultOutput) FirewallPolicyArn() pulumi.StringOutput {
	return o.ApplyT(func(v LookupFirewallResult) string { return v.FirewallPolicyArn }).(pulumi.StringOutput)
}

// A flag indicating whether the firewall is protected against a change to the firewall policy association.
func (o LookupFirewallResultOutput) FirewallPolicyChangeProtection() pulumi.BoolOutput {
	return o.ApplyT(func(v LookupFirewallResult) bool { return v.FirewallPolicyChangeProtection }).(pulumi.BoolOutput)
}

// Nested list of information about the current status of the firewall.
func (o LookupFirewallResultOutput) FirewallStatuses() GetFirewallFirewallStatusArrayOutput {
	return o.ApplyT(func(v LookupFirewallResult) []GetFirewallFirewallStatus { return v.FirewallStatuses }).(GetFirewallFirewallStatusArrayOutput)
}

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

// Descriptive name of the firewall.
func (o LookupFirewallResultOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v LookupFirewallResult) string { return v.Name }).(pulumi.StringOutput)
}

// A flag indicating whether the firewall is protected against changes to the subnet associations.
func (o LookupFirewallResultOutput) SubnetChangeProtection() pulumi.BoolOutput {
	return o.ApplyT(func(v LookupFirewallResult) bool { return v.SubnetChangeProtection }).(pulumi.BoolOutput)
}

// Set of configuration blocks describing the public subnets. Each subnet must belong to a different Availability Zone in the VPC. AWS Network Firewall creates a firewall endpoint in each subnet.
func (o LookupFirewallResultOutput) SubnetMappings() GetFirewallSubnetMappingArrayOutput {
	return o.ApplyT(func(v LookupFirewallResult) []GetFirewallSubnetMapping { return v.SubnetMappings }).(GetFirewallSubnetMappingArrayOutput)
}

// Map of resource tags to associate with the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (o LookupFirewallResultOutput) Tags() pulumi.StringMapOutput {
	return o.ApplyT(func(v LookupFirewallResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
}

// String token used when updating a firewall.
func (o LookupFirewallResultOutput) UpdateToken() pulumi.StringOutput {
	return o.ApplyT(func(v LookupFirewallResult) string { return v.UpdateToken }).(pulumi.StringOutput)
}

// Unique identifier of the VPC where AWS Network Firewall should create the firewall.
func (o LookupFirewallResultOutput) VpcId() pulumi.StringOutput {
	return o.ApplyT(func(v LookupFirewallResult) string { return v.VpcId }).(pulumi.StringOutput)
}

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