1. Docs
  2. Reference
  3. API
  4. AWS
  5. ec2
  6. VpnGatewayRoutePropagation

VpnGatewayRoutePropagation

Requests automatic route propagation between a VPN gateway and a route table.

Note: This resource should not be used with a route table that has the propagating_vgws argument set. If that argument is set, any route propagation not explicitly listed in its value will be removed.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Ec2.VpnGatewayRoutePropagation("example", new Aws.Ec2.VpnGatewayRoutePropagationArgs
        {
            RouteTableId = aws_route_table.Example.Id,
            VpnGatewayId = aws_vpn_gateway.Example.Id,
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/ec2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := ec2.NewVpnGatewayRoutePropagation(ctx, "example", &ec2.VpnGatewayRoutePropagationArgs{
            RouteTableId: pulumi.String(aws_route_table.Example.Id),
            VpnGatewayId: pulumi.String(aws_vpn_gateway.Example.Id),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

example = aws.ec2.VpnGatewayRoutePropagation("example",
    route_table_id=aws_route_table["example"]["id"],
    vpn_gateway_id=aws_vpn_gateway["example"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2.VpnGatewayRoutePropagation("example", {
    routeTableId: aws_route_table_example.id,
    vpnGatewayId: aws_vpn_gateway_example.id,
});

Create a VpnGatewayRoutePropagation Resource

new VpnGatewayRoutePropagation(name: string, args: VpnGatewayRoutePropagationArgs, opts?: CustomResourceOptions);
def VpnGatewayRoutePropagation(resource_name, opts=None, route_table_id=None, vpn_gateway_id=None, __props__=None);
func NewVpnGatewayRoutePropagation(ctx *Context, name string, args VpnGatewayRoutePropagationArgs, opts ...ResourceOption) (*VpnGatewayRoutePropagation, error)
public VpnGatewayRoutePropagation(string name, VpnGatewayRoutePropagationArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args VpnGatewayRoutePropagationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args VpnGatewayRoutePropagationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VpnGatewayRoutePropagationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

VpnGatewayRoutePropagation Resource Properties

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

Inputs

The VpnGatewayRoutePropagation resource accepts the following input properties:

RouteTableId string

The id of the aws.ec2.RouteTable to propagate routes into.

VpnGatewayId string

The id of the aws.ec2.VpnGateway to propagate routes from.

RouteTableId string

The id of the aws.ec2.RouteTable to propagate routes into.

VpnGatewayId string

The id of the aws.ec2.VpnGateway to propagate routes from.

routeTableId string

The id of the aws.ec2.RouteTable to propagate routes into.

vpnGatewayId string

The id of the aws.ec2.VpnGateway to propagate routes from.

route_table_id str

The id of the aws.ec2.RouteTable to propagate routes into.

vpn_gateway_id str

The id of the aws.ec2.VpnGateway to propagate routes from.

Outputs

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

Look up an Existing VpnGatewayRoutePropagation Resource

Get an existing VpnGatewayRoutePropagation 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?: VpnGatewayRoutePropagationState, opts?: CustomResourceOptions): VpnGatewayRoutePropagation
static get(resource_name, id, opts=None, route_table_id=None, vpn_gateway_id=None, __props__=None);
func GetVpnGatewayRoutePropagation(ctx *Context, name string, id IDInput, state *VpnGatewayRoutePropagationState, opts ...ResourceOption) (*VpnGatewayRoutePropagation, error)
public static VpnGatewayRoutePropagation Get(string name, Input<string> id, VpnGatewayRoutePropagationState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

RouteTableId string

The id of the aws.ec2.RouteTable to propagate routes into.

VpnGatewayId string

The id of the aws.ec2.VpnGateway to propagate routes from.

RouteTableId string

The id of the aws.ec2.RouteTable to propagate routes into.

VpnGatewayId string

The id of the aws.ec2.VpnGateway to propagate routes from.

routeTableId string

The id of the aws.ec2.RouteTable to propagate routes into.

vpnGatewayId string

The id of the aws.ec2.VpnGateway to propagate routes from.

route_table_id str

The id of the aws.ec2.RouteTable to propagate routes into.

vpn_gateway_id str

The id of the aws.ec2.VpnGateway to propagate routes from.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.