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

sdwan.PolicyObjectColorList

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 Policy Object Color List Policy_object.

    • Minimum SD-WAN Manager version: 20.12.0

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdwan from "@pulumi/sdwan";
    
    const example = new sdwan.PolicyObjectColorList("example", {
        name: "Example",
        description: "My Example",
        featureProfileId: "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
        entries: [{
            color: "blue",
        }],
    });
    
    import pulumi
    import pulumi_sdwan as sdwan
    
    example = sdwan.PolicyObjectColorList("example",
        name="Example",
        description="My Example",
        feature_profile_id="f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
        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.NewPolicyObjectColorList(ctx, "example", &sdwan.PolicyObjectColorListArgs{
    			Name:             pulumi.String("Example"),
    			Description:      pulumi.String("My Example"),
    			FeatureProfileId: pulumi.String("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"),
    			Entries: sdwan.PolicyObjectColorListEntryArray{
    				&sdwan.PolicyObjectColorListEntryArgs{
    					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.PolicyObjectColorList("example", new()
        {
            Name = "Example",
            Description = "My Example",
            FeatureProfileId = "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
            Entries = new[]
            {
                new Sdwan.Inputs.PolicyObjectColorListEntryArgs
                {
                    Color = "blue",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdwan.PolicyObjectColorList;
    import com.pulumi.sdwan.PolicyObjectColorListArgs;
    import com.pulumi.sdwan.inputs.PolicyObjectColorListEntryArgs;
    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 PolicyObjectColorList("example", PolicyObjectColorListArgs.builder()
                .name("Example")
                .description("My Example")
                .featureProfileId("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac")
                .entries(PolicyObjectColorListEntryArgs.builder()
                    .color("blue")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: sdwan:PolicyObjectColorList
        properties:
          name: Example
          description: My Example
          featureProfileId: f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac
          entries:
            - color: blue
    

    Create PolicyObjectColorList Resource

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

    Constructor syntax

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

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

    Entries List<PolicyObjectColorListEntry>
    Color List
    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the Policy_object
    Name string
    The name of the Policy_object
    Entries []PolicyObjectColorListEntryArgs
    Color List
    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the Policy_object
    Name string
    The name of the Policy_object
    entries List<PolicyObjectColorListEntry>
    Color List
    featureProfileId String
    Feature Profile ID
    description String
    The description of the Policy_object
    name String
    The name of the Policy_object
    entries PolicyObjectColorListEntry[]
    Color List
    featureProfileId string
    Feature Profile ID
    description string
    The description of the Policy_object
    name string
    The name of the Policy_object
    entries Sequence[PolicyObjectColorListEntryArgs]
    Color List
    feature_profile_id str
    Feature Profile ID
    description str
    The description of the Policy_object
    name str
    The name of the Policy_object
    entries List<Property Map>
    Color List
    featureProfileId 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 PolicyObjectColorList 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 PolicyObjectColorList Resource

    Get an existing PolicyObjectColorList 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?: PolicyObjectColorListState, opts?: CustomResourceOptions): PolicyObjectColorList
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            entries: Optional[Sequence[PolicyObjectColorListEntryArgs]] = None,
            feature_profile_id: Optional[str] = None,
            name: Optional[str] = None,
            version: Optional[int] = None) -> PolicyObjectColorList
    func GetPolicyObjectColorList(ctx *Context, name string, id IDInput, state *PolicyObjectColorListState, opts ...ResourceOption) (*PolicyObjectColorList, error)
    public static PolicyObjectColorList Get(string name, Input<string> id, PolicyObjectColorListState? state, CustomResourceOptions? opts = null)
    public static PolicyObjectColorList get(String name, Output<String> id, PolicyObjectColorListState 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 of the Policy_object
    Entries List<PolicyObjectColorListEntry>
    Color 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 []PolicyObjectColorListEntryArgs
    Color 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<PolicyObjectColorListEntry>
    Color 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 PolicyObjectColorListEntry[]
    Color 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[PolicyObjectColorListEntryArgs]
    Color 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>
    Color List
    featureProfileId String
    Feature Profile ID
    name String
    The name of the Policy_object
    version Number
    The version of the Policy_object

    Supporting Types

    PolicyObjectColorListEntry, PolicyObjectColorListEntryArgs

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

    Import

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

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

    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