NATGateway | Praxis resources

Resource definition

What this resource looks like

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

resources: {
  natgw: {
  	apiVersion: "praxis.io/alpha"
  	kind:       "NATGateway"
  	metadata: name: "\(_naming.prefix)-natgw"
  	spec: {
  		region:           _naming.region
  		subnetId:         "${resources.publicSubnetA.outputs.subnetId}"
  		connectivityType: "public"
  		allocationId:     "${resources.natEip.outputs.allocationId}"
  		tags:             #StandardTags
  	}
  }
}

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 stacks saas platform stacks three tier app vpc multi az vpc

Desired state

Configuration

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

regionRequired

Region.

string

String

subnetIdRequired

Subnet ID.

string

String

connectivityTypeOptional

Connectivity Type.

"public" | "private" | *"public"

EnumDefault "public"

allocationIdOptional

Allocation ID.

string

String

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>}.

natGatewayIdString

subnetIdString

vpcIdString

connectivityTypeString

stateString

publicIpString · optional

privateIpString

allocationIdString · optional

networkInterfaceIdString

Read without ownership

Data-source lookup

A data block reads an existing NATGateway 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: "NATGateway"
  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 NATGateway. The example starts in observed mode so Praxis reports drift without correcting it.

praxis import NATGateway \
  --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 natgw

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

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

	spec: {
		region:           string
		subnetId:         string
		connectivityType: "public" | "private" | *"public"
		allocationId?:    string
		tags: [string]: string
	}

	outputs?: {
		natGatewayId:       string
		subnetId:           string
		vpcId:              string
		connectivityType:   string
		state:              string
		publicIp?:          string
		privateIp:          string
		allocationId?:      string
		networkInterfaceId: string
	}
}

View this schema on GitHub →