SNSTopic | Praxis resources

Resource definition

What this resource looks like

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

resources: {
  alertTopic: {
  	apiVersion: "praxis.io/alpha"
  	kind:       "SNSTopic"
  	metadata: name: "\(_naming.prefix)-alerts"
  	spec: {
  		region:    _naming.region
  		topicName: "\(_naming.prefix)-alerts"
  		tags: #StandardTags & {purpose: "alerting"}
  	}
  }
}

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

Desired state

Configuration

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

regionRequired

Region.

string

String

topicNameRequired

Topic Name.

string & =~"^[a-zA-Z0-9_-]{1,256}(\\.fifo)?$"

String

displayNameOptional

Display Name.

string

String

fifoTopicOptional

Fifo Topic.

bool | *false

BooleanDefault false

contentBasedDeduplicationOptional

Content Based Deduplication.

bool | *false

BooleanDefault false

policyOptional

Omitted optional attributes are declarative defaults/absence. Re-applying a spec without a previously configured value removes that provider value.

string

String

deliveryPolicyOptional

Delivery Policy.

string

String

kmsMasterKeyIdOptional

Kms Master Key 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>}.

topicArnString

topicNameString

ownerString

Read without ownership

Data-source lookup

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

praxis import SNSTopic \
  --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 sns

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

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

	spec: {
		region: string

		topicName: string & =~"^[a-zA-Z0-9_-]{1,256}(\\.fifo)?$"

		displayName?: string

		fifoTopic: bool | *false

		contentBasedDeduplication: bool | *false

		// Omitted optional attributes are declarative defaults/absence. Re-applying
		// a spec without a previously configured value removes that provider value.
		policy?: string

		deliveryPolicy?: string

		kmsMasterKeyId?: string

		tags: [string]: string
	}

	outputs?: {
		topicArn:  string
		topicName: string
		owner:     string
	}
}

View this schema on GitHub →