1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getGatewayCategories
Cloudflare v5.39.1 published on Tuesday, Sep 24, 2024 by Pulumi

cloudflare.getGatewayCategories

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.39.1 published on Tuesday, Sep 24, 2024 by Pulumi

    Use this data source to retrieve all Gateway categories for an account.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const example = cloudflare.getGatewayCategories({
        accountId: "f037e56e89293a057740de681ac9abbe",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.get_gateway_categories(account_id="f037e56e89293a057740de681ac9abbe")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.GetGatewayCategories(ctx, &cloudflare.GetGatewayCategoriesArgs{
    			AccountId: "f037e56e89293a057740de681ac9abbe",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Cloudflare.GetGatewayCategories.Invoke(new()
        {
            AccountId = "f037e56e89293a057740de681ac9abbe",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.CloudflareFunctions;
    import com.pulumi.cloudflare.inputs.GetGatewayCategoriesArgs;
    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 = CloudflareFunctions.getGatewayCategories(GetGatewayCategoriesArgs.builder()
                .accountId("f037e56e89293a057740de681ac9abbe")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: cloudflare:getGatewayCategories
          Arguments:
            accountId: f037e56e89293a057740de681ac9abbe
    

    Using getGatewayCategories

    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 getGatewayCategories(args: GetGatewayCategoriesArgs, opts?: InvokeOptions): Promise<GetGatewayCategoriesResult>
    function getGatewayCategoriesOutput(args: GetGatewayCategoriesOutputArgs, opts?: InvokeOptions): Output<GetGatewayCategoriesResult>
    def get_gateway_categories(account_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetGatewayCategoriesResult
    def get_gateway_categories_output(account_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetGatewayCategoriesResult]
    func GetGatewayCategories(ctx *Context, args *GetGatewayCategoriesArgs, opts ...InvokeOption) (*GetGatewayCategoriesResult, error)
    func GetGatewayCategoriesOutput(ctx *Context, args *GetGatewayCategoriesOutputArgs, opts ...InvokeOption) GetGatewayCategoriesResultOutput

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

    public static class GetGatewayCategories 
    {
        public static Task<GetGatewayCategoriesResult> InvokeAsync(GetGatewayCategoriesArgs args, InvokeOptions? opts = null)
        public static Output<GetGatewayCategoriesResult> Invoke(GetGatewayCategoriesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGatewayCategoriesResult> getGatewayCategories(GetGatewayCategoriesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: cloudflare:index/getGatewayCategories:getGatewayCategories
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    The account ID to fetch Gateway Categories from.
    AccountId string
    The account ID to fetch Gateway Categories from.
    accountId String
    The account ID to fetch Gateway Categories from.
    accountId string
    The account ID to fetch Gateway Categories from.
    account_id str
    The account ID to fetch Gateway Categories from.
    accountId String
    The account ID to fetch Gateway Categories from.

    getGatewayCategories Result

    The following output properties are available:

    AccountId string
    The account ID to fetch Gateway Categories from.
    Categories List<GetGatewayCategoriesCategory>
    A list of Gateway Categories.
    Id string
    The provider-assigned unique ID for this managed resource.
    AccountId string
    The account ID to fetch Gateway Categories from.
    Categories []GetGatewayCategoriesCategory
    A list of Gateway Categories.
    Id string
    The provider-assigned unique ID for this managed resource.
    accountId String
    The account ID to fetch Gateway Categories from.
    categories List<GetGatewayCategoriesCategory>
    A list of Gateway Categories.
    id String
    The provider-assigned unique ID for this managed resource.
    accountId string
    The account ID to fetch Gateway Categories from.
    categories GetGatewayCategoriesCategory[]
    A list of Gateway Categories.
    id string
    The provider-assigned unique ID for this managed resource.
    account_id str
    The account ID to fetch Gateway Categories from.
    categories Sequence[GetGatewayCategoriesCategory]
    A list of Gateway Categories.
    id str
    The provider-assigned unique ID for this managed resource.
    accountId String
    The account ID to fetch Gateway Categories from.
    categories List<Property Map>
    A list of Gateway Categories.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetGatewayCategoriesCategory

    Beta bool
    True if the category is in beta and subject to change.
    Class string
    Which account types are allowed to create policies based on this category.
    Description string
    A short summary of domains in the category.
    Id int
    The identifier for this category. There is only one category per ID.
    Name string
    The name of the category.
    Subcategories List<GetGatewayCategoriesCategorySubcategory>
    A list of subcategories.
    Beta bool
    True if the category is in beta and subject to change.
    Class string
    Which account types are allowed to create policies based on this category.
    Description string
    A short summary of domains in the category.
    Id int
    The identifier for this category. There is only one category per ID.
    Name string
    The name of the category.
    Subcategories []GetGatewayCategoriesCategorySubcategory
    A list of subcategories.
    beta Boolean
    True if the category is in beta and subject to change.
    class_ String
    Which account types are allowed to create policies based on this category.
    description String
    A short summary of domains in the category.
    id Integer
    The identifier for this category. There is only one category per ID.
    name String
    The name of the category.
    subcategories List<GetGatewayCategoriesCategorySubcategory>
    A list of subcategories.
    beta boolean
    True if the category is in beta and subject to change.
    class string
    Which account types are allowed to create policies based on this category.
    description string
    A short summary of domains in the category.
    id number
    The identifier for this category. There is only one category per ID.
    name string
    The name of the category.
    subcategories GetGatewayCategoriesCategorySubcategory[]
    A list of subcategories.
    beta bool
    True if the category is in beta and subject to change.
    class_ str
    Which account types are allowed to create policies based on this category.
    description str
    A short summary of domains in the category.
    id int
    The identifier for this category. There is only one category per ID.
    name str
    The name of the category.
    subcategories Sequence[GetGatewayCategoriesCategorySubcategory]
    A list of subcategories.
    beta Boolean
    True if the category is in beta and subject to change.
    class String
    Which account types are allowed to create policies based on this category.
    description String
    A short summary of domains in the category.
    id Number
    The identifier for this category. There is only one category per ID.
    name String
    The name of the category.
    subcategories List<Property Map>
    A list of subcategories.

    GetGatewayCategoriesCategorySubcategory

    Beta bool
    True if the subcategory is in beta and subject to change.
    Class string
    Which account types are allowed to create policies based on this subcategory.
    Description string
    A short summary of domains in the subcategory.
    Id int
    The identifier for this subcategory. There is only one subcategory per ID.
    Name string
    The name of the subcategory.
    Beta bool
    True if the subcategory is in beta and subject to change.
    Class string
    Which account types are allowed to create policies based on this subcategory.
    Description string
    A short summary of domains in the subcategory.
    Id int
    The identifier for this subcategory. There is only one subcategory per ID.
    Name string
    The name of the subcategory.
    beta Boolean
    True if the subcategory is in beta and subject to change.
    class_ String
    Which account types are allowed to create policies based on this subcategory.
    description String
    A short summary of domains in the subcategory.
    id Integer
    The identifier for this subcategory. There is only one subcategory per ID.
    name String
    The name of the subcategory.
    beta boolean
    True if the subcategory is in beta and subject to change.
    class string
    Which account types are allowed to create policies based on this subcategory.
    description string
    A short summary of domains in the subcategory.
    id number
    The identifier for this subcategory. There is only one subcategory per ID.
    name string
    The name of the subcategory.
    beta bool
    True if the subcategory is in beta and subject to change.
    class_ str
    Which account types are allowed to create policies based on this subcategory.
    description str
    A short summary of domains in the subcategory.
    id int
    The identifier for this subcategory. There is only one subcategory per ID.
    name str
    The name of the subcategory.
    beta Boolean
    True if the subcategory is in beta and subject to change.
    class String
    Which account types are allowed to create policies based on this subcategory.
    description String
    A short summary of domains in the subcategory.
    id Number
    The identifier for this subcategory. There is only one subcategory per ID.
    name String
    The name of the subcategory.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v5.39.1 published on Tuesday, Sep 24, 2024 by Pulumi