software.amazon.awscdk.services.ec2

Class CfnTransitGatewayPeeringAttachment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnTransitGatewayPeeringAttachment

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.362Z")
 @Stability(value=Stable)
public class CfnTransitGatewayPeeringAttachment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::TransitGatewayPeeringAttachment`.

Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different AWS account .

After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.

Example:

 // 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.*;
 CfnTransitGatewayPeeringAttachment cfnTransitGatewayPeeringAttachment = CfnTransitGatewayPeeringAttachment.Builder.create(this, "MyCfnTransitGatewayPeeringAttachment")
         .peerAccountId("peerAccountId")
         .peerRegion("peerRegion")
         .peerTransitGatewayId("peerTransitGatewayId")
         .transitGatewayId("transitGatewayId")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTransitGatewayPeeringAttachment.Builder A fluent builder for CfnTransitGatewayPeeringAttachment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTransitGatewayPeeringAttachment(software.constructs.Construct scope, String id, CfnTransitGatewayPeeringAttachmentProps props) Create a new `AWS::EC2::TransitGatewayPeeringAttachment`.
protected	CfnTransitGatewayPeeringAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTransitGatewayPeeringAttachment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCreationTime() The time the transit gateway peering attachment was created.
String	getAttrState() The state of the transit gateway peering attachment.
String	getAttrTransitGatewayAttachmentId() The ID of the transit gateway peering attachment.
protected Map<String,Object>	getCfnProperties()
String	getPeerAccountId() The ID of the AWS account that owns the transit gateway.
String	getPeerRegion() The Region of the transit gateway.
String	getPeerTransitGatewayId() The ID of the transit gateway.
TagManager	getTags() The tags for the transit gateway peering attachment.
String	getTransitGatewayId() The ID of the transit gateway peering attachment.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPeerAccountId(String value) The ID of the AWS account that owns the transit gateway.
void	setPeerRegion(String value) The Region of the transit gateway.
void	setPeerTransitGatewayId(String value) The ID of the transit gateway.
void	setTransitGatewayId(String value) The ID of the transit gateway peering attachment.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTransitGatewayPeeringAttachment

protected CfnTransitGatewayPeeringAttachment(software.amazon.jsii.JsiiObjectRef objRef)

CfnTransitGatewayPeeringAttachment

protected CfnTransitGatewayPeeringAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTransitGatewayPeeringAttachment

@Stability(value=Stable)
public CfnTransitGatewayPeeringAttachment(@NotNull
                                                                   software.constructs.Construct scope,
                                                                   @NotNull
                                                                   String id,
                                                                   @NotNull
                                                                   CfnTransitGatewayPeeringAttachmentProps props)

Create a new `AWS::EC2::TransitGatewayPeeringAttachment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreationTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreationTime()

The time the transit gateway peering attachment was created.

getAttrState

@Stability(value=Stable)
 @NotNull
public String getAttrState()

The state of the transit gateway peering attachment.

Note that the initiating state has been deprecated.

getAttrTransitGatewayAttachmentId

@Stability(value=Stable)
 @NotNull
public String getAttrTransitGatewayAttachmentId()

The ID of the transit gateway peering attachment.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags for the transit gateway peering attachment.

getPeerAccountId

@Stability(value=Stable)
 @NotNull
public String getPeerAccountId()

The ID of the AWS account that owns the transit gateway.

setPeerAccountId

@Stability(value=Stable)
public void setPeerAccountId(@NotNull
                                                      String value)

The ID of the AWS account that owns the transit gateway.

getPeerRegion

@Stability(value=Stable)
 @NotNull
public String getPeerRegion()

The Region of the transit gateway.

setPeerRegion

@Stability(value=Stable)
public void setPeerRegion(@NotNull
                                                   String value)

The Region of the transit gateway.

getPeerTransitGatewayId

@Stability(value=Stable)
 @NotNull
public String getPeerTransitGatewayId()

The ID of the transit gateway.

setPeerTransitGatewayId

@Stability(value=Stable)
public void setPeerTransitGatewayId(@NotNull
                                                             String value)

The ID of the transit gateway.

getTransitGatewayId

@Stability(value=Stable)
 @NotNull
public String getTransitGatewayId()

The ID of the transit gateway peering attachment.

setTransitGatewayId

@Stability(value=Stable)
public void setTransitGatewayId(@NotNull
                                                         String value)

The ID of the transit gateway peering attachment.