SNS

3 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

SNSSubscription # GA

SNSSubscription is the Schema for managing SNS Subscriptions.

kubectl get snssubscriptions · example on GitHub

Example

# SNSSubscription — SNS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/sns.html#snssubscription
apiVersion: aws.konfig.io/v1alpha1
kind: SNSSubscription
metadata:
  name: example-snssubscription
  namespace: default
spec:
  endpoint: example
  filterPolicy: example
  protocol: sqs
  providerRef:
    name: example-snssubscription
    region: us-east-1
  rawMessageDelivery: false
  topicRef:
    name: example-topic

Spec

Field	Type	Required	Description
`endpoint`	string	yes	Endpoint is the subscription endpoint (queue ARN, URL, email, etc.).
`filterPolicy`	string	—	FilterPolicy is a JSON filter policy for message filtering.
`protocol`	enum	yes	Protocol is the subscription protocol: sqs, https, email, lambda, etc. Allowed: `sqs, https, http, email, email-json, sms, lambda, firehose…`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`rawMessageDelivery`	boolean	—	RawMessageDelivery enables raw message delivery (no JSON wrapping).
`topicRef`	object	yes	TopicRef references the SNS topic to subscribe to.
`topicRef.arn`	string	—	ARN is a direct SNS topic ARN (bypasses CR lookup).
`topicRef.name`	string	—	Name is the name of an SNSTopic CR in the same namespace.

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`subscriptionArn`	string	—	SubscriptionARN is the ARN of the subscription.

SNSTopic # GA

SNSTopic is the Schema for managing SNS Topics.

kubectl get snstopics · example on GitHub

Example

# SNSTopic — SNS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/sns.html#snstopic
apiVersion: aws.konfig.io/v1alpha1
kind: SNSTopic
metadata:
  name: example-snstopic
  namespace: default
spec:
  contentBasedDeduplication: false
  fifo: false
  kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  policy: '{"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["s3:GetObject"], "Resource":
    "*"}]}'
  providerRef:
    name: example-snstopic
    region: us-east-1
  tags:
    environment: dev
    team: platform
  topicName: example-snstopic

Spec

Field	Type	Required	Description
`contentBasedDeduplication`	boolean	—	ContentBasedDeduplication enables deduplication based on message body (only valid for FIFO topics).
`fifo`	boolean	—	FIFO enables FIFO ordering and exactly-once delivery.
`kmsKeyId`	string	—	KMSKeyID is the KMS key ARN or alias for SSE-KMS encryption.
`policy`	string	—	Policy is a JSON resource policy for the topic.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are AWS resource tags to apply.
`topicName`	string	yes	TopicName is the name of the SNS topic.

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`topicArn`	string	—	TopicARN is the ARN of the SNS topic.

SNSTopicInlinePolicy # CLOUD CONTROL · AWS::SNS::TopicInlinePolicy

SNSTopicInlinePolicy manages AWS::SNS::TopicInlinePolicy through the AWS Cloud Control API.

kubectl get snstopicinlinepolicies · example on GitHub

Example

# SNSTopicInlinePolicy — SNS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/sns.html#snstopicinlinepolicy
apiVersion: aws.konfig.io/v1alpha1
kind: SNSTopicInlinePolicy
metadata:
  name: example-snstopicinlinepolicy
  namespace: default
spec:
  providerRef:
    name: example-snstopicinlinepolicy
    region: us-east-1
  topicArn: arn:aws:iam::123456789012:role/example-role

Spec

Field	Type	Required	Description
`policyDocument`	object	yes	A policy document that contains permissions to add to the specified SNS topics.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`topicArn`	string	yes	The Amazon Resource Name (ARN) of the topic to which you want to add the policy.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.