Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Outscale Provider
  3. API Docs
  4. VirtualGatewayRoutePropagation
outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale
outscale/terraform-provider-outscale

outscale.VirtualGatewayRoutePropagation

Explore with Pulumi AI

outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale
outscale/terraform-provider-outscale

Manages a virtual gateway route propagation.

For more information on this resource, see the User Guide.
For more information on this resource actions, see the API documentation.

Example Usage

Required resources

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

const virtualGateway01 = new outscale.VirtualGateway("virtualGateway01", {connectionType: "ipsec.1"});
const net01 = new outscale.Net("net01", {ipRange: "10.0.0.0/16"});
const routeTable01 = new outscale.RouteTable("routeTable01", {netId: net01.netId});
const virtualGatewayLink01 = new outscale.VirtualGatewayLink("virtualGatewayLink01", {
    virtualGatewayId: virtualGateway01.virtualGatewayId,
    netId: net01.netId,
});
Copy
import pulumi
import pulumi_outscale as outscale

virtual_gateway01 = outscale.VirtualGateway("virtualGateway01", connection_type="ipsec.1")
net01 = outscale.Net("net01", ip_range="10.0.0.0/16")
route_table01 = outscale.RouteTable("routeTable01", net_id=net01.net_id)
virtual_gateway_link01 = outscale.VirtualGatewayLink("virtualGatewayLink01",
    virtual_gateway_id=virtual_gateway01.virtual_gateway_id,
    net_id=net01.net_id)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		virtualGateway01, err := outscale.NewVirtualGateway(ctx, "virtualGateway01", &outscale.VirtualGatewayArgs{
			ConnectionType: pulumi.String("ipsec.1"),
		})
		if err != nil {
			return err
		}
		net01, err := outscale.NewNet(ctx, "net01", &outscale.NetArgs{
			IpRange: pulumi.String("10.0.0.0/16"),
		})
		if err != nil {
			return err
		}
		_, err = outscale.NewRouteTable(ctx, "routeTable01", &outscale.RouteTableArgs{
			NetId: net01.NetId,
		})
		if err != nil {
			return err
		}
		_, err = outscale.NewVirtualGatewayLink(ctx, "virtualGatewayLink01", &outscale.VirtualGatewayLinkArgs{
			VirtualGatewayId: virtualGateway01.VirtualGatewayId,
			NetId:            net01.NetId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;

return await Deployment.RunAsync(() => 
{
    var virtualGateway01 = new Outscale.VirtualGateway("virtualGateway01", new()
    {
        ConnectionType = "ipsec.1",
    });

    var net01 = new Outscale.Net("net01", new()
    {
        IpRange = "10.0.0.0/16",
    });

    var routeTable01 = new Outscale.RouteTable("routeTable01", new()
    {
        NetId = net01.NetId,
    });

    var virtualGatewayLink01 = new Outscale.VirtualGatewayLink("virtualGatewayLink01", new()
    {
        VirtualGatewayId = virtualGateway01.VirtualGatewayId,
        NetId = net01.NetId,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.VirtualGateway;
import com.pulumi.outscale.VirtualGatewayArgs;
import com.pulumi.outscale.Net;
import com.pulumi.outscale.NetArgs;
import com.pulumi.outscale.RouteTable;
import com.pulumi.outscale.RouteTableArgs;
import com.pulumi.outscale.VirtualGatewayLink;
import com.pulumi.outscale.VirtualGatewayLinkArgs;
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 virtualGateway01 = new VirtualGateway("virtualGateway01", VirtualGatewayArgs.builder()
            .connectionType("ipsec.1")
            .build());

        var net01 = new Net("net01", NetArgs.builder()
            .ipRange("10.0.0.0/16")
            .build());

        var routeTable01 = new RouteTable("routeTable01", RouteTableArgs.builder()
            .netId(net01.netId())
            .build());

        var virtualGatewayLink01 = new VirtualGatewayLink("virtualGatewayLink01", VirtualGatewayLinkArgs.builder()
            .virtualGatewayId(virtualGateway01.virtualGatewayId())
            .netId(net01.netId())
            .build());

    }
}
Copy
resources:
  virtualGateway01:
    type: outscale:VirtualGateway
    properties:
      connectionType: ipsec.1
  net01:
    type: outscale:Net
    properties:
      ipRange: 10.0.0.0/16
  routeTable01:
    type: outscale:RouteTable
    properties:
      netId: ${net01.netId}
  virtualGatewayLink01:
    type: outscale:VirtualGatewayLink
    properties:
      virtualGatewayId: ${virtualGateway01.virtualGatewayId}
      netId: ${net01.netId}
Copy

Activate the propagation of routes to a route table of a Net by a virtual gateway

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

const virtualGatewayRoutePropagation01 = new outscale.VirtualGatewayRoutePropagation("virtualGatewayRoutePropagation01", {
    enable: true,
    virtualGatewayId: outscale_virtual_gateway.virtual_gateway01.virtual_gateway_id,
    routeTableId: outscale_route_table.route_table01.route_table_id,
}, {
    dependsOn: [outscale_virtual_gateway_link.virtual_gateway_link01],
});
Copy
import pulumi
import pulumi_outscale as outscale

virtual_gateway_route_propagation01 = outscale.VirtualGatewayRoutePropagation("virtualGatewayRoutePropagation01",
    enable=True,
    virtual_gateway_id=outscale_virtual_gateway["virtual_gateway01"]["virtual_gateway_id"],
    route_table_id=outscale_route_table["route_table01"]["route_table_id"],
    opts = pulumi.ResourceOptions(depends_on=[outscale_virtual_gateway_link["virtual_gateway_link01"]]))
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.NewVirtualGatewayRoutePropagation(ctx, "virtualGatewayRoutePropagation01", &outscale.VirtualGatewayRoutePropagationArgs{
			Enable:           pulumi.Bool(true),
			VirtualGatewayId: pulumi.Any(outscale_virtual_gateway.Virtual_gateway01.Virtual_gateway_id),
			RouteTableId:     pulumi.Any(outscale_route_table.Route_table01.Route_table_id),
		}, pulumi.DependsOn([]pulumi.Resource{
			outscale_virtual_gateway_link.Virtual_gateway_link01,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;

return await Deployment.RunAsync(() => 
{
    var virtualGatewayRoutePropagation01 = new Outscale.VirtualGatewayRoutePropagation("virtualGatewayRoutePropagation01", new()
    {
        Enable = true,
        VirtualGatewayId = outscale_virtual_gateway.Virtual_gateway01.Virtual_gateway_id,
        RouteTableId = outscale_route_table.Route_table01.Route_table_id,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            outscale_virtual_gateway_link.Virtual_gateway_link01,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.VirtualGatewayRoutePropagation;
import com.pulumi.outscale.VirtualGatewayRoutePropagationArgs;
import com.pulumi.resources.CustomResourceOptions;
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 virtualGatewayRoutePropagation01 = new VirtualGatewayRoutePropagation("virtualGatewayRoutePropagation01", VirtualGatewayRoutePropagationArgs.builder()
            .enable(true)
            .virtualGatewayId(outscale_virtual_gateway.virtual_gateway01().virtual_gateway_id())
            .routeTableId(outscale_route_table.route_table01().route_table_id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(outscale_virtual_gateway_link.virtual_gateway_link01())
                .build());

    }
}
Copy
resources:
  virtualGatewayRoutePropagation01:
    type: outscale:VirtualGatewayRoutePropagation
    properties:
      enable: true
      virtualGatewayId: ${outscale_virtual_gateway.virtual_gateway01.virtual_gateway_id}
      routeTableId: ${outscale_route_table.route_table01.route_table_id}
    options:
      dependsOn:
        - ${outscale_virtual_gateway_link.virtual_gateway_link01}
Copy

Create VirtualGatewayRoutePropagation Resource

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

Constructor syntax

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

@overload
def VirtualGatewayRoutePropagation(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   enable: Optional[bool] = None,
                                   route_table_id: Optional[str] = None,
                                   virtual_gateway_id: Optional[str] = None,
                                   virtual_gateway_route_propagation_id: Optional[str] = None)
func NewVirtualGatewayRoutePropagation(ctx *Context, name string, args VirtualGatewayRoutePropagationArgs, opts ...ResourceOption) (*VirtualGatewayRoutePropagation, error)
public VirtualGatewayRoutePropagation(string name, VirtualGatewayRoutePropagationArgs args, CustomResourceOptions? opts = null)
public VirtualGatewayRoutePropagation(String name, VirtualGatewayRoutePropagationArgs args)
public VirtualGatewayRoutePropagation(String name, VirtualGatewayRoutePropagationArgs args, CustomResourceOptions options)

type: outscale:VirtualGatewayRoutePropagation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VirtualGatewayRoutePropagationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VirtualGatewayRoutePropagationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VirtualGatewayRoutePropagationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VirtualGatewayRoutePropagationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VirtualGatewayRoutePropagationArgs
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 virtualGatewayRoutePropagationResource = new Outscale.VirtualGatewayRoutePropagation("virtualGatewayRoutePropagationResource", new()
{
    Enable = false,
    RouteTableId = "string",
    VirtualGatewayId = "string",
    VirtualGatewayRoutePropagationId = "string",
});
Copy
example, err := outscale.NewVirtualGatewayRoutePropagation(ctx, "virtualGatewayRoutePropagationResource", &outscale.VirtualGatewayRoutePropagationArgs{
	Enable:                           pulumi.Bool(false),
	RouteTableId:                     pulumi.String("string"),
	VirtualGatewayId:                 pulumi.String("string"),
	VirtualGatewayRoutePropagationId: pulumi.String("string"),
})
Copy
var virtualGatewayRoutePropagationResource = new VirtualGatewayRoutePropagation("virtualGatewayRoutePropagationResource", VirtualGatewayRoutePropagationArgs.builder()
    .enable(false)
    .routeTableId("string")
    .virtualGatewayId("string")
    .virtualGatewayRoutePropagationId("string")
    .build());
Copy
virtual_gateway_route_propagation_resource = outscale.VirtualGatewayRoutePropagation("virtualGatewayRoutePropagationResource",
    enable=False,
    route_table_id="string",
    virtual_gateway_id="string",
    virtual_gateway_route_propagation_id="string")
Copy
const virtualGatewayRoutePropagationResource = new outscale.VirtualGatewayRoutePropagation("virtualGatewayRoutePropagationResource", {
    enable: false,
    routeTableId: "string",
    virtualGatewayId: "string",
    virtualGatewayRoutePropagationId: "string",
});
Copy
type: outscale:VirtualGatewayRoutePropagation
properties:
    enable: false
    routeTableId: string
    virtualGatewayId: string
    virtualGatewayRoutePropagationId: string
Copy

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

Enable This property is required. bool
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
RouteTableId This property is required. string
The ID of the route table.
VirtualGatewayId This property is required. string
The ID of the virtual gateway.
VirtualGatewayRoutePropagationId string
Enable This property is required. bool
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
RouteTableId This property is required. string
The ID of the route table.
VirtualGatewayId This property is required. string
The ID of the virtual gateway.
VirtualGatewayRoutePropagationId string
enable This property is required. Boolean
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
routeTableId This property is required. String
The ID of the route table.
virtualGatewayId This property is required. String
The ID of the virtual gateway.
virtualGatewayRoutePropagationId String
enable This property is required. boolean
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
routeTableId This property is required. string
The ID of the route table.
virtualGatewayId This property is required. string
The ID of the virtual gateway.
virtualGatewayRoutePropagationId string
enable This property is required. bool
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
route_table_id This property is required. str
The ID of the route table.
virtual_gateway_id This property is required. str
The ID of the virtual gateway.
virtual_gateway_route_propagation_id str
enable This property is required. Boolean
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
routeTableId This property is required. String
The ID of the route table.
virtualGatewayId This property is required. String
The ID of the virtual gateway.
virtualGatewayRoutePropagationId String

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
RequestId string
Id string
The provider-assigned unique ID for this managed resource.
RequestId string
id String
The provider-assigned unique ID for this managed resource.
requestId String
id string
The provider-assigned unique ID for this managed resource.
requestId string
id str
The provider-assigned unique ID for this managed resource.
request_id str
id String
The provider-assigned unique ID for this managed resource.
requestId String

Look up Existing VirtualGatewayRoutePropagation Resource

Get an existing VirtualGatewayRoutePropagation 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?: VirtualGatewayRoutePropagationState, opts?: CustomResourceOptions): VirtualGatewayRoutePropagation
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enable: Optional[bool] = None,
        request_id: Optional[str] = None,
        route_table_id: Optional[str] = None,
        virtual_gateway_id: Optional[str] = None,
        virtual_gateway_route_propagation_id: Optional[str] = None) -> VirtualGatewayRoutePropagation
func GetVirtualGatewayRoutePropagation(ctx *Context, name string, id IDInput, state *VirtualGatewayRoutePropagationState, opts ...ResourceOption) (*VirtualGatewayRoutePropagation, error)
public static VirtualGatewayRoutePropagation Get(string name, Input<string> id, VirtualGatewayRoutePropagationState? state, CustomResourceOptions? opts = null)
public static VirtualGatewayRoutePropagation get(String name, Output<String> id, VirtualGatewayRoutePropagationState state, CustomResourceOptions options)
resources:  _:    type: outscale:VirtualGatewayRoutePropagation    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Enable bool
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
RequestId string
RouteTableId string
The ID of the route table.
VirtualGatewayId string
The ID of the virtual gateway.
VirtualGatewayRoutePropagationId string
Enable bool
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
RequestId string
RouteTableId string
The ID of the route table.
VirtualGatewayId string
The ID of the virtual gateway.
VirtualGatewayRoutePropagationId string
enable Boolean
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
requestId String
routeTableId String
The ID of the route table.
virtualGatewayId String
The ID of the virtual gateway.
virtualGatewayRoutePropagationId String
enable boolean
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
requestId string
routeTableId string
The ID of the route table.
virtualGatewayId string
The ID of the virtual gateway.
virtualGatewayRoutePropagationId string
enable bool
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
request_id str
route_table_id str
The ID of the route table.
virtual_gateway_id str
The ID of the virtual gateway.
virtual_gateway_route_propagation_id str
enable Boolean
If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
requestId String
routeTableId String
The ID of the route table.
virtualGatewayId String
The ID of the virtual gateway.
virtualGatewayRoutePropagationId String

Package Details

Repository
outscale outscale/terraform-provider-outscale
License
Notes
This Pulumi package is based on the outscale Terraform Provider.
outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale
outscale/terraform-provider-outscale