Topic
sns.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | sns-controller/apis/v1alpha1#Topic |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Topic |
| ListKind | TopicList |
| Plural | topics |
| Singular | topic |
A wrapper type for the topic’s Amazon Resource Name (ARN). To retrieve a topic’s attributes, use GetTopicAttributes.
Spec
contentBasedDeduplication: string
dataProtectionPolicy: string
deliveryPolicy: string
displayName: string
fifoTopic: string
kmsMasterKeyID: string
kmsMasterKeyRef:
from:
name: string
name: string
policy: string
policyRef:
from:
name: string
signatureVersion: string
tags:
- key: string
value: string
tracingConfig: string
| Field | Description |
|---|---|
| contentBasedDeduplication Optional | string |
| dataProtectionPolicy Optional | string The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720. |
| deliveryPolicy Optional | string |
| displayName Optional | string |
| fifoTopic Optional | string |
| kmsMasterKeyID Optional | string |
| kmsMasterKeyRef Optional | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api |
| kmsMasterKeyRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| kmsMasterKeyRef.from.name Optional | string |
| name Required | string The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix. |
| policy Optional | string |
| policyRef Optional | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api |
| policyRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| policyRef.from.name Optional | string |
| signatureVersion Optional | string |
| tags Optional | array The list of tags to add to a new topic. To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions. |
| tags.[] Required | object The list of tags to be added to the specified topic. |
| tags.[].value Optional | string |
| tracingConfig Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
effectiveDeliveryPolicy: string
owner: string
topicARN: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| effectiveDeliveryPolicy Optional | string |
| owner Optional | string |
| topicARN Optional | string |