1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. PreferredColorGroupPolicyObject
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi

sdwan.PreferredColorGroupPolicyObject

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi

    This resource can manage a Preferred Color Group Policy Object .

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdwan from "@pulumi/sdwan";
    
    const example = new sdwan.PreferredColorGroupPolicyObject("example", {
        name: "Example",
        primaryColorPreference: "blue bronze",
        primaryPathPreference: "direct-path",
        secondaryColorPreference: "3g",
        secondaryPathPreference: "multi-hop-path",
        tertiaryColorPreference: "custom1",
        tertiaryPathPreference: "all-paths",
    });
    
    import pulumi
    import pulumi_sdwan as sdwan
    
    example = sdwan.PreferredColorGroupPolicyObject("example",
        name="Example",
        primary_color_preference="blue bronze",
        primary_path_preference="direct-path",
        secondary_color_preference="3g",
        secondary_path_preference="multi-hop-path",
        tertiary_color_preference="custom1",
        tertiary_path_preference="all-paths")
    
    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.NewPreferredColorGroupPolicyObject(ctx, "example", &sdwan.PreferredColorGroupPolicyObjectArgs{
    			Name:                     pulumi.String("Example"),
    			PrimaryColorPreference:   pulumi.String("blue bronze"),
    			PrimaryPathPreference:    pulumi.String("direct-path"),
    			SecondaryColorPreference: pulumi.String("3g"),
    			SecondaryPathPreference:  pulumi.String("multi-hop-path"),
    			TertiaryColorPreference:  pulumi.String("custom1"),
    			TertiaryPathPreference:   pulumi.String("all-paths"),
    		})
    		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.PreferredColorGroupPolicyObject("example", new()
        {
            Name = "Example",
            PrimaryColorPreference = "blue bronze",
            PrimaryPathPreference = "direct-path",
            SecondaryColorPreference = "3g",
            SecondaryPathPreference = "multi-hop-path",
            TertiaryColorPreference = "custom1",
            TertiaryPathPreference = "all-paths",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdwan.PreferredColorGroupPolicyObject;
    import com.pulumi.sdwan.PreferredColorGroupPolicyObjectArgs;
    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 PreferredColorGroupPolicyObject("example", PreferredColorGroupPolicyObjectArgs.builder()
                .name("Example")
                .primaryColorPreference("blue bronze")
                .primaryPathPreference("direct-path")
                .secondaryColorPreference("3g")
                .secondaryPathPreference("multi-hop-path")
                .tertiaryColorPreference("custom1")
                .tertiaryPathPreference("all-paths")
                .build());
    
        }
    }
    
    resources:
      example:
        type: sdwan:PreferredColorGroupPolicyObject
        properties:
          name: Example
          primaryColorPreference: blue bronze
          primaryPathPreference: direct-path
          secondaryColorPreference: 3g
          secondaryPathPreference: multi-hop-path
          tertiaryColorPreference: custom1
          tertiaryPathPreference: all-paths
    

    Create PreferredColorGroupPolicyObject Resource

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

    Constructor syntax

    new PreferredColorGroupPolicyObject(name: string, args: PreferredColorGroupPolicyObjectArgs, opts?: CustomResourceOptions);
    @overload
    def PreferredColorGroupPolicyObject(resource_name: str,
                                        args: PreferredColorGroupPolicyObjectArgs,
                                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def PreferredColorGroupPolicyObject(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        primary_color_preference: Optional[str] = None,
                                        name: Optional[str] = None,
                                        primary_path_preference: Optional[str] = None,
                                        secondary_color_preference: Optional[str] = None,
                                        secondary_path_preference: Optional[str] = None,
                                        tertiary_color_preference: Optional[str] = None,
                                        tertiary_path_preference: Optional[str] = None)
    func NewPreferredColorGroupPolicyObject(ctx *Context, name string, args PreferredColorGroupPolicyObjectArgs, opts ...ResourceOption) (*PreferredColorGroupPolicyObject, error)
    public PreferredColorGroupPolicyObject(string name, PreferredColorGroupPolicyObjectArgs args, CustomResourceOptions? opts = null)
    public PreferredColorGroupPolicyObject(String name, PreferredColorGroupPolicyObjectArgs args)
    public PreferredColorGroupPolicyObject(String name, PreferredColorGroupPolicyObjectArgs args, CustomResourceOptions options)
    
    type: sdwan:PreferredColorGroupPolicyObject
    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 PreferredColorGroupPolicyObjectArgs
    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 PreferredColorGroupPolicyObjectArgs
    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 PreferredColorGroupPolicyObjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PreferredColorGroupPolicyObjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PreferredColorGroupPolicyObjectArgs
    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 preferredColorGroupPolicyObjectResource = new Sdwan.PreferredColorGroupPolicyObject("preferredColorGroupPolicyObjectResource", new()
    {
        PrimaryColorPreference = "string",
        Name = "string",
        PrimaryPathPreference = "string",
        SecondaryColorPreference = "string",
        SecondaryPathPreference = "string",
        TertiaryColorPreference = "string",
        TertiaryPathPreference = "string",
    });
    
    example, err := sdwan.NewPreferredColorGroupPolicyObject(ctx, "preferredColorGroupPolicyObjectResource", &sdwan.PreferredColorGroupPolicyObjectArgs{
    	PrimaryColorPreference:   pulumi.String("string"),
    	Name:                     pulumi.String("string"),
    	PrimaryPathPreference:    pulumi.String("string"),
    	SecondaryColorPreference: pulumi.String("string"),
    	SecondaryPathPreference:  pulumi.String("string"),
    	TertiaryColorPreference:  pulumi.String("string"),
    	TertiaryPathPreference:   pulumi.String("string"),
    })
    
    var preferredColorGroupPolicyObjectResource = new PreferredColorGroupPolicyObject("preferredColorGroupPolicyObjectResource", PreferredColorGroupPolicyObjectArgs.builder()
        .primaryColorPreference("string")
        .name("string")
        .primaryPathPreference("string")
        .secondaryColorPreference("string")
        .secondaryPathPreference("string")
        .tertiaryColorPreference("string")
        .tertiaryPathPreference("string")
        .build());
    
    preferred_color_group_policy_object_resource = sdwan.PreferredColorGroupPolicyObject("preferredColorGroupPolicyObjectResource",
        primary_color_preference="string",
        name="string",
        primary_path_preference="string",
        secondary_color_preference="string",
        secondary_path_preference="string",
        tertiary_color_preference="string",
        tertiary_path_preference="string")
    
    const preferredColorGroupPolicyObjectResource = new sdwan.PreferredColorGroupPolicyObject("preferredColorGroupPolicyObjectResource", {
        primaryColorPreference: "string",
        name: "string",
        primaryPathPreference: "string",
        secondaryColorPreference: "string",
        secondaryPathPreference: "string",
        tertiaryColorPreference: "string",
        tertiaryPathPreference: "string",
    });
    
    type: sdwan:PreferredColorGroupPolicyObject
    properties:
        name: string
        primaryColorPreference: string
        primaryPathPreference: string
        secondaryColorPreference: string
        secondaryPathPreference: string
        tertiaryColorPreference: string
        tertiaryPathPreference: string
    

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

    PrimaryColorPreference string
    Color or space separated list of colors
    Name string
    The name of the policy object
    PrimaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    SecondaryColorPreference string
    Color or space separated list of colors
    SecondaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    TertiaryColorPreference string
    Color or space separated list of colors
    TertiaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    PrimaryColorPreference string
    Color or space separated list of colors
    Name string
    The name of the policy object
    PrimaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    SecondaryColorPreference string
    Color or space separated list of colors
    SecondaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    TertiaryColorPreference string
    Color or space separated list of colors
    TertiaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    primaryColorPreference String
    Color or space separated list of colors
    name String
    The name of the policy object
    primaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    secondaryColorPreference String
    Color or space separated list of colors
    secondaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    tertiaryColorPreference String
    Color or space separated list of colors
    tertiaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    primaryColorPreference string
    Color or space separated list of colors
    name string
    The name of the policy object
    primaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    secondaryColorPreference string
    Color or space separated list of colors
    secondaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    tertiaryColorPreference string
    Color or space separated list of colors
    tertiaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    primary_color_preference str
    Color or space separated list of colors
    name str
    The name of the policy object
    primary_path_preference str
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    secondary_color_preference str
    Color or space separated list of colors
    secondary_path_preference str
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    tertiary_color_preference str
    Color or space separated list of colors
    tertiary_path_preference str
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    primaryColorPreference String
    Color or space separated list of colors
    name String
    The name of the policy object
    primaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    secondaryColorPreference String
    Color or space separated list of colors
    secondaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    tertiaryColorPreference String
    Color or space separated list of colors
    tertiaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PreferredColorGroupPolicyObject 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 PreferredColorGroupPolicyObject Resource

    Get an existing PreferredColorGroupPolicyObject 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?: PreferredColorGroupPolicyObjectState, opts?: CustomResourceOptions): PreferredColorGroupPolicyObject
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            primary_color_preference: Optional[str] = None,
            primary_path_preference: Optional[str] = None,
            secondary_color_preference: Optional[str] = None,
            secondary_path_preference: Optional[str] = None,
            tertiary_color_preference: Optional[str] = None,
            tertiary_path_preference: Optional[str] = None,
            version: Optional[int] = None) -> PreferredColorGroupPolicyObject
    func GetPreferredColorGroupPolicyObject(ctx *Context, name string, id IDInput, state *PreferredColorGroupPolicyObjectState, opts ...ResourceOption) (*PreferredColorGroupPolicyObject, error)
    public static PreferredColorGroupPolicyObject Get(string name, Input<string> id, PreferredColorGroupPolicyObjectState? state, CustomResourceOptions? opts = null)
    public static PreferredColorGroupPolicyObject get(String name, Output<String> id, PreferredColorGroupPolicyObjectState 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:
    Name string
    The name of the policy object
    PrimaryColorPreference string
    Color or space separated list of colors
    PrimaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    SecondaryColorPreference string
    Color or space separated list of colors
    SecondaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    TertiaryColorPreference string
    Color or space separated list of colors
    TertiaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    Version int
    The version of the object
    Name string
    The name of the policy object
    PrimaryColorPreference string
    Color or space separated list of colors
    PrimaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    SecondaryColorPreference string
    Color or space separated list of colors
    SecondaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    TertiaryColorPreference string
    Color or space separated list of colors
    TertiaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    Version int
    The version of the object
    name String
    The name of the policy object
    primaryColorPreference String
    Color or space separated list of colors
    primaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    secondaryColorPreference String
    Color or space separated list of colors
    secondaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    tertiaryColorPreference String
    Color or space separated list of colors
    tertiaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    version Integer
    The version of the object
    name string
    The name of the policy object
    primaryColorPreference string
    Color or space separated list of colors
    primaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    secondaryColorPreference string
    Color or space separated list of colors
    secondaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    tertiaryColorPreference string
    Color or space separated list of colors
    tertiaryPathPreference string
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    version number
    The version of the object
    name str
    The name of the policy object
    primary_color_preference str
    Color or space separated list of colors
    primary_path_preference str
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    secondary_color_preference str
    Color or space separated list of colors
    secondary_path_preference str
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    tertiary_color_preference str
    Color or space separated list of colors
    tertiary_path_preference str
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    version int
    The version of the object
    name String
    The name of the policy object
    primaryColorPreference String
    Color or space separated list of colors
    primaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    secondaryColorPreference String
    Color or space separated list of colors
    secondaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    tertiaryColorPreference String
    Color or space separated list of colors
    tertiaryPathPreference String
    Path preference - Choices: direct-path, multi-hop-path, all-paths
    version Number
    The version of the object

    Import

    $ pulumi import sdwan:index/preferredColorGroupPolicyObject:PreferredColorGroupPolicyObject 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.0 published on Friday, Nov 1, 2024 by Pulumi