1. Packages
  2. Palo Alto Networks Cloud NGFW for AWS Provider
  3. API Docs
  4. getNgfw
Palo Alto Networks Cloud NGFW for AWS v0.1.1 published on Saturday, Mar 15, 2025 by Pulumi

cloudngfwaws.getNgfw

Explore with Pulumi AI

Palo Alto Networks Cloud NGFW for AWS v0.1.1 published on Saturday, Mar 15, 2025 by Pulumi

Data source for retrieving NGFW information.

Admin Permission Type

  • Firewall

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudngfwaws from "@pulumi/cloudngfwaws";

const example = cloudngfwaws.getNgfw({
    name: "example-instance",
});
Copy
import pulumi
import pulumi_cloudngfwaws as cloudngfwaws

example = cloudngfwaws.get_ngfw(name="example-instance")
Copy
package main

import (
	"github.com/pulumi/pulumi-cloudngfwaws/sdk/go/cloudngfwaws"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudngfwaws.LookupNgfw(ctx, &cloudngfwaws.LookupNgfwArgs{
			Name: "example-instance",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using CloudNgfwAws = Pulumi.CloudNgfwAws;

return await Deployment.RunAsync(() => 
{
    var example = CloudNgfwAws.GetNgfw.Invoke(new()
    {
        Name = "example-instance",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudngfwaws.CloudngfwawsFunctions;
import com.pulumi.cloudngfwaws.inputs.GetNgfwArgs;
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 = CloudngfwawsFunctions.getNgfw(GetNgfwArgs.builder()
            .name("example-instance")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: cloudngfwaws:getNgfw
      arguments:
        name: example-instance
Copy

Using getNgfw

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 getNgfw(args: GetNgfwArgs, opts?: InvokeOptions): Promise<GetNgfwResult>
function getNgfwOutput(args: GetNgfwOutputArgs, opts?: InvokeOptions): Output<GetNgfwResult>
Copy
def get_ngfw(account_id: Optional[str] = None,
             name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetNgfwResult
def get_ngfw_output(account_id: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetNgfwResult]
Copy
func LookupNgfw(ctx *Context, args *LookupNgfwArgs, opts ...InvokeOption) (*LookupNgfwResult, error)
func LookupNgfwOutput(ctx *Context, args *LookupNgfwOutputArgs, opts ...InvokeOption) LookupNgfwResultOutput
Copy

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

public static class GetNgfw 
{
    public static Task<GetNgfwResult> InvokeAsync(GetNgfwArgs args, InvokeOptions? opts = null)
    public static Output<GetNgfwResult> Invoke(GetNgfwInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNgfwResult> getNgfw(GetNgfwArgs args, InvokeOptions options)
public static Output<GetNgfwResult> getNgfw(GetNgfwArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: cloudngfwaws:index/getNgfw:getNgfw
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
The NGFW name.
AccountId Changes to this property will trigger replacement. string
The account ID. This field is mandatory if using multiple accounts.
Name
This property is required.
Changes to this property will trigger replacement.
string
The NGFW name.
AccountId Changes to this property will trigger replacement. string
The account ID. This field is mandatory if using multiple accounts.
name
This property is required.
Changes to this property will trigger replacement.
String
The NGFW name.
accountId Changes to this property will trigger replacement. String
The account ID. This field is mandatory if using multiple accounts.
name
This property is required.
Changes to this property will trigger replacement.
string
The NGFW name.
accountId Changes to this property will trigger replacement. string
The account ID. This field is mandatory if using multiple accounts.
name
This property is required.
Changes to this property will trigger replacement.
str
The NGFW name.
account_id Changes to this property will trigger replacement. str
The account ID. This field is mandatory if using multiple accounts.
name
This property is required.
Changes to this property will trigger replacement.
String
The NGFW name.
accountId Changes to this property will trigger replacement. String
The account ID. This field is mandatory if using multiple accounts.

getNgfw Result

The following output properties are available:

AppIdVersion string
App-ID version number.
AutomaticUpgradeAppIdVersion bool
Automatic App-ID upgrade version number.
Description string
The description.
EndpointMode string
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
EndpointServiceName string
The endpoint service name.
FirewallId string
The Id of the NGFW.
GlobalRulestack string
The global rulestack for this NGFW.
Id string
The provider-assigned unique ID for this managed resource.
LinkId string
The link ID.
LinkStatus string
The link status.
MultiVpc bool
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
Name string
The NGFW name.
Rulestack string
The rulestack for this NGFW.
Statuses List<Pulumi.CloudNgfwAws.Outputs.GetNgfwStatus>
SubnetMappings List<Pulumi.CloudNgfwAws.Outputs.GetNgfwSubnetMapping>
Subnet mappings.
Tags Dictionary<string, string>
The tags.
UpdateToken string
The update token.
VpcId string
The vpc id.
AccountId string
The account ID. This field is mandatory if using multiple accounts.
AppIdVersion string
App-ID version number.
AutomaticUpgradeAppIdVersion bool
Automatic App-ID upgrade version number.
Description string
The description.
EndpointMode string
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
EndpointServiceName string
The endpoint service name.
FirewallId string
The Id of the NGFW.
GlobalRulestack string
The global rulestack for this NGFW.
Id string
The provider-assigned unique ID for this managed resource.
LinkId string
The link ID.
LinkStatus string
The link status.
MultiVpc bool
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
Name string
The NGFW name.
Rulestack string
The rulestack for this NGFW.
Statuses []GetNgfwStatus
SubnetMappings []GetNgfwSubnetMapping
Subnet mappings.
Tags map[string]string
The tags.
UpdateToken string
The update token.
VpcId string
The vpc id.
AccountId string
The account ID. This field is mandatory if using multiple accounts.
appIdVersion String
App-ID version number.
automaticUpgradeAppIdVersion Boolean
Automatic App-ID upgrade version number.
description String
The description.
endpointMode String
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
endpointServiceName String
The endpoint service name.
firewallId String
The Id of the NGFW.
globalRulestack String
The global rulestack for this NGFW.
id String
The provider-assigned unique ID for this managed resource.
linkId String
The link ID.
linkStatus String
The link status.
multiVpc Boolean
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
name String
The NGFW name.
rulestack String
The rulestack for this NGFW.
statuses List<GetNgfwStatus>
subnetMappings List<GetNgfwSubnetMapping>
Subnet mappings.
tags Map<String,String>
The tags.
updateToken String
The update token.
vpcId String
The vpc id.
accountId String
The account ID. This field is mandatory if using multiple accounts.
appIdVersion string
App-ID version number.
automaticUpgradeAppIdVersion boolean
Automatic App-ID upgrade version number.
description string
The description.
endpointMode string
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
endpointServiceName string
The endpoint service name.
firewallId string
The Id of the NGFW.
globalRulestack string
The global rulestack for this NGFW.
id string
The provider-assigned unique ID for this managed resource.
linkId string
The link ID.
linkStatus string
The link status.
multiVpc boolean
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
name string
The NGFW name.
rulestack string
The rulestack for this NGFW.
statuses GetNgfwStatus[]
subnetMappings GetNgfwSubnetMapping[]
Subnet mappings.
tags {[key: string]: string}
The tags.
updateToken string
The update token.
vpcId string
The vpc id.
accountId string
The account ID. This field is mandatory if using multiple accounts.
app_id_version str
App-ID version number.
automatic_upgrade_app_id_version bool
Automatic App-ID upgrade version number.
description str
The description.
endpoint_mode str
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
endpoint_service_name str
The endpoint service name.
firewall_id str
The Id of the NGFW.
global_rulestack str
The global rulestack for this NGFW.
id str
The provider-assigned unique ID for this managed resource.
link_id str
The link ID.
link_status str
The link status.
multi_vpc bool
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
name str
The NGFW name.
rulestack str
The rulestack for this NGFW.
statuses Sequence[GetNgfwStatus]
subnet_mappings Sequence[GetNgfwSubnetMapping]
Subnet mappings.
tags Mapping[str, str]
The tags.
update_token str
The update token.
vpc_id str
The vpc id.
account_id str
The account ID. This field is mandatory if using multiple accounts.
appIdVersion String
App-ID version number.
automaticUpgradeAppIdVersion Boolean
Automatic App-ID upgrade version number.
description String
The description.
endpointMode String
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
endpointServiceName String
The endpoint service name.
firewallId String
The Id of the NGFW.
globalRulestack String
The global rulestack for this NGFW.
id String
The provider-assigned unique ID for this managed resource.
linkId String
The link ID.
linkStatus String
The link status.
multiVpc Boolean
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
name String
The NGFW name.
rulestack String
The rulestack for this NGFW.
statuses List<Property Map>
subnetMappings List<Property Map>
Subnet mappings.
tags Map<String>
The tags.
updateToken String
The update token.
vpcId String
The vpc id.
accountId String
The account ID. This field is mandatory if using multiple accounts.

Supporting Types

GetNgfwStatus

Attachments This property is required. List<Pulumi.CloudNgfwAws.Inputs.GetNgfwStatusAttachment>
The firewall attachments.
FailureReason This property is required. string
The firewall failure reason.
FirewallStatus This property is required. string
The firewall status.
RulestackStatus This property is required. string
The rulestack status.
Attachments This property is required. []GetNgfwStatusAttachment
The firewall attachments.
FailureReason This property is required. string
The firewall failure reason.
FirewallStatus This property is required. string
The firewall status.
RulestackStatus This property is required. string
The rulestack status.
attachments This property is required. List<GetNgfwStatusAttachment>
The firewall attachments.
failureReason This property is required. String
The firewall failure reason.
firewallStatus This property is required. String
The firewall status.
rulestackStatus This property is required. String
The rulestack status.
attachments This property is required. GetNgfwStatusAttachment[]
The firewall attachments.
failureReason This property is required. string
The firewall failure reason.
firewallStatus This property is required. string
The firewall status.
rulestackStatus This property is required. string
The rulestack status.
attachments This property is required. Sequence[GetNgfwStatusAttachment]
The firewall attachments.
failure_reason This property is required. str
The firewall failure reason.
firewall_status This property is required. str
The firewall status.
rulestack_status This property is required. str
The rulestack status.
attachments This property is required. List<Property Map>
The firewall attachments.
failureReason This property is required. String
The firewall failure reason.
firewallStatus This property is required. String
The firewall status.
rulestackStatus This property is required. String
The rulestack status.

GetNgfwStatusAttachment

EndpointId This property is required. string
The endpoint id.
RejectedReason This property is required. string
The reject reason.
Status This property is required. string
The attachment status.
SubnetId This property is required. string
The subnet id.
EndpointId This property is required. string
The endpoint id.
RejectedReason This property is required. string
The reject reason.
Status This property is required. string
The attachment status.
SubnetId This property is required. string
The subnet id.
endpointId This property is required. String
The endpoint id.
rejectedReason This property is required. String
The reject reason.
status This property is required. String
The attachment status.
subnetId This property is required. String
The subnet id.
endpointId This property is required. string
The endpoint id.
rejectedReason This property is required. string
The reject reason.
status This property is required. string
The attachment status.
subnetId This property is required. string
The subnet id.
endpoint_id This property is required. str
The endpoint id.
rejected_reason This property is required. str
The reject reason.
status This property is required. str
The attachment status.
subnet_id This property is required. str
The subnet id.
endpointId This property is required. String
The endpoint id.
rejectedReason This property is required. String
The reject reason.
status This property is required. String
The attachment status.
subnetId This property is required. String
The subnet id.

GetNgfwSubnetMapping

AvailabilityZone This property is required. string
The availability zone, for when the endpoint mode is customer managed.
AvailabilityZoneId This property is required. string
The availability zone ID, for when the endpoint mode is customer managed.
SubnetId This property is required. string
The subnet id, for when the endpoint mode is service managed.
AvailabilityZone This property is required. string
The availability zone, for when the endpoint mode is customer managed.
AvailabilityZoneId This property is required. string
The availability zone ID, for when the endpoint mode is customer managed.
SubnetId This property is required. string
The subnet id, for when the endpoint mode is service managed.
availabilityZone This property is required. String
The availability zone, for when the endpoint mode is customer managed.
availabilityZoneId This property is required. String
The availability zone ID, for when the endpoint mode is customer managed.
subnetId This property is required. String
The subnet id, for when the endpoint mode is service managed.
availabilityZone This property is required. string
The availability zone, for when the endpoint mode is customer managed.
availabilityZoneId This property is required. string
The availability zone ID, for when the endpoint mode is customer managed.
subnetId This property is required. string
The subnet id, for when the endpoint mode is service managed.
availability_zone This property is required. str
The availability zone, for when the endpoint mode is customer managed.
availability_zone_id This property is required. str
The availability zone ID, for when the endpoint mode is customer managed.
subnet_id This property is required. str
The subnet id, for when the endpoint mode is service managed.
availabilityZone This property is required. String
The availability zone, for when the endpoint mode is customer managed.
availabilityZoneId This property is required. String
The availability zone ID, for when the endpoint mode is customer managed.
subnetId This property is required. String
The subnet id, for when the endpoint mode is service managed.

Package Details

Repository
cloudngfwaws pulumi/pulumi-cloudngfwaws
License
Apache-2.0
Notes
This Pulumi package is based on the cloudngfwaws Terraform Provider.
Palo Alto Networks Cloud NGFW for AWS v0.1.1 published on Saturday, Mar 15, 2025 by Pulumi