aws-cdk-lib.aws_ec2.CfnVPCPeeringConnectionProps

interface CfnVPCPeeringConnectionProps

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnVPCPeeringConnectionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnVPCPeeringConnectionProps
Javasoftware.amazon.awscdk.services.ec2.CfnVPCPeeringConnectionProps
Pythonaws_cdk.aws_ec2.CfnVPCPeeringConnectionProps
TypeScript aws-cdk-lib » aws_ec2 » CfnVPCPeeringConnectionProps

Properties for defining a CfnVPCPeeringConnection.

Example

// 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
  peerOwnerId: 'peerOwnerId',
  peerRegion: 'peerRegion',
  peerRoleArn: 'peerRoleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
peerVpcIdstringThe ID of the VPC with which you are creating the VPC peering connection.
vpcIdstringThe ID of the VPC.
peerOwnerId?stringThe AWS account ID of the owner of the accepter VPC.
peerRegion?stringThe 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.
peerRoleArn?stringThe Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
tags?CfnTag[]Any tags assigned to the resource.

peerVpcId

Type: string

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

You must specify this parameter in the request.


vpcId

Type: string

The ID of the VPC.


peerOwnerId?

Type: string (optional)

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

Default: Your AWS account ID


peerRegion?

Type: string (optional)

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.


peerRoleArn?

Type: string (optional)

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.


tags?

Type: CfnTag[] (optional)

Any tags assigned to the resource.