Skip to content
v2.276.0

CfnRouteServerProps Struct ​

Properties for defining a CfnRouteServer.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnRouteServerProps: ec2.CfnRouteServerProps = {
  amazonSideAsn: 123,

  // the properties below are optional
  persistRoutes: 'persistRoutes',
  persistRoutesDuration: 123,
  snsNotificationsEnabled: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

cfn_route_server_props = ec2.CfnRouteServerProps(
    amazon_side_asn=123,

    # the properties below are optional
    persist_routes="persistRoutes",
    persist_routes_duration=123,
    sns_notifications_enabled=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.*;

CfnRouteServerProps cfnRouteServerProps = CfnRouteServerProps.builder()
        .amazonSideAsn(123)

        // the properties below are optional
        .persistRoutes("persistRoutes")
        .persistRoutesDuration(123)
        .snsNotificationsEnabled(false)
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;

var cfnRouteServerProps = new CfnRouteServerProps {
    AmazonSideAsn = 123,

    // the properties below are optional
    PersistRoutes = "persistRoutes",
    PersistRoutesDuration = 123,
    SnsNotificationsEnabled = false,
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnRouteServerProps := &CfnRouteServerProps{
	AmazonSideAsn: jsii.Number(123),

	// the properties below are optional
	PersistRoutes: jsii.String("persistRoutes"),
	PersistRoutesDuration: jsii.Number(123),
	SnsNotificationsEnabled: jsii.Boolean(false),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

amazonSideAsnnumberamazon_side_asnint | floatamazonSideAsnNumberAmazonSideAsndoubleAmazonSideAsn*float64required#
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance.

Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.

persistRoutesoptionalstringpersist_routesoptionalstrpersistRoutesoptionalStringPersistRoutesoptionalstringPersistRoutesoptional*string#
Indicates whether routes should be persisted after all BGP sessions are terminated.
persistRoutesDurationoptionalnumberpersist_routes_durationoptionalint | floatpersistRoutesDurationoptionalNumberPersistRoutesDurationoptionaldoublePersistRoutesDurationoptional*float64#
The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB.
notes

Value must be in the range of 1-5. The default value is 1. Only valid if persistRoutesState is 'enabled'.

If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.

snsNotificationsEnabledoptionalboolean | IResolvablesns_notifications_enabledoptionaltyping.Union[bool, IResolvable]snsNotificationsEnabledoptionalBooleanSnsNotificationsEnabledoptionalboolSnsNotificationsEnabledoptionalinterface{}#
Indicates whether SNS notifications are enabled for the route server.

Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS .

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Any tags assigned to the route server.