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

sdwan.PolicyObjectVpnGroup

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 Policy Object VPN Group Policy_object.

    • Minimum SD-WAN Manager version: 20.12.0

    Example Usage

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

const example = new sdwan.PolicyObjectVpnGroup("example", {
    name: "Example",
    description: "My Example",
    featureProfileId: "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
    entries: [{
        vpn: 100,
    }],
});

    import pulumi
import pulumi_sdwan as sdwan

example = sdwan.PolicyObjectVpnGroup("example",
    name="Example",
    description="My Example",
    feature_profile_id="f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
    entries=[{
        "vpn": 100,
    }])

    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.NewPolicyObjectVpnGroup(ctx, "example", &sdwan.PolicyObjectVpnGroupArgs{
			Name:             pulumi.String("Example"),
			Description:      pulumi.String("My Example"),
			FeatureProfileId: pulumi.String("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"),
			Entries: sdwan.PolicyObjectVpnGroupEntryArray{
				&sdwan.PolicyObjectVpnGroupEntryArgs{
					Vpn: pulumi.Int(100),
				},
			},
		})
		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.PolicyObjectVpnGroup("example", new()
    {
        Name = "Example",
        Description = "My Example",
        FeatureProfileId = "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
        Entries = new[]
        {
            new Sdwan.Inputs.PolicyObjectVpnGroupEntryArgs
            {
                Vpn = 100,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.PolicyObjectVpnGroup;
import com.pulumi.sdwan.PolicyObjectVpnGroupArgs;
import com.pulumi.sdwan.inputs.PolicyObjectVpnGroupEntryArgs;
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 PolicyObjectVpnGroup("example", PolicyObjectVpnGroupArgs.builder()
            .name("Example")
            .description("My Example")
            .featureProfileId("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac")
            .entries(PolicyObjectVpnGroupEntryArgs.builder()
                .vpn(100)
                .build())
            .build());

    }
}

    resources:
  example:
    type: sdwan:PolicyObjectVpnGroup
    properties:
      name: Example
      description: My Example
      featureProfileId: f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac
      entries:
        - vpn: 100

    Create PolicyObjectVpnGroup Resource

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

    Constructor syntax

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

@overload
def PolicyObjectVpnGroup(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         entries: Optional[Sequence[PolicyObjectVpnGroupEntryArgs]] = None,
                         feature_profile_id: Optional[str] = None,
                         description: Optional[str] = None,
                         name: Optional[str] = None)
    func NewPolicyObjectVpnGroup(ctx *Context, name string, args PolicyObjectVpnGroupArgs, opts ...ResourceOption) (*PolicyObjectVpnGroup, error)
    public PolicyObjectVpnGroup(string name, PolicyObjectVpnGroupArgs args, CustomResourceOptions? opts = null)
    public PolicyObjectVpnGroup(String name, PolicyObjectVpnGroupArgs args)
public PolicyObjectVpnGroup(String name, PolicyObjectVpnGroupArgs args, CustomResourceOptions options)

    type: sdwan:PolicyObjectVpnGroup
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 PolicyObjectVpnGroupArgs
    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 PolicyObjectVpnGroupArgs
    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 PolicyObjectVpnGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyObjectVpnGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyObjectVpnGroupArgs
    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 policyObjectVpnGroupResource = new Sdwan.PolicyObjectVpnGroup("policyObjectVpnGroupResource", new()
{
    Entries = new[]
    {
        new Sdwan.Inputs.PolicyObjectVpnGroupEntryArgs
        {
            Vpn = 0,
        },
    },
    FeatureProfileId = "string",
    Description = "string",
    Name = "string",
});

    example, err := sdwan.NewPolicyObjectVpnGroup(ctx, "policyObjectVpnGroupResource", &sdwan.PolicyObjectVpnGroupArgs{
	Entries: sdwan.PolicyObjectVpnGroupEntryArray{
		&sdwan.PolicyObjectVpnGroupEntryArgs{
			Vpn: pulumi.Int(0),
		},
	},
	FeatureProfileId: pulumi.String("string"),
	Description:      pulumi.String("string"),
	Name:             pulumi.String("string"),
})

    var policyObjectVpnGroupResource = new PolicyObjectVpnGroup("policyObjectVpnGroupResource", PolicyObjectVpnGroupArgs.builder()
    .entries(PolicyObjectVpnGroupEntryArgs.builder()
        .vpn(0)
        .build())
    .featureProfileId("string")
    .description("string")
    .name("string")
    .build());

    policy_object_vpn_group_resource = sdwan.PolicyObjectVpnGroup("policyObjectVpnGroupResource",
    entries=[{
        "vpn": 0,
    }],
    feature_profile_id="string",
    description="string",
    name="string")

    const policyObjectVpnGroupResource = new sdwan.PolicyObjectVpnGroup("policyObjectVpnGroupResource", {
    entries: [{
        vpn: 0,
    }],
    featureProfileId: "string",
    description: "string",
    name: "string",
});

    type: sdwan:PolicyObjectVpnGroup
properties:
    description: string
    entries:
        - vpn: 0
    featureProfileId: string
    name: string

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

    Entries List<PolicyObjectVpnGroupEntry>
    VPN List
    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the Policy_object
    Name string
    The name of the Policy_object
    Entries []PolicyObjectVpnGroupEntryArgs
    VPN List
    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the Policy_object
    Name string
    The name of the Policy_object
    entries List<PolicyObjectVpnGroupEntry>
    VPN List
    featureProfileId String
    Feature Profile ID
    description String
    The description of the Policy_object
    name String
    The name of the Policy_object
    entries PolicyObjectVpnGroupEntry[]
    VPN List
    featureProfileId string
    Feature Profile ID
    description string
    The description of the Policy_object
    name string
    The name of the Policy_object
    entries Sequence[PolicyObjectVpnGroupEntryArgs]
    VPN List
    feature_profile_id str
    Feature Profile ID
    description str
    The description of the Policy_object
    name str
    The name of the Policy_object
    entries List<Property Map>
    VPN List
    featureProfileId String
    Feature Profile ID
    description String
    The description of the Policy_object
    name String
    The name of the Policy_object

    Outputs

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

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

    Look up Existing PolicyObjectVpnGroup Resource

    Get an existing PolicyObjectVpnGroup 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?: PolicyObjectVpnGroupState, opts?: CustomResourceOptions): PolicyObjectVpnGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        entries: Optional[Sequence[PolicyObjectVpnGroupEntryArgs]] = None,
        feature_profile_id: Optional[str] = None,
        name: Optional[str] = None,
        version: Optional[int] = None) -> PolicyObjectVpnGroup
    func GetPolicyObjectVpnGroup(ctx *Context, name string, id IDInput, state *PolicyObjectVpnGroupState, opts ...ResourceOption) (*PolicyObjectVpnGroup, error)
    public static PolicyObjectVpnGroup Get(string name, Input<string> id, PolicyObjectVpnGroupState? state, CustomResourceOptions? opts = null)
    public static PolicyObjectVpnGroup get(String name, Output<String> id, PolicyObjectVpnGroupState 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_object
    Entries List<PolicyObjectVpnGroupEntry>
    VPN List
    FeatureProfileId string
    Feature Profile ID
    Name string
    The name of the Policy_object
    Version int
    The version of the Policy_object
    Description string
    The description of the Policy_object
    Entries []PolicyObjectVpnGroupEntryArgs
    VPN List
    FeatureProfileId string
    Feature Profile ID
    Name string
    The name of the Policy_object
    Version int
    The version of the Policy_object
    description String
    The description of the Policy_object
    entries List<PolicyObjectVpnGroupEntry>
    VPN List
    featureProfileId String
    Feature Profile ID
    name String
    The name of the Policy_object
    version Integer
    The version of the Policy_object
    description string
    The description of the Policy_object
    entries PolicyObjectVpnGroupEntry[]
    VPN List
    featureProfileId string
    Feature Profile ID
    name string
    The name of the Policy_object
    version number
    The version of the Policy_object
    description str
    The description of the Policy_object
    entries Sequence[PolicyObjectVpnGroupEntryArgs]
    VPN List
    feature_profile_id str
    Feature Profile ID
    name str
    The name of the Policy_object
    version int
    The version of the Policy_object
    description String
    The description of the Policy_object
    entries List<Property Map>
    VPN List
    featureProfileId String
    Feature Profile ID
    name String
    The name of the Policy_object
    version Number
    The version of the Policy_object

    Supporting Types

    PolicyObjectVpnGroupEntry, PolicyObjectVpnGroupEntryArgs

    Vpn int
    can be single vpn id or vpn id range
    Vpn int
    can be single vpn id or vpn id range
    vpn Integer
    can be single vpn id or vpn id range
    vpn number
    can be single vpn id or vpn id range
    vpn int
    can be single vpn id or vpn id range
    vpn Number
    can be single vpn id or vpn id range

    Import

    Expected import identifier with the format: “policy_object_vpn_group_id,feature_profile_id”

    $ pulumi import sdwan:index/policyObjectVpnGroup:PolicyObjectVpnGroup example "f6b2c44c-693c-4763-b010-895aa3d236bd,f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"

    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