Package software.amazon.awscdk.services.ec2

Class CfnVPCPeeringConnection

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.174Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnVPCPeeringConnection

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

    • CfnVPCPeeringConnection

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

    • CfnVPCPeeringConnection

      @Stability(Stable) public CfnVPCPeeringConnection(@NotNull Construct scope, @NotNull String id, @NotNull 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 Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the peering connection.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Any tags assigned to the resource.

    • getPeerVpcId

      @Stability(Stable) @NotNull public 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

      @Stability(Stable) public void setPeerVpcId(@NotNull 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

      @Stability(Stable) @NotNull public String getVpcId()
      The ID of the VPC.

    • setVpcId

      @Stability(Stable) public void setVpcId(@NotNull String value)
      The ID of the VPC.

    • getPeerOwnerId

      @Stability(Stable) @Nullable public String getPeerOwnerId()
      The AWS account ID of the owner of the accepter VPC.

      Default: Your AWS account ID

    • setPeerOwnerId

      @Stability(Stable) public void setPeerOwnerId(@Nullable String value)
      The AWS account ID of the owner of the accepter VPC.

      Default: Your AWS account ID

    • getPeerRegion

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

      @Stability(Stable) public void setPeerRegion(@Nullable 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

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

      @Stability(Stable) public void setPeerRoleArn(@Nullable 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.