1. Packages
  2. Cisco Catalyst SD-WAN Provider
  3. API Docs
  4. PolicyObjectPreferredColorGroup
Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi

sdwan.PolicyObjectPreferredColorGroup

Explore with Pulumi AI

This resource can manage a Policy Object Preferred Color Group Policy_object.

  • Minimum SD-WAN Manager version: 20.12.0

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.PolicyObjectPreferredColorGroup;
import com.pulumi.sdwan.PolicyObjectPreferredColorGroupArgs;
import com.pulumi.sdwan.inputs.PolicyObjectPreferredColorGroupEntryArgs;
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 PolicyObjectPreferredColorGroup("example", PolicyObjectPreferredColorGroupArgs.builder()
            .name("Example")
            .description("My Example")
            .featureProfileId("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac")
            .entries(PolicyObjectPreferredColorGroupEntryArgs.builder()
                .primary_color_preference("default")
                .primary_path_preference("direct-path")
                .secondary_color_preference("bronze")
                .secondary_path_preference("all-paths")
                .tertiary_color_preference("blue")
                .tertiary_path_preference("all-paths")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: sdwan:PolicyObjectPreferredColorGroup
    properties:
      name: Example
      description: My Example
      featureProfileId: f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac
      entries:
        - primary_color_preference:
            - default
          primary_path_preference: direct-path
          secondary_color_preference:
            - bronze
          secondary_path_preference: all-paths
          tertiary_color_preference:
            - blue
          tertiary_path_preference: all-paths
Copy

Create PolicyObjectPreferredColorGroup Resource

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

Constructor syntax

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

@overload
def PolicyObjectPreferredColorGroup(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    entries: Optional[Sequence[PolicyObjectPreferredColorGroupEntryArgs]] = None,
                                    feature_profile_id: Optional[str] = None,
                                    description: Optional[str] = None,
                                    name: Optional[str] = None)
func NewPolicyObjectPreferredColorGroup(ctx *Context, name string, args PolicyObjectPreferredColorGroupArgs, opts ...ResourceOption) (*PolicyObjectPreferredColorGroup, error)
public PolicyObjectPreferredColorGroup(string name, PolicyObjectPreferredColorGroupArgs args, CustomResourceOptions? opts = null)
public PolicyObjectPreferredColorGroup(String name, PolicyObjectPreferredColorGroupArgs args)
public PolicyObjectPreferredColorGroup(String name, PolicyObjectPreferredColorGroupArgs args, CustomResourceOptions options)
type: sdwan:PolicyObjectPreferredColorGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PolicyObjectPreferredColorGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PolicyObjectPreferredColorGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyObjectPreferredColorGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyObjectPreferredColorGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PolicyObjectPreferredColorGroupArgs
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 policyObjectPreferredColorGroupResource = new Sdwan.PolicyObjectPreferredColorGroup("policyObjectPreferredColorGroupResource", new()
{
    Entries = new[]
    {
        new Sdwan.Inputs.PolicyObjectPreferredColorGroupEntryArgs
        {
            PrimaryColorPreferences = new[]
            {
                "string",
            },
            PrimaryPathPreference = "string",
            SecondaryColorPreferences = new[]
            {
                "string",
            },
            SecondaryPathPreference = "string",
            TertiaryColorPreferences = new[]
            {
                "string",
            },
            TertiaryPathPreference = "string",
        },
    },
    FeatureProfileId = "string",
    Description = "string",
    Name = "string",
});
Copy
example, err := sdwan.NewPolicyObjectPreferredColorGroup(ctx, "policyObjectPreferredColorGroupResource", &sdwan.PolicyObjectPreferredColorGroupArgs{
	Entries: sdwan.PolicyObjectPreferredColorGroupEntryArray{
		&sdwan.PolicyObjectPreferredColorGroupEntryArgs{
			PrimaryColorPreferences: pulumi.StringArray{
				pulumi.String("string"),
			},
			PrimaryPathPreference: pulumi.String("string"),
			SecondaryColorPreferences: pulumi.StringArray{
				pulumi.String("string"),
			},
			SecondaryPathPreference: pulumi.String("string"),
			TertiaryColorPreferences: pulumi.StringArray{
				pulumi.String("string"),
			},
			TertiaryPathPreference: pulumi.String("string"),
		},
	},
	FeatureProfileId: pulumi.String("string"),
	Description:      pulumi.String("string"),
	Name:             pulumi.String("string"),
})
Copy
var policyObjectPreferredColorGroupResource = new PolicyObjectPreferredColorGroup("policyObjectPreferredColorGroupResource", PolicyObjectPreferredColorGroupArgs.builder()
    .entries(PolicyObjectPreferredColorGroupEntryArgs.builder()
        .primaryColorPreferences("string")
        .primaryPathPreference("string")
        .secondaryColorPreferences("string")
        .secondaryPathPreference("string")
        .tertiaryColorPreferences("string")
        .tertiaryPathPreference("string")
        .build())
    .featureProfileId("string")
    .description("string")
    .name("string")
    .build());
Copy
policy_object_preferred_color_group_resource = sdwan.PolicyObjectPreferredColorGroup("policyObjectPreferredColorGroupResource",
    entries=[{
        "primary_color_preferences": ["string"],
        "primary_path_preference": "string",
        "secondary_color_preferences": ["string"],
        "secondary_path_preference": "string",
        "tertiary_color_preferences": ["string"],
        "tertiary_path_preference": "string",
    }],
    feature_profile_id="string",
    description="string",
    name="string")
Copy
const policyObjectPreferredColorGroupResource = new sdwan.PolicyObjectPreferredColorGroup("policyObjectPreferredColorGroupResource", {
    entries: [{
        primaryColorPreferences: ["string"],
        primaryPathPreference: "string",
        secondaryColorPreferences: ["string"],
        secondaryPathPreference: "string",
        tertiaryColorPreferences: ["string"],
        tertiaryPathPreference: "string",
    }],
    featureProfileId: "string",
    description: "string",
    name: "string",
});
Copy
type: sdwan:PolicyObjectPreferredColorGroup
properties:
    description: string
    entries:
        - primaryColorPreferences:
            - string
          primaryPathPreference: string
          secondaryColorPreferences:
            - string
          secondaryPathPreference: string
          tertiaryColorPreferences:
            - string
          tertiaryPathPreference: string
    featureProfileId: string
    name: string
Copy

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

Entries This property is required. List<PolicyObjectPreferredColorGroupEntry>
Preferred Color Group List
FeatureProfileId This property is required. string
Feature Profile ID
Description string
The description of the Policy_object
Name string
The name of the Policy_object
Entries This property is required. []PolicyObjectPreferredColorGroupEntryArgs
Preferred Color Group List
FeatureProfileId This property is required. string
Feature Profile ID
Description string
The description of the Policy_object
Name string
The name of the Policy_object
entries This property is required. List<PolicyObjectPreferredColorGroupEntry>
Preferred Color Group List
featureProfileId This property is required. String
Feature Profile ID
description String
The description of the Policy_object
name String
The name of the Policy_object
entries This property is required. PolicyObjectPreferredColorGroupEntry[]
Preferred Color Group List
featureProfileId This property is required. string
Feature Profile ID
description string
The description of the Policy_object
name string
The name of the Policy_object
entries This property is required. Sequence[PolicyObjectPreferredColorGroupEntryArgs]
Preferred Color Group List
feature_profile_id This property is required. str
Feature Profile ID
description str
The description of the Policy_object
name str
The name of the Policy_object
entries This property is required. List<Property Map>
Preferred Color Group List
featureProfileId This property is required. String
Feature Profile ID
description String
The description of the Policy_object
name String
The name of the Policy_object

Outputs

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

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

Look up Existing PolicyObjectPreferredColorGroup Resource

Get an existing PolicyObjectPreferredColorGroup 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?: PolicyObjectPreferredColorGroupState, opts?: CustomResourceOptions): PolicyObjectPreferredColorGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        entries: Optional[Sequence[PolicyObjectPreferredColorGroupEntryArgs]] = None,
        feature_profile_id: Optional[str] = None,
        name: Optional[str] = None,
        version: Optional[int] = None) -> PolicyObjectPreferredColorGroup
func GetPolicyObjectPreferredColorGroup(ctx *Context, name string, id IDInput, state *PolicyObjectPreferredColorGroupState, opts ...ResourceOption) (*PolicyObjectPreferredColorGroup, error)
public static PolicyObjectPreferredColorGroup Get(string name, Input<string> id, PolicyObjectPreferredColorGroupState? state, CustomResourceOptions? opts = null)
public static PolicyObjectPreferredColorGroup get(String name, Output<String> id, PolicyObjectPreferredColorGroupState state, CustomResourceOptions options)
resources:  _:    type: sdwan:PolicyObjectPreferredColorGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 of the Policy_object
Entries List<PolicyObjectPreferredColorGroupEntry>
Preferred Color Group List
FeatureProfileId string
Feature Profile ID
Name string
The name of the Policy_object
Version int
The version of the Policy_object
Description string
The description of the Policy_object
Entries []PolicyObjectPreferredColorGroupEntryArgs
Preferred Color Group List
FeatureProfileId string
Feature Profile ID
Name string
The name of the Policy_object
Version int
The version of the Policy_object
description String
The description of the Policy_object
entries List<PolicyObjectPreferredColorGroupEntry>
Preferred Color Group List
featureProfileId String
Feature Profile ID
name String
The name of the Policy_object
version Integer
The version of the Policy_object
description string
The description of the Policy_object
entries PolicyObjectPreferredColorGroupEntry[]
Preferred Color Group List
featureProfileId string
Feature Profile ID
name string
The name of the Policy_object
version number
The version of the Policy_object
description str
The description of the Policy_object
entries Sequence[PolicyObjectPreferredColorGroupEntryArgs]
Preferred Color Group List
feature_profile_id str
Feature Profile ID
name str
The name of the Policy_object
version int
The version of the Policy_object
description String
The description of the Policy_object
entries List<Property Map>
Preferred Color Group List
featureProfileId String
Feature Profile ID
name String
The name of the Policy_object
version Number
The version of the Policy_object

Supporting Types

PolicyObjectPreferredColorGroupEntry
, PolicyObjectPreferredColorGroupEntryArgs

PrimaryColorPreferences List<string>
PrimaryPathPreference string
  • Choices: all-paths, direct-path, multi-hop-path
SecondaryColorPreferences List<string>
SecondaryPathPreference string
  • Choices: all-paths, direct-path, multi-hop-path
TertiaryColorPreferences List<string>
TertiaryPathPreference string
  • Choices: all-paths, direct-path, multi-hop-path
PrimaryColorPreferences []string
PrimaryPathPreference string
  • Choices: all-paths, direct-path, multi-hop-path
SecondaryColorPreferences []string
SecondaryPathPreference string
  • Choices: all-paths, direct-path, multi-hop-path
TertiaryColorPreferences []string
TertiaryPathPreference string
  • Choices: all-paths, direct-path, multi-hop-path
primaryColorPreferences List<String>
primaryPathPreference String
  • Choices: all-paths, direct-path, multi-hop-path
secondaryColorPreferences List<String>
secondaryPathPreference String
  • Choices: all-paths, direct-path, multi-hop-path
tertiaryColorPreferences List<String>
tertiaryPathPreference String
  • Choices: all-paths, direct-path, multi-hop-path
primaryColorPreferences string[]
primaryPathPreference string
  • Choices: all-paths, direct-path, multi-hop-path
secondaryColorPreferences string[]
secondaryPathPreference string
  • Choices: all-paths, direct-path, multi-hop-path
tertiaryColorPreferences string[]
tertiaryPathPreference string
  • Choices: all-paths, direct-path, multi-hop-path
primary_color_preferences Sequence[str]
primary_path_preference str
  • Choices: all-paths, direct-path, multi-hop-path
secondary_color_preferences Sequence[str]
secondary_path_preference str
  • Choices: all-paths, direct-path, multi-hop-path
tertiary_color_preferences Sequence[str]
tertiary_path_preference str
  • Choices: all-paths, direct-path, multi-hop-path
primaryColorPreferences List<String>
primaryPathPreference String
  • Choices: all-paths, direct-path, multi-hop-path
secondaryColorPreferences List<String>
secondaryPathPreference String
  • Choices: all-paths, direct-path, multi-hop-path
tertiaryColorPreferences List<String>
tertiaryPathPreference String
  • Choices: all-paths, direct-path, multi-hop-path

Import

Expected import identifier with the format: “policy_object_preferred_color_group_id,feature_profile_id”

$ pulumi import sdwan:index/policyObjectPreferredColorGroup:PolicyObjectPreferredColorGroup example "f6b2c44c-693c-4763-b010-895aa3d236bd,f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"
Copy

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.