Show / Hide Table of Contents

Class CfnTransitGatewayConnectPeer

Describes a transit gateway Connect peer.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnTransitGatewayConnectPeer
Implements
IInspectable
ITransitGatewayConnectPeerRef
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 CfnTransitGatewayConnectPeer : CfnResource, IInspectable, ITransitGatewayConnectPeerRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnTransitGatewayConnectPeer Inherits CfnResource Implements IInspectable, ITransitGatewayConnectPeerRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

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 cfnTransitGatewayConnectPeer = new CfnTransitGatewayConnectPeer(this, "MyCfnTransitGatewayConnectPeer", new CfnTransitGatewayConnectPeerProps {
                 ConnectPeerConfiguration = new TransitGatewayConnectPeerConfigurationProperty {
                     InsideCidrBlocks = new [] { "insideCidrBlocks" },
                     PeerAddress = "peerAddress",

                     // the properties below are optional
                     BgpConfigurations = new [] { new TransitGatewayAttachmentBgpConfigurationProperty {
                         BgpStatus = "bgpStatus",
                         PeerAddress = "peerAddress",
                         PeerAsn = 123,
                         TransitGatewayAddress = "transitGatewayAddress",
                         TransitGatewayAsn = 123
                     } },
                     Protocol = "protocol",
                     TransitGatewayAddress = "transitGatewayAddress"
                 },
                 TransitGatewayAttachmentId = "transitGatewayAttachmentId",

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

Synopsis

Constructors

CfnTransitGatewayConnectPeer(Construct, string, ICfnTransitGatewayConnectPeerProps)

Create a new AWS::EC2::TransitGatewayConnectPeer.

Properties

AttrConnectPeerConfigurationBgpConfigurations

The BGP configuration details.

AttrConnectPeerConfigurationProtocol

The tunnel protocol.

AttrCreationTime

The creation time.

AttrState

The state of the Connect peer.

AttrTransitGatewayConnectPeerId

The ID of the Connect peer.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CdkTagManager

Tag Manager which manages the tags for this resource.

CfnProperties

Describes a transit gateway Connect peer.

ConnectPeerConfiguration

The Connect peer details.

Tags

The tags for the Connect peer.

TransitGatewayAttachmentId

The ID of the Connect attachment.

TransitGatewayConnectPeerRef

A reference to a TransitGatewayConnectPeer resource.

Methods

ArnForTransitGatewayConnectPeer(ITransitGatewayConnectPeerRef)

Describes a transit gateway Connect peer.

FromTransitGatewayConnectPeerId(Construct, string, string)

Creates a new ITransitGatewayConnectPeerRef from a transitGatewayConnectPeerId.

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

IsCfnTransitGatewayConnectPeer(object)

Checks whether the given object is a CfnTransitGatewayConnectPeer.

RenderProperties(IDictionary<string, object>)

Describes a transit gateway Connect peer.

Constructors

CfnTransitGatewayConnectPeer(Construct, string, ICfnTransitGatewayConnectPeerProps)

Create a new AWS::EC2::TransitGatewayConnectPeer.

public CfnTransitGatewayConnectPeer(Construct scope, string id, ICfnTransitGatewayConnectPeerProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnTransitGatewayConnectPeerProps

Resource properties.

Remarks

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

ExampleMetadata: fixture=_generated

Properties

AttrConnectPeerConfigurationBgpConfigurations

The BGP configuration details.

public virtual IResolvable AttrConnectPeerConfigurationBgpConfigurations { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: ConnectPeerConfiguration.BgpConfigurations

AttrConnectPeerConfigurationProtocol

The tunnel protocol.

public virtual string AttrConnectPeerConfigurationProtocol { get; }
Property Value

string

Remarks

CloudformationAttribute: ConnectPeerConfiguration.Protocol

AttrCreationTime

The creation time.

public virtual string AttrCreationTime { get; }
Property Value

string

Remarks

CloudformationAttribute: CreationTime

AttrState

The state of the Connect peer.

public virtual string AttrState { get; }
Property Value

string

Remarks

CloudformationAttribute: State

AttrTransitGatewayConnectPeerId

The ID of the Connect peer.

public virtual string AttrTransitGatewayConnectPeerId { get; }
Property Value

string

Remarks

CloudformationAttribute: TransitGatewayConnectPeerId

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

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

ExampleMetadata: fixture=_generated

CfnProperties

Describes a transit gateway Connect peer.

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

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

ExampleMetadata: fixture=_generated

ConnectPeerConfiguration

The Connect peer details.

public virtual object ConnectPeerConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnTransitGatewayConnectPeer.ITransitGatewayConnectPeerConfigurationProperty

Tags

The tags for the Connect peer.

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

ICfnTag[]

Remarks

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

ExampleMetadata: fixture=_generated

TransitGatewayAttachmentId

The ID of the Connect attachment.

public virtual string TransitGatewayAttachmentId { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

ExampleMetadata: fixture=_generated

TransitGatewayConnectPeerRef

A reference to a TransitGatewayConnectPeer resource.

public virtual ITransitGatewayConnectPeerReference TransitGatewayConnectPeerRef { get; }
Property Value

ITransitGatewayConnectPeerReference

Remarks

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

ExampleMetadata: fixture=_generated

Methods

ArnForTransitGatewayConnectPeer(ITransitGatewayConnectPeerRef)

Describes a transit gateway Connect peer.

public static string ArnForTransitGatewayConnectPeer(ITransitGatewayConnectPeerRef resource)
Parameters
resource ITransitGatewayConnectPeerRef
Returns

string

Remarks

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

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 cfnTransitGatewayConnectPeer = new CfnTransitGatewayConnectPeer(this, "MyCfnTransitGatewayConnectPeer", new CfnTransitGatewayConnectPeerProps {
                 ConnectPeerConfiguration = new TransitGatewayConnectPeerConfigurationProperty {
                     InsideCidrBlocks = new [] { "insideCidrBlocks" },
                     PeerAddress = "peerAddress",

                     // the properties below are optional
                     BgpConfigurations = new [] { new TransitGatewayAttachmentBgpConfigurationProperty {
                         BgpStatus = "bgpStatus",
                         PeerAddress = "peerAddress",
                         PeerAsn = 123,
                         TransitGatewayAddress = "transitGatewayAddress",
                         TransitGatewayAsn = 123
                     } },
                     Protocol = "protocol",
                     TransitGatewayAddress = "transitGatewayAddress"
                 },
                 TransitGatewayAttachmentId = "transitGatewayAttachmentId",

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

FromTransitGatewayConnectPeerId(Construct, string, string)

Creates a new ITransitGatewayConnectPeerRef from a transitGatewayConnectPeerId.

public static ITransitGatewayConnectPeerRef FromTransitGatewayConnectPeerId(Construct scope, string id, string transitGatewayConnectPeerId)
Parameters
scope Construct
id string
transitGatewayConnectPeerId string
Returns

ITransitGatewayConnectPeerRef

Remarks

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

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

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

ExampleMetadata: fixture=_generated

IsCfnTransitGatewayConnectPeer(object)

Checks whether the given object is a CfnTransitGatewayConnectPeer.

public static bool IsCfnTransitGatewayConnectPeer(object x)
Parameters
x object
Returns

bool

Remarks

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Describes a transit gateway Connect peer.

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

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

CloudformationResource: AWS::EC2::TransitGatewayConnectPeer

ExampleMetadata: fixture=_generated

Implements

IInspectable
ITransitGatewayConnectPeerRef
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
ITaggableV2
Back to top Generated by DocFX