Cisco Catalyst SD-WAN v0.1.1, May 31 24

Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi

sdwan.ConfigurationGroup

Explore with Pulumi AI

Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi

Example Usage

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

const example = new sdwan.ConfigurationGroup("example", {
    name: "CG_1",
    description: "My config group 1",
    solution: "sdwan",
    featureProfiles: [{
        id: "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
    }],
});

import pulumi
import pulumi_sdwan as sdwan

example = sdwan.ConfigurationGroup("example",
    name="CG_1",
    description="My config group 1",
    solution="sdwan",
    feature_profiles=[sdwan.ConfigurationGroupFeatureProfileArgs(
        id="f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
    )])

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.NewConfigurationGroup(ctx, "example", &sdwan.ConfigurationGroupArgs{
			Name:        pulumi.String("CG_1"),
			Description: pulumi.String("My config group 1"),
			Solution:    pulumi.String("sdwan"),
			FeatureProfiles: sdwan.ConfigurationGroupFeatureProfileArray{
				&sdwan.ConfigurationGroupFeatureProfileArgs{
					Id: pulumi.String("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"),
				},
			},
		})
		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.ConfigurationGroup("example", new()
    {
        Name = "CG_1",
        Description = "My config group 1",
        Solution = "sdwan",
        FeatureProfiles = new[]
        {
            new Sdwan.Inputs.ConfigurationGroupFeatureProfileArgs
            {
                Id = "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.ConfigurationGroup;
import com.pulumi.sdwan.ConfigurationGroupArgs;
import com.pulumi.sdwan.inputs.ConfigurationGroupFeatureProfileArgs;
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 ConfigurationGroup("example", ConfigurationGroupArgs.builder()        
            .name("CG_1")
            .description("My config group 1")
            .solution("sdwan")
            .featureProfiles(ConfigurationGroupFeatureProfileArgs.builder()
                .id("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac")
                .build())
            .build());

    }
}

resources:
  example:
    type: sdwan:ConfigurationGroup
    properties:
      name: CG_1
      description: My config group 1
      solution: sdwan
      featureProfiles:
        - id: f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac

Create ConfigurationGroup Resource

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

Constructor syntax

new ConfigurationGroup(name: string, args: ConfigurationGroupArgs, opts?: CustomResourceOptions);

@overload
def ConfigurationGroup(resource_name: str,
                       args: ConfigurationGroupArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def ConfigurationGroup(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       description: Optional[str] = None,
                       solution: Optional[str] = None,
                       feature_profiles: Optional[Sequence[ConfigurationGroupFeatureProfileArgs]] = None,
                       name: Optional[str] = None,
                       topology_devices: Optional[Sequence[ConfigurationGroupTopologyDeviceArgs]] = None,
                       topology_site_devices: Optional[int] = None)

func NewConfigurationGroup(ctx *Context, name string, args ConfigurationGroupArgs, opts ...ResourceOption) (*ConfigurationGroup, error)

public ConfigurationGroup(string name, ConfigurationGroupArgs args, CustomResourceOptions? opts = null)

public ConfigurationGroup(String name, ConfigurationGroupArgs args)
public ConfigurationGroup(String name, ConfigurationGroupArgs args, CustomResourceOptions options)

type: sdwan:ConfigurationGroup
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 ConfigurationGroupArgs: 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 ConfigurationGroupArgs: 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 ConfigurationGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConfigurationGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ConfigurationGroupArgs: 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 configurationGroupResource = new Sdwan.ConfigurationGroup("configurationGroupResource", new()
{
    Description = "string",
    Solution = "string",
    FeatureProfiles = new[]
    {
        new Sdwan.Inputs.ConfigurationGroupFeatureProfileArgs
        {
            Id = "string",
        },
    },
    Name = "string",
    TopologyDevices = new[]
    {
        new Sdwan.Inputs.ConfigurationGroupTopologyDeviceArgs
        {
            CriteriaAttribute = "string",
            CriteriaValue = "string",
            UnsupportedFeatures = new[]
            {
                new Sdwan.Inputs.ConfigurationGroupTopologyDeviceUnsupportedFeatureArgs
                {
                    ParcelId = "string",
                    ParcelType = "string",
                },
            },
        },
    },
    TopologySiteDevices = 0,
});

example, err := sdwan.NewConfigurationGroup(ctx, "configurationGroupResource", &sdwan.ConfigurationGroupArgs{
	Description: pulumi.String("string"),
	Solution:    pulumi.String("string"),
	FeatureProfiles: sdwan.ConfigurationGroupFeatureProfileArray{
		&sdwan.ConfigurationGroupFeatureProfileArgs{
			Id: pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	TopologyDevices: sdwan.ConfigurationGroupTopologyDeviceArray{
		&sdwan.ConfigurationGroupTopologyDeviceArgs{
			CriteriaAttribute: pulumi.String("string"),
			CriteriaValue:     pulumi.String("string"),
			UnsupportedFeatures: sdwan.ConfigurationGroupTopologyDeviceUnsupportedFeatureArray{
				&sdwan.ConfigurationGroupTopologyDeviceUnsupportedFeatureArgs{
					ParcelId:   pulumi.String("string"),
					ParcelType: pulumi.String("string"),
				},
			},
		},
	},
	TopologySiteDevices: pulumi.Int(0),
})

var configurationGroupResource = new ConfigurationGroup("configurationGroupResource", ConfigurationGroupArgs.builder()
    .description("string")
    .solution("string")
    .featureProfiles(ConfigurationGroupFeatureProfileArgs.builder()
        .id("string")
        .build())
    .name("string")
    .topologyDevices(ConfigurationGroupTopologyDeviceArgs.builder()
        .criteriaAttribute("string")
        .criteriaValue("string")
        .unsupportedFeatures(ConfigurationGroupTopologyDeviceUnsupportedFeatureArgs.builder()
            .parcelId("string")
            .parcelType("string")
            .build())
        .build())
    .topologySiteDevices(0)
    .build());

configuration_group_resource = sdwan.ConfigurationGroup("configurationGroupResource",
    description="string",
    solution="string",
    feature_profiles=[sdwan.ConfigurationGroupFeatureProfileArgs(
        id="string",
    )],
    name="string",
    topology_devices=[sdwan.ConfigurationGroupTopologyDeviceArgs(
        criteria_attribute="string",
        criteria_value="string",
        unsupported_features=[sdwan.ConfigurationGroupTopologyDeviceUnsupportedFeatureArgs(
            parcel_id="string",
            parcel_type="string",
        )],
    )],
    topology_site_devices=0)

const configurationGroupResource = new sdwan.ConfigurationGroup("configurationGroupResource", {
    description: "string",
    solution: "string",
    featureProfiles: [{
        id: "string",
    }],
    name: "string",
    topologyDevices: [{
        criteriaAttribute: "string",
        criteriaValue: "string",
        unsupportedFeatures: [{
            parcelId: "string",
            parcelType: "string",
        }],
    }],
    topologySiteDevices: 0,
});

type: sdwan:ConfigurationGroup
properties:
    description: string
    featureProfiles:
        - id: string
    name: string
    solution: string
    topologyDevices:
        - criteriaAttribute: string
          criteriaValue: string
          unsupportedFeatures:
            - parcelId: string
              parcelType: string
    topologySiteDevices: 0

ConfigurationGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ConfigurationGroup resource accepts the following input properties:

Description string: Description
Solution string: Type of solution - Choices: mobility, sdwan, nfvirtual
FeatureProfiles List<ConfigurationGroupFeatureProfile>: List of feature profiles
Name string: The name of the configuration group
TopologyDevices List<ConfigurationGroupTopologyDevice>: List of topology device types
TopologySiteDevices int: Number of devices per site - Range: 1-20

Description string: Description
Solution string: Type of solution - Choices: mobility, sdwan, nfvirtual
FeatureProfiles []ConfigurationGroupFeatureProfileArgs: List of feature profiles
Name string: The name of the configuration group
TopologyDevices []ConfigurationGroupTopologyDeviceArgs: List of topology device types
TopologySiteDevices int: Number of devices per site - Range: 1-20

description String: Description
solution String: Type of solution - Choices: mobility, sdwan, nfvirtual
featureProfiles List<ConfigurationGroupFeatureProfile>: List of feature profiles
name String: The name of the configuration group
topologyDevices List<ConfigurationGroupTopologyDevice>: List of topology device types
topologySiteDevices Integer: Number of devices per site - Range: 1-20

description string: Description
solution string: Type of solution - Choices: mobility, sdwan, nfvirtual
featureProfiles ConfigurationGroupFeatureProfile[]: List of feature profiles
name string: The name of the configuration group
topologyDevices ConfigurationGroupTopologyDevice[]: List of topology device types
topologySiteDevices number: Number of devices per site - Range: 1-20

description str: Description
solution str: Type of solution - Choices: mobility, sdwan, nfvirtual
feature_profiles Sequence[ConfigurationGroupFeatureProfileArgs]: List of feature profiles
name str: The name of the configuration group
topology_devices Sequence[ConfigurationGroupTopologyDeviceArgs]: List of topology device types
topology_site_devices int: Number of devices per site - Range: 1-20

description String: Description
solution String: Type of solution - Choices: mobility, sdwan, nfvirtual
featureProfiles List<Property Map>: List of feature profiles
name String: The name of the configuration group
topologyDevices List<Property Map>: List of topology device types
topologySiteDevices Number: Number of devices per site - Range: 1-20

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing ConfigurationGroup Resource

Get an existing ConfigurationGroup 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?: ConfigurationGroupState, opts?: CustomResourceOptions): ConfigurationGroup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        feature_profiles: Optional[Sequence[ConfigurationGroupFeatureProfileArgs]] = None,
        name: Optional[str] = None,
        solution: Optional[str] = None,
        topology_devices: Optional[Sequence[ConfigurationGroupTopologyDeviceArgs]] = None,
        topology_site_devices: Optional[int] = None) -> ConfigurationGroup

func GetConfigurationGroup(ctx *Context, name string, id IDInput, state *ConfigurationGroupState, opts ...ResourceOption) (*ConfigurationGroup, error)

public static ConfigurationGroup Get(string name, Input<string> id, ConfigurationGroupState? state, CustomResourceOptions? opts = null)

public static ConfigurationGroup get(String name, Output<String> id, ConfigurationGroupState 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: Description
FeatureProfiles List<ConfigurationGroupFeatureProfile>: List of feature profiles
Name string: The name of the configuration group
Solution string: Type of solution - Choices: mobility, sdwan, nfvirtual
TopologyDevices List<ConfigurationGroupTopologyDevice>: List of topology device types
TopologySiteDevices int: Number of devices per site - Range: 1-20

Description string: Description
FeatureProfiles []ConfigurationGroupFeatureProfileArgs: List of feature profiles
Name string: The name of the configuration group
Solution string: Type of solution - Choices: mobility, sdwan, nfvirtual
TopologyDevices []ConfigurationGroupTopologyDeviceArgs: List of topology device types
TopologySiteDevices int: Number of devices per site - Range: 1-20

description String: Description
featureProfiles List<ConfigurationGroupFeatureProfile>: List of feature profiles
name String: The name of the configuration group
solution String: Type of solution - Choices: mobility, sdwan, nfvirtual
topologyDevices List<ConfigurationGroupTopologyDevice>: List of topology device types
topologySiteDevices Integer: Number of devices per site - Range: 1-20

description string: Description
featureProfiles ConfigurationGroupFeatureProfile[]: List of feature profiles
name string: The name of the configuration group
solution string: Type of solution - Choices: mobility, sdwan, nfvirtual
topologyDevices ConfigurationGroupTopologyDevice[]: List of topology device types
topologySiteDevices number: Number of devices per site - Range: 1-20

description str: Description
feature_profiles Sequence[ConfigurationGroupFeatureProfileArgs]: List of feature profiles
name str: The name of the configuration group
solution str: Type of solution - Choices: mobility, sdwan, nfvirtual
topology_devices Sequence[ConfigurationGroupTopologyDeviceArgs]: List of topology device types
topology_site_devices int: Number of devices per site - Range: 1-20

description String: Description
featureProfiles List<Property Map>: List of feature profiles
name String: The name of the configuration group
solution String: Type of solution - Choices: mobility, sdwan, nfvirtual
topologyDevices List<Property Map>: List of topology device types
topologySiteDevices Number: Number of devices per site - Range: 1-20

Supporting Types

ConfigurationGroupFeatureProfile, ConfigurationGroupFeatureProfileArgs

Id string: Feature profile ID

Id string: Feature profile ID

id String: Feature profile ID

id string: Feature profile ID

id str: Feature profile ID

id String: Feature profile ID

ConfigurationGroupTopologyDevice, ConfigurationGroupTopologyDeviceArgs

CriteriaAttribute string

Criteria attribute

Choices: tag

CriteriaValue string

Criteria value

UnsupportedFeatures List<ConfigurationGroupTopologyDeviceUnsupportedFeature>

List of unsupported features

CriteriaAttribute string

Criteria attribute

Choices: tag

CriteriaValue string

Criteria value

UnsupportedFeatures []ConfigurationGroupTopologyDeviceUnsupportedFeature

List of unsupported features

criteriaAttribute String

Criteria attribute

Choices: tag

criteriaValue String

Criteria value

unsupportedFeatures List<ConfigurationGroupTopologyDeviceUnsupportedFeature>

List of unsupported features

criteriaAttribute string

Criteria attribute

Choices: tag

criteriaValue string

Criteria value

unsupportedFeatures ConfigurationGroupTopologyDeviceUnsupportedFeature[]

List of unsupported features

criteria_attribute str

Criteria attribute

Choices: tag

criteria_value str

Criteria value

unsupported_features Sequence[ConfigurationGroupTopologyDeviceUnsupportedFeature]

List of unsupported features

criteriaAttribute String

Criteria attribute

Choices: tag

criteriaValue String

Criteria value

unsupportedFeatures List<Property Map>

List of unsupported features

ConfigurationGroupTopologyDeviceUnsupportedFeature, ConfigurationGroupTopologyDeviceUnsupportedFeatureArgs

ParcelId string

Parcel ID

ParcelType string

Parcel type

Choices: wan/vpn/interface/gre, wan/vpn/interface/ethernet, wan/vpn/interface/cellular, wan/vpn/interface/ipsec, wan/vpn/interface/serial, routing/ospf, lan/vpn/interface/ethernet, lan/vpn/interface/svi, lan/vpn/interface/ipsec, lan/vpn

ParcelId string

Parcel ID

ParcelType string

Parcel type

Choices: wan/vpn/interface/gre, wan/vpn/interface/ethernet, wan/vpn/interface/cellular, wan/vpn/interface/ipsec, wan/vpn/interface/serial, routing/ospf, lan/vpn/interface/ethernet, lan/vpn/interface/svi, lan/vpn/interface/ipsec, lan/vpn

parcelId String

Parcel ID

parcelType String

Parcel type

Choices: wan/vpn/interface/gre, wan/vpn/interface/ethernet, wan/vpn/interface/cellular, wan/vpn/interface/ipsec, wan/vpn/interface/serial, routing/ospf, lan/vpn/interface/ethernet, lan/vpn/interface/svi, lan/vpn/interface/ipsec, lan/vpn

parcelId string

Parcel ID

parcelType string

Parcel type

Choices: wan/vpn/interface/gre, wan/vpn/interface/ethernet, wan/vpn/interface/cellular, wan/vpn/interface/ipsec, wan/vpn/interface/serial, routing/ospf, lan/vpn/interface/ethernet, lan/vpn/interface/svi, lan/vpn/interface/ipsec, lan/vpn

parcel_id str

Parcel ID

parcel_type str

Parcel type

Choices: wan/vpn/interface/gre, wan/vpn/interface/ethernet, wan/vpn/interface/cellular, wan/vpn/interface/ipsec, wan/vpn/interface/serial, routing/ospf, lan/vpn/interface/ethernet, lan/vpn/interface/svi, lan/vpn/interface/ipsec, lan/vpn

parcelId String

Parcel ID

parcelType String

Parcel type

Choices: wan/vpn/interface/gre, wan/vpn/interface/ethernet, wan/vpn/interface/cellular, wan/vpn/interface/ipsec, wan/vpn/interface/serial, routing/ospf, lan/vpn/interface/ethernet, lan/vpn/interface/svi, lan/vpn/interface/ipsec, lan/vpn

Import

$ pulumi import sdwan:index/configurationGroup:ConfigurationGroup 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.

Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi

pulumi/pulumi-sdwan

sdwan.ConfigurationGroup

On this page

On this page

Example Usage

Create ConfigurationGroup Resource

Constructor syntax

Parameters

Constructor example

ConfigurationGroup Resource Properties

Inputs

Outputs

Look up Existing ConfigurationGroup Resource

Supporting Types

ConfigurationGroupFeatureProfile, ConfigurationGroupFeatureProfileArgs

ConfigurationGroupTopologyDevice, ConfigurationGroupTopologyDeviceArgs

ConfigurationGroupTopologyDeviceUnsupportedFeature, ConfigurationGroupTopologyDeviceUnsupportedFeatureArgs

Import

Package Details

On this page

On this page