Class CfnRouteServerPeer

Specifies a BGP peer configuration for a route server endpoint.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnRouteServerPeer

Implements

IInspectable

IRouteServerPeerRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnRouteServerPeer : CfnResource, IInspectable, IRouteServerPeerRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnRouteServerPeer Inherits CfnResource Implements IInspectable, IRouteServerPeerRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

Examples

// 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 cfnRouteServerPeer = new CfnRouteServerPeer(this, "MyCfnRouteServerPeer", new CfnRouteServerPeerProps {
                 BgpOptions = new BgpOptionsProperty {
                     PeerAsn = 123,
                     PeerLivenessDetection = "peerLivenessDetection"
                 },
                 PeerAddress = "peerAddress",
                 RouteServerEndpointId = "routeServerEndpointId",

                 // the properties below are optional
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnRouteServerPeer(Construct, string, ICfnRouteServerPeerProps)

Create a new AWS::EC2::RouteServerPeer.

Properties

AttrArn	The ARN of the route server peer.
AttrEndpointEniAddress	The IP address of the Elastic network interface for the route server endpoint.
AttrEndpointEniId	The ID of the Elastic network interface for the route server endpoint.
AttrId	The ID of the route server peer.
AttrRouteServerId	The ID of the route server associated with this peer.
AttrSubnetId	The ID of the subnet containing the route server peer.
AttrVpcId	The ID of the VPC containing the route server peer.
BgpOptions	The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Specifies a BGP peer configuration for a route server endpoint.
PeerAddress	The IPv4 address of the peer device.
RouteServerEndpointId	The ID of the route server endpoint associated with this peer.
RouteServerPeerRef	A reference to a RouteServerPeer resource.
Tags	Any tags assigned to the route server peer.

Methods

ArnForRouteServerPeer(IRouteServerPeerRef)	Specifies a BGP peer configuration for a route server endpoint.
FromRouteServerPeerArn(Construct, string, string)	Creates a new IRouteServerPeerRef from an ARN.
FromRouteServerPeerId(Construct, string, string)	Creates a new IRouteServerPeerRef from a routeServerPeerId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnRouteServerPeer(object)	Checks whether the given object is a CfnRouteServerPeer.
RenderProperties(IDictionary<string, object>)	Specifies a BGP peer configuration for a route server endpoint.

Constructors

CfnRouteServerPeer(Construct, string, ICfnRouteServerPeerProps)

Create a new AWS::EC2::RouteServerPeer.

public CfnRouteServerPeer(Construct scope, string id, ICfnRouteServerPeerProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnRouteServerPeerProps

Resource properties.

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

Properties

AttrArn

The ARN of the route server peer.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrEndpointEniAddress

The IP address of the Elastic network interface for the route server endpoint.

public virtual string AttrEndpointEniAddress { get; }

Property Value

string

Remarks

CloudformationAttribute: EndpointEniAddress

AttrEndpointEniId

The ID of the Elastic network interface for the route server endpoint.

public virtual string AttrEndpointEniId { get; }

Property Value

string

Remarks

CloudformationAttribute: EndpointEniId

AttrId

The ID of the route server peer.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

AttrRouteServerId

The ID of the route server associated with this peer.

public virtual string AttrRouteServerId { get; }

Property Value

string

Remarks

CloudformationAttribute: RouteServerId

AttrSubnetId

The ID of the subnet containing the route server peer.

public virtual string AttrSubnetId { get; }

Property Value

string

Remarks

CloudformationAttribute: SubnetId

AttrVpcId

The ID of the VPC containing the route server peer.

public virtual string AttrVpcId { get; }

Property Value

string

Remarks

CloudformationAttribute: VpcId

BgpOptions

The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.

public virtual object BgpOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnRouteServerPeer.IBgpOptionsProperty

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

CfnProperties

Specifies a BGP peer configuration for a route server endpoint.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

PeerAddress

The IPv4 address of the peer device.

public virtual string PeerAddress { get; set; }

Property Value

string

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

RouteServerEndpointId

The ID of the route server endpoint associated with this peer.

public virtual string RouteServerEndpointId { get; set; }

Property Value

string

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

RouteServerPeerRef

A reference to a RouteServerPeer resource.

public virtual IRouteServerPeerReference RouteServerPeerRef { get; }

Property Value

IRouteServerPeerReference

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

Tags

Any tags assigned to the route server peer.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

Methods

ArnForRouteServerPeer(IRouteServerPeerRef)

Specifies a BGP peer configuration for a route server endpoint.

public static string ArnForRouteServerPeer(IRouteServerPeerRef resource)

Parameters

resource IRouteServerPeerRef

Returns

string

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

Examples

// 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 cfnRouteServerPeer = new CfnRouteServerPeer(this, "MyCfnRouteServerPeer", new CfnRouteServerPeerProps {
                 BgpOptions = new BgpOptionsProperty {
                     PeerAsn = 123,
                     PeerLivenessDetection = "peerLivenessDetection"
                 },
                 PeerAddress = "peerAddress",
                 RouteServerEndpointId = "routeServerEndpointId",

                 // the properties below are optional
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromRouteServerPeerArn(Construct, string, string)

Creates a new IRouteServerPeerRef from an ARN.

public static IRouteServerPeerRef FromRouteServerPeerArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IRouteServerPeerRef

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

FromRouteServerPeerId(Construct, string, string)

Creates a new IRouteServerPeerRef from a routeServerPeerId.

public static IRouteServerPeerRef FromRouteServerPeerId(Construct scope, string id, string routeServerPeerId)

Parameters

scope Construct

id string

routeServerPeerId string

Returns

IRouteServerPeerRef

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

IsCfnRouteServerPeer(object)

Checks whether the given object is a CfnRouteServerPeer.

public static bool IsCfnRouteServerPeer(object x)

Parameters

x object

Returns

bool

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies a BGP peer configuration for a route server endpoint.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html

CloudformationResource: AWS::EC2::RouteServerPeer

ExampleMetadata: fixture=_generated

Implements

IInspectable

IRouteServerPeerRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2