Package software.amazon.awscdk.services.ec2

Interface CfnVPCPeeringConnectionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVPCPeeringConnectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:18.081Z")
@Stability(Stable)
public interface CfnVPCPeeringConnectionProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ec2.*;
 CfnVPCPeeringConnectionProps cfnVPCPeeringConnectionProps = CfnVPCPeeringConnectionProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVPCPeeringConnectionProps.Builder	A builder for CfnVPCPeeringConnectionProps
static final class	CfnVPCPeeringConnectionProps.Jsii$Proxy	An implementation for CfnVPCPeeringConnectionProps

Method Summary

Modifier and Type	Method	Description
static CfnVPCPeeringConnectionProps.Builder	builder()
default String	getPeerOwnerId()	The AWS account ID of the owner of the accepter VPC.
default 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 String	getPeerRoleArn()	The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
String	getPeerVpcId()	The ID of the VPC with which you are creating the VPC peering connection.
default List<CfnTag>	getTags()	Any tags assigned to the resource.
String	getVpcId()	The ID of the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPeerVpcId

@Stability(Stable)
@NotNull
String getPeerVpcId()

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

You must specify this parameter in the request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peervpcid

getVpcId

@Stability(Stable)
@NotNull
String getVpcId()

The ID of the VPC.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-vpcid

getPeerOwnerId

@Stability(Stable)
@Nullable
default String getPeerOwnerId()

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

Default: Your AWS account ID

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerownerid

getPeerRegion

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerregion

getPeerRoleArn

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerrolearn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Any tags assigned to the resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-tags

builder

@Stability(Stable)
static CfnVPCPeeringConnectionProps.Builder builder()

Returns:

a CfnVPCPeeringConnectionProps.Builder of CfnVPCPeeringConnectionProps