Skip to content
v2.274.0

CfnVPCPeeringConnectionProps Struct ​

Properties for defining a CfnVPCPeeringConnection.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnVPCPeeringConnectionProps: ec2.CfnVPCPeeringConnectionProps = {
  peerVpcId: 'peerVpcId',
  vpcId: 'vpcId',

  // the properties below are optional
  assumeRoleRegion: 'assumeRoleRegion',
  peerOwnerId: 'peerOwnerId',
  peerRegion: 'peerRegion',
  peerRoleArn: 'peerRoleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

assumeRoleRegionoptionalstringassume_role_regionoptionalstrassumeRoleRegionoptionalStringAssumeRoleRegionoptionalstringAssumeRoleRegionoptional*string#
The Region code to use when calling Security Token Service (STS) to assume the PeerRoleArn, if provided.
peerOwnerIdoptionalstringpeer_owner_idoptionalstrpeerOwnerIdoptionalStringPeerOwnerIdoptionalstringPeerOwnerIdoptional*string#
The AWS account ID of the owner of the accepter VPC.

Default: Your AWS account ID

peerRegionoptionalstringpeer_regionoptionalstrpeerRegionoptionalStringPeerRegionoptionalstringPeerRegionoptional*string#
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.

peerRoleArnoptionalstringpeer_role_arnoptionalstrpeerRoleArnoptionalStringPeerRoleArnoptionalstringPeerRoleArnoptional*string#
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.

peerVpcIdstring | IVPCRefpeer_vpc_idtyping.Union[str, IVPCRef]peerVpcIdStringPeerVpcIdstringPeerVpcIdinterface{}required#
The ID of the VPC with which you are creating the VPC peering connection.

You must specify this parameter in the request.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Any tags assigned to the resource.
vpcIdstring | IVPCRefvpc_idtyping.Union[str, IVPCRef]vpcIdStringVpcIdstringVpcIdinterface{}required#
The ID of the VPC.