Documentation ¶
Overview ¶
+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the sns.services.k8s.aws API. +groupName=sns.services.k8s.aws
Index ¶
- Variables
- type BatchResultErrorEntry
- type Endpoint
- type LanguageCodeString
- type MessageAttributeValue
- type NumberCapability
- type PhoneNumberInformation
- type PlatformApplication
- type PlatformApplicationList
- type PlatformApplicationSpec
- type PlatformApplicationStatus
- type PlatformApplication_SDK
- type PlatformEndpoint
- type PlatformEndpointList
- type PlatformEndpointSpec
- type PlatformEndpointStatus
- type PublishBatchRequestEntry
- type PublishBatchResultEntry
- type RouteType
- type SMSSandboxPhoneNumberVerificationStatus
- type Subscription
- type Tag
- type Topic
- type TopicList
- type TopicSpec
- type TopicStatus
- type Topic_SDK
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is the API Group Version used to register the objects GroupVersion = schema.GroupVersion{Group: "sns.services.k8s.aws", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type BatchResultErrorEntry ¶
type BatchResultErrorEntry struct { Code *string `json:"code,omitempty"` ID *string `json:"id,omitempty"` Message *string `json:"message,omitempty"` }
Gives a detailed description of failed messages in the batch.
func (*BatchResultErrorEntry) DeepCopy ¶
func (in *BatchResultErrorEntry) DeepCopy() *BatchResultErrorEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BatchResultErrorEntry.
func (*BatchResultErrorEntry) DeepCopyInto ¶
func (in *BatchResultErrorEntry) DeepCopyInto(out *BatchResultErrorEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Endpoint ¶
type Endpoint struct { Attributes map[string]*string `json:"attributes,omitempty"` EndpointARN *string `json:"endpointARN,omitempty"` }
The endpoint for mobile app and device.
func (*Endpoint) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Endpoint.
func (*Endpoint) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LanguageCodeString ¶
type LanguageCodeString string
const ( LanguageCodeString_en_US LanguageCodeString = "en-US" LanguageCodeString_en_GB LanguageCodeString = "en-GB" LanguageCodeString_es_419 LanguageCodeString = "es-419" LanguageCodeString_es_ES LanguageCodeString = "es-ES" LanguageCodeString_de_DE LanguageCodeString = "de-DE" LanguageCodeString_fr_CA LanguageCodeString = "fr-CA" LanguageCodeString_fr_FR LanguageCodeString = "fr-FR" LanguageCodeString_it_IT LanguageCodeString = "it-IT" LanguageCodeString_ja_JP LanguageCodeString = "ja-JP" LanguageCodeString_pt_BR LanguageCodeString = "pt-BR" LanguageCodeString_kr_KR LanguageCodeString = "kr-KR" LanguageCodeString_zh_CN LanguageCodeString = "zh-CN" LanguageCodeString_zh_TW LanguageCodeString = "zh-TW" )
type MessageAttributeValue ¶
type MessageAttributeValue struct { DataType *string `json:"dataType,omitempty"` StringValue *string `json:"stringValue,omitempty"` }
The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html).
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Amazon SNS message attributes (https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html) and Publishing to a mobile phone (https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html) in the Amazon SNS Developer Guide.
func (*MessageAttributeValue) DeepCopy ¶
func (in *MessageAttributeValue) DeepCopy() *MessageAttributeValue
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MessageAttributeValue.
func (*MessageAttributeValue) DeepCopyInto ¶
func (in *MessageAttributeValue) DeepCopyInto(out *MessageAttributeValue)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NumberCapability ¶
type NumberCapability string
const ( NumberCapability_SMS NumberCapability = "SMS" NumberCapability_MMS NumberCapability = "MMS" NumberCapability_VOICE NumberCapability = "VOICE" )
type PhoneNumberInformation ¶
type PhoneNumberInformation struct { PhoneNumber *string `json:"phoneNumber,omitempty"` Status *string `json:"status,omitempty"` }
A list of phone numbers and their metadata.
func (*PhoneNumberInformation) DeepCopy ¶
func (in *PhoneNumberInformation) DeepCopy() *PhoneNumberInformation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PhoneNumberInformation.
func (*PhoneNumberInformation) DeepCopyInto ¶
func (in *PhoneNumberInformation) DeepCopyInto(out *PhoneNumberInformation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlatformApplication ¶
type PlatformApplication struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec PlatformApplicationSpec `json:"spec,omitempty"` Status PlatformApplicationStatus `json:"status,omitempty"` }
PlatformApplication is the Schema for the PlatformApplications API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*PlatformApplication) DeepCopy ¶
func (in *PlatformApplication) DeepCopy() *PlatformApplication
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformApplication.
func (*PlatformApplication) DeepCopyInto ¶
func (in *PlatformApplication) DeepCopyInto(out *PlatformApplication)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PlatformApplication) DeepCopyObject ¶
func (in *PlatformApplication) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PlatformApplicationList ¶
type PlatformApplicationList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []PlatformApplication `json:"items"` }
PlatformApplicationList contains a list of PlatformApplication +kubebuilder:object:root=true
func (*PlatformApplicationList) DeepCopy ¶
func (in *PlatformApplicationList) DeepCopy() *PlatformApplicationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformApplicationList.
func (*PlatformApplicationList) DeepCopyInto ¶
func (in *PlatformApplicationList) DeepCopyInto(out *PlatformApplicationList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PlatformApplicationList) DeepCopyObject ¶
func (in *PlatformApplicationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PlatformApplicationSpec ¶
type PlatformApplicationSpec struct { EventDeliveryFailure *string `json:"eventDeliveryFailure,omitempty"` EventEndpointCreated *string `json:"eventEndpointCreated,omitempty"` EventEndpointDeleted *string `json:"eventEndpointDeleted,omitempty"` EventEndpointUpdated *string `json:"eventEndpointUpdated,omitempty"` FailureFeedbackRoleARN *string `json:"failureFeedbackRoleARN,omitempty"` // 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. // +kubebuilder:validation:Required Name *string `json:"name"` // The following platforms are supported: ADM (Amazon Device Messaging), APNS // (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud // Messaging). // +kubebuilder:validation:Required Platform *string `json:"platform"` PlatformCredential *string `json:"platformCredential,omitempty"` PlatformPrincipal *string `json:"platformPrincipal,omitempty"` SuccessFeedbackRoleARN *string `json:"successFeedbackRoleARN,omitempty"` SuccessFeedbackSampleRate *string `json:"successFeedbackSampleRate,omitempty"` }
PlatformApplicationSpec defines the desired state of PlatformApplication.
Platform application object.
func (*PlatformApplicationSpec) DeepCopy ¶
func (in *PlatformApplicationSpec) DeepCopy() *PlatformApplicationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformApplicationSpec.
func (*PlatformApplicationSpec) DeepCopyInto ¶
func (in *PlatformApplicationSpec) DeepCopyInto(out *PlatformApplicationSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlatformApplicationStatus ¶
type PlatformApplicationStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` }
PlatformApplicationStatus defines the observed state of PlatformApplication
func (*PlatformApplicationStatus) DeepCopy ¶
func (in *PlatformApplicationStatus) DeepCopy() *PlatformApplicationStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformApplicationStatus.
func (*PlatformApplicationStatus) DeepCopyInto ¶
func (in *PlatformApplicationStatus) DeepCopyInto(out *PlatformApplicationStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlatformApplication_SDK ¶
type PlatformApplication_SDK struct { Attributes map[string]*string `json:"attributes,omitempty"` PlatformApplicationARN *string `json:"platformApplicationARN,omitempty"` }
Platform application object.
func (*PlatformApplication_SDK) DeepCopy ¶
func (in *PlatformApplication_SDK) DeepCopy() *PlatformApplication_SDK
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformApplication_SDK.
func (*PlatformApplication_SDK) DeepCopyInto ¶
func (in *PlatformApplication_SDK) DeepCopyInto(out *PlatformApplication_SDK)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlatformEndpoint ¶
type PlatformEndpoint struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec PlatformEndpointSpec `json:"spec,omitempty"` Status PlatformEndpointStatus `json:"status,omitempty"` }
PlatformEndpoint is the Schema for the PlatformEndpoints API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*PlatformEndpoint) DeepCopy ¶
func (in *PlatformEndpoint) DeepCopy() *PlatformEndpoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformEndpoint.
func (*PlatformEndpoint) DeepCopyInto ¶
func (in *PlatformEndpoint) DeepCopyInto(out *PlatformEndpoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PlatformEndpoint) DeepCopyObject ¶
func (in *PlatformEndpoint) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PlatformEndpointList ¶
type PlatformEndpointList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []PlatformEndpoint `json:"items"` }
PlatformEndpointList contains a list of PlatformEndpoint +kubebuilder:object:root=true
func (*PlatformEndpointList) DeepCopy ¶
func (in *PlatformEndpointList) DeepCopy() *PlatformEndpointList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformEndpointList.
func (*PlatformEndpointList) DeepCopyInto ¶
func (in *PlatformEndpointList) DeepCopyInto(out *PlatformEndpointList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PlatformEndpointList) DeepCopyObject ¶
func (in *PlatformEndpointList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PlatformEndpointSpec ¶
type PlatformEndpointSpec struct { CustomUserData *string `json:"customUserData,omitempty"` Enabled *string `json:"enabled,omitempty"` // PlatformApplicationArn returned from CreatePlatformApplication is used to // create a an endpoint. // +kubebuilder:validation:Required PlatformApplicationARN *string `json:"platformApplicationARN"` // +kubebuilder:validation:Required Token *string `json:"token"` }
PlatformEndpointSpec defines the desired state of PlatformEndpoint.
func (*PlatformEndpointSpec) DeepCopy ¶
func (in *PlatformEndpointSpec) DeepCopy() *PlatformEndpointSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformEndpointSpec.
func (*PlatformEndpointSpec) DeepCopyInto ¶
func (in *PlatformEndpointSpec) DeepCopyInto(out *PlatformEndpointSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlatformEndpointStatus ¶
type PlatformEndpointStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // EndpointArn returned from CreateEndpoint action. // +kubebuilder:validation:Optional EndpointARN *string `json:"endpointARN,omitempty"` }
PlatformEndpointStatus defines the observed state of PlatformEndpoint
func (*PlatformEndpointStatus) DeepCopy ¶
func (in *PlatformEndpointStatus) DeepCopy() *PlatformEndpointStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformEndpointStatus.
func (*PlatformEndpointStatus) DeepCopyInto ¶
func (in *PlatformEndpointStatus) DeepCopyInto(out *PlatformEndpointStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PublishBatchRequestEntry ¶
type PublishBatchRequestEntry struct { ID *string `json:"id,omitempty"` MessageDeduplicationID *string `json:"messageDeduplicationID,omitempty"` MessageGroupID *string `json:"messageGroupID,omitempty"` }
Contains the details of a single Amazon SNS message along with an Id that identifies a message within the batch.
func (*PublishBatchRequestEntry) DeepCopy ¶
func (in *PublishBatchRequestEntry) DeepCopy() *PublishBatchRequestEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PublishBatchRequestEntry.
func (*PublishBatchRequestEntry) DeepCopyInto ¶
func (in *PublishBatchRequestEntry) DeepCopyInto(out *PublishBatchRequestEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PublishBatchResultEntry ¶
type PublishBatchResultEntry struct { ID *string `json:"id,omitempty"` SequenceNumber *string `json:"sequenceNumber,omitempty"` }
Encloses data related to a successful message in a batch request for topic.
func (*PublishBatchResultEntry) DeepCopy ¶
func (in *PublishBatchResultEntry) DeepCopy() *PublishBatchResultEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PublishBatchResultEntry.
func (*PublishBatchResultEntry) DeepCopyInto ¶
func (in *PublishBatchResultEntry) DeepCopyInto(out *PublishBatchResultEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SMSSandboxPhoneNumberVerificationStatus ¶
type SMSSandboxPhoneNumberVerificationStatus string
const ( SMSSandboxPhoneNumberVerificationStatus_Pending SMSSandboxPhoneNumberVerificationStatus = "Pending" SMSSandboxPhoneNumberVerificationStatus_Verified SMSSandboxPhoneNumberVerificationStatus = "Verified" )
type Subscription ¶
type Subscription struct {
TopicARN *string `json:"topicARN,omitempty"`
}
A wrapper type for the attributes of an Amazon SNS subscription.
func (*Subscription) DeepCopy ¶
func (in *Subscription) DeepCopy() *Subscription
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Subscription.
func (*Subscription) DeepCopyInto ¶
func (in *Subscription) DeepCopyInto(out *Subscription)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Tag ¶
The list of tags to be added to the specified topic.
func (*Tag) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tag.
func (*Tag) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Topic ¶
type Topic struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec TopicSpec `json:"spec,omitempty"` Status TopicStatus `json:"status,omitempty"` }
Topic is the Schema for the Topics API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*Topic) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Topic.
func (*Topic) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Topic) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TopicList ¶
type TopicList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Topic `json:"items"` }
TopicList contains a list of Topic +kubebuilder:object:root=true
func (*TopicList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TopicList.
func (*TopicList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TopicList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TopicSpec ¶
type TopicSpec struct { // 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. DataProtectionPolicy *string `json:"dataProtectionPolicy,omitempty"` DeliveryPolicy *string `json:"deliveryPolicy,omitempty"` DisplayName *string `json:"displayName,omitempty"` KMSMasterKeyID *string `json:"kmsMasterKeyID,omitempty"` // 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. // +kubebuilder:validation:Required Name *string `json:"name"` Policy *string `json:"policy,omitempty"` // 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 []*Tag `json:"tags,omitempty"` }
TopicSpec defines the desired state of Topic.
A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.
func (*TopicSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TopicSpec.
func (*TopicSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TopicStatus ¶
type TopicStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // +kubebuilder:validation:Optional EffectiveDeliveryPolicy *string `json:"effectiveDeliveryPolicy,omitempty"` // +kubebuilder:validation:Optional Owner *string `json:"owner,omitempty"` }
TopicStatus defines the observed state of Topic
func (*TopicStatus) DeepCopy ¶
func (in *TopicStatus) DeepCopy() *TopicStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TopicStatus.
func (*TopicStatus) DeepCopyInto ¶
func (in *TopicStatus) DeepCopyInto(out *TopicStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Topic_SDK ¶
type Topic_SDK struct {
TopicARN *string `json:"topicARN,omitempty"`
}
A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.
func (*Topic_SDK) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Topic_SDK.
func (*Topic_SDK) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.