1. Packages
  2. Packages
  3. Cisco Catalyst SD-WAN Provider
  4. API Docs
  5. TopologyGroup
Viewing docs for Cisco Catalyst SD-WAN v0.9.1
published on Friday, Jun 26, 2026 by Pulumi
sdwan logo
Viewing docs for Cisco Catalyst SD-WAN v0.9.1
published on Friday, Jun 26, 2026 by Pulumi

    This resource can manage a Topology Group .

    • Minimum SD-WAN Manager version: 20.15.0

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdwan from "@pulumi/sdwan";
    
    const example = new sdwan.TopologyGroup("example", {
        name: "TG_1",
        description: "My topology group 1",
        solution: "sdwan",
        featureProfileIds: ["f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"],
    });
    
    import pulumi
    import pulumi_sdwan as sdwan
    
    example = sdwan.TopologyGroup("example",
        name="TG_1",
        description="My topology group 1",
        solution="sdwan",
        feature_profile_ids=["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.NewTopologyGroup(ctx, "example", &sdwan.TopologyGroupArgs{
    			Name:        pulumi.String("TG_1"),
    			Description: pulumi.String("My topology group 1"),
    			Solution:    pulumi.String("sdwan"),
    			FeatureProfileIds: pulumi.StringArray{
    				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.TopologyGroup("example", new()
        {
            Name = "TG_1",
            Description = "My topology group 1",
            Solution = "sdwan",
            FeatureProfileIds = new[]
            {
                "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.TopologyGroup;
    import com.pulumi.sdwan.TopologyGroupArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 TopologyGroup("example", TopologyGroupArgs.builder()
                .name("TG_1")
                .description("My topology group 1")
                .solution("sdwan")
                .featureProfileIds("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac")
                .build());
    
        }
    }
    
    resources:
      example:
        type: sdwan:TopologyGroup
        properties:
          name: TG_1
          description: My topology group 1
          solution: sdwan
          featureProfileIds:
            - f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac
    
    pulumi {
      required_providers {
        sdwan = {
          source = "pulumi/sdwan"
        }
      }
    }
    
    resource "sdwan_topologygroup" "example" {
      name                = "TG_1"
      description         = "My topology group 1"
      solution            = "sdwan"
      feature_profile_ids = ["f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"]
    }
    

    Create TopologyGroup Resource

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

    Constructor syntax

    new TopologyGroup(name: string, args: TopologyGroupArgs, opts?: CustomResourceOptions);
    @overload
    def TopologyGroup(resource_name: str,
                      args: TopologyGroupArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def TopologyGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      description: Optional[str] = None,
                      solution: Optional[str] = None,
                      feature_profile_ids: Optional[Sequence[str]] = None,
                      name: Optional[str] = None)
    func NewTopologyGroup(ctx *Context, name string, args TopologyGroupArgs, opts ...ResourceOption) (*TopologyGroup, error)
    public TopologyGroup(string name, TopologyGroupArgs args, CustomResourceOptions? opts = null)
    public TopologyGroup(String name, TopologyGroupArgs args)
    public TopologyGroup(String name, TopologyGroupArgs args, CustomResourceOptions options)
    
    type: sdwan:TopologyGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "sdwan_topologygroup" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args TopologyGroupArgs
    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 TopologyGroupArgs
    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 TopologyGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TopologyGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TopologyGroupArgs
    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 topologyGroupResource = new Sdwan.TopologyGroup("topologyGroupResource", new()
    {
        Description = "string",
        Solution = "string",
        FeatureProfileIds = new[]
        {
            "string",
        },
        Name = "string",
    });
    
    example, err := sdwan.NewTopologyGroup(ctx, "topologyGroupResource", &sdwan.TopologyGroupArgs{
    	Description: pulumi.String("string"),
    	Solution:    pulumi.String("string"),
    	FeatureProfileIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    })
    
    resource "sdwan_topologygroup" "topologyGroupResource" {
      description         = "string"
      solution            = "string"
      feature_profile_ids = ["string"]
      name                = "string"
    }
    
    var topologyGroupResource = new TopologyGroup("topologyGroupResource", TopologyGroupArgs.builder()
        .description("string")
        .solution("string")
        .featureProfileIds("string")
        .name("string")
        .build());
    
    topology_group_resource = sdwan.TopologyGroup("topologyGroupResource",
        description="string",
        solution="string",
        feature_profile_ids=["string"],
        name="string")
    
    const topologyGroupResource = new sdwan.TopologyGroup("topologyGroupResource", {
        description: "string",
        solution: "string",
        featureProfileIds: ["string"],
        name: "string",
    });
    
    type: sdwan:TopologyGroup
    properties:
        description: string
        featureProfileIds:
            - string
        name: string
        solution: string
    

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

    Description string
    Description
    Solution string
    Type of solution

    • Choices: sdwan
    FeatureProfileIds List<string>
    List of feature profile IDs
    Name string
    The name of the topology group
    Description string
    Description
    Solution string
    Type of solution

    • Choices: sdwan
    FeatureProfileIds []string
    List of feature profile IDs
    Name string
    The name of the topology group
    description string
    Description
    solution string
    Type of solution

    • Choices: sdwan
    feature_profile_ids list(string)
    List of feature profile IDs
    name string
    The name of the topology group
    description String
    Description
    solution String
    Type of solution

    • Choices: sdwan
    featureProfileIds List<String>
    List of feature profile IDs
    name String
    The name of the topology group
    description string
    Description
    solution string
    Type of solution

    • Choices: sdwan
    featureProfileIds string[]
    List of feature profile IDs
    name string
    The name of the topology group
    description str
    Description
    solution str
    Type of solution

    • Choices: sdwan
    feature_profile_ids Sequence[str]
    List of feature profile IDs
    name str
    The name of the topology group
    description String
    Description
    solution String
    Type of solution

    • Choices: sdwan
    featureProfileIds List<String>
    List of feature profile IDs
    name String
    The name of the topology group

    Outputs

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

    Get an existing TopologyGroup 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?: TopologyGroupState, opts?: CustomResourceOptions): TopologyGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            feature_profile_ids: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            solution: Optional[str] = None) -> TopologyGroup
    func GetTopologyGroup(ctx *Context, name string, id IDInput, state *TopologyGroupState, opts ...ResourceOption) (*TopologyGroup, error)
    public static TopologyGroup Get(string name, Input<string> id, TopologyGroupState? state, CustomResourceOptions? opts = null)
    public static TopologyGroup get(String name, Output<String> id, TopologyGroupState state, CustomResourceOptions options)
    resources:  _:    type: sdwan:TopologyGroup    get:      id: ${id}
    import {
      to = sdwan_topologygroup.example
      id = "${id}"
    }
    
    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
    FeatureProfileIds List<string>
    List of feature profile IDs
    Name string
    The name of the topology group
    Solution string
    Type of solution

    • Choices: sdwan
    Description string
    Description
    FeatureProfileIds []string
    List of feature profile IDs
    Name string
    The name of the topology group
    Solution string
    Type of solution

    • Choices: sdwan
    description string
    Description
    feature_profile_ids list(string)
    List of feature profile IDs
    name string
    The name of the topology group
    solution string
    Type of solution

    • Choices: sdwan
    description String
    Description
    featureProfileIds List<String>
    List of feature profile IDs
    name String
    The name of the topology group
    solution String
    Type of solution

    • Choices: sdwan
    description string
    Description
    featureProfileIds string[]
    List of feature profile IDs
    name string
    The name of the topology group
    solution string
    Type of solution

    • Choices: sdwan
    description str
    Description
    feature_profile_ids Sequence[str]
    List of feature profile IDs
    name str
    The name of the topology group
    solution str
    Type of solution

    • Choices: sdwan
    description String
    Description
    featureProfileIds List<String>
    List of feature profile IDs
    name String
    The name of the topology group
    solution String
    Type of solution

    • Choices: sdwan

    Import

    The pulumi import command can be used, for example:

    $ pulumi import sdwan:index/topologyGroup:TopologyGroup 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
    Viewing docs for Cisco Catalyst SD-WAN v0.9.1
    published on Friday, Jun 26, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial