AutoVpnSetting resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
const example = new scm.AutoVpnSetting("example", {
enableMeshBetweenHubs: true,
vpnAddressPools: ["10.91.0.0/25"],
asRange: {
start: 65001,
end: 65200,
},
});
import pulumi
import pulumi_scm as scm
example = scm.AutoVpnSetting("example",
enable_mesh_between_hubs=True,
vpn_address_pools=["10.91.0.0/25"],
as_range={
"start": 65001,
"end": 65200,
})
package main
import (
"github.com/pulumi/pulumi-scm/sdk/go/scm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := scm.NewAutoVpnSetting(ctx, "example", &scm.AutoVpnSettingArgs{
EnableMeshBetweenHubs: pulumi.Bool(true),
VpnAddressPools: pulumi.StringArray{
pulumi.String("10.91.0.0/25"),
},
AsRange: &scm.AutoVpnSettingAsRangeArgs{
Start: pulumi.Int(65001),
End: pulumi.Int(65200),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
var example = new Scm.AutoVpnSetting("example", new()
{
EnableMeshBetweenHubs = true,
VpnAddressPools = new[]
{
"10.91.0.0/25",
},
AsRange = new Scm.Inputs.AutoVpnSettingAsRangeArgs
{
Start = 65001,
End = 65200,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.AutoVpnSetting;
import com.pulumi.scm.AutoVpnSettingArgs;
import com.pulumi.scm.inputs.AutoVpnSettingAsRangeArgs;
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 AutoVpnSetting("example", AutoVpnSettingArgs.builder()
.enableMeshBetweenHubs(true)
.vpnAddressPools("10.91.0.0/25")
.asRange(AutoVpnSettingAsRangeArgs.builder()
.start(65001)
.end(65200)
.build())
.build());
}
}
resources:
example:
type: scm:AutoVpnSetting
properties:
enableMeshBetweenHubs: true # Required list of CIDRs
vpnAddressPools:
- 10.91.0.0/25
asRange:
start: 65001
end: 65200
Create AutoVpnSetting Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AutoVpnSetting(name: string, args: AutoVpnSettingArgs, opts?: CustomResourceOptions);@overload
def AutoVpnSetting(resource_name: str,
args: AutoVpnSettingArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AutoVpnSetting(resource_name: str,
opts: Optional[ResourceOptions] = None,
as_range: Optional[AutoVpnSettingAsRangeArgs] = None,
vpn_address_pools: Optional[Sequence[str]] = None,
enable_mesh_between_hubs: Optional[bool] = None)func NewAutoVpnSetting(ctx *Context, name string, args AutoVpnSettingArgs, opts ...ResourceOption) (*AutoVpnSetting, error)public AutoVpnSetting(string name, AutoVpnSettingArgs args, CustomResourceOptions? opts = null)
public AutoVpnSetting(String name, AutoVpnSettingArgs args)
public AutoVpnSetting(String name, AutoVpnSettingArgs args, CustomResourceOptions options)
type: scm:AutoVpnSetting
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 AutoVpnSettingArgs
- 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 AutoVpnSettingArgs
- 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 AutoVpnSettingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AutoVpnSettingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AutoVpnSettingArgs
- 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 autoVpnSettingResource = new Scm.AutoVpnSetting("autoVpnSettingResource", new()
{
AsRange = new Scm.Inputs.AutoVpnSettingAsRangeArgs
{
End = 0,
Start = 0,
},
VpnAddressPools = new[]
{
"string",
},
EnableMeshBetweenHubs = false,
});
example, err := scm.NewAutoVpnSetting(ctx, "autoVpnSettingResource", &scm.AutoVpnSettingArgs{
AsRange: &scm.AutoVpnSettingAsRangeArgs{
End: pulumi.Int(0),
Start: pulumi.Int(0),
},
VpnAddressPools: pulumi.StringArray{
pulumi.String("string"),
},
EnableMeshBetweenHubs: pulumi.Bool(false),
})
var autoVpnSettingResource = new AutoVpnSetting("autoVpnSettingResource", AutoVpnSettingArgs.builder()
.asRange(AutoVpnSettingAsRangeArgs.builder()
.end(0)
.start(0)
.build())
.vpnAddressPools("string")
.enableMeshBetweenHubs(false)
.build());
auto_vpn_setting_resource = scm.AutoVpnSetting("autoVpnSettingResource",
as_range={
"end": 0,
"start": 0,
},
vpn_address_pools=["string"],
enable_mesh_between_hubs=False)
const autoVpnSettingResource = new scm.AutoVpnSetting("autoVpnSettingResource", {
asRange: {
end: 0,
start: 0,
},
vpnAddressPools: ["string"],
enableMeshBetweenHubs: false,
});
type: scm:AutoVpnSetting
properties:
asRange:
end: 0
start: 0
enableMeshBetweenHubs: false
vpnAddressPools:
- string
AutoVpnSetting 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 AutoVpnSetting resource accepts the following input properties:
- As
Range AutoVpn Setting As Range - As range
- Vpn
Address List<string>Pools - VPN address pool
- Enable
Mesh boolBetween Hubs - Enable mesh connection between hubs?
- As
Range AutoVpn Setting As Range Args - As range
- Vpn
Address []stringPools - VPN address pool
- Enable
Mesh boolBetween Hubs - Enable mesh connection between hubs?
- as
Range AutoVpn Setting As Range - As range
- vpn
Address List<String>Pools - VPN address pool
- enable
Mesh BooleanBetween Hubs - Enable mesh connection between hubs?
- as
Range AutoVpn Setting As Range - As range
- vpn
Address string[]Pools - VPN address pool
- enable
Mesh booleanBetween Hubs - Enable mesh connection between hubs?
- as_
range AutoVpn Setting As Range Args - As range
- vpn_
address_ Sequence[str]pools - VPN address pool
- enable_
mesh_ boolbetween_ hubs - Enable mesh connection between hubs?
- as
Range Property Map - As range
- vpn
Address List<String>Pools - VPN address pool
- enable
Mesh BooleanBetween Hubs - Enable mesh connection between hubs?
Outputs
All input properties are implicitly available as output properties. Additionally, the AutoVpnSetting resource produces the following output properties:
Look up Existing AutoVpnSetting Resource
Get an existing AutoVpnSetting 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?: AutoVpnSettingState, opts?: CustomResourceOptions): AutoVpnSetting@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
as_range: Optional[AutoVpnSettingAsRangeArgs] = None,
enable_mesh_between_hubs: Optional[bool] = None,
tfid: Optional[str] = None,
vpn_address_pools: Optional[Sequence[str]] = None) -> AutoVpnSettingfunc GetAutoVpnSetting(ctx *Context, name string, id IDInput, state *AutoVpnSettingState, opts ...ResourceOption) (*AutoVpnSetting, error)public static AutoVpnSetting Get(string name, Input<string> id, AutoVpnSettingState? state, CustomResourceOptions? opts = null)public static AutoVpnSetting get(String name, Output<String> id, AutoVpnSettingState state, CustomResourceOptions options)resources: _: type: scm:AutoVpnSetting 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.
- As
Range AutoVpn Setting As Range - As range
- Enable
Mesh boolBetween Hubs - Enable mesh connection between hubs?
- Tfid string
- Vpn
Address List<string>Pools - VPN address pool
- As
Range AutoVpn Setting As Range Args - As range
- Enable
Mesh boolBetween Hubs - Enable mesh connection between hubs?
- Tfid string
- Vpn
Address []stringPools - VPN address pool
- as
Range AutoVpn Setting As Range - As range
- enable
Mesh BooleanBetween Hubs - Enable mesh connection between hubs?
- tfid String
- vpn
Address List<String>Pools - VPN address pool
- as
Range AutoVpn Setting As Range - As range
- enable
Mesh booleanBetween Hubs - Enable mesh connection between hubs?
- tfid string
- vpn
Address string[]Pools - VPN address pool
- as_
range AutoVpn Setting As Range Args - As range
- enable_
mesh_ boolbetween_ hubs - Enable mesh connection between hubs?
- tfid str
- vpn_
address_ Sequence[str]pools - VPN address pool
- as
Range Property Map - As range
- enable
Mesh BooleanBetween Hubs - Enable mesh connection between hubs?
- tfid String
- vpn
Address List<String>Pools - VPN address pool
Supporting Types
AutoVpnSettingAsRange, AutoVpnSettingAsRangeArgs
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
