Subscription
sns.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | sns-controller/apis/v1alpha1#Subscription |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Subscription |
| ListKind | SubscriptionList |
| Plural | subscriptions |
| Singular | subscription |
A wrapper type for the attributes of an Amazon SNS subscription.
Spec
deliveryPolicy: string
endpoint: string
filterPolicy: string
filterPolicyScope: string
protocol: string
rawMessageDelivery: string
redrivePolicy: string
subscriptionRoleARN: string
topicARN: string
topicRef:
from:
name: string
namespace: string
| Field | Description |
|---|---|
| deliveryPolicy Optional | string |
| endpoint Optional | string The endpoint that you want to receive notifications. Endpoints vary by protocol: * For the http protocol, the (public) endpoint is a URL beginning with http://. * For the https protocol, the (public) endpoint is a URL beginning with https://. * For the email protocol, the endpoint is an email address. * For the email-json protocol, the endpoint is an email address. * For the sms protocol, the endpoint is a phone number of an SMS-enabled device. * For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue. * For the application protocol, the endpoint is the EndpointArn of a mobile app and device. * For the lambda protocol, the endpoint is the ARN of an Lambda function. * For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream. |
| filterPolicy Optional | string |
| filterPolicyScope Optional | string |
| protocol Required | string The protocol that you want to use. Supported protocols include: * http – delivery of JSON-encoded message via HTTP POST * https – delivery of JSON-encoded message via HTTPS POST * email – delivery of message via SMTP * email-json – delivery of JSON-encoded message via SMTP * sms – delivery of message via SMS * sqs – delivery of JSON-encoded message to an Amazon SQS queue * application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device * lambda – delivery of JSON-encoded message to an Lambda function * firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream. |
| rawMessageDelivery Optional | string |
| redrivePolicy Optional | string |
| subscriptionRoleARN Optional | string |
| topicARN Optional | string The ARN of the topic you want to subscribe to. |
| topicRef 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 |
| topicRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| topicRef.from.name Optional | string |
| topicRef.from.namespace Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
confirmationWasAuthenticated: string
effectiveDeliveryPolicy: string
owner: string
pendingConfirmation: 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. 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 |
| confirmationWasAuthenticated Optional | string |
| effectiveDeliveryPolicy Optional | string |
| owner Optional | string |
| pendingConfirmation Optional | string |