1. Packages
  2. Heroku
  3. API Docs
  4. space
  5. VpnConnection
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns

heroku.space.VpnConnection

Explore with Pulumi AI

heroku logo
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns

    Create VpnConnection Resource

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

    Constructor syntax

    new VpnConnection(name: string, args: VpnConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def VpnConnection(resource_name: str,
                      args: VpnConnectionArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def VpnConnection(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      public_ip: Optional[str] = None,
                      routable_cidrs: Optional[Sequence[str]] = None,
                      space: Optional[str] = None,
                      name: Optional[str] = None,
                      tunnels: Optional[Sequence[VpnConnectionTunnelArgs]] = None)
    func NewVpnConnection(ctx *Context, name string, args VpnConnectionArgs, opts ...ResourceOption) (*VpnConnection, error)
    public VpnConnection(string name, VpnConnectionArgs args, CustomResourceOptions? opts = null)
    public VpnConnection(String name, VpnConnectionArgs args)
    public VpnConnection(String name, VpnConnectionArgs args, CustomResourceOptions options)
    
    type: heroku:space:VpnConnection
    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 VpnConnectionArgs
    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 VpnConnectionArgs
    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 VpnConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpnConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpnConnectionArgs
    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 vpnConnectionResource = new Heroku.Space.VpnConnection("vpnConnectionResource", new()
    {
        PublicIp = "string",
        RoutableCidrs = new[]
        {
            "string",
        },
        Space = "string",
        Name = "string",
        Tunnels = new[]
        {
            new Heroku.Space.Inputs.VpnConnectionTunnelArgs
            {
                Ip = "string",
                PreSharedKey = "string",
            },
        },
    });
    
    example, err := space.NewVpnConnection(ctx, "vpnConnectionResource", &space.VpnConnectionArgs{
    	PublicIp: pulumi.String("string"),
    	RoutableCidrs: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Space: pulumi.String("string"),
    	Name:  pulumi.String("string"),
    	Tunnels: space.VpnConnectionTunnelArray{
    		&space.VpnConnectionTunnelArgs{
    			Ip:           pulumi.String("string"),
    			PreSharedKey: pulumi.String("string"),
    		},
    	},
    })
    
    var vpnConnectionResource = new VpnConnection("vpnConnectionResource", VpnConnectionArgs.builder()
        .publicIp("string")
        .routableCidrs("string")
        .space("string")
        .name("string")
        .tunnels(VpnConnectionTunnelArgs.builder()
            .ip("string")
            .preSharedKey("string")
            .build())
        .build());
    
    vpn_connection_resource = heroku.space.VpnConnection("vpnConnectionResource",
        public_ip="string",
        routable_cidrs=["string"],
        space="string",
        name="string",
        tunnels=[{
            "ip": "string",
            "pre_shared_key": "string",
        }])
    
    const vpnConnectionResource = new heroku.space.VpnConnection("vpnConnectionResource", {
        publicIp: "string",
        routableCidrs: ["string"],
        space: "string",
        name: "string",
        tunnels: [{
            ip: "string",
            preSharedKey: "string",
        }],
    });
    
    type: heroku:space:VpnConnection
    properties:
        name: string
        publicIp: string
        routableCidrs:
            - string
        space: string
        tunnels:
            - ip: string
              preSharedKey: string
    

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IkeVersion int
    SpaceCidrBlock string
    Id string
    The provider-assigned unique ID for this managed resource.
    IkeVersion int
    SpaceCidrBlock string
    id String
    The provider-assigned unique ID for this managed resource.
    ikeVersion Integer
    spaceCidrBlock String
    id string
    The provider-assigned unique ID for this managed resource.
    ikeVersion number
    spaceCidrBlock string
    id str
    The provider-assigned unique ID for this managed resource.
    ike_version int
    space_cidr_block str
    id String
    The provider-assigned unique ID for this managed resource.
    ikeVersion Number
    spaceCidrBlock String

    Look up Existing VpnConnection Resource

    Get an existing VpnConnection 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?: VpnConnectionState, opts?: CustomResourceOptions): VpnConnection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ike_version: Optional[int] = None,
            name: Optional[str] = None,
            public_ip: Optional[str] = None,
            routable_cidrs: Optional[Sequence[str]] = None,
            space: Optional[str] = None,
            space_cidr_block: Optional[str] = None,
            tunnels: Optional[Sequence[VpnConnectionTunnelArgs]] = None) -> VpnConnection
    func GetVpnConnection(ctx *Context, name string, id IDInput, state *VpnConnectionState, opts ...ResourceOption) (*VpnConnection, error)
    public static VpnConnection Get(string name, Input<string> id, VpnConnectionState? state, CustomResourceOptions? opts = null)
    public static VpnConnection get(String name, Output<String> id, VpnConnectionState 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:

    Supporting Types

    VpnConnectionTunnel, VpnConnectionTunnelArgs

    Ip string
    PreSharedKey string
    Ip string
    PreSharedKey string
    ip String
    preSharedKey String
    ip string
    preSharedKey string
    ip String
    preSharedKey String

    Package Details

    Repository
    heroku pulumiverse/pulumi-heroku
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the heroku Terraform Provider.
    heroku logo
    Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns