software.amazon.awscdk.services.ec2

Class CfnVPCPeeringConnection

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ec2.CfnVPCPeeringConnection

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.895Z")
public class CfnVPCPeeringConnection
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::VPCPeeringConnection`.

Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to a different AWS account and can be in a different Region than the requester VPC.

The requester VPC and accepter VPC cannot have overlapping CIDR blocks. If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed .

If the VPCs belong to different accounts, the acceptor account must have a role that allows the requester account to accept the VPC peering connection. For more information, see Walkthough: Peer with a VPC in another AWS account .

If the requester and acceptor VPCs are in the same account, the peering request is accepted without a peering role.

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.*;
 CfnVPCPeeringConnection cfnVPCPeeringConnection = CfnVPCPeeringConnection.Builder.create(this, "MyCfnVPCPeeringConnection")
         .peerVpcId("peerVpcId")
         .vpcId("vpcId")
         // the properties below are optional
         .peerOwnerId("peerOwnerId")
         .peerRegion("peerRegion")
         .peerRoleArn("peerRoleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVPCPeeringConnection(Construct scope, java.lang.String id, CfnVPCPeeringConnectionProps props) Create a new `AWS::EC2::VPCPeeringConnection`.
protected	CfnVPCPeeringConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVPCPeeringConnection(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrId() The ID of the peering connection.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getPeerOwnerId() The AWS account ID of the owner of the accepter VPC.
java.lang.String	getPeerRegion() The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
java.lang.String	getPeerRoleArn() The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
java.lang.String	getPeerVpcId() The ID of the VPC with which you are creating the VPC peering connection.
TagManager	getTags() Any tags assigned to the resource.
java.lang.String	getVpcId() The ID of the VPC.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setPeerOwnerId(java.lang.String value) The AWS account ID of the owner of the accepter VPC.
void	setPeerRegion(java.lang.String value) The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
void	setPeerRoleArn(java.lang.String value) The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
void	setPeerVpcId(java.lang.String value) The ID of the VPC with which you are creating the VPC peering connection.
void	setVpcId(java.lang.String value) The ID of the VPC.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVPCPeeringConnection

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

CfnVPCPeeringConnection

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

CfnVPCPeeringConnection

public CfnVPCPeeringConnection(Construct scope,
                               java.lang.String id,
                               CfnVPCPeeringConnectionProps props)

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

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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

public java.lang.String getAttrId()

The ID of the peering connection.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Any tags assigned to the resource.

getPeerVpcId

public java.lang.String getPeerVpcId()

The ID of the VPC with which you are creating the VPC peering connection.

You must specify this parameter in the request.

setPeerVpcId

public void setPeerVpcId(java.lang.String value)

The ID of the VPC with which you are creating the VPC peering connection.

You must specify this parameter in the request.

getVpcId

public java.lang.String getVpcId()

The ID of the VPC.

setVpcId

public void setVpcId(java.lang.String value)

The ID of the VPC.

getPeerOwnerId

public java.lang.String getPeerOwnerId()

The AWS account ID of the owner of the accepter VPC.

Default: Your AWS account ID

setPeerOwnerId

public void setPeerOwnerId(java.lang.String value)

The AWS account ID of the owner of the accepter VPC.

Default: Your AWS account ID

getPeerRegion

public java.lang.String getPeerRegion()

The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.

Default: The Region in which you make the request.

setPeerRegion

public void setPeerRegion(java.lang.String value)

The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.

Default: The Region in which you make the request.

getPeerRoleArn

public java.lang.String getPeerRoleArn()

The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.

This is required when you are peering a VPC in a different AWS account.

setPeerRoleArn

public void setPeerRoleArn(java.lang.String value)

The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.

This is required when you are peering a VPC in a different AWS account.