Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco Catalyst SD-WAN Provider
  3. API Docs
  4. VpnMembershipPolicyDefinition
Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-sdwan

sdwan.VpnMembershipPolicyDefinition

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-sdwan

    This resource can manage a VPN Membership 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.VpnMembershipPolicyDefinition;
import com.pulumi.sdwan.VpnMembershipPolicyDefinitionArgs;
import com.pulumi.sdwan.inputs.VpnMembershipPolicyDefinitionSiteArgs;
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 VpnMembershipPolicyDefinition("example", VpnMembershipPolicyDefinitionArgs.builder()
            .name("Example")
            .description("My description")
            .sites(VpnMembershipPolicyDefinitionSiteArgs.builder()
                .site_list_id("e858e1c4-6aa8-4de7-99df-c3adbf80290d")
                .vpn_list_ids("04fcbb0b-efbf-43d2-a04b-847d3a7b104e")
                .build())
            .build());

    }
}

    resources:
  example:
    type: sdwan:VpnMembershipPolicyDefinition
    properties:
      name: Example
      description: My description
      sites:
        - site_list_id: e858e1c4-6aa8-4de7-99df-c3adbf80290d
          vpn_list_ids:
            - 04fcbb0b-efbf-43d2-a04b-847d3a7b104e

    Create VpnMembershipPolicyDefinition Resource

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

    Constructor syntax

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

@overload
def VpnMembershipPolicyDefinition(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  description: Optional[str] = None,
                                  sites: Optional[Sequence[VpnMembershipPolicyDefinitionSiteArgs]] = None,
                                  name: Optional[str] = None)
    func NewVpnMembershipPolicyDefinition(ctx *Context, name string, args VpnMembershipPolicyDefinitionArgs, opts ...ResourceOption) (*VpnMembershipPolicyDefinition, error)
    public VpnMembershipPolicyDefinition(string name, VpnMembershipPolicyDefinitionArgs args, CustomResourceOptions? opts = null)
    public VpnMembershipPolicyDefinition(String name, VpnMembershipPolicyDefinitionArgs args)
public VpnMembershipPolicyDefinition(String name, VpnMembershipPolicyDefinitionArgs args, CustomResourceOptions options)

    type: sdwan:VpnMembershipPolicyDefinition
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 VpnMembershipPolicyDefinitionArgs
    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 VpnMembershipPolicyDefinitionArgs
    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 VpnMembershipPolicyDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpnMembershipPolicyDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpnMembershipPolicyDefinitionArgs
    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 vpnMembershipPolicyDefinitionResource = new Sdwan.VpnMembershipPolicyDefinition("vpnMembershipPolicyDefinitionResource", new()
{
    Description = "string",
    Sites = new[]
    {
        new Sdwan.Inputs.VpnMembershipPolicyDefinitionSiteArgs
        {
            SiteListId = "string",
            SiteListVersion = 0,
            VpnListIds = new[]
            {
                "string",
            },
            VpnListVersions = new[]
            {
                "string",
            },
        },
    },
    Name = "string",
});

    example, err := sdwan.NewVpnMembershipPolicyDefinition(ctx, "vpnMembershipPolicyDefinitionResource", &sdwan.VpnMembershipPolicyDefinitionArgs{
	Description: pulumi.String("string"),
	Sites: sdwan.VpnMembershipPolicyDefinitionSiteArray{
		&sdwan.VpnMembershipPolicyDefinitionSiteArgs{
			SiteListId:      pulumi.String("string"),
			SiteListVersion: pulumi.Int(0),
			VpnListIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			VpnListVersions: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Name: pulumi.String("string"),
})

    var vpnMembershipPolicyDefinitionResource = new VpnMembershipPolicyDefinition("vpnMembershipPolicyDefinitionResource", VpnMembershipPolicyDefinitionArgs.builder()
    .description("string")
    .sites(VpnMembershipPolicyDefinitionSiteArgs.builder()
        .siteListId("string")
        .siteListVersion(0)
        .vpnListIds("string")
        .vpnListVersions("string")
        .build())
    .name("string")
    .build());

    vpn_membership_policy_definition_resource = sdwan.VpnMembershipPolicyDefinition("vpnMembershipPolicyDefinitionResource",
    description="string",
    sites=[{
        "site_list_id": "string",
        "site_list_version": 0,
        "vpn_list_ids": ["string"],
        "vpn_list_versions": ["string"],
    }],
    name="string")

    const vpnMembershipPolicyDefinitionResource = new sdwan.VpnMembershipPolicyDefinition("vpnMembershipPolicyDefinitionResource", {
    description: "string",
    sites: [{
        siteListId: "string",
        siteListVersion: 0,
        vpnListIds: ["string"],
        vpnListVersions: ["string"],
    }],
    name: "string",
});

    type: sdwan:VpnMembershipPolicyDefinition
properties:
    description: string
    name: string
    sites:
        - siteListId: string
          siteListVersion: 0
          vpnListIds:
            - string
          vpnListVersions:
            - string

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

    Description string
    The description of the policy definition
    Sites List<VpnMembershipPolicyDefinitionSite>
    List of sites
    Name string
    The name of the policy definition
    Description string
    The description of the policy definition
    Sites []VpnMembershipPolicyDefinitionSiteArgs
    List of sites
    Name string
    The name of the policy definition
    description String
    The description of the policy definition
    sites List<VpnMembershipPolicyDefinitionSite>
    List of sites
    name String
    The name of the policy definition
    description string
    The description of the policy definition
    sites VpnMembershipPolicyDefinitionSite[]
    List of sites
    name string
    The name of the policy definition
    description str
    The description of the policy definition
    sites Sequence[VpnMembershipPolicyDefinitionSiteArgs]
    List of sites
    name str
    The name of the policy definition
    description String
    The description of the policy definition
    sites List<Property Map>
    List of sites
    name String
    The name of the policy definition

    Outputs

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

    Get an existing VpnMembershipPolicyDefinition 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?: VpnMembershipPolicyDefinitionState, opts?: CustomResourceOptions): VpnMembershipPolicyDefinition
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        sites: Optional[Sequence[VpnMembershipPolicyDefinitionSiteArgs]] = None,
        type: Optional[str] = None,
        version: Optional[int] = None) -> VpnMembershipPolicyDefinition
    func GetVpnMembershipPolicyDefinition(ctx *Context, name string, id IDInput, state *VpnMembershipPolicyDefinitionState, opts ...ResourceOption) (*VpnMembershipPolicyDefinition, error)
    public static VpnMembershipPolicyDefinition Get(string name, Input<string> id, VpnMembershipPolicyDefinitionState? state, CustomResourceOptions? opts = null)
    public static VpnMembershipPolicyDefinition get(String name, Output<String> id, VpnMembershipPolicyDefinitionState state, CustomResourceOptions options)
    resources:  _:    type: sdwan:VpnMembershipPolicyDefinition    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.
    The following state arguments are supported:
    Description string
    The description of the policy definition
    Name string
    The name of the policy definition
    Sites List<VpnMembershipPolicyDefinitionSite>
    List of sites
    Type string
    Type
    Version int
    The version of the object
    Description string
    The description of the policy definition
    Name string
    The name of the policy definition
    Sites []VpnMembershipPolicyDefinitionSiteArgs
    List of sites
    Type string
    Type
    Version int
    The version of the object
    description String
    The description of the policy definition
    name String
    The name of the policy definition
    sites List<VpnMembershipPolicyDefinitionSite>
    List of sites
    type String
    Type
    version Integer
    The version of the object
    description string
    The description of the policy definition
    name string
    The name of the policy definition
    sites VpnMembershipPolicyDefinitionSite[]
    List of sites
    type string
    Type
    version number
    The version of the object
    description str
    The description of the policy definition
    name str
    The name of the policy definition
    sites Sequence[VpnMembershipPolicyDefinitionSiteArgs]
    List of sites
    type str
    Type
    version int
    The version of the object
    description String
    The description of the policy definition
    name String
    The name of the policy definition
    sites List<Property Map>
    List of sites
    type String
    Type
    version Number
    The version of the object

    Supporting Types

    VpnMembershipPolicyDefinitionSite, VpnMembershipPolicyDefinitionSiteArgs

    SiteListId string
    Site list ID
    SiteListVersion int
    Site list version
    VpnListIds List<string>
    VPN list IDs
    VpnListVersions List<string>
    VPN list versions
    SiteListId string
    Site list ID
    SiteListVersion int
    Site list version
    VpnListIds []string
    VPN list IDs
    VpnListVersions []string
    VPN list versions
    siteListId String
    Site list ID
    siteListVersion Integer
    Site list version
    vpnListIds List<String>
    VPN list IDs
    vpnListVersions List<String>
    VPN list versions
    siteListId string
    Site list ID
    siteListVersion number
    Site list version
    vpnListIds string[]
    VPN list IDs
    vpnListVersions string[]
    VPN list versions
    site_list_id str
    Site list ID
    site_list_version int
    Site list version
    vpn_list_ids Sequence[str]
    VPN list IDs
    vpn_list_versions Sequence[str]
    VPN list versions
    siteListId String
    Site list ID
    siteListVersion Number
    Site list version
    vpnListIds List<String>
    VPN list IDs
    vpnListVersions List<String>
    VPN list versions

    Import

    $ pulumi import sdwan:index/vpnMembershipPolicyDefinition:VpnMembershipPolicyDefinition 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.3.0 published on Friday, Mar 28, 2025 by Pulumi
    pulumi/pulumi-sdwan