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

cloudngfwaws.Ngfw

Explore with Pulumi AI

Example Usage

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

const rs = new cloudngfwaws.CommitRulestack("rs", {rulestack: "my-rulestack"});
const exampleVpc = new aws.index.Vpc("example", {
    cidrBlock: "172.16.0.0/16",
    tags: {
        name: "tf-example",
    },
});
const subnet1 = new aws.index.Subnet("subnet1", {
    vpcId: myVpc.id,
    cidrBlock: "172.16.10.0/24",
    availabilityZone: "us-west-2a",
    tags: {
        name: "tf-example",
    },
});
const subnet2 = new aws.index.Subnet("subnet2", {
    vpcId: myVpc.id,
    cidrBlock: "172.16.20.0/24",
    availabilityZone: "us-west-2b",
    tags: {
        name: "tf-example",
    },
});
const example = new cloudngfwaws.Ngfw("example", {
    name: "example-instance",
    vpcId: exampleVpc.id,
    accountId: "12345678",
    description: "Example description",
    linkId: "Link-81e80ccc-357a-4e4e-8325-1ed1d830cba5",
    endpointMode: "ServiceManaged",
    subnetMappings: [
        {
            subnetId: subnet1.id,
        },
        {
            subnetId: subnet2.id,
        },
    ],
    rulestack: rs.rulestack,
    tags: {
        Foo: "bar",
    },
});
Copy
import pulumi
import pulumi_aws as aws
import pulumi_cloudngfwaws as cloudngfwaws

rs = cloudngfwaws.CommitRulestack("rs", rulestack="my-rulestack")
example_vpc = aws.index.Vpc("example",
    cidr_block=172.16.0.0/16,
    tags={
        name: tf-example,
    })
subnet1 = aws.index.Subnet("subnet1",
    vpc_id=my_vpc.id,
    cidr_block=172.16.10.0/24,
    availability_zone=us-west-2a,
    tags={
        name: tf-example,
    })
subnet2 = aws.index.Subnet("subnet2",
    vpc_id=my_vpc.id,
    cidr_block=172.16.20.0/24,
    availability_zone=us-west-2b,
    tags={
        name: tf-example,
    })
example = cloudngfwaws.Ngfw("example",
    name="example-instance",
    vpc_id=example_vpc["id"],
    account_id="12345678",
    description="Example description",
    link_id="Link-81e80ccc-357a-4e4e-8325-1ed1d830cba5",
    endpoint_mode="ServiceManaged",
    subnet_mappings=[
        {
            "subnet_id": subnet1["id"],
        },
        {
            "subnet_id": subnet2["id"],
        },
    ],
    rulestack=rs.rulestack,
    tags={
        "Foo": "bar",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/go/aws"
	"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 {
		rs, err := cloudngfwaws.NewCommitRulestack(ctx, "rs", &cloudngfwaws.CommitRulestackArgs{
			Rulestack: pulumi.String("my-rulestack"),
		})
		if err != nil {
			return err
		}
		exampleVpc, err := aws.NewVpc(ctx, "example", &aws.VpcArgs{
			CidrBlock: "172.16.0.0/16",
			Tags: map[string]interface{}{
				"name": "tf-example",
			},
		})
		if err != nil {
			return err
		}
		subnet1, err := aws.NewSubnet(ctx, "subnet1", &aws.SubnetArgs{
			VpcId:            myVpc.Id,
			CidrBlock:        "172.16.10.0/24",
			AvailabilityZone: "us-west-2a",
			Tags: map[string]interface{}{
				"name": "tf-example",
			},
		})
		if err != nil {
			return err
		}
		subnet2, err := aws.NewSubnet(ctx, "subnet2", &aws.SubnetArgs{
			VpcId:            myVpc.Id,
			CidrBlock:        "172.16.20.0/24",
			AvailabilityZone: "us-west-2b",
			Tags: map[string]interface{}{
				"name": "tf-example",
			},
		})
		if err != nil {
			return err
		}
		_, err = cloudngfwaws.NewNgfw(ctx, "example", &cloudngfwaws.NgfwArgs{
			Name:         pulumi.String("example-instance"),
			VpcId:        exampleVpc.Id,
			AccountId:    pulumi.String("12345678"),
			Description:  pulumi.String("Example description"),
			LinkId:       pulumi.String("Link-81e80ccc-357a-4e4e-8325-1ed1d830cba5"),
			EndpointMode: pulumi.String("ServiceManaged"),
			SubnetMappings: cloudngfwaws.NgfwSubnetMappingArray{
				&cloudngfwaws.NgfwSubnetMappingArgs{
					SubnetId: subnet1.Id,
				},
				&cloudngfwaws.NgfwSubnetMappingArgs{
					SubnetId: subnet2.Id,
				},
			},
			Rulestack: rs.Rulestack,
			Tags: pulumi.StringMap{
				"Foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using CloudNgfwAws = Pulumi.CloudNgfwAws;

return await Deployment.RunAsync(() => 
{
    var rs = new CloudNgfwAws.CommitRulestack("rs", new()
    {
        Rulestack = "my-rulestack",
    });

    var exampleVpc = new Aws.Index.Vpc("example", new()
    {
        CidrBlock = "172.16.0.0/16",
        Tags = 
        {
            { "name", "tf-example" },
        },
    });

    var subnet1 = new Aws.Index.Subnet("subnet1", new()
    {
        VpcId = myVpc.Id,
        CidrBlock = "172.16.10.0/24",
        AvailabilityZone = "us-west-2a",
        Tags = 
        {
            { "name", "tf-example" },
        },
    });

    var subnet2 = new Aws.Index.Subnet("subnet2", new()
    {
        VpcId = myVpc.Id,
        CidrBlock = "172.16.20.0/24",
        AvailabilityZone = "us-west-2b",
        Tags = 
        {
            { "name", "tf-example" },
        },
    });

    var example = new CloudNgfwAws.Ngfw("example", new()
    {
        Name = "example-instance",
        VpcId = exampleVpc.Id,
        AccountId = "12345678",
        Description = "Example description",
        LinkId = "Link-81e80ccc-357a-4e4e-8325-1ed1d830cba5",
        EndpointMode = "ServiceManaged",
        SubnetMappings = new[]
        {
            new CloudNgfwAws.Inputs.NgfwSubnetMappingArgs
            {
                SubnetId = subnet1.Id,
            },
            new CloudNgfwAws.Inputs.NgfwSubnetMappingArgs
            {
                SubnetId = subnet2.Id,
            },
        },
        Rulestack = rs.Rulestack,
        Tags = 
        {
            { "Foo", "bar" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudngfwaws.CommitRulestack;
import com.pulumi.cloudngfwaws.CommitRulestackArgs;
import com.pulumi.aws.vpc;
import com.pulumi.aws.VpcArgs;
import com.pulumi.aws.subnet;
import com.pulumi.aws.SubnetArgs;
import com.pulumi.cloudngfwaws.Ngfw;
import com.pulumi.cloudngfwaws.NgfwArgs;
import com.pulumi.cloudngfwaws.inputs.NgfwSubnetMappingArgs;
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) {
        var rs = new CommitRulestack("rs", CommitRulestackArgs.builder()
            .rulestack("my-rulestack")
            .build());

        var exampleVpc = new Vpc("exampleVpc", VpcArgs.builder()
            .cidrBlock("172.16.0.0/16")
            .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

        var subnet1 = new Subnet("subnet1", SubnetArgs.builder()
            .vpcId(myVpc.id())
            .cidrBlock("172.16.10.0/24")
            .availabilityZone("us-west-2a")
            .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

        var subnet2 = new Subnet("subnet2", SubnetArgs.builder()
            .vpcId(myVpc.id())
            .cidrBlock("172.16.20.0/24")
            .availabilityZone("us-west-2b")
            .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

        var example = new Ngfw("example", NgfwArgs.builder()
            .name("example-instance")
            .vpcId(exampleVpc.id())
            .accountId("12345678")
            .description("Example description")
            .linkId("Link-81e80ccc-357a-4e4e-8325-1ed1d830cba5")
            .endpointMode("ServiceManaged")
            .subnetMappings(            
                NgfwSubnetMappingArgs.builder()
                    .subnetId(subnet1.id())
                    .build(),
                NgfwSubnetMappingArgs.builder()
                    .subnetId(subnet2.id())
                    .build())
            .rulestack(rs.rulestack())
            .tags(Map.of("Foo", "bar"))
            .build());

    }
}
Copy
resources:
  example:
    type: cloudngfwaws:Ngfw
    properties:
      name: example-instance
      vpcId: ${exampleVpc.id}
      accountId: '12345678'
      description: Example description
      linkId: Link-81e80ccc-357a-4e4e-8325-1ed1d830cba5
      endpointMode: ServiceManaged
      subnetMappings:
        - subnetId: ${subnet1.id}
        - subnetId: ${subnet2.id}
      rulestack: ${rs.rulestack}
      tags:
        Foo: bar
  rs:
    type: cloudngfwaws:CommitRulestack
    properties:
      rulestack: my-rulestack
  exampleVpc:
    type: aws:vpc
    name: example
    properties:
      cidrBlock: 172.16.0.0/16
      tags:
        name: tf-example
  subnet1:
    type: aws:subnet
    properties:
      vpcId: ${myVpc.id}
      cidrBlock: 172.16.10.0/24
      availabilityZone: us-west-2a
      tags:
        name: tf-example
  subnet2:
    type: aws:subnet
    properties:
      vpcId: ${myVpc.id}
      cidrBlock: 172.16.20.0/24
      availabilityZone: us-west-2b
      tags:
        name: tf-example
Copy

Create Ngfw Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Ngfw(name: string, args: NgfwArgs, opts?: CustomResourceOptions);
@overload
def Ngfw(resource_name: str,
         args: NgfwArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Ngfw(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         endpoint_mode: Optional[str] = None,
         vpc_id: Optional[str] = None,
         subnet_mappings: Optional[Sequence[NgfwSubnetMappingArgs]] = None,
         link_id: Optional[str] = None,
         description: Optional[str] = None,
         global_rulestack: Optional[str] = None,
         account_id: Optional[str] = None,
         multi_vpc: Optional[bool] = None,
         name: Optional[str] = None,
         rulestack: Optional[str] = None,
         automatic_upgrade_app_id_version: Optional[bool] = None,
         tags: Optional[Mapping[str, str]] = None,
         app_id_version: Optional[str] = None)
func NewNgfw(ctx *Context, name string, args NgfwArgs, opts ...ResourceOption) (*Ngfw, error)
public Ngfw(string name, NgfwArgs args, CustomResourceOptions? opts = null)
public Ngfw(String name, NgfwArgs args)
public Ngfw(String name, NgfwArgs args, CustomResourceOptions options)
type: cloudngfwaws:Ngfw
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NgfwArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. NgfwArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. NgfwArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NgfwArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NgfwArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var ngfwResource = new CloudNgfwAws.Ngfw("ngfwResource", new()
{
    EndpointMode = "string",
    VpcId = "string",
    SubnetMappings = new[]
    {
        new CloudNgfwAws.Inputs.NgfwSubnetMappingArgs
        {
            AvailabilityZone = "string",
            AvailabilityZoneId = "string",
            SubnetId = "string",
        },
    },
    LinkId = "string",
    Description = "string",
    GlobalRulestack = "string",
    AccountId = "string",
    MultiVpc = false,
    Name = "string",
    Rulestack = "string",
    AutomaticUpgradeAppIdVersion = false,
    Tags = 
    {
        { "string", "string" },
    },
    AppIdVersion = "string",
});
Copy
example, err := cloudngfwaws.NewNgfw(ctx, "ngfwResource", &cloudngfwaws.NgfwArgs{
	EndpointMode: pulumi.String("string"),
	VpcId:        pulumi.String("string"),
	SubnetMappings: cloudngfwaws.NgfwSubnetMappingArray{
		&cloudngfwaws.NgfwSubnetMappingArgs{
			AvailabilityZone:   pulumi.String("string"),
			AvailabilityZoneId: pulumi.String("string"),
			SubnetId:           pulumi.String("string"),
		},
	},
	LinkId:                       pulumi.String("string"),
	Description:                  pulumi.String("string"),
	GlobalRulestack:              pulumi.String("string"),
	AccountId:                    pulumi.String("string"),
	MultiVpc:                     pulumi.Bool(false),
	Name:                         pulumi.String("string"),
	Rulestack:                    pulumi.String("string"),
	AutomaticUpgradeAppIdVersion: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AppIdVersion: pulumi.String("string"),
})
Copy
var ngfwResource = new Ngfw("ngfwResource", NgfwArgs.builder()
    .endpointMode("string")
    .vpcId("string")
    .subnetMappings(NgfwSubnetMappingArgs.builder()
        .availabilityZone("string")
        .availabilityZoneId("string")
        .subnetId("string")
        .build())
    .linkId("string")
    .description("string")
    .globalRulestack("string")
    .accountId("string")
    .multiVpc(false)
    .name("string")
    .rulestack("string")
    .automaticUpgradeAppIdVersion(false)
    .tags(Map.of("string", "string"))
    .appIdVersion("string")
    .build());
Copy
ngfw_resource = cloudngfwaws.Ngfw("ngfwResource",
    endpoint_mode="string",
    vpc_id="string",
    subnet_mappings=[{
        "availability_zone": "string",
        "availability_zone_id": "string",
        "subnet_id": "string",
    }],
    link_id="string",
    description="string",
    global_rulestack="string",
    account_id="string",
    multi_vpc=False,
    name="string",
    rulestack="string",
    automatic_upgrade_app_id_version=False,
    tags={
        "string": "string",
    },
    app_id_version="string")
Copy
const ngfwResource = new cloudngfwaws.Ngfw("ngfwResource", {
    endpointMode: "string",
    vpcId: "string",
    subnetMappings: [{
        availabilityZone: "string",
        availabilityZoneId: "string",
        subnetId: "string",
    }],
    linkId: "string",
    description: "string",
    globalRulestack: "string",
    accountId: "string",
    multiVpc: false,
    name: "string",
    rulestack: "string",
    automaticUpgradeAppIdVersion: false,
    tags: {
        string: "string",
    },
    appIdVersion: "string",
});
Copy
type: cloudngfwaws:Ngfw
properties:
    accountId: string
    appIdVersion: string
    automaticUpgradeAppIdVersion: false
    description: string
    endpointMode: string
    globalRulestack: string
    linkId: string
    multiVpc: false
    name: string
    rulestack: string
    subnetMappings:
        - availabilityZone: string
          availabilityZoneId: string
          subnetId: string
    tags:
        string: string
    vpcId: string
Copy

Ngfw Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Ngfw resource accepts the following input properties:

EndpointMode
This property is required.
Changes to this property will trigger replacement.
string
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
SubnetMappings This property is required. List<Pulumi.CloudNgfwAws.Inputs.NgfwSubnetMapping>
Subnet mappings.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
The vpc id.
AccountId Changes to this property will trigger replacement. 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. Defaults to true.
Description string
The description.
GlobalRulestack Changes to this property will trigger replacement. string
The global rulestack for this NGFW.
LinkId string
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
MultiVpc bool
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
Name Changes to this property will trigger replacement. string
The NGFW name.
Rulestack string
The rulestack for this NGFW.
Tags Dictionary<string, string>
The tags.
EndpointMode
This property is required.
Changes to this property will trigger replacement.
string
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
SubnetMappings This property is required. []NgfwSubnetMappingArgs
Subnet mappings.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
The vpc id.
AccountId Changes to this property will trigger replacement. 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. Defaults to true.
Description string
The description.
GlobalRulestack Changes to this property will trigger replacement. string
The global rulestack for this NGFW.
LinkId string
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
MultiVpc bool
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
Name Changes to this property will trigger replacement. string
The NGFW name.
Rulestack string
The rulestack for this NGFW.
Tags map[string]string
The tags.
endpointMode
This property is required.
Changes to this property will trigger replacement.
String
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
subnetMappings This property is required. List<NgfwSubnetMapping>
Subnet mappings.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
The vpc id.
accountId Changes to this property will trigger replacement. 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. Defaults to true.
description String
The description.
globalRulestack Changes to this property will trigger replacement. String
The global rulestack for this NGFW.
linkId String
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
multiVpc Boolean
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
name Changes to this property will trigger replacement. String
The NGFW name.
rulestack String
The rulestack for this NGFW.
tags Map<String,String>
The tags.
endpointMode
This property is required.
Changes to this property will trigger replacement.
string
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
subnetMappings This property is required. NgfwSubnetMapping[]
Subnet mappings.
vpcId
This property is required.
Changes to this property will trigger replacement.
string
The vpc id.
accountId Changes to this property will trigger replacement. 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. Defaults to true.
description string
The description.
globalRulestack Changes to this property will trigger replacement. string
The global rulestack for this NGFW.
linkId string
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
multiVpc boolean
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
name Changes to this property will trigger replacement. string
The NGFW name.
rulestack string
The rulestack for this NGFW.
tags {[key: string]: string}
The tags.
endpoint_mode
This property is required.
Changes to this property will trigger replacement.
str
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
subnet_mappings This property is required. Sequence[NgfwSubnetMappingArgs]
Subnet mappings.
vpc_id
This property is required.
Changes to this property will trigger replacement.
str
The vpc id.
account_id Changes to this property will trigger replacement. str
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. Defaults to true.
description str
The description.
global_rulestack Changes to this property will trigger replacement. str
The global rulestack for this NGFW.
link_id str
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
multi_vpc bool
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
name Changes to this property will trigger replacement. str
The NGFW name.
rulestack str
The rulestack for this NGFW.
tags Mapping[str, str]
The tags.
endpointMode
This property is required.
Changes to this property will trigger replacement.
String
Set endpoint mode from the following options. Valid values are ServiceManaged or CustomerManaged.
subnetMappings This property is required. List<Property Map>
Subnet mappings.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
The vpc id.
accountId Changes to this property will trigger replacement. 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. Defaults to true.
description String
The description.
globalRulestack Changes to this property will trigger replacement. String
The global rulestack for this NGFW.
linkId String
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
multiVpc Boolean
Share NGFW with Multiple VPCs. This feature can be enabled only if the endpoint_mode is CustomerManaged.
name Changes to this property will trigger replacement. String
The NGFW name.
rulestack String
The rulestack for this NGFW.
tags Map<String>
The tags.

Outputs

All input properties are implicitly available as output properties. Additionally, the Ngfw resource produces the following output properties:

EndpointServiceName string
The endpoint service name.
FirewallId string
The Id of the NGFW.
Id string
The provider-assigned unique ID for this managed resource.
LinkStatus string
The link status.
Statuses List<Pulumi.CloudNgfwAws.Outputs.NgfwStatus>
UpdateToken string
The update token.
EndpointServiceName string
The endpoint service name.
FirewallId string
The Id of the NGFW.
Id string
The provider-assigned unique ID for this managed resource.
LinkStatus string
The link status.
Statuses []NgfwStatus
UpdateToken string
The update token.
endpointServiceName String
The endpoint service name.
firewallId String
The Id of the NGFW.
id String
The provider-assigned unique ID for this managed resource.
linkStatus String
The link status.
statuses List<NgfwStatus>
updateToken String
The update token.
endpointServiceName string
The endpoint service name.
firewallId string
The Id of the NGFW.
id string
The provider-assigned unique ID for this managed resource.
linkStatus string
The link status.
statuses NgfwStatus[]
updateToken string
The update token.
endpoint_service_name str
The endpoint service name.
firewall_id str
The Id of the NGFW.
id str
The provider-assigned unique ID for this managed resource.
link_status str
The link status.
statuses Sequence[NgfwStatus]
update_token str
The update token.
endpointServiceName String
The endpoint service name.
firewallId String
The Id of the NGFW.
id String
The provider-assigned unique ID for this managed resource.
linkStatus String
The link status.
statuses List<Property Map>
updateToken String
The update token.

Look up Existing Ngfw Resource

Get an existing Ngfw resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NgfwState, opts?: CustomResourceOptions): Ngfw
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        app_id_version: Optional[str] = None,
        automatic_upgrade_app_id_version: Optional[bool] = None,
        description: Optional[str] = None,
        endpoint_mode: Optional[str] = None,
        endpoint_service_name: Optional[str] = None,
        firewall_id: Optional[str] = None,
        global_rulestack: Optional[str] = None,
        link_id: Optional[str] = None,
        link_status: Optional[str] = None,
        multi_vpc: Optional[bool] = None,
        name: Optional[str] = None,
        rulestack: Optional[str] = None,
        statuses: Optional[Sequence[NgfwStatusArgs]] = None,
        subnet_mappings: Optional[Sequence[NgfwSubnetMappingArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        update_token: Optional[str] = None,
        vpc_id: Optional[str] = None) -> Ngfw
func GetNgfw(ctx *Context, name string, id IDInput, state *NgfwState, opts ...ResourceOption) (*Ngfw, error)
public static Ngfw Get(string name, Input<string> id, NgfwState? state, CustomResourceOptions? opts = null)
public static Ngfw get(String name, Output<String> id, NgfwState state, CustomResourceOptions options)
resources:  _:    type: cloudngfwaws:Ngfw    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountId Changes to this property will trigger replacement. 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. Defaults to true.
Description string
The description.
EndpointMode Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
The global rulestack for this NGFW.
LinkId string
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
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 Changes to this property will trigger replacement. string
The NGFW name.
Rulestack string
The rulestack for this NGFW.
Statuses List<Pulumi.CloudNgfwAws.Inputs.NgfwStatus>
SubnetMappings List<Pulumi.CloudNgfwAws.Inputs.NgfwSubnetMapping>
Subnet mappings.
Tags Dictionary<string, string>
The tags.
UpdateToken string
The update token.
VpcId Changes to this property will trigger replacement. string
The vpc id.
AccountId Changes to this property will trigger replacement. 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. Defaults to true.
Description string
The description.
EndpointMode Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
The global rulestack for this NGFW.
LinkId string
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
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 Changes to this property will trigger replacement. string
The NGFW name.
Rulestack string
The rulestack for this NGFW.
Statuses []NgfwStatusArgs
SubnetMappings []NgfwSubnetMappingArgs
Subnet mappings.
Tags map[string]string
The tags.
UpdateToken string
The update token.
VpcId Changes to this property will trigger replacement. string
The vpc id.
accountId Changes to this property will trigger replacement. 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. Defaults to true.
description String
The description.
endpointMode Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The global rulestack for this NGFW.
linkId String
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
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 Changes to this property will trigger replacement. String
The NGFW name.
rulestack String
The rulestack for this NGFW.
statuses List<NgfwStatus>
subnetMappings List<NgfwSubnetMapping>
Subnet mappings.
tags Map<String,String>
The tags.
updateToken String
The update token.
vpcId Changes to this property will trigger replacement. String
The vpc id.
accountId Changes to this property will trigger replacement. 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. Defaults to true.
description string
The description.
endpointMode Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
The global rulestack for this NGFW.
linkId string
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
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 Changes to this property will trigger replacement. string
The NGFW name.
rulestack string
The rulestack for this NGFW.
statuses NgfwStatus[]
subnetMappings NgfwSubnetMapping[]
Subnet mappings.
tags {[key: string]: string}
The tags.
updateToken string
The update token.
vpcId Changes to this property will trigger replacement. string
The vpc id.
account_id Changes to this property will trigger replacement. str
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. Defaults to true.
description str
The description.
endpoint_mode Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
The global rulestack for this NGFW.
link_id str
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
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 Changes to this property will trigger replacement. str
The NGFW name.
rulestack str
The rulestack for this NGFW.
statuses Sequence[NgfwStatusArgs]
subnet_mappings Sequence[NgfwSubnetMappingArgs]
Subnet mappings.
tags Mapping[str, str]
The tags.
update_token str
The update token.
vpc_id Changes to this property will trigger replacement. str
The vpc id.
accountId Changes to this property will trigger replacement. 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. Defaults to true.
description String
The description.
endpointMode Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The global rulestack for this NGFW.
linkId String
A unique identifier for establishing and managing the link between the Cloud NGFW and other AWS resources.
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The vpc id.

Supporting Types

NgfwStatus
, NgfwStatusArgs

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

NgfwStatusAttachment
, NgfwStatusAttachmentArgs

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

NgfwSubnetMapping
, NgfwSubnetMappingArgs

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

Import

import name is <account_id>:

$ pulumi import cloudngfwaws:index/ngfw:Ngfw example 12345678:example-instance
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
cloudngfwaws pulumi/pulumi-cloudngfwaws
License
Apache-2.0
Notes
This Pulumi package is based on the cloudngfwaws Terraform Provider.