Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. MeshTopologyPolicyDefinition
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi
pulumi/pulumi-sdwan

sdwan.MeshTopologyPolicyDefinition

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi
pulumi/pulumi-sdwan

    This resource can manage a Mesh 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.MeshTopologyPolicyDefinition;
import com.pulumi.sdwan.MeshTopologyPolicyDefinitionArgs;
import com.pulumi.sdwan.inputs.MeshTopologyPolicyDefinitionRegionArgs;
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 MeshTopologyPolicyDefinition("example", MeshTopologyPolicyDefinitionArgs.builder()
            .name("Example")
            .description("My description")
            .vpnListId("04fcbb0b-efbf-43d2-a04b-847d3a7b104e")
            .regions(MeshTopologyPolicyDefinitionRegionArgs.builder()
                .name("Region1")
                .site_list_ids("e858e1c4-6aa8-4de7-99df-c3adbf80290d")
                .build())
            .build());

    }
}

    resources:
  example:
    type: sdwan:MeshTopologyPolicyDefinition
    properties:
      name: Example
      description: My description
      vpnListId: 04fcbb0b-efbf-43d2-a04b-847d3a7b104e
      regions:
        - name: Region1
          site_list_ids:
            - e858e1c4-6aa8-4de7-99df-c3adbf80290d

    Create MeshTopologyPolicyDefinition Resource

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

    Constructor syntax

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

@overload
def MeshTopologyPolicyDefinition(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 description: Optional[str] = None,
                                 regions: Optional[Sequence[MeshTopologyPolicyDefinitionRegionArgs]] = None,
                                 name: Optional[str] = None,
                                 vpn_list_id: Optional[str] = None,
                                 vpn_list_version: Optional[int] = None)
    func NewMeshTopologyPolicyDefinition(ctx *Context, name string, args MeshTopologyPolicyDefinitionArgs, opts ...ResourceOption) (*MeshTopologyPolicyDefinition, error)
    public MeshTopologyPolicyDefinition(string name, MeshTopologyPolicyDefinitionArgs args, CustomResourceOptions? opts = null)
    public MeshTopologyPolicyDefinition(String name, MeshTopologyPolicyDefinitionArgs args)
public MeshTopologyPolicyDefinition(String name, MeshTopologyPolicyDefinitionArgs args, CustomResourceOptions options)

    type: sdwan:MeshTopologyPolicyDefinition
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 MeshTopologyPolicyDefinitionArgs
    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 MeshTopologyPolicyDefinitionArgs
    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 MeshTopologyPolicyDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MeshTopologyPolicyDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MeshTopologyPolicyDefinitionArgs
    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 meshTopologyPolicyDefinitionResource = new Sdwan.MeshTopologyPolicyDefinition("meshTopologyPolicyDefinitionResource", new()
{
    Description = "string",
    Regions = new[]
    {
        new Sdwan.Inputs.MeshTopologyPolicyDefinitionRegionArgs
        {
            Name = "string",
            SiteListIds = new[]
            {
                "string",
            },
            SiteListVersions = new[]
            {
                "string",
            },
        },
    },
    Name = "string",
    VpnListId = "string",
    VpnListVersion = 0,
});

    example, err := sdwan.NewMeshTopologyPolicyDefinition(ctx, "meshTopologyPolicyDefinitionResource", &sdwan.MeshTopologyPolicyDefinitionArgs{
	Description: pulumi.String("string"),
	Regions: sdwan.MeshTopologyPolicyDefinitionRegionArray{
		&sdwan.MeshTopologyPolicyDefinitionRegionArgs{
			Name: pulumi.String("string"),
			SiteListIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			SiteListVersions: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Name:           pulumi.String("string"),
	VpnListId:      pulumi.String("string"),
	VpnListVersion: pulumi.Int(0),
})

    var meshTopologyPolicyDefinitionResource = new MeshTopologyPolicyDefinition("meshTopologyPolicyDefinitionResource", MeshTopologyPolicyDefinitionArgs.builder()
    .description("string")
    .regions(MeshTopologyPolicyDefinitionRegionArgs.builder()
        .name("string")
        .siteListIds("string")
        .siteListVersions("string")
        .build())
    .name("string")
    .vpnListId("string")
    .vpnListVersion(0)
    .build());

    mesh_topology_policy_definition_resource = sdwan.MeshTopologyPolicyDefinition("meshTopologyPolicyDefinitionResource",
    description="string",
    regions=[{
        "name": "string",
        "site_list_ids": ["string"],
        "site_list_versions": ["string"],
    }],
    name="string",
    vpn_list_id="string",
    vpn_list_version=0)

    const meshTopologyPolicyDefinitionResource = new sdwan.MeshTopologyPolicyDefinition("meshTopologyPolicyDefinitionResource", {
    description: "string",
    regions: [{
        name: "string",
        siteListIds: ["string"],
        siteListVersions: ["string"],
    }],
    name: "string",
    vpnListId: "string",
    vpnListVersion: 0,
});

    type: sdwan:MeshTopologyPolicyDefinition
properties:
    description: string
    name: string
    regions:
        - name: string
          siteListIds:
            - string
          siteListVersions:
            - string
    vpnListId: string
    vpnListVersion: 0

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

    Description string
    The description of the policy definition
    Regions List<MeshTopologyPolicyDefinitionRegion>
    List of regions
    Name string
    The name of the policy definition
    VpnListId string
    VPN list ID
    VpnListVersion int
    VPN list version
    Description string
    The description of the policy definition
    Regions []MeshTopologyPolicyDefinitionRegionArgs
    List of regions
    Name string
    The name of the policy definition
    VpnListId string
    VPN list ID
    VpnListVersion int
    VPN list version
    description String
    The description of the policy definition
    regions List<MeshTopologyPolicyDefinitionRegion>
    List of regions
    name String
    The name of the policy definition
    vpnListId String
    VPN list ID
    vpnListVersion Integer
    VPN list version
    description string
    The description of the policy definition
    regions MeshTopologyPolicyDefinitionRegion[]
    List of regions
    name string
    The name of the policy definition
    vpnListId string
    VPN list ID
    vpnListVersion number
    VPN list version
    description str
    The description of the policy definition
    regions Sequence[MeshTopologyPolicyDefinitionRegionArgs]
    List of regions
    name str
    The name of the policy definition
    vpn_list_id str
    VPN list ID
    vpn_list_version int
    VPN list version
    description String
    The description of the policy definition
    regions List<Property Map>
    List of regions
    name String
    The name of the policy definition
    vpnListId String
    VPN list ID
    vpnListVersion Number
    VPN list version

    Outputs

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

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

    Look up Existing MeshTopologyPolicyDefinition Resource

    Get an existing MeshTopologyPolicyDefinition 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?: MeshTopologyPolicyDefinitionState, opts?: CustomResourceOptions): MeshTopologyPolicyDefinition
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        regions: Optional[Sequence[MeshTopologyPolicyDefinitionRegionArgs]] = None,
        type: Optional[str] = None,
        version: Optional[int] = None,
        vpn_list_id: Optional[str] = None,
        vpn_list_version: Optional[int] = None) -> MeshTopologyPolicyDefinition
    func GetMeshTopologyPolicyDefinition(ctx *Context, name string, id IDInput, state *MeshTopologyPolicyDefinitionState, opts ...ResourceOption) (*MeshTopologyPolicyDefinition, error)
    public static MeshTopologyPolicyDefinition Get(string name, Input<string> id, MeshTopologyPolicyDefinitionState? state, CustomResourceOptions? opts = null)
    public static MeshTopologyPolicyDefinition get(String name, Output<String> id, MeshTopologyPolicyDefinitionState 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 definition
    Name string
    The name of the policy definition
    Regions List<MeshTopologyPolicyDefinitionRegion>
    List of regions
    Type string
    Type
    Version int
    The version of the object
    VpnListId string
    VPN list ID
    VpnListVersion int
    VPN list version
    Description string
    The description of the policy definition
    Name string
    The name of the policy definition
    Regions []MeshTopologyPolicyDefinitionRegionArgs
    List of regions
    Type string
    Type
    Version int
    The version of the object
    VpnListId string
    VPN list ID
    VpnListVersion int
    VPN list version
    description String
    The description of the policy definition
    name String
    The name of the policy definition
    regions List<MeshTopologyPolicyDefinitionRegion>
    List of regions
    type String
    Type
    version Integer
    The version of the object
    vpnListId String
    VPN list ID
    vpnListVersion Integer
    VPN list version
    description string
    The description of the policy definition
    name string
    The name of the policy definition
    regions MeshTopologyPolicyDefinitionRegion[]
    List of regions
    type string
    Type
    version number
    The version of the object
    vpnListId string
    VPN list ID
    vpnListVersion number
    VPN list version
    description str
    The description of the policy definition
    name str
    The name of the policy definition
    regions Sequence[MeshTopologyPolicyDefinitionRegionArgs]
    List of regions
    type str
    Type
    version int
    The version of the object
    vpn_list_id str
    VPN list ID
    vpn_list_version int
    VPN list version
    description String
    The description of the policy definition
    name String
    The name of the policy definition
    regions List<Property Map>
    List of regions
    type String
    Type
    version Number
    The version of the object
    vpnListId String
    VPN list ID
    vpnListVersion Number
    VPN list version

    Supporting Types

    MeshTopologyPolicyDefinitionRegion, MeshTopologyPolicyDefinitionRegionArgs

    Name string
    Region name
    SiteListIds List<string>
    Site list IDs
    SiteListVersions List<string>
    Site list versions
    Name string
    Region name
    SiteListIds []string
    Site list IDs
    SiteListVersions []string
    Site list versions
    name String
    Region name
    siteListIds List<String>
    Site list IDs
    siteListVersions List<String>
    Site list versions
    name string
    Region name
    siteListIds string[]
    Site list IDs
    siteListVersions string[]
    Site list versions
    name str
    Region name
    site_list_ids Sequence[str]
    Site list IDs
    site_list_versions Sequence[str]
    Site list versions
    name String
    Region name
    siteListIds List<String>
    Site list IDs
    siteListVersions List<String>
    Site list versions

    Import

    $ pulumi import sdwan:index/meshTopologyPolicyDefinition:MeshTopologyPolicyDefinition 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
    Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi
    pulumi/pulumi-sdwan