1. Packages
  2. Palo Alto Networks Cloud NGFW For AWS Provider
  3. API Docs
  4. PrefixList
Palo Alto Networks Cloud NGFW for AWS v0.0.2 published on Wednesday, Nov 13, 2024 by Pulumi

cloudngfwaws.PrefixList

Explore with Pulumi AI

cloudngfwaws logo
Palo Alto Networks Cloud NGFW for AWS v0.0.2 published on Wednesday, Nov 13, 2024 by Pulumi

    Resource for prefix list manipulation.

    Admin Permission Type

    • Rulestack (for scope="Local")
    • Global Rulestack (for scope="Global")

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudngfwaws from "@pulumi/cloudngfwaws";
    
    const r = new cloudngfwaws.Rulestack("r", {
        name: "terraform-rulestack",
        scope: "Local",
        accountId: "123456789",
        description: "Made by Pulumi",
        profileConfig: {
            antiSpyware: "BestPractice",
        },
    });
    const example = new cloudngfwaws.PrefixList("example", {
        rulestack: r.name,
        name: "tf-prefix-list",
        description: "Also configured by Terraform",
        prefixLists: [
            "192.168.0.0",
            "10.1.5.0",
        ],
        auditComment: "initial config",
    });
    
    import pulumi
    import pulumi_cloudngfwaws as cloudngfwaws
    
    r = cloudngfwaws.Rulestack("r",
        name="terraform-rulestack",
        scope="Local",
        account_id="123456789",
        description="Made by Pulumi",
        profile_config={
            "anti_spyware": "BestPractice",
        })
    example = cloudngfwaws.PrefixList("example",
        rulestack=r.name,
        name="tf-prefix-list",
        description="Also configured by Terraform",
        prefix_lists=[
            "192.168.0.0",
            "10.1.5.0",
        ],
        audit_comment="initial config")
    
    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 {
    		r, err := cloudngfwaws.NewRulestack(ctx, "r", &cloudngfwaws.RulestackArgs{
    			Name:        pulumi.String("terraform-rulestack"),
    			Scope:       pulumi.String("Local"),
    			AccountId:   pulumi.String("123456789"),
    			Description: pulumi.String("Made by Pulumi"),
    			ProfileConfig: &cloudngfwaws.RulestackProfileConfigArgs{
    				AntiSpyware: pulumi.String("BestPractice"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = cloudngfwaws.NewPrefixList(ctx, "example", &cloudngfwaws.PrefixListArgs{
    			Rulestack:   r.Name,
    			Name:        pulumi.String("tf-prefix-list"),
    			Description: pulumi.String("Also configured by Terraform"),
    			PrefixLists: pulumi.StringArray{
    				pulumi.String("192.168.0.0"),
    				pulumi.String("10.1.5.0"),
    			},
    			AuditComment: pulumi.String("initial config"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using CloudNgfwAws = Pulumi.CloudNgfwAws;
    
    return await Deployment.RunAsync(() => 
    {
        var r = new CloudNgfwAws.Rulestack("r", new()
        {
            Name = "terraform-rulestack",
            Scope = "Local",
            AccountId = "123456789",
            Description = "Made by Pulumi",
            ProfileConfig = new CloudNgfwAws.Inputs.RulestackProfileConfigArgs
            {
                AntiSpyware = "BestPractice",
            },
        });
    
        var example = new CloudNgfwAws.PrefixList("example", new()
        {
            Rulestack = r.Name,
            Name = "tf-prefix-list",
            Description = "Also configured by Terraform",
            PrefixLists = new[]
            {
                "192.168.0.0",
                "10.1.5.0",
            },
            AuditComment = "initial config",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudngfwaws.Rulestack;
    import com.pulumi.cloudngfwaws.RulestackArgs;
    import com.pulumi.cloudngfwaws.inputs.RulestackProfileConfigArgs;
    import com.pulumi.cloudngfwaws.PrefixList;
    import com.pulumi.cloudngfwaws.PrefixListArgs;
    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 r = new Rulestack("r", RulestackArgs.builder()
                .name("terraform-rulestack")
                .scope("Local")
                .accountId("123456789")
                .description("Made by Pulumi")
                .profileConfig(RulestackProfileConfigArgs.builder()
                    .antiSpyware("BestPractice")
                    .build())
                .build());
    
            var example = new PrefixList("example", PrefixListArgs.builder()
                .rulestack(r.name())
                .name("tf-prefix-list")
                .description("Also configured by Terraform")
                .prefixLists(            
                    "192.168.0.0",
                    "10.1.5.0")
                .auditComment("initial config")
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudngfwaws:PrefixList
        properties:
          rulestack: ${r.name}
          name: tf-prefix-list
          description: Also configured by Terraform
          prefixLists:
            - 192.168.0.0
            - 10.1.5.0
          auditComment: initial config
      r:
        type: cloudngfwaws:Rulestack
        properties:
          name: terraform-rulestack
          scope: Local
          accountId: '123456789'
          description: Made by Pulumi
          profileConfig:
            antiSpyware: BestPractice
    

    Create PrefixList Resource

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

    Constructor syntax

    new PrefixList(name: string, args: PrefixListArgs, opts?: CustomResourceOptions);
    @overload
    def PrefixList(resource_name: str,
                   args: PrefixListArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def PrefixList(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   prefix_lists: Optional[Sequence[str]] = None,
                   rulestack: Optional[str] = None,
                   audit_comment: Optional[str] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None,
                   scope: Optional[str] = None)
    func NewPrefixList(ctx *Context, name string, args PrefixListArgs, opts ...ResourceOption) (*PrefixList, error)
    public PrefixList(string name, PrefixListArgs args, CustomResourceOptions? opts = null)
    public PrefixList(String name, PrefixListArgs args)
    public PrefixList(String name, PrefixListArgs args, CustomResourceOptions options)
    
    type: cloudngfwaws:PrefixList
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PrefixListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PrefixListArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PrefixListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrefixListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrefixListArgs
    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 prefixListResource = new CloudNgfwAws.PrefixList("prefixListResource", new()
    {
        PrefixLists = new[]
        {
            "string",
        },
        Rulestack = "string",
        AuditComment = "string",
        Description = "string",
        Name = "string",
        Scope = "string",
    });
    
    example, err := cloudngfwaws.NewPrefixList(ctx, "prefixListResource", &cloudngfwaws.PrefixListArgs{
    	PrefixLists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Rulestack:    pulumi.String("string"),
    	AuditComment: pulumi.String("string"),
    	Description:  pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	Scope:        pulumi.String("string"),
    })
    
    var prefixListResource = new PrefixList("prefixListResource", PrefixListArgs.builder()
        .prefixLists("string")
        .rulestack("string")
        .auditComment("string")
        .description("string")
        .name("string")
        .scope("string")
        .build());
    
    prefix_list_resource = cloudngfwaws.PrefixList("prefixListResource",
        prefix_lists=["string"],
        rulestack="string",
        audit_comment="string",
        description="string",
        name="string",
        scope="string")
    
    const prefixListResource = new cloudngfwaws.PrefixList("prefixListResource", {
        prefixLists: ["string"],
        rulestack: "string",
        auditComment: "string",
        description: "string",
        name: "string",
        scope: "string",
    });
    
    type: cloudngfwaws:PrefixList
    properties:
        auditComment: string
        description: string
        name: string
        prefixLists:
            - string
        rulestack: string
        scope: string
    

    PrefixList 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 PrefixList resource accepts the following input properties:

    PrefixLists List<string>
    The prefix list.
    Rulestack string
    The rulestack.
    AuditComment string
    The audit comment.
    Description string
    The description.
    Name string
    The name.
    Scope string
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.
    PrefixLists []string
    The prefix list.
    Rulestack string
    The rulestack.
    AuditComment string
    The audit comment.
    Description string
    The description.
    Name string
    The name.
    Scope string
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.
    prefixLists List<String>
    The prefix list.
    rulestack String
    The rulestack.
    auditComment String
    The audit comment.
    description String
    The description.
    name String
    The name.
    scope String
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.
    prefixLists string[]
    The prefix list.
    rulestack string
    The rulestack.
    auditComment string
    The audit comment.
    description string
    The description.
    name string
    The name.
    scope string
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.
    prefix_lists Sequence[str]
    The prefix list.
    rulestack str
    The rulestack.
    audit_comment str
    The audit comment.
    description str
    The description.
    name str
    The name.
    scope str
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.
    prefixLists List<String>
    The prefix list.
    rulestack String
    The rulestack.
    auditComment String
    The audit comment.
    description String
    The description.
    name String
    The name.
    scope String
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateToken string
    The update token.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateToken string
    The update token.
    id String
    The provider-assigned unique ID for this managed resource.
    updateToken String
    The update token.
    id string
    The provider-assigned unique ID for this managed resource.
    updateToken string
    The update token.
    id str
    The provider-assigned unique ID for this managed resource.
    update_token str
    The update token.
    id String
    The provider-assigned unique ID for this managed resource.
    updateToken String
    The update token.

    Look up Existing PrefixList Resource

    Get an existing PrefixList 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?: PrefixListState, opts?: CustomResourceOptions): PrefixList
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            audit_comment: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            prefix_lists: Optional[Sequence[str]] = None,
            rulestack: Optional[str] = None,
            scope: Optional[str] = None,
            update_token: Optional[str] = None) -> PrefixList
    func GetPrefixList(ctx *Context, name string, id IDInput, state *PrefixListState, opts ...ResourceOption) (*PrefixList, error)
    public static PrefixList Get(string name, Input<string> id, PrefixListState? state, CustomResourceOptions? opts = null)
    public static PrefixList get(String name, Output<String> id, PrefixListState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AuditComment string
    The audit comment.
    Description string
    The description.
    Name string
    The name.
    PrefixLists List<string>
    The prefix list.
    Rulestack string
    The rulestack.
    Scope string
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.
    UpdateToken string
    The update token.
    AuditComment string
    The audit comment.
    Description string
    The description.
    Name string
    The name.
    PrefixLists []string
    The prefix list.
    Rulestack string
    The rulestack.
    Scope string
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.
    UpdateToken string
    The update token.
    auditComment String
    The audit comment.
    description String
    The description.
    name String
    The name.
    prefixLists List<String>
    The prefix list.
    rulestack String
    The rulestack.
    scope String
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.
    updateToken String
    The update token.
    auditComment string
    The audit comment.
    description string
    The description.
    name string
    The name.
    prefixLists string[]
    The prefix list.
    rulestack string
    The rulestack.
    scope string
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.
    updateToken string
    The update token.
    audit_comment str
    The audit comment.
    description str
    The description.
    name str
    The name.
    prefix_lists Sequence[str]
    The prefix list.
    rulestack str
    The rulestack.
    scope str
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.
    update_token str
    The update token.
    auditComment String
    The audit comment.
    description String
    The description.
    name String
    The name.
    prefixLists List<String>
    The prefix list.
    rulestack String
    The rulestack.
    scope String
    The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are Local or Global. Defaults to Local.
    updateToken String
    The update token.

    Import

    import name is ::<prefix_list_name>

    $ pulumi import cloudngfwaws:index/prefixList:PrefixList example Local:terraform-rulestack:tf-prefix-list
    

    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.
    cloudngfwaws logo
    Palo Alto Networks Cloud NGFW for AWS v0.0.2 published on Wednesday, Nov 13, 2024 by Pulumi