sdwan.HubAndSpokeTopologyPolicyDefinition
Explore with Pulumi AI
This resource can manage a Hub and Spoke Topology Policy Definition .
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.HubAndSpokeTopologyPolicyDefinition;
import com.pulumi.sdwan.HubAndSpokeTopologyPolicyDefinitionArgs;
import com.pulumi.sdwan.inputs.HubAndSpokeTopologyPolicyDefinitionTopologyArgs;
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 HubAndSpokeTopologyPolicyDefinition("example", HubAndSpokeTopologyPolicyDefinitionArgs.builder()
            .name("Example")
            .description("My description")
            .vpnListId("04fcbb0b-efbf-43d2-a04b-847d3a7b104e")
            .topologies(HubAndSpokeTopologyPolicyDefinitionTopologyArgs.builder()
                .name("Topology1")
                .all_hubs_are_equal(false)
                .advertise_hub_tlocs(true)
                .tloc_list_id("b326e448-bf33-47e4-83e7-f947e6981382")
                .spokes(HubAndSpokeTopologyPolicyDefinitionTopologySpokeArgs.builder()
                    .siteListId("e858e1c4-6aa8-4de7-99df-c3adbf80290d")
                    .hubs(HubAndSpokeTopologyPolicyDefinitionTopologySpokeHubArgs.builder()
                        .siteListId("e858e1c4-6aa8-4de7-99df-c3adbf80290d")
                        .preference("30")
                        .build())
                    .build())
                .build())
            .build());
    }
}
resources:
  example:
    type: sdwan:HubAndSpokeTopologyPolicyDefinition
    properties:
      name: Example
      description: My description
      vpnListId: 04fcbb0b-efbf-43d2-a04b-847d3a7b104e
      topologies:
        - name: Topology1
          all_hubs_are_equal: false
          advertise_hub_tlocs: true
          tloc_list_id: b326e448-bf33-47e4-83e7-f947e6981382
          spokes:
            - siteListId: e858e1c4-6aa8-4de7-99df-c3adbf80290d
              hubs:
                - siteListId: e858e1c4-6aa8-4de7-99df-c3adbf80290d
                  preference: '30'
Create HubAndSpokeTopologyPolicyDefinition Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HubAndSpokeTopologyPolicyDefinition(name: string, args: HubAndSpokeTopologyPolicyDefinitionArgs, opts?: CustomResourceOptions);@overload
def HubAndSpokeTopologyPolicyDefinition(resource_name: str,
                                        args: HubAndSpokeTopologyPolicyDefinitionArgs,
                                        opts: Optional[ResourceOptions] = None)
@overload
def HubAndSpokeTopologyPolicyDefinition(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        description: Optional[str] = None,
                                        topologies: Optional[Sequence[HubAndSpokeTopologyPolicyDefinitionTopologyArgs]] = None,
                                        name: Optional[str] = None,
                                        vpn_list_id: Optional[str] = None,
                                        vpn_list_version: Optional[int] = None)func NewHubAndSpokeTopologyPolicyDefinition(ctx *Context, name string, args HubAndSpokeTopologyPolicyDefinitionArgs, opts ...ResourceOption) (*HubAndSpokeTopologyPolicyDefinition, error)public HubAndSpokeTopologyPolicyDefinition(string name, HubAndSpokeTopologyPolicyDefinitionArgs args, CustomResourceOptions? opts = null)
public HubAndSpokeTopologyPolicyDefinition(String name, HubAndSpokeTopologyPolicyDefinitionArgs args)
public HubAndSpokeTopologyPolicyDefinition(String name, HubAndSpokeTopologyPolicyDefinitionArgs args, CustomResourceOptions options)
type: sdwan:HubAndSpokeTopologyPolicyDefinition
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 HubAndSpokeTopologyPolicyDefinitionArgs
- 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 HubAndSpokeTopologyPolicyDefinitionArgs
- 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 HubAndSpokeTopologyPolicyDefinitionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HubAndSpokeTopologyPolicyDefinitionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HubAndSpokeTopologyPolicyDefinitionArgs
- 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 hubAndSpokeTopologyPolicyDefinitionResource = new Sdwan.HubAndSpokeTopologyPolicyDefinition("hubAndSpokeTopologyPolicyDefinitionResource", new()
{
    Description = "string",
    Topologies = new[]
    {
        new Sdwan.Inputs.HubAndSpokeTopologyPolicyDefinitionTopologyArgs
        {
            Name = "string",
            AdvertiseHubTlocs = false,
            AllHubsAreEqual = false,
            Spokes = new[]
            {
                new Sdwan.Inputs.HubAndSpokeTopologyPolicyDefinitionTopologySpokeArgs
                {
                    Hubs = new[]
                    {
                        new Sdwan.Inputs.HubAndSpokeTopologyPolicyDefinitionTopologySpokeHubArgs
                        {
                            Ipv4PrefixListIds = new[]
                            {
                                "string",
                            },
                            Ipv6PrefixListIds = new[]
                            {
                                "string",
                            },
                            Preference = "string",
                            SiteListId = "string",
                            SiteListVersion = 0,
                        },
                    },
                    SiteListId = "string",
                    SiteListVersion = 0,
                },
            },
            TlocListId = "string",
        },
    },
    Name = "string",
    VpnListId = "string",
    VpnListVersion = 0,
});
example, err := sdwan.NewHubAndSpokeTopologyPolicyDefinition(ctx, "hubAndSpokeTopologyPolicyDefinitionResource", &sdwan.HubAndSpokeTopologyPolicyDefinitionArgs{
	Description: pulumi.String("string"),
	Topologies: sdwan.HubAndSpokeTopologyPolicyDefinitionTopologyArray{
		&sdwan.HubAndSpokeTopologyPolicyDefinitionTopologyArgs{
			Name:              pulumi.String("string"),
			AdvertiseHubTlocs: pulumi.Bool(false),
			AllHubsAreEqual:   pulumi.Bool(false),
			Spokes: sdwan.HubAndSpokeTopologyPolicyDefinitionTopologySpokeArray{
				&sdwan.HubAndSpokeTopologyPolicyDefinitionTopologySpokeArgs{
					Hubs: sdwan.HubAndSpokeTopologyPolicyDefinitionTopologySpokeHubArray{
						&sdwan.HubAndSpokeTopologyPolicyDefinitionTopologySpokeHubArgs{
							Ipv4PrefixListIds: pulumi.StringArray{
								pulumi.String("string"),
							},
							Ipv6PrefixListIds: pulumi.StringArray{
								pulumi.String("string"),
							},
							Preference:      pulumi.String("string"),
							SiteListId:      pulumi.String("string"),
							SiteListVersion: pulumi.Int(0),
						},
					},
					SiteListId:      pulumi.String("string"),
					SiteListVersion: pulumi.Int(0),
				},
			},
			TlocListId: pulumi.String("string"),
		},
	},
	Name:           pulumi.String("string"),
	VpnListId:      pulumi.String("string"),
	VpnListVersion: pulumi.Int(0),
})
var hubAndSpokeTopologyPolicyDefinitionResource = new HubAndSpokeTopologyPolicyDefinition("hubAndSpokeTopologyPolicyDefinitionResource", HubAndSpokeTopologyPolicyDefinitionArgs.builder()
    .description("string")
    .topologies(HubAndSpokeTopologyPolicyDefinitionTopologyArgs.builder()
        .name("string")
        .advertiseHubTlocs(false)
        .allHubsAreEqual(false)
        .spokes(HubAndSpokeTopologyPolicyDefinitionTopologySpokeArgs.builder()
            .hubs(HubAndSpokeTopologyPolicyDefinitionTopologySpokeHubArgs.builder()
                .ipv4PrefixListIds("string")
                .ipv6PrefixListIds("string")
                .preference("string")
                .siteListId("string")
                .siteListVersion(0)
                .build())
            .siteListId("string")
            .siteListVersion(0)
            .build())
        .tlocListId("string")
        .build())
    .name("string")
    .vpnListId("string")
    .vpnListVersion(0)
    .build());
hub_and_spoke_topology_policy_definition_resource = sdwan.HubAndSpokeTopologyPolicyDefinition("hubAndSpokeTopologyPolicyDefinitionResource",
    description="string",
    topologies=[{
        "name": "string",
        "advertise_hub_tlocs": False,
        "all_hubs_are_equal": False,
        "spokes": [{
            "hubs": [{
                "ipv4_prefix_list_ids": ["string"],
                "ipv6_prefix_list_ids": ["string"],
                "preference": "string",
                "site_list_id": "string",
                "site_list_version": 0,
            }],
            "site_list_id": "string",
            "site_list_version": 0,
        }],
        "tloc_list_id": "string",
    }],
    name="string",
    vpn_list_id="string",
    vpn_list_version=0)
const hubAndSpokeTopologyPolicyDefinitionResource = new sdwan.HubAndSpokeTopologyPolicyDefinition("hubAndSpokeTopologyPolicyDefinitionResource", {
    description: "string",
    topologies: [{
        name: "string",
        advertiseHubTlocs: false,
        allHubsAreEqual: false,
        spokes: [{
            hubs: [{
                ipv4PrefixListIds: ["string"],
                ipv6PrefixListIds: ["string"],
                preference: "string",
                siteListId: "string",
                siteListVersion: 0,
            }],
            siteListId: "string",
            siteListVersion: 0,
        }],
        tlocListId: "string",
    }],
    name: "string",
    vpnListId: "string",
    vpnListVersion: 0,
});
type: sdwan:HubAndSpokeTopologyPolicyDefinition
properties:
    description: string
    name: string
    topologies:
        - advertiseHubTlocs: false
          allHubsAreEqual: false
          name: string
          spokes:
            - hubs:
                - ipv4PrefixListIds:
                    - string
                  ipv6PrefixListIds:
                    - string
                  preference: string
                  siteListId: string
                  siteListVersion: 0
              siteListId: string
              siteListVersion: 0
          tlocListId: string
    vpnListId: string
    vpnListVersion: 0
HubAndSpokeTopologyPolicyDefinition 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 HubAndSpokeTopologyPolicyDefinition resource accepts the following input properties:
- Description string
- The description of the policy definition
- Topologies
List<HubAnd Spoke Topology Policy Definition Topology> 
- List of topologies
- Name string
- The name of the policy definition
- VpnList stringId 
- VPN list ID
- VpnList intVersion 
- VPN list version
- Description string
- The description of the policy definition
- Topologies
[]HubAnd Spoke Topology Policy Definition Topology Args 
- List of topologies
- Name string
- The name of the policy definition
- VpnList stringId 
- VPN list ID
- VpnList intVersion 
- VPN list version
- description String
- The description of the policy definition
- topologies
List<HubAnd Spoke Topology Policy Definition Topology> 
- List of topologies
- name String
- The name of the policy definition
- vpnList StringId 
- VPN list ID
- vpnList IntegerVersion 
- VPN list version
- description string
- The description of the policy definition
- topologies
HubAnd Spoke Topology Policy Definition Topology[] 
- List of topologies
- name string
- The name of the policy definition
- vpnList stringId 
- VPN list ID
- vpnList numberVersion 
- VPN list version
- description str
- The description of the policy definition
- topologies
Sequence[HubAnd Spoke Topology Policy Definition Topology Args] 
- List of topologies
- name str
- The name of the policy definition
- vpn_list_ strid 
- VPN list ID
- vpn_list_ intversion 
- VPN list version
- description String
- The description of the policy definition
- topologies List<Property Map>
- List of topologies
- name String
- The name of the policy definition
- vpnList StringId 
- VPN list ID
- vpnList NumberVersion 
- VPN list version
Outputs
All input properties are implicitly available as output properties. Additionally, the HubAndSpokeTopologyPolicyDefinition resource produces the following output properties:
Look up Existing HubAndSpokeTopologyPolicyDefinition Resource
Get an existing HubAndSpokeTopologyPolicyDefinition 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?: HubAndSpokeTopologyPolicyDefinitionState, opts?: CustomResourceOptions): HubAndSpokeTopologyPolicyDefinition@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        topologies: Optional[Sequence[HubAndSpokeTopologyPolicyDefinitionTopologyArgs]] = None,
        type: Optional[str] = None,
        version: Optional[int] = None,
        vpn_list_id: Optional[str] = None,
        vpn_list_version: Optional[int] = None) -> HubAndSpokeTopologyPolicyDefinitionfunc GetHubAndSpokeTopologyPolicyDefinition(ctx *Context, name string, id IDInput, state *HubAndSpokeTopologyPolicyDefinitionState, opts ...ResourceOption) (*HubAndSpokeTopologyPolicyDefinition, error)public static HubAndSpokeTopologyPolicyDefinition Get(string name, Input<string> id, HubAndSpokeTopologyPolicyDefinitionState? state, CustomResourceOptions? opts = null)public static HubAndSpokeTopologyPolicyDefinition get(String name, Output<String> id, HubAndSpokeTopologyPolicyDefinitionState state, CustomResourceOptions options)resources:  _:    type: sdwan:HubAndSpokeTopologyPolicyDefinition    get:      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.
- Description string
- The description of the policy definition
- Name string
- The name of the policy definition
- Topologies
List<HubAnd Spoke Topology Policy Definition Topology> 
- List of topologies
- Type string
- Type
- Version int
- The version of the object
- VpnList stringId 
- VPN list ID
- VpnList intVersion 
- VPN list version
- Description string
- The description of the policy definition
- Name string
- The name of the policy definition
- Topologies
[]HubAnd Spoke Topology Policy Definition Topology Args 
- List of topologies
- Type string
- Type
- Version int
- The version of the object
- VpnList stringId 
- VPN list ID
- VpnList intVersion 
- VPN list version
- description String
- The description of the policy definition
- name String
- The name of the policy definition
- topologies
List<HubAnd Spoke Topology Policy Definition Topology> 
- List of topologies
- type String
- Type
- version Integer
- The version of the object
- vpnList StringId 
- VPN list ID
- vpnList IntegerVersion 
- VPN list version
- description string
- The description of the policy definition
- name string
- The name of the policy definition
- topologies
HubAnd Spoke Topology Policy Definition Topology[] 
- List of topologies
- type string
- Type
- version number
- The version of the object
- vpnList stringId 
- VPN list ID
- vpnList numberVersion 
- VPN list version
- description str
- The description of the policy definition
- name str
- The name of the policy definition
- topologies
Sequence[HubAnd Spoke Topology Policy Definition Topology Args] 
- List of topologies
- type str
- Type
- version int
- The version of the object
- vpn_list_ strid 
- VPN list ID
- vpn_list_ intversion 
- VPN list version
- description String
- The description of the policy definition
- name String
- The name of the policy definition
- topologies List<Property Map>
- List of topologies
- type String
- Type
- version Number
- The version of the object
- vpnList StringId 
- VPN list ID
- vpnList NumberVersion 
- VPN list version
Supporting Types
HubAndSpokeTopologyPolicyDefinitionTopology, HubAndSpokeTopologyPolicyDefinitionTopologyArgs              
- Name string
- Topology name
- AdvertiseHub boolTlocs 
- Advertise Hub TLOCs
- AllHubs boolAre Equal 
- All hubs are equal (All Spokes Sites connect to all Hubs)
- Spokes
List<HubAnd Spoke Topology Policy Definition Topology Spoke> 
- List of spokes
- TlocList stringId 
- TLOC list ID (required when advertise_hub_tlocsis 'true')
- Name string
- Topology name
- AdvertiseHub boolTlocs 
- Advertise Hub TLOCs
- AllHubs boolAre Equal 
- All hubs are equal (All Spokes Sites connect to all Hubs)
- Spokes
[]HubAnd Spoke Topology Policy Definition Topology Spoke 
- List of spokes
- TlocList stringId 
- TLOC list ID (required when advertise_hub_tlocsis 'true')
- name String
- Topology name
- advertiseHub BooleanTlocs 
- Advertise Hub TLOCs
- allHubs BooleanAre Equal 
- All hubs are equal (All Spokes Sites connect to all Hubs)
- spokes
List<HubAnd Spoke Topology Policy Definition Topology Spoke> 
- List of spokes
- tlocList StringId 
- TLOC list ID (required when advertise_hub_tlocsis 'true')
- name string
- Topology name
- advertiseHub booleanTlocs 
- Advertise Hub TLOCs
- allHubs booleanAre Equal 
- All hubs are equal (All Spokes Sites connect to all Hubs)
- spokes
HubAnd Spoke Topology Policy Definition Topology Spoke[] 
- List of spokes
- tlocList stringId 
- TLOC list ID (required when advertise_hub_tlocsis 'true')
- name str
- Topology name
- advertise_hub_ booltlocs 
- Advertise Hub TLOCs
- all_hubs_ boolare_ equal 
- All hubs are equal (All Spokes Sites connect to all Hubs)
- spokes
Sequence[HubAnd Spoke Topology Policy Definition Topology Spoke] 
- List of spokes
- tloc_list_ strid 
- TLOC list ID (required when advertise_hub_tlocsis 'true')
- name String
- Topology name
- advertiseHub BooleanTlocs 
- Advertise Hub TLOCs
- allHubs BooleanAre Equal 
- All hubs are equal (All Spokes Sites connect to all Hubs)
- spokes List<Property Map>
- List of spokes
- tlocList StringId 
- TLOC list ID (required when advertise_hub_tlocsis 'true')
HubAndSpokeTopologyPolicyDefinitionTopologySpoke, HubAndSpokeTopologyPolicyDefinitionTopologySpokeArgs                
- Hubs
List<HubAnd Spoke Topology Policy Definition Topology Spoke Hub> 
- List of hubs
- SiteList stringId 
- Site list ID
- SiteList intVersion 
- Site list version
- Hubs
[]HubAnd Spoke Topology Policy Definition Topology Spoke Hub 
- List of hubs
- SiteList stringId 
- Site list ID
- SiteList intVersion 
- Site list version
- hubs
List<HubAnd Spoke Topology Policy Definition Topology Spoke Hub> 
- List of hubs
- siteList StringId 
- Site list ID
- siteList IntegerVersion 
- Site list version
- hubs
HubAnd Spoke Topology Policy Definition Topology Spoke Hub[] 
- List of hubs
- siteList stringId 
- Site list ID
- siteList numberVersion 
- Site list version
- hubs
Sequence[HubAnd Spoke Topology Policy Definition Topology Spoke Hub] 
- List of hubs
- site_list_ strid 
- Site list ID
- site_list_ intversion 
- Site list version
- hubs List<Property Map>
- List of hubs
- siteList StringId 
- Site list ID
- siteList NumberVersion 
- Site list version
HubAndSpokeTopologyPolicyDefinitionTopologySpokeHub, HubAndSpokeTopologyPolicyDefinitionTopologySpokeHubArgs                  
- Ipv4PrefixList List<string>Ids 
- List of IPv4 prefix list IDs
- Ipv6PrefixList List<string>Ids 
- List of IPv6 prefix list IDs
- Preference string
- Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equalis 'false')
- SiteList stringId 
- Site list ID
- SiteList intVersion 
- Site list version
- Ipv4PrefixList []stringIds 
- List of IPv4 prefix list IDs
- Ipv6PrefixList []stringIds 
- List of IPv6 prefix list IDs
- Preference string
- Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equalis 'false')
- SiteList stringId 
- Site list ID
- SiteList intVersion 
- Site list version
- ipv4PrefixList List<String>Ids 
- List of IPv4 prefix list IDs
- ipv6PrefixList List<String>Ids 
- List of IPv6 prefix list IDs
- preference String
- Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equalis 'false')
- siteList StringId 
- Site list ID
- siteList IntegerVersion 
- Site list version
- ipv4PrefixList string[]Ids 
- List of IPv4 prefix list IDs
- ipv6PrefixList string[]Ids 
- List of IPv6 prefix list IDs
- preference string
- Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equalis 'false')
- siteList stringId 
- Site list ID
- siteList numberVersion 
- Site list version
- ipv4_prefix_ Sequence[str]list_ ids 
- List of IPv4 prefix list IDs
- ipv6_prefix_ Sequence[str]list_ ids 
- List of IPv6 prefix list IDs
- preference str
- Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equalis 'false')
- site_list_ strid 
- Site list ID
- site_list_ intversion 
- Site list version
- ipv4PrefixList List<String>Ids 
- List of IPv4 prefix list IDs
- ipv6PrefixList List<String>Ids 
- List of IPv6 prefix list IDs
- preference String
- Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equalis 'false')
- siteList StringId 
- Site list ID
- siteList NumberVersion 
- Site list version
Import
$ pulumi import sdwan:index/hubAndSpokeTopologyPolicyDefinition:HubAndSpokeTopologyPolicyDefinition 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 sdwanTerraform Provider.
