VPCPeeringConnection | Praxis resources

Resource definition

What this resource looks like

This is the CUE shape a Praxis template uses to declare a VPCPeeringConnection. The resource key is local to the template; metadata.name supplies its stable Praxis identity.

resources: {
  vpcPeering: {
  	apiVersion: "praxis.io/alpha"
  	kind:       "VPCPeeringConnection"
  	metadata: name: "\(_naming.prefix)-to-shared"
  	spec: {
  		region:         _naming.region
  		requesterVpcId: "${resources.vpc.outputs.vpcId}"
  		accepterVpcId:  "${data.sharedVpc.outputs.vpcId}"
  		autoAccept:     true
  		requesterOptions: allowDnsResolutionFromRemoteVpc: true
  		accepterOptions: allowDnsResolutionFromRemoteVpc:  true
  		tags: #InfraTags
  	}
  }
}

Excerpted from examples/stacks/end-to-end.cue. Open the complete example for its variables and related resources.

Complete examples in the repository

stacks end to end vpc vpc peering

Desired state

Configuration

The spec block accepts 9 fields. 4 are required by the schema; fields with defaults can be omitted.

regionRequired

Region.

string

String

requesterVpcIdRequired

Requester VPC ID.

string

String

accepterVpcIdRequired

Accepter VPC ID.

string

String

peerOwnerIdOptional

Peer Owner ID.

string

String

peerRegionOptional

Peer Region.

string

String

autoAcceptOptional

Auto Accept.

bool | *true

BooleanDefault true

requesterOptionsOptional

Requester Options.

allowDnsResolutionFromRemoteVpc: bool | *false

ObjectDefault false

accepterOptionsOptional

Accepter Options.

allowDnsResolutionFromRemoteVpc: bool | *false

ObjectDefault false

tagsRequired

Tags.

[string]: string

Map

Observed values

Outputs

Praxis records these values after observation. A dependent resource can read one with ${resources.<name>.outputs.<field>}.

vpcPeeringConnectionIdString

requesterVpcIdString

accepterVpcIdString

requesterCidrBlockString

accepterCidrBlockString

statusString

requesterOwnerIdString

accepterOwnerIdString

Read without ownership

Data-source lookup

A data block reads an existing VPCPeeringConnection and exposes its outputs without storing lifecycle state. The generic filter surface accepts id, name, and tag; supported combinations depend on the AWS identity used by this resource.

data: existing: {
  kind: "VPCPeeringConnection"
  region: "us-west-2"
  filter: {
    name: "replace-with-provider-name"
  }
}

Understand data sources and filters →

Adopt existing infrastructure

Import

Import persists Praxis state for an existing AWS resource. For this kind, supply: Provider identifier for the existing VPCPeeringConnection. The example starts in observed mode so Praxis reports drift without correcting it.

praxis import VPCPeeringConnection \
  --id <provider-identifier> \
  --region us-west-2 \
  --account production \
  --observe

Choose managed or observed ownership →

Canonical contract

Complete CUE schema

The field guide above is derived from this definition. The schema remains the source of truth for accepted values, defaults, validation constraints, and outputs in the current alpha revision.

Show the complete schema

package vpcpeering

#VPCPeeringConnection: {
	apiVersion: "praxis.io/alpha"
	kind:       "VPCPeeringConnection"

	metadata: {
		name: string & =~"^[a-zA-Z0-9][a-zA-Z0-9._-]{0,254}$"
		labels: [string]: string
	}

	spec: {
		region: string

		requesterVpcId: string
		accepterVpcId:  string

		peerOwnerId?: string
		peerRegion?:  string

		autoAccept: bool | *true

		requesterOptions?: allowDnsResolutionFromRemoteVpc: bool | *false

		accepterOptions?: allowDnsResolutionFromRemoteVpc: bool | *false

		tags: [string]: string
	}

	outputs?: {
		vpcPeeringConnectionId: string
		requesterVpcId:         string
		accepterVpcId:          string
		requesterCidrBlock:     string
		accepterCidrBlock:      string
		status:                 string
		requesterOwnerId:       string
		accepterOwnerId:        string
	}
}

View this schema on GitHub →