LocalGatewayRoute class

Manages an EC2 Local Gateway Route. More information can be found in the Outposts User Guide.

Example Usage

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

const example = new aws.ec2.LocalGatewayRoute("example", {
    destinationCidrBlock: "172.16.0.0/16",
    localGatewayRouteTableId: exampleAwsEc2LocalGatewayRouteTable.id,
    localGatewayVirtualInterfaceGroupId: exampleAwsEc2LocalGatewayVirtualInterfaceGroup.id,
});
import pulumi
import pulumi_aws as aws

example = aws.ec2.LocalGatewayRoute("example",
    destination_cidr_block="172.16.0.0/16",
    local_gateway_route_table_id=example_aws_ec2_local_gateway_route_table["id"],
    local_gateway_virtual_interface_group_id=example_aws_ec2_local_gateway_virtual_interface_group["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ec2.LocalGatewayRoute("example", new()
    {
        DestinationCidrBlock = "172.16.0.0/16",
        LocalGatewayRouteTableId = exampleAwsEc2LocalGatewayRouteTable.Id,
        LocalGatewayVirtualInterfaceGroupId = exampleAwsEc2LocalGatewayVirtualInterfaceGroup.Id,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewLocalGatewayRoute(ctx, "example", &ec2.LocalGatewayRouteArgs{
			DestinationCidrBlock:                pulumi.String("172.16.0.0/16"),
			LocalGatewayRouteTableId:            pulumi.Any(exampleAwsEc2LocalGatewayRouteTable.Id),
			LocalGatewayVirtualInterfaceGroupId: pulumi.Any(exampleAwsEc2LocalGatewayVirtualInterfaceGroup.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_localgatewayroute" "example" {
  destination_cidr_block                   = "172.16.0.0/16"
  local_gateway_route_table_id             = exampleAwsEc2LocalGatewayRouteTable.id
  local_gateway_virtual_interface_group_id = exampleAwsEc2LocalGatewayVirtualInterfaceGroup.id
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.LocalGatewayRoute;
import com.pulumi.aws.ec2.LocalGatewayRouteArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 LocalGatewayRoute("example", LocalGatewayRouteArgs.builder()
            .destinationCidrBlock("172.16.0.0/16")
            .localGatewayRouteTableId(exampleAwsEc2LocalGatewayRouteTable.id())
            .localGatewayVirtualInterfaceGroupId(exampleAwsEc2LocalGatewayVirtualInterfaceGroup.id())
            .build());

    }
}
resources:
  example:
    type: aws:ec2:LocalGatewayRoute
    properties:
      destinationCidrBlock: 172.16.0.0/16
      localGatewayRouteTableId: ${exampleAwsEc2LocalGatewayRouteTable.id}
      localGatewayVirtualInterfaceGroupId: ${exampleAwsEc2LocalGatewayVirtualInterfaceGroup.id}

Import

Using pulumi import, import aws.ec2.LocalGatewayRoute using the EC2 Local Gateway Route Table identifier and destination CIDR block separated by underscores (_). For example:

$ pulumi import aws:ec2/localGatewayRoute:LocalGatewayRoute example lgw-rtb-12345678_172.16.0.0/16

Constructors

LocalGatewayRoute(String name, {LocalGatewayRouteArgs? args, CustomResourceOptions? options})
Creates a new LocalGatewayRoute. name The Pulumi resource name. args Arguments used to configure this LocalGatewayRoute. The set of arguments for LocalGatewayRoute. options Resource options controlling this resource's behavior.
LocalGatewayRoute.reference(String urn)
Creates a typed reference to an existing LocalGatewayRoute resource.

Properties

childResources Set<Resource>
finalinherited
completionSources Map<String, IOutputCompletionSource>
latefinalinherited
destinationCidrBlock ↔ Output<String>
IPv4 CIDR range used for destination matches. Routing decisions are based on the most specific match.
latefinal
hashCode int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference bool
Whether this instance represents a resource value returned over RPC.
finalinherited
localGatewayRouteTableId ↔ Output<String>
Identifier of EC2 Local Gateway Route Table.
latefinal
localGatewayVirtualInterfaceGroupId ↔ Output<String>
Identifier of EC2 Local Gateway Virtual Interface Group.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
transformations List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() String
Returns this resource's logical name.
inherited
getResourceType() String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {LocalGatewayRouteState? state, CustomResourceOptions? options}) LocalGatewayRoute
Gets an existing LocalGatewayRoute resource's state with the given name and id.