PlatformApplication
sns.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | sns-controller/apis/v1alpha1#PlatformApplication |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | PlatformApplication |
| ListKind | PlatformApplicationList |
| Plural | platformapplications |
| Singular | platformapplication |
Platform application object.
Spec
eventDeliveryFailure: string
eventEndpointCreated: string
eventEndpointCreatedRef:
from:
name: string
namespace: string
eventEndpointDeleted: string
eventEndpointDeletedRef:
from:
name: string
namespace: string
eventEndpointUpdated: string
eventEndpointUpdatedRef:
from:
name: string
namespace: string
failureFeedbackRoleARN: string
failureFeedbackRoleRef:
from:
name: string
namespace: string
name: string
platform: string
platformCredential: string
platformPrincipal: string
successFeedbackRoleARN: string
successFeedbackRoleRef:
from:
name: string
namespace: string
successFeedbackSampleRate: string
| Field | Description |
|---|---|
| eventDeliveryFailure Optional | string |
| eventEndpointCreated Optional | string |
| eventEndpointCreatedRef 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 |
| eventEndpointCreatedRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| eventEndpointCreatedRef.from.name Optional | string |
| eventEndpointCreatedRef.from.namespace Optional | string |
| eventEndpointDeleted Optional | string |
| eventEndpointDeletedRef 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 |
| eventEndpointDeletedRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| eventEndpointDeletedRef.from.name Optional | string |
| eventEndpointDeletedRef.from.namespace Optional | string |
| eventEndpointUpdated Optional | string |
| eventEndpointUpdatedRef 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 |
| eventEndpointUpdatedRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| eventEndpointUpdatedRef.from.name Optional | string |
| eventEndpointUpdatedRef.from.namespace Optional | string |
| failureFeedbackRoleARN Optional | string |
| failureFeedbackRoleRef 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 |
| failureFeedbackRoleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| failureFeedbackRoleRef.from.name Optional | string |
| failureFeedbackRoleRef.from.namespace Optional | string |
| name Required | string Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long. |
| platform Required | string The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging). |
| platformCredential Optional | string |
| platformPrincipal Optional | string |
| successFeedbackRoleARN Optional | string |
| successFeedbackRoleRef 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 |
| successFeedbackRoleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| successFeedbackRoleRef.from.name Optional | string |
| successFeedbackRoleRef.from.namespace Optional | string |
| successFeedbackSampleRate Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: 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 |