Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scm Provider
  3. API Docs
  4. UrlCategory
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

scm.UrlCategory

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

    Retrieves a config item.

    Example Usage

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

const example = new scm.UrlCategory("example", {folder: "Shared"});

    import pulumi
import pulumi_scm as scm

example = scm.UrlCategory("example", folder="Shared")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scm.NewUrlCategory(ctx, "example", &scm.UrlCategoryArgs{
			Folder: pulumi.String("Shared"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    var example = new Scm.UrlCategory("example", new()
    {
        Folder = "Shared",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.UrlCategory;
import com.pulumi.scm.UrlCategoryArgs;
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 example = new UrlCategory("example", UrlCategoryArgs.builder()
            .folder("Shared")
            .build());

    }
}

    resources:
  example:
    type: scm:UrlCategory
    properties:
      folder: Shared

    Create UrlCategory Resource

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

    Constructor syntax

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

@overload
def UrlCategory(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                device: Optional[str] = None,
                folder: Optional[str] = None,
                lists: Optional[Sequence[str]] = None,
                name: Optional[str] = None,
                snippet: Optional[str] = None,
                type: Optional[str] = None)
    func NewUrlCategory(ctx *Context, name string, args *UrlCategoryArgs, opts ...ResourceOption) (*UrlCategory, error)
    public UrlCategory(string name, UrlCategoryArgs? args = null, CustomResourceOptions? opts = null)
    public UrlCategory(String name, UrlCategoryArgs args)
public UrlCategory(String name, UrlCategoryArgs args, CustomResourceOptions options)

    type: scm:UrlCategory
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 UrlCategoryArgs
    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 UrlCategoryArgs
    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 UrlCategoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UrlCategoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UrlCategoryArgs
    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 urlCategoryResource = new Scm.UrlCategory("urlCategoryResource", new()
{
    Description = "string",
    Device = "string",
    Folder = "string",
    Lists = new[]
    {
        "string",
    },
    Name = "string",
    Snippet = "string",
    Type = "string",
});

    example, err := scm.NewUrlCategory(ctx, "urlCategoryResource", &scm.UrlCategoryArgs{
	Description: pulumi.String("string"),
	Device:      pulumi.String("string"),
	Folder:      pulumi.String("string"),
	Lists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:    pulumi.String("string"),
	Snippet: pulumi.String("string"),
	Type:    pulumi.String("string"),
})

    var urlCategoryResource = new UrlCategory("urlCategoryResource", UrlCategoryArgs.builder()
    .description("string")
    .device("string")
    .folder("string")
    .lists("string")
    .name("string")
    .snippet("string")
    .type("string")
    .build());

    url_category_resource = scm.UrlCategory("urlCategoryResource",
    description="string",
    device="string",
    folder="string",
    lists=["string"],
    name="string",
    snippet="string",
    type="string")

    const urlCategoryResource = new scm.UrlCategory("urlCategoryResource", {
    description: "string",
    device: "string",
    folder: "string",
    lists: ["string"],
    name: "string",
    snippet: "string",
    type: "string",
});

    type: scm:UrlCategory
properties:
    description: string
    device: string
    folder: string
    lists:
        - string
    name: string
    snippet: string
    type: string

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

    Description string
    The Description param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Lists List<string>
    The List param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    Type string
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".
    Description string
    The Description param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Lists []string
    The List param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    Type string
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".
    description String
    The Description param.
    device String
    The Device param.
    folder String
    The Folder param.
    lists List<String>
    The List param.
    name String
    The Name param.
    snippet String
    The Snippet param.
    type String
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".
    description string
    The Description param.
    device string
    The Device param.
    folder string
    The Folder param.
    lists string[]
    The List param.
    name string
    The Name param.
    snippet string
    The Snippet param.
    type string
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".
    description str
    The Description param.
    device str
    The Device param.
    folder str
    The Folder param.
    lists Sequence[str]
    The List param.
    name str
    The Name param.
    snippet str
    The Snippet param.
    type str
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".
    description String
    The Description param.
    device String
    The Device param.
    folder String
    The Folder param.
    lists List<String>
    The List param.
    name String
    The Name param.
    snippet String
    The Snippet param.
    type String
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    id string
    The provider-assigned unique ID for this managed resource.
    tfid string
    id str
    The provider-assigned unique ID for this managed resource.
    tfid str
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String

    Look up Existing UrlCategory Resource

    Get an existing UrlCategory 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?: UrlCategoryState, opts?: CustomResourceOptions): UrlCategory
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        folder: Optional[str] = None,
        lists: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        snippet: Optional[str] = None,
        tfid: Optional[str] = None,
        type: Optional[str] = None) -> UrlCategory
    func GetUrlCategory(ctx *Context, name string, id IDInput, state *UrlCategoryState, opts ...ResourceOption) (*UrlCategory, error)
    public static UrlCategory Get(string name, Input<string> id, UrlCategoryState? state, CustomResourceOptions? opts = null)
    public static UrlCategory get(String name, Output<String> id, UrlCategoryState 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:
    Description string
    The Description param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Lists List<string>
    The List param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    Tfid string
    Type string
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".
    Description string
    The Description param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Lists []string
    The List param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    Tfid string
    Type string
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".
    description String
    The Description param.
    device String
    The Device param.
    folder String
    The Folder param.
    lists List<String>
    The List param.
    name String
    The Name param.
    snippet String
    The Snippet param.
    tfid String
    type String
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".
    description string
    The Description param.
    device string
    The Device param.
    folder string
    The Folder param.
    lists string[]
    The List param.
    name string
    The Name param.
    snippet string
    The Snippet param.
    tfid string
    type string
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".
    description str
    The Description param.
    device str
    The Device param.
    folder str
    The Folder param.
    lists Sequence[str]
    The List param.
    name str
    The Name param.
    snippet str
    The Snippet param.
    tfid str
    type str
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".
    description String
    The Description param.
    device String
    The Device param.
    folder String
    The Folder param.
    lists List<String>
    The List param.
    name String
    The Name param.
    snippet String
    The Snippet param.
    tfid String
    type String
    The Type param. String must be one of these: "URL List", "Category Match". Default: "URL List".

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
    pulumi/pulumi-scm