1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. ApplianceVpnSiteToSiteVpn
Meraki v0.1.2 published on Tuesday, May 21, 2024 by Pulumi

meraki.networks.ApplianceVpnSiteToSiteVpn

Explore with Pulumi AI

meraki logo
Meraki v0.1.2 published on Tuesday, May 21, 2024 by Pulumi

    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.meraki.networks.ApplianceVpnSiteToSiteVpn;
    import com.pulumi.meraki.networks.ApplianceVpnSiteToSiteVpnArgs;
    import com.pulumi.meraki.networks.inputs.ApplianceVpnSiteToSiteVpnHubArgs;
    import com.pulumi.meraki.networks.inputs.ApplianceVpnSiteToSiteVpnSubnetArgs;
    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 ApplianceVpnSiteToSiteVpn("example", ApplianceVpnSiteToSiteVpnArgs.builder()        
                .hubs(ApplianceVpnSiteToSiteVpnHubArgs.builder()
                    .hub_id("N_4901849")
                    .use_default_route(true)
                    .build())
                .mode("spoke")
                .networkId("string")
                .subnets(ApplianceVpnSiteToSiteVpnSubnetArgs.builder()
                    .local_subnet("192.168.1.0/24")
                    .use_vpn(true)
                    .build())
                .build());
    
            ctx.export("merakiNetworksApplianceVpnSiteToSiteVpnExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:networks:ApplianceVpnSiteToSiteVpn
        properties:
          hubs:
            - hub_id: N_4901849
              use_default_route: true
          mode: spoke
          networkId: string
          subnets:
            - local_subnet: 192.168.1.0/24
              use_vpn: true
    outputs:
      merakiNetworksApplianceVpnSiteToSiteVpnExample: ${example}
    

    Create ApplianceVpnSiteToSiteVpn Resource

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

    Constructor syntax

    new ApplianceVpnSiteToSiteVpn(name: string, args: ApplianceVpnSiteToSiteVpnArgs, opts?: CustomResourceOptions);
    @overload
    def ApplianceVpnSiteToSiteVpn(resource_name: str,
                                  args: ApplianceVpnSiteToSiteVpnArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApplianceVpnSiteToSiteVpn(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  network_id: Optional[str] = None,
                                  hubs: Optional[Sequence[ApplianceVpnSiteToSiteVpnHubArgs]] = None,
                                  mode: Optional[str] = None,
                                  subnets: Optional[Sequence[ApplianceVpnSiteToSiteVpnSubnetArgs]] = None)
    func NewApplianceVpnSiteToSiteVpn(ctx *Context, name string, args ApplianceVpnSiteToSiteVpnArgs, opts ...ResourceOption) (*ApplianceVpnSiteToSiteVpn, error)
    public ApplianceVpnSiteToSiteVpn(string name, ApplianceVpnSiteToSiteVpnArgs args, CustomResourceOptions? opts = null)
    public ApplianceVpnSiteToSiteVpn(String name, ApplianceVpnSiteToSiteVpnArgs args)
    public ApplianceVpnSiteToSiteVpn(String name, ApplianceVpnSiteToSiteVpnArgs args, CustomResourceOptions options)
    
    type: meraki:networks:ApplianceVpnSiteToSiteVpn
    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 ApplianceVpnSiteToSiteVpnArgs
    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 ApplianceVpnSiteToSiteVpnArgs
    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 ApplianceVpnSiteToSiteVpnArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplianceVpnSiteToSiteVpnArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplianceVpnSiteToSiteVpnArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var applianceVpnSiteToSiteVpnResource = new Meraki.Networks.ApplianceVpnSiteToSiteVpn("applianceVpnSiteToSiteVpnResource", new()
    {
        NetworkId = "string",
        Hubs = new[]
        {
            new Meraki.Networks.Inputs.ApplianceVpnSiteToSiteVpnHubArgs
            {
                HubId = "string",
                UseDefaultRoute = false,
            },
        },
        Mode = "string",
        Subnets = new[]
        {
            new Meraki.Networks.Inputs.ApplianceVpnSiteToSiteVpnSubnetArgs
            {
                LocalSubnet = "string",
                UseVpn = false,
            },
        },
    });
    
    example, err := networks.NewApplianceVpnSiteToSiteVpn(ctx, "applianceVpnSiteToSiteVpnResource", &networks.ApplianceVpnSiteToSiteVpnArgs{
    	NetworkId: pulumi.String("string"),
    	Hubs: networks.ApplianceVpnSiteToSiteVpnHubArray{
    		&networks.ApplianceVpnSiteToSiteVpnHubArgs{
    			HubId:           pulumi.String("string"),
    			UseDefaultRoute: pulumi.Bool(false),
    		},
    	},
    	Mode: pulumi.String("string"),
    	Subnets: networks.ApplianceVpnSiteToSiteVpnSubnetArray{
    		&networks.ApplianceVpnSiteToSiteVpnSubnetArgs{
    			LocalSubnet: pulumi.String("string"),
    			UseVpn:      pulumi.Bool(false),
    		},
    	},
    })
    
    var applianceVpnSiteToSiteVpnResource = new ApplianceVpnSiteToSiteVpn("applianceVpnSiteToSiteVpnResource", ApplianceVpnSiteToSiteVpnArgs.builder()        
        .networkId("string")
        .hubs(ApplianceVpnSiteToSiteVpnHubArgs.builder()
            .hubId("string")
            .useDefaultRoute(false)
            .build())
        .mode("string")
        .subnets(ApplianceVpnSiteToSiteVpnSubnetArgs.builder()
            .localSubnet("string")
            .useVpn(false)
            .build())
        .build());
    
    appliance_vpn_site_to_site_vpn_resource = meraki.networks.ApplianceVpnSiteToSiteVpn("applianceVpnSiteToSiteVpnResource",
        network_id="string",
        hubs=[meraki.networks.ApplianceVpnSiteToSiteVpnHubArgs(
            hub_id="string",
            use_default_route=False,
        )],
        mode="string",
        subnets=[meraki.networks.ApplianceVpnSiteToSiteVpnSubnetArgs(
            local_subnet="string",
            use_vpn=False,
        )])
    
    const applianceVpnSiteToSiteVpnResource = new meraki.networks.ApplianceVpnSiteToSiteVpn("applianceVpnSiteToSiteVpnResource", {
        networkId: "string",
        hubs: [{
            hubId: "string",
            useDefaultRoute: false,
        }],
        mode: "string",
        subnets: [{
            localSubnet: "string",
            useVpn: false,
        }],
    });
    
    type: meraki:networks:ApplianceVpnSiteToSiteVpn
    properties:
        hubs:
            - hubId: string
              useDefaultRoute: false
        mode: string
        networkId: string
        subnets:
            - localSubnet: string
              useVpn: false
    

    ApplianceVpnSiteToSiteVpn Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ApplianceVpnSiteToSiteVpn resource accepts the following input properties:

    NetworkId string
    networkId path parameter. Network ID
    Hubs List<ApplianceVpnSiteToSiteVpnHub>
    The list of VPN hubs, in order of preference.
    Mode string
    The site-to-site VPN mode.
    Subnets List<ApplianceVpnSiteToSiteVpnSubnet>
    The list of subnets and their VPN presence.
    NetworkId string
    networkId path parameter. Network ID
    Hubs []ApplianceVpnSiteToSiteVpnHubArgs
    The list of VPN hubs, in order of preference.
    Mode string
    The site-to-site VPN mode.
    Subnets []ApplianceVpnSiteToSiteVpnSubnetArgs
    The list of subnets and their VPN presence.
    networkId String
    networkId path parameter. Network ID
    hubs List<ApplianceVpnSiteToSiteVpnHub>
    The list of VPN hubs, in order of preference.
    mode String
    The site-to-site VPN mode.
    subnets List<ApplianceVpnSiteToSiteVpnSubnet>
    The list of subnets and their VPN presence.
    networkId string
    networkId path parameter. Network ID
    hubs ApplianceVpnSiteToSiteVpnHub[]
    The list of VPN hubs, in order of preference.
    mode string
    The site-to-site VPN mode.
    subnets ApplianceVpnSiteToSiteVpnSubnet[]
    The list of subnets and their VPN presence.
    network_id str
    networkId path parameter. Network ID
    hubs Sequence[ApplianceVpnSiteToSiteVpnHubArgs]
    The list of VPN hubs, in order of preference.
    mode str
    The site-to-site VPN mode.
    subnets Sequence[ApplianceVpnSiteToSiteVpnSubnetArgs]
    The list of subnets and their VPN presence.
    networkId String
    networkId path parameter. Network ID
    hubs List<Property Map>
    The list of VPN hubs, in order of preference.
    mode String
    The site-to-site VPN mode.
    subnets List<Property Map>
    The list of subnets and their VPN presence.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApplianceVpnSiteToSiteVpn 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApplianceVpnSiteToSiteVpn Resource

    Get an existing ApplianceVpnSiteToSiteVpn 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?: ApplianceVpnSiteToSiteVpnState, opts?: CustomResourceOptions): ApplianceVpnSiteToSiteVpn
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            hubs: Optional[Sequence[ApplianceVpnSiteToSiteVpnHubArgs]] = None,
            mode: Optional[str] = None,
            network_id: Optional[str] = None,
            subnets: Optional[Sequence[ApplianceVpnSiteToSiteVpnSubnetArgs]] = None) -> ApplianceVpnSiteToSiteVpn
    func GetApplianceVpnSiteToSiteVpn(ctx *Context, name string, id IDInput, state *ApplianceVpnSiteToSiteVpnState, opts ...ResourceOption) (*ApplianceVpnSiteToSiteVpn, error)
    public static ApplianceVpnSiteToSiteVpn Get(string name, Input<string> id, ApplianceVpnSiteToSiteVpnState? state, CustomResourceOptions? opts = null)
    public static ApplianceVpnSiteToSiteVpn get(String name, Output<String> id, ApplianceVpnSiteToSiteVpnState 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:
    Hubs List<ApplianceVpnSiteToSiteVpnHub>
    The list of VPN hubs, in order of preference.
    Mode string
    The site-to-site VPN mode.
    NetworkId string
    networkId path parameter. Network ID
    Subnets List<ApplianceVpnSiteToSiteVpnSubnet>
    The list of subnets and their VPN presence.
    Hubs []ApplianceVpnSiteToSiteVpnHubArgs
    The list of VPN hubs, in order of preference.
    Mode string
    The site-to-site VPN mode.
    NetworkId string
    networkId path parameter. Network ID
    Subnets []ApplianceVpnSiteToSiteVpnSubnetArgs
    The list of subnets and their VPN presence.
    hubs List<ApplianceVpnSiteToSiteVpnHub>
    The list of VPN hubs, in order of preference.
    mode String
    The site-to-site VPN mode.
    networkId String
    networkId path parameter. Network ID
    subnets List<ApplianceVpnSiteToSiteVpnSubnet>
    The list of subnets and their VPN presence.
    hubs ApplianceVpnSiteToSiteVpnHub[]
    The list of VPN hubs, in order of preference.
    mode string
    The site-to-site VPN mode.
    networkId string
    networkId path parameter. Network ID
    subnets ApplianceVpnSiteToSiteVpnSubnet[]
    The list of subnets and their VPN presence.
    hubs Sequence[ApplianceVpnSiteToSiteVpnHubArgs]
    The list of VPN hubs, in order of preference.
    mode str
    The site-to-site VPN mode.
    network_id str
    networkId path parameter. Network ID
    subnets Sequence[ApplianceVpnSiteToSiteVpnSubnetArgs]
    The list of subnets and their VPN presence.
    hubs List<Property Map>
    The list of VPN hubs, in order of preference.
    mode String
    The site-to-site VPN mode.
    networkId String
    networkId path parameter. Network ID
    subnets List<Property Map>
    The list of subnets and their VPN presence.

    Supporting Types

    ApplianceVpnSiteToSiteVpnHub, ApplianceVpnSiteToSiteVpnHubArgs

    HubId string
    The network ID of the hub.
    UseDefaultRoute bool
    Indicates whether default route traffic should be sent to this hub.
    HubId string
    The network ID of the hub.
    UseDefaultRoute bool
    Indicates whether default route traffic should be sent to this hub.
    hubId String
    The network ID of the hub.
    useDefaultRoute Boolean
    Indicates whether default route traffic should be sent to this hub.
    hubId string
    The network ID of the hub.
    useDefaultRoute boolean
    Indicates whether default route traffic should be sent to this hub.
    hub_id str
    The network ID of the hub.
    use_default_route bool
    Indicates whether default route traffic should be sent to this hub.
    hubId String
    The network ID of the hub.
    useDefaultRoute Boolean
    Indicates whether default route traffic should be sent to this hub.

    ApplianceVpnSiteToSiteVpnSubnet, ApplianceVpnSiteToSiteVpnSubnetArgs

    LocalSubnet string
    The CIDR notation subnet used within the VPN
    UseVpn bool
    Indicates the presence of the subnet in the VPN
    LocalSubnet string
    The CIDR notation subnet used within the VPN
    UseVpn bool
    Indicates the presence of the subnet in the VPN
    localSubnet String
    The CIDR notation subnet used within the VPN
    useVpn Boolean
    Indicates the presence of the subnet in the VPN
    localSubnet string
    The CIDR notation subnet used within the VPN
    useVpn boolean
    Indicates the presence of the subnet in the VPN
    local_subnet str
    The CIDR notation subnet used within the VPN
    use_vpn bool
    Indicates the presence of the subnet in the VPN
    localSubnet String
    The CIDR notation subnet used within the VPN
    useVpn Boolean
    Indicates the presence of the subnet in the VPN

    Import

    $ pulumi import meraki:networks/applianceVpnSiteToSiteVpn:ApplianceVpnSiteToSiteVpn example "network_id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Meraki v0.1.2 published on Tuesday, May 21, 2024 by Pulumi