AwsVpcPeeringArgs

interface AwsVpcPeeringArgs extends Omit<aws.ec2.VpcPeeringConnectionArgs, 'autoAccept' | 'peerVpcId' | 'tags' | 'vpcId'> {
accepter?: Input<VpcPeeringConnectionAccepter | undefined>;
autoAccept?: boolean;
peerOwnerId?: Input<string | undefined>;
peerRegion?: Input<string | undefined>;
peerVpc: AwsVpcReference;
region?: Input<string | undefined>;
requester?: Input<VpcPeeringConnectionRequester | undefined>;
tags?: Input<Record<string, Input<string>>>;
vpc: AwsVpcReference;
}

Input arguments for the VPC peering capability.

Remarks

The component creates the requester-side peering connection only. It never creates routes or accepts a cross-account/cross-region request, because those actions require an explicitly configured accepter-side provider. autoAccept defaults to false and may only be enabled for same-account, same-region peerings.

Example

CODE

import type { AwsVpcPeeringArgs } from '@jobcloud/aws-vpc';

const peering: AwsVpcPeeringArgs = {
  vpc: { vpcId: 'vpc-0123456789abcdef0' },
  peerVpc: { vpcId: 'vpc-0fedcba9876543210' },
};

Hierarchy

VpcPeeringConnectionArgs, "autoAccept" | "peerVpcId" | "tags" | "vpcId">
AwsVpcPeeringArgs

Properties

`accepter: Input<VpcPeeringConnectionAccepter | undefined>`

Inherited from accepter

An optional configuration block that allows for VPC Peering Connection options to be set for the VPC that accepts the peering connection (a maximum of one).

`autoAccept: boolean`

Whether to accept a same-account, same-region peering request automatically.

Default: ```ts false ```

`peerOwnerId: Input<string | undefined>`

Inherited from peerOwnerId

The AWS account ID of the target peer VPC. Defaults to the account ID the AWS provider is currently connected to, so must be managed if connecting cross-account.

`peerRegion: Input<string | undefined>`

Inherited from peerRegion

The region of the accepter VPC of the VPC Peering Connection. autoAccept must be false, and use the aws.ec2.VpcPeeringConnectionAccepter to manage the accepter side.

`peerVpc: AwsVpcReference`

Accepter VPC reference.

`region: Input<string | undefined>`

Inherited from region

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

`requester: Input<VpcPeeringConnectionRequester | undefined>`

Inherited from requester

A optional configuration block that allows for VPC Peering Connection options to be set for the VPC that requests the peering connection (a maximum of one).

`tags: Input<Record<string, Input<string>>>`

Optional tags merged with the mandatory JobCloud default tags.

`vpc: AwsVpcReference`

Requester VPC reference.