Class: Aws::EC2::Types::RouteServer

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::RouteServer

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Describes a route server and its configuration.

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

Route server supports the follow route table types:

• VPC route tables not associated with subnets

• Subnet route tables

• Internet gateway route tables

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use [Transit Gateway Connect].

[1]: docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #amazon_side_asn ⇒ Integer

  The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance.

• #persist_routes_duration ⇒ Integer

  The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB.

• #persist_routes_state ⇒ String

  The current state of route persistence for the route server.

• #route_server_id ⇒ String

  The unique identifier of the route server.

• #sns_notifications_enabled ⇒ Boolean

  Indicates whether SNS notifications are enabled for the route server.

• #sns_topic_arn ⇒ String

  The ARN of the SNS topic where notifications are published.

• #state ⇒ String

  The current state of the route server.

• #tags ⇒ Array<Types::Tag>

  Any tags assigned to the route server.

Instance Attribute Details

#amazon_side_asn ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 64626

class RouteServer < Struct.new(
  :route_server_id,
  :amazon_side_asn,
  :state,
  :tags,
  :persist_routes_state,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :sns_topic_arn)
  SENSITIVE = []
  include Aws::Structure
end

#persist_routes_duration ⇒ Integer

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. 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.

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 64626

class RouteServer < Struct.new(
  :route_server_id,
  :amazon_side_asn,
  :state,
  :tags,
  :persist_routes_state,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :sns_topic_arn)
  SENSITIVE = []
  include Aws::Structure
end

#persist_routes_state ⇒ String

The current state of route persistence for the route server.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 64626

class RouteServer < Struct.new(
  :route_server_id,
  :amazon_side_asn,
  :state,
  :tags,
  :persist_routes_state,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :sns_topic_arn)
  SENSITIVE = []
  include Aws::Structure
end

#route_server_id ⇒ String

The unique identifier of the route server.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 64626

class RouteServer < Struct.new(
  :route_server_id,
  :amazon_side_asn,
  :state,
  :tags,
  :persist_routes_state,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :sns_topic_arn)
  SENSITIVE = []
  include Aws::Structure
end

#sns_notifications_enabled ⇒ Boolean

Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 64626

class RouteServer < Struct.new(
  :route_server_id,
  :amazon_side_asn,
  :state,
  :tags,
  :persist_routes_state,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :sns_topic_arn)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arn ⇒ String

The ARN of the SNS topic where notifications are published.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 64626

class RouteServer < Struct.new(
  :route_server_id,
  :amazon_side_asn,
  :state,
  :tags,
  :persist_routes_state,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :sns_topic_arn)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of the route server.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 64626

class RouteServer < Struct.new(
  :route_server_id,
  :amazon_side_asn,
  :state,
  :tags,
  :persist_routes_state,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :sns_topic_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the route server.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-ec2/types.rb', line 64626

class RouteServer < Struct.new(
  :route_server_id,
  :amazon_side_asn,
  :state,
  :tags,
  :persist_routes_state,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :sns_topic_arn)
  SENSITIVE = []
  include Aws::Structure
end