1. Packages
  2. Cisco Catalyst SD-WAN Provider
  3. API Docs
  4. ColorListPolicyObject
Cisco Catalyst SD-WAN v0.2.3 published on Wednesday, Dec 4, 2024 by Pulumi

sdwan.ColorListPolicyObject

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.2.3 published on Wednesday, Dec 4, 2024 by Pulumi

    This resource can manage a Color List Policy Object .

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdwan from "@pulumi/sdwan";
    
    const example = new sdwan.ColorListPolicyObject("example", {
        name: "Example",
        entries: [{
            color: "blue",
        }],
    });
    
    import pulumi
    import pulumi_sdwan as sdwan
    
    example = sdwan.ColorListPolicyObject("example",
        name="Example",
        entries=[{
            "color": "blue",
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-sdwan/sdk/go/sdwan"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sdwan.NewColorListPolicyObject(ctx, "example", &sdwan.ColorListPolicyObjectArgs{
    			Name: pulumi.String("Example"),
    			Entries: sdwan.ColorListPolicyObjectEntryArray{
    				&sdwan.ColorListPolicyObjectEntryArgs{
    					Color: pulumi.String("blue"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Sdwan = Pulumi.Sdwan;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Sdwan.ColorListPolicyObject("example", new()
        {
            Name = "Example",
            Entries = new[]
            {
                new Sdwan.Inputs.ColorListPolicyObjectEntryArgs
                {
                    Color = "blue",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdwan.ColorListPolicyObject;
    import com.pulumi.sdwan.ColorListPolicyObjectArgs;
    import com.pulumi.sdwan.inputs.ColorListPolicyObjectEntryArgs;
    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 ColorListPolicyObject("example", ColorListPolicyObjectArgs.builder()
                .name("Example")
                .entries(ColorListPolicyObjectEntryArgs.builder()
                    .color("blue")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: sdwan:ColorListPolicyObject
        properties:
          name: Example
          entries:
            - color: blue
    

    Create ColorListPolicyObject Resource

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

    Constructor syntax

    new ColorListPolicyObject(name: string, args: ColorListPolicyObjectArgs, opts?: CustomResourceOptions);
    @overload
    def ColorListPolicyObject(resource_name: str,
                              args: ColorListPolicyObjectArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def ColorListPolicyObject(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              entries: Optional[Sequence[ColorListPolicyObjectEntryArgs]] = None,
                              name: Optional[str] = None)
    func NewColorListPolicyObject(ctx *Context, name string, args ColorListPolicyObjectArgs, opts ...ResourceOption) (*ColorListPolicyObject, error)
    public ColorListPolicyObject(string name, ColorListPolicyObjectArgs args, CustomResourceOptions? opts = null)
    public ColorListPolicyObject(String name, ColorListPolicyObjectArgs args)
    public ColorListPolicyObject(String name, ColorListPolicyObjectArgs args, CustomResourceOptions options)
    
    type: sdwan:ColorListPolicyObject
    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 ColorListPolicyObjectArgs
    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 ColorListPolicyObjectArgs
    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 ColorListPolicyObjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ColorListPolicyObjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ColorListPolicyObjectArgs
    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 colorListPolicyObjectResource = new Sdwan.ColorListPolicyObject("colorListPolicyObjectResource", new()
    {
        Entries = new[]
        {
            new Sdwan.Inputs.ColorListPolicyObjectEntryArgs
            {
                Color = "string",
            },
        },
        Name = "string",
    });
    
    example, err := sdwan.NewColorListPolicyObject(ctx, "colorListPolicyObjectResource", &sdwan.ColorListPolicyObjectArgs{
    	Entries: sdwan.ColorListPolicyObjectEntryArray{
    		&sdwan.ColorListPolicyObjectEntryArgs{
    			Color: pulumi.String("string"),
    		},
    	},
    	Name: pulumi.String("string"),
    })
    
    var colorListPolicyObjectResource = new ColorListPolicyObject("colorListPolicyObjectResource", ColorListPolicyObjectArgs.builder()
        .entries(ColorListPolicyObjectEntryArgs.builder()
            .color("string")
            .build())
        .name("string")
        .build());
    
    color_list_policy_object_resource = sdwan.ColorListPolicyObject("colorListPolicyObjectResource",
        entries=[{
            "color": "string",
        }],
        name="string")
    
    const colorListPolicyObjectResource = new sdwan.ColorListPolicyObject("colorListPolicyObjectResource", {
        entries: [{
            color: "string",
        }],
        name: "string",
    });
    
    type: sdwan:ColorListPolicyObject
    properties:
        entries:
            - color: string
        name: string
    

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

    Entries List<ColorListPolicyObjectEntry>
    List of entries
    Name string
    The name of the policy object
    Entries []ColorListPolicyObjectEntryArgs
    List of entries
    Name string
    The name of the policy object
    entries List<ColorListPolicyObjectEntry>
    List of entries
    name String
    The name of the policy object
    entries ColorListPolicyObjectEntry[]
    List of entries
    name string
    The name of the policy object
    entries Sequence[ColorListPolicyObjectEntryArgs]
    List of entries
    name str
    The name of the policy object
    entries List<Property Map>
    List of entries
    name String
    The name of the policy object

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the object
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the object
    id String
    The provider-assigned unique ID for this managed resource.
    version Integer
    The version of the object
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The version of the object
    id str
    The provider-assigned unique ID for this managed resource.
    version int
    The version of the object
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The version of the object

    Look up Existing ColorListPolicyObject Resource

    Get an existing ColorListPolicyObject 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?: ColorListPolicyObjectState, opts?: CustomResourceOptions): ColorListPolicyObject
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            entries: Optional[Sequence[ColorListPolicyObjectEntryArgs]] = None,
            name: Optional[str] = None,
            version: Optional[int] = None) -> ColorListPolicyObject
    func GetColorListPolicyObject(ctx *Context, name string, id IDInput, state *ColorListPolicyObjectState, opts ...ResourceOption) (*ColorListPolicyObject, error)
    public static ColorListPolicyObject Get(string name, Input<string> id, ColorListPolicyObjectState? state, CustomResourceOptions? opts = null)
    public static ColorListPolicyObject get(String name, Output<String> id, ColorListPolicyObjectState 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:
    Entries List<ColorListPolicyObjectEntry>
    List of entries
    Name string
    The name of the policy object
    Version int
    The version of the object
    Entries []ColorListPolicyObjectEntryArgs
    List of entries
    Name string
    The name of the policy object
    Version int
    The version of the object
    entries List<ColorListPolicyObjectEntry>
    List of entries
    name String
    The name of the policy object
    version Integer
    The version of the object
    entries ColorListPolicyObjectEntry[]
    List of entries
    name string
    The name of the policy object
    version number
    The version of the object
    entries Sequence[ColorListPolicyObjectEntryArgs]
    List of entries
    name str
    The name of the policy object
    version int
    The version of the object
    entries List<Property Map>
    List of entries
    name String
    The name of the policy object
    version Number
    The version of the object

    Supporting Types

    ColorListPolicyObjectEntry, ColorListPolicyObjectEntryArgs

    Color string
    Color

    • Choices: default, 3g, biz-internet, blue, bronze, custom1, custom2, custom3, gold, green, lte, metro-ethernet, mpls, private1, private2, private3, private4, private5, private6, public-internet, red, silver
    Color string
    Color

    • Choices: default, 3g, biz-internet, blue, bronze, custom1, custom2, custom3, gold, green, lte, metro-ethernet, mpls, private1, private2, private3, private4, private5, private6, public-internet, red, silver
    color String
    Color

    • Choices: default, 3g, biz-internet, blue, bronze, custom1, custom2, custom3, gold, green, lte, metro-ethernet, mpls, private1, private2, private3, private4, private5, private6, public-internet, red, silver
    color string
    Color

    • Choices: default, 3g, biz-internet, blue, bronze, custom1, custom2, custom3, gold, green, lte, metro-ethernet, mpls, private1, private2, private3, private4, private5, private6, public-internet, red, silver
    color str
    Color

    • Choices: default, 3g, biz-internet, blue, bronze, custom1, custom2, custom3, gold, green, lte, metro-ethernet, mpls, private1, private2, private3, private4, private5, private6, public-internet, red, silver
    color String
    Color

    • Choices: default, 3g, biz-internet, blue, bronze, custom1, custom2, custom3, gold, green, lte, metro-ethernet, mpls, private1, private2, private3, private4, private5, private6, public-internet, red, silver

    Import

    $ pulumi import sdwan:index/colorListPolicyObject:ColorListPolicyObject example "f6b2c44c-693c-4763-b010-895aa3d236bd"
    

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

    Package Details

    Repository
    sdwan pulumi/pulumi-sdwan
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdwan Terraform Provider.
    sdwan logo
    Cisco Catalyst SD-WAN v0.2.3 published on Wednesday, Dec 4, 2024 by Pulumi