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

cloudngfwaws.getCustomUrlCategory

Explore with Pulumi AI

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

    Data source for retrieving custom url category information.

    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: "my-rulestack",
        scope: "Local",
        accountId: "12345",
        description: "Made by Pulumi",
        profileConfig: {
            antiSpyware: "BestPractice",
        },
    });
    const example = cloudngfwaws.getCustomUrlCategoryOutput({
        rulestack: r.name,
        name: "foobar",
    });
    
    import pulumi
    import pulumi_cloudngfwaws as cloudngfwaws
    
    r = cloudngfwaws.Rulestack("r",
        name="my-rulestack",
        scope="Local",
        account_id="12345",
        description="Made by Pulumi",
        profile_config={
            "anti_spyware": "BestPractice",
        })
    example = cloudngfwaws.get_custom_url_category_output(rulestack=r.name,
        name="foobar")
    
    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("my-rulestack"),
    			Scope:       pulumi.String("Local"),
    			AccountId:   pulumi.String("12345"),
    			Description: pulumi.String("Made by Pulumi"),
    			ProfileConfig: &cloudngfwaws.RulestackProfileConfigArgs{
    				AntiSpyware: pulumi.String("BestPractice"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_ = cloudngfwaws.LookupCustomUrlCategoryOutput(ctx, cloudngfwaws.GetCustomUrlCategoryOutputArgs{
    			Rulestack: r.Name,
    			Name:      pulumi.String("foobar"),
    		}, nil)
    		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 = "my-rulestack",
            Scope = "Local",
            AccountId = "12345",
            Description = "Made by Pulumi",
            ProfileConfig = new CloudNgfwAws.Inputs.RulestackProfileConfigArgs
            {
                AntiSpyware = "BestPractice",
            },
        });
    
        var example = CloudNgfwAws.GetCustomUrlCategory.Invoke(new()
        {
            Rulestack = r.Name,
            Name = "foobar",
        });
    
    });
    
    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.CloudngfwawsFunctions;
    import com.pulumi.cloudngfwaws.inputs.GetCustomUrlCategoryArgs;
    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("my-rulestack")
                .scope("Local")
                .accountId("12345")
                .description("Made by Pulumi")
                .profileConfig(RulestackProfileConfigArgs.builder()
                    .antiSpyware("BestPractice")
                    .build())
                .build());
    
            final var example = CloudngfwawsFunctions.getCustomUrlCategory(GetCustomUrlCategoryArgs.builder()
                .rulestack(r.name())
                .name("foobar")
                .build());
    
        }
    }
    
    resources:
      r:
        type: cloudngfwaws:Rulestack
        properties:
          name: my-rulestack
          scope: Local
          accountId: '12345'
          description: Made by Pulumi
          profileConfig:
            antiSpyware: BestPractice
    variables:
      example:
        fn::invoke:
          Function: cloudngfwaws:getCustomUrlCategory
          Arguments:
            rulestack: ${r.name}
            name: foobar
    

    Using getCustomUrlCategory

    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 getCustomUrlCategory(args: GetCustomUrlCategoryArgs, opts?: InvokeOptions): Promise<GetCustomUrlCategoryResult>
    function getCustomUrlCategoryOutput(args: GetCustomUrlCategoryOutputArgs, opts?: InvokeOptions): Output<GetCustomUrlCategoryResult>
    def get_custom_url_category(config_type: Optional[str] = None,
                                name: Optional[str] = None,
                                rulestack: Optional[str] = None,
                                scope: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetCustomUrlCategoryResult
    def get_custom_url_category_output(config_type: Optional[pulumi.Input[str]] = None,
                                name: Optional[pulumi.Input[str]] = None,
                                rulestack: Optional[pulumi.Input[str]] = None,
                                scope: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetCustomUrlCategoryResult]
    func LookupCustomUrlCategory(ctx *Context, args *LookupCustomUrlCategoryArgs, opts ...InvokeOption) (*LookupCustomUrlCategoryResult, error)
    func LookupCustomUrlCategoryOutput(ctx *Context, args *LookupCustomUrlCategoryOutputArgs, opts ...InvokeOption) LookupCustomUrlCategoryResultOutput

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

    public static class GetCustomUrlCategory 
    {
        public static Task<GetCustomUrlCategoryResult> InvokeAsync(GetCustomUrlCategoryArgs args, InvokeOptions? opts = null)
        public static Output<GetCustomUrlCategoryResult> Invoke(GetCustomUrlCategoryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCustomUrlCategoryResult> getCustomUrlCategory(GetCustomUrlCategoryArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: cloudngfwaws:index/getCustomUrlCategory:getCustomUrlCategory
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name.
    Rulestack string
    The rulestack.
    ConfigType string
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.
    Name string
    The name.
    Rulestack string
    The rulestack.
    ConfigType string
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.
    name String
    The name.
    rulestack String
    The rulestack.
    configType String
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.
    name string
    The name.
    rulestack string
    The rulestack.
    configType string
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.
    name str
    The name.
    rulestack str
    The rulestack.
    config_type str
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.
    name String
    The name.
    rulestack String
    The rulestack.
    configType String
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.

    getCustomUrlCategory Result

    The following output properties are available:

    Action string
    The action to take. Valid values are none, alert, allow, block, continue, or override.
    AuditComment string
    The audit comment.
    Description string
    The description.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name.
    Rulestack string
    The rulestack.
    UpdateToken string
    The update token.
    UrlLists List<string>
    The URL list for this custom URL category.
    ConfigType string
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.
    Action string
    The action to take. Valid values are none, alert, allow, block, continue, or override.
    AuditComment string
    The audit comment.
    Description string
    The description.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name.
    Rulestack string
    The rulestack.
    UpdateToken string
    The update token.
    UrlLists []string
    The URL list for this custom URL category.
    ConfigType string
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.
    action String
    The action to take. Valid values are none, alert, allow, block, continue, or override.
    auditComment String
    The audit comment.
    description String
    The description.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name.
    rulestack String
    The rulestack.
    updateToken String
    The update token.
    urlLists List<String>
    The URL list for this custom URL category.
    configType String
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.
    action string
    The action to take. Valid values are none, alert, allow, block, continue, or override.
    auditComment string
    The audit comment.
    description string
    The description.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name.
    rulestack string
    The rulestack.
    updateToken string
    The update token.
    urlLists string[]
    The URL list for this custom URL category.
    configType string
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.
    action str
    The action to take. Valid values are none, alert, allow, block, continue, or override.
    audit_comment str
    The audit comment.
    description str
    The description.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name.
    rulestack str
    The rulestack.
    update_token str
    The update token.
    url_lists Sequence[str]
    The URL list for this custom URL category.
    config_type str
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.
    action String
    The action to take. Valid values are none, alert, allow, block, continue, or override.
    auditComment String
    The audit comment.
    description String
    The description.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name.
    rulestack String
    The rulestack.
    updateToken String
    The update token.
    urlLists List<String>
    The URL list for this custom URL category.
    configType String
    Retrieve either the candidate or running config. Valid values are candidate or running. Defaults to candidate.
    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.

    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