Class: Aws::EC2::Types::CreateRouteServerRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CreateRouteServerRequest

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #amazon_side_asn ⇒ Integer

  The private Autonomous System Number (ASN) for the Amazon side of the BGP session.

• #client_token ⇒ String

  Unique, case-sensitive identifier to ensure idempotency of the request.

• #dry_run ⇒ Boolean

  A check for whether you have the required permissions for the action without actually making the request and provides an error response.

• #persist_routes ⇒ String

  Indicates whether routes should be persisted after all BGP sessions are terminated.

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

• #sns_notifications_enabled ⇒ Boolean

  Indicates whether SNS notifications should be enabled for route server events.

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The tags to apply to the route server during creation.

Instance Attribute Details

#amazon_side_asn ⇒ Integer

The private Autonomous System Number (ASN) for the Amazon side of the BGP session. 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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15480

class CreateRouteServerRequest < Struct.new(
  :amazon_side_asn,
  :client_token,
  :dry_run,
  :persist_routes,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

Unique, case-sensitive identifier to ensure idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

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

class CreateRouteServerRequest < Struct.new(
  :amazon_side_asn,
  :client_token,
  :dry_run,
  :persist_routes,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

• (Boolean)

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

class CreateRouteServerRequest < Struct.new(
  :amazon_side_asn,
  :client_token,
  :dry_run,
  :persist_routes,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#persist_routes ⇒ String

Indicates whether routes should be persisted after all BGP sessions are terminated.

Returns:

• (String)

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

class CreateRouteServerRequest < Struct.new(
  :amazon_side_asn,
  :client_token,
  :dry_run,
  :persist_routes,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :tag_specifications)
  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. Required if PersistRoutes 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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15480

class CreateRouteServerRequest < Struct.new(
  :amazon_side_asn,
  :client_token,
  :dry_run,
  :persist_routes,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#sns_notifications_enabled ⇒ Boolean

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

Returns:

• (Boolean)

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

class CreateRouteServerRequest < Struct.new(
  :amazon_side_asn,
  :client_token,
  :dry_run,
  :persist_routes,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the route server during creation.

Returns:

• (Array<Types::TagSpecification>)

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

class CreateRouteServerRequest < Struct.new(
  :amazon_side_asn,
  :client_token,
  :dry_run,
  :persist_routes,
  :persist_routes_duration,
  :sns_notifications_enabled,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end