RouteServer class
Provides a resource for managing a VPC Route Server.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.vpc.RouteServer("test", {
amazonSideAsn: 65534,
tags: {
Name: "Test",
},
});
import pulumi
import pulumi_aws as aws
test = aws.vpc.RouteServer("test",
amazon_side_asn=65534,
tags={
"Name": "Test",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Vpc.RouteServer("test", new()
{
AmazonSideAsn = 65534,
Tags =
{
{ "Name", "Test" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vpc.NewRouteServer(ctx, "test", &vpc.RouteServerArgs{
AmazonSideAsn: pulumi.Int(65534),
Tags: pulumi.StringMap{
"Name": pulumi.String("Test"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_vpc_routeserver" "test" {
amazon_side_asn = 65534
tags = {
"Name" = "Test"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.vpc.RouteServer;
import com.pulumi.aws.vpc.RouteServerArgs;
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 test = new RouteServer("test", RouteServerArgs.builder()
.amazonSideAsn(65534)
.tags(Map.of("Name", "Test"))
.build());
}
}
resources:
test:
type: aws:vpc:RouteServer
properties:
amazonSideAsn: 65534
tags:
Name: Test
Persist Route and SNS Notification
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.vpc.RouteServer("test", {
amazonSideAsn: 65534,
persistRoutes: "enable",
persistRoutesDuration: 2,
snsNotificationsEnabled: true,
tags: {
Name: "Main Route Server",
},
});
import pulumi
import pulumi_aws as aws
test = aws.vpc.RouteServer("test",
amazon_side_asn=65534,
persist_routes="enable",
persist_routes_duration=2,
sns_notifications_enabled=True,
tags={
"Name": "Main Route Server",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Vpc.RouteServer("test", new()
{
AmazonSideAsn = 65534,
PersistRoutes = "enable",
PersistRoutesDuration = 2,
SnsNotificationsEnabled = true,
Tags =
{
{ "Name", "Main Route Server" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vpc.NewRouteServer(ctx, "test", &vpc.RouteServerArgs{
AmazonSideAsn: pulumi.Int(65534),
PersistRoutes: pulumi.String("enable"),
PersistRoutesDuration: pulumi.Int(2),
SnsNotificationsEnabled: pulumi.Bool(true),
Tags: pulumi.StringMap{
"Name": pulumi.String("Main Route Server"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_vpc_routeserver" "test" {
amazon_side_asn = 65534
persist_routes = "enable"
persist_routes_duration = 2
sns_notifications_enabled = true
tags = {
"Name" = "Main Route Server"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.vpc.RouteServer;
import com.pulumi.aws.vpc.RouteServerArgs;
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 test = new RouteServer("test", RouteServerArgs.builder()
.amazonSideAsn(65534)
.persistRoutes("enable")
.persistRoutesDuration(2)
.snsNotificationsEnabled(true)
.tags(Map.of("Name", "Main Route Server"))
.build());
}
}
resources:
test:
type: aws:vpc:RouteServer
properties:
amazonSideAsn: 65534
persistRoutes: enable
persistRoutesDuration: 2
snsNotificationsEnabled: true
tags:
Name: Main Route Server
Import
Using pulumi import, import VPC Route Server using the routeServerId. For example:
$ pulumi import aws:vpc/routeServer:RouteServer example rs-12345678
Constructors
- RouteServer(String name, {RouteServerArgs? args, CustomResourceOptions? options})
-
Creates a new RouteServer.
nameThe Pulumi resource name.argsArguments used to configure this RouteServer. The set of arguments for RouteServer.optionsResource options controlling this resource's behavior. - RouteServer.reference(String urn)
- Creates a typed reference to an existing RouteServer resource.
Properties
-
amazonSideAsn
↔ Output<
int> -
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.
latefinal
-
arn
↔ Output<
String> -
The ARN of the route server.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- 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
-
persistRoutes
↔ Output<
String> -
Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are
enable,disable,resetlatefinal -
persistRoutesDuration
↔ Output<
int?> -
The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if
persistRoutesis enabled.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
-
routeServerId
↔ Output<
String> -
The unique identifier of the route server.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
snsNotificationsEnabled
↔ Output<
bool> -
Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
latefinal
-
snsTopicArn
↔ Output<
String> -
The ARN of the SNS topic where notifications are published.
latefinal
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
RouteServerTimeouts?> -
latefinal
-
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, {RouteServerState? state, CustomResourceOptions? options}) → RouteServer -
Gets an existing RouteServer resource's state with the given
nameandid.