v1alpha1

package
v0.31.0-rc.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 11, 2022 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package v1alpha1 contains managed resources for AWS SNS services such as SNSTopic & SNSSubscription. +kubebuilder:object:generate=true +groupName=notification.aws.crossplane.io +versionName=v1alpha1

Index

Constants

View Source
const (
	Group   = "notification.aws.crossplane.io"
	Version = "v1alpha1"
)

Package type metadata.

Variables

View Source
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)
View Source
var (
	SNSTopicKind             = reflect.TypeOf(SNSTopic{}).Name()
	SNSTopicGroupKind        = schema.GroupKind{Group: Group, Kind: SNSTopicKind}.String()
	SNSTopicKindAPIVersion   = SNSTopicKind + "." + SchemeGroupVersion.String()
	SNSTopicGroupVersionKind = SchemeGroupVersion.WithKind(SNSTopicKind)
)

SNSTopic type metadata.

View Source
var (
	SNSSubscriptionKind             = reflect.TypeOf(SNSSubscription{}).Name()
	SNSSubscriptionGroupKind        = schema.GroupKind{Group: Group, Kind: SNSSubscriptionKind}.String()
	SNSSubscriptionKindAPIVersion   = SNSSubscriptionKind + "." + SchemeGroupVersion.String()
	SNSSubscriptionGroupVersionKind = SchemeGroupVersion.WithKind(SNSSubscriptionKind)
)

SNSSubscription type metadata.

Functions

func SNSTopicARN

func SNSTopicARN() reference.ExtractValueFn

SNSTopicARN returns a function that returns the ARN of the given SNS Topic.

Types

type ConfirmationStatus

type ConfirmationStatus string

ConfirmationStatus represents Status of SNS Subscription Confirmation

const (
	// ConfirmationPending represents Pending Confirmation Request for SNS Subscription
	ConfirmationPending ConfirmationStatus = "ConfirmationPending"
	// ConfirmationSuccessful represents confirmed SNS Subscription
	ConfirmationSuccessful ConfirmationStatus = "Confirmed"
)

type SNSSubscription

type SNSSubscription struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   SNSSubscriptionSpec   `json:"spec"`
	Status SNSSubscriptionStatus `json:"status,omitempty"`
}

SNSSubscription defines a managed resource that represents state of a AWS SNS Subscription +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="ENDPOINT",type="string",JSONPath=".spec.forProvider.endpoint" +kubebuilder:printcolumn:name="PROTOCOL",type="string",JSONPath=".spec.forProvider.protocol" +kubebuilder:printcolumn:name="STATUS",type="string",JSONPath=".status.atProvider.status" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,aws} +kubebuilder:deprecatedversion:warning="Please use v1beta1 version of SNS group." Deprecated: Please use v1beta1 version of SNS group.

func (*SNSSubscription) DeepCopy

func (in *SNSSubscription) DeepCopy() *SNSSubscription

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSSubscription.

func (*SNSSubscription) DeepCopyInto

func (in *SNSSubscription) DeepCopyInto(out *SNSSubscription)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*SNSSubscription) DeepCopyObject

func (in *SNSSubscription) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*SNSSubscription) GetCondition

func (mg *SNSSubscription) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this SNSSubscription.

func (*SNSSubscription) GetDeletionPolicy

func (mg *SNSSubscription) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this SNSSubscription.

func (*SNSSubscription) GetProviderConfigReference

func (mg *SNSSubscription) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this SNSSubscription.

func (*SNSSubscription) GetProviderReference

func (mg *SNSSubscription) GetProviderReference() *xpv1.Reference

GetProviderReference of this SNSSubscription. Deprecated: Use GetProviderConfigReference.

func (*SNSSubscription) GetPublishConnectionDetailsTo

func (mg *SNSSubscription) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this SNSSubscription.

func (*SNSSubscription) GetWriteConnectionSecretToReference

func (mg *SNSSubscription) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this SNSSubscription.

func (*SNSSubscription) ResolveReferences

func (mg *SNSSubscription) ResolveReferences(ctx context.Context, c client.Reader) error

ResolveReferences for SNS Subscription managed type

func (*SNSSubscription) SetConditions

func (mg *SNSSubscription) SetConditions(c ...xpv1.Condition)

SetConditions of this SNSSubscription.

func (*SNSSubscription) SetDeletionPolicy

func (mg *SNSSubscription) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this SNSSubscription.

func (*SNSSubscription) SetProviderConfigReference

func (mg *SNSSubscription) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this SNSSubscription.

func (*SNSSubscription) SetProviderReference

func (mg *SNSSubscription) SetProviderReference(r *xpv1.Reference)

SetProviderReference of this SNSSubscription. Deprecated: Use SetProviderConfigReference.

func (*SNSSubscription) SetPublishConnectionDetailsTo

func (mg *SNSSubscription) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this SNSSubscription.

func (*SNSSubscription) SetWriteConnectionSecretToReference

func (mg *SNSSubscription) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this SNSSubscription.

type SNSSubscriptionList

type SNSSubscriptionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []SNSSubscription `json:"items"`
}

SNSSubscriptionList contains a list of SNSTopic

func (*SNSSubscriptionList) DeepCopy

func (in *SNSSubscriptionList) DeepCopy() *SNSSubscriptionList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSSubscriptionList.

func (*SNSSubscriptionList) DeepCopyInto

func (in *SNSSubscriptionList) DeepCopyInto(out *SNSSubscriptionList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*SNSSubscriptionList) DeepCopyObject

func (in *SNSSubscriptionList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*SNSSubscriptionList) GetItems

func (l *SNSSubscriptionList) GetItems() []resource.Managed

GetItems of this SNSSubscriptionList.

type SNSSubscriptionObservation

type SNSSubscriptionObservation struct {

	// The subscription's owner.
	// +optional
	Owner *string `json:"owner,omitempty"`

	// Status represents Confirmation Status of SNS Subscription
	// +optional
	Status *ConfirmationStatus `json:"status,omitempty"`

	// ConfirmationWasAuthenticated – true if the subscription confirmation
	// request was authenticated.
	// +optional
	ConfirmationWasAuthenticated *bool `json:"confirmationWasAuthenticated,omitempty"`
}

SNSSubscriptionObservation represents the observed state of a AWS SNS Topic

func (*SNSSubscriptionObservation) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSSubscriptionObservation.

func (*SNSSubscriptionObservation) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SNSSubscriptionParameters

type SNSSubscriptionParameters struct {
	// Region is the region you'd like your SNSSubscription to be in.
	Region string `json:"region"`

	// TopicArn is the Arn of the SNS Topic
	// +immutable
	TopicARN string `json:"topicArn,omitempty"`

	// TopicArnRef references a SNS Topic and retrieves its TopicArn
	// +optional
	TopicARNRef *xpv1.Reference `json:"topicArnRef,omitempty"`

	// TopicArnSelector selects a reference to a SNS Topic and retrieves
	// its TopicArn
	// +optional
	TopicARNSelector *xpv1.Selector `json:"topicArnSelector,omitempty"`

	// The subscription's protocol.
	// +immutable
	Protocol string `json:"protocol"`

	// The subscription's endpoint
	// +immutable
	Endpoint string `json:"endpoint"`

	//  DeliveryPolicy defines how Amazon SNS retries failed
	//  deliveries to HTTP/S endpoints.
	// +optional
	DeliveryPolicy *string `json:"deliveryPolicy,omitempty"`

	//  The simple JSON object that lets your subscriber receive
	//  only a subset of messages, rather than receiving every message published
	//  to the topic.
	// +optional
	FilterPolicy *string `json:"filterPolicy,omitempty"`

	//  When set to true, enables raw message delivery
	//  to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints
	//  to process JSON formatting, which is otherwise created for Amazon SNS
	//  metadata.
	// +optional
	RawMessageDelivery *string `json:"rawMessageDelivery,omitempty"`

	//  When specified, sends undeliverable messages to the
	//  specified Amazon SQS dead-letter queue. Messages that can't be delivered
	//  due to client errors (for example, when the subscribed endpoint is unreachable)
	//  or server errors (for example, when the service that powers the subscribed
	//  endpoint becomes unavailable) are held in the dead-letter queue for further
	//  analysis or reprocessing.
	// +optional
	RedrivePolicy *string `json:"redrivePolicy,omitempty"`
}

SNSSubscriptionParameters define the desired state of a AWS SNS Topic

func (*SNSSubscriptionParameters) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSSubscriptionParameters.

func (*SNSSubscriptionParameters) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SNSSubscriptionSpec

type SNSSubscriptionSpec struct {
	xpv1.ResourceSpec `json:",inline"`
	ForProvider       SNSSubscriptionParameters `json:"forProvider"`
}

SNSSubscriptionSpec defined the desired state of a AWS SNS Topic

func (*SNSSubscriptionSpec) DeepCopy

func (in *SNSSubscriptionSpec) DeepCopy() *SNSSubscriptionSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSSubscriptionSpec.

func (*SNSSubscriptionSpec) DeepCopyInto

func (in *SNSSubscriptionSpec) DeepCopyInto(out *SNSSubscriptionSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SNSSubscriptionStatus

type SNSSubscriptionStatus struct {
	xpv1.ResourceStatus `json:",inline"`
	AtProvider          SNSSubscriptionObservation `json:"atProvider,omitempty"`
}

SNSSubscriptionStatus is the status of AWS SNS Topic

func (*SNSSubscriptionStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSSubscriptionStatus.

func (*SNSSubscriptionStatus) DeepCopyInto

func (in *SNSSubscriptionStatus) DeepCopyInto(out *SNSSubscriptionStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SNSTopic

type SNSTopic struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   SNSTopicSpec   `json:"spec"`
	Status SNSTopicStatus `json:"status,omitempty"`
}

SNSTopic defines a managed resource that represents state of a AWS SNSTopic +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="TOPIC-NAME",type="string",JSONPath=".spec.forProvider.name" +kubebuilder:printcolumn:name="DISPLAY-NAME",type="string",JSONPath=".spec.forProvider.displayName" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,aws} +kubebuilder:deprecatedversion:warning="Please use v1beta1 version of SNS group." Deprecated: Please use v1beta1 version of SNS group.

func (*SNSTopic) DeepCopy

func (in *SNSTopic) DeepCopy() *SNSTopic

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSTopic.

func (*SNSTopic) DeepCopyInto

func (in *SNSTopic) DeepCopyInto(out *SNSTopic)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*SNSTopic) DeepCopyObject

func (in *SNSTopic) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*SNSTopic) GetCondition

func (mg *SNSTopic) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this SNSTopic.

func (*SNSTopic) GetDeletionPolicy

func (mg *SNSTopic) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this SNSTopic.

func (*SNSTopic) GetProviderConfigReference

func (mg *SNSTopic) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this SNSTopic.

func (*SNSTopic) GetProviderReference

func (mg *SNSTopic) GetProviderReference() *xpv1.Reference

GetProviderReference of this SNSTopic. Deprecated: Use GetProviderConfigReference.

func (*SNSTopic) GetPublishConnectionDetailsTo

func (mg *SNSTopic) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this SNSTopic.

func (*SNSTopic) GetWriteConnectionSecretToReference

func (mg *SNSTopic) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this SNSTopic.

func (*SNSTopic) SetConditions

func (mg *SNSTopic) SetConditions(c ...xpv1.Condition)

SetConditions of this SNSTopic.

func (*SNSTopic) SetDeletionPolicy

func (mg *SNSTopic) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this SNSTopic.

func (*SNSTopic) SetProviderConfigReference

func (mg *SNSTopic) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this SNSTopic.

func (*SNSTopic) SetProviderReference

func (mg *SNSTopic) SetProviderReference(r *xpv1.Reference)

SetProviderReference of this SNSTopic. Deprecated: Use SetProviderConfigReference.

func (*SNSTopic) SetPublishConnectionDetailsTo

func (mg *SNSTopic) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this SNSTopic.

func (*SNSTopic) SetWriteConnectionSecretToReference

func (mg *SNSTopic) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this SNSTopic.

type SNSTopicList

type SNSTopicList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []SNSTopic `json:"items"`
}

SNSTopicList contains a list of SNSTopic

func (*SNSTopicList) DeepCopy

func (in *SNSTopicList) DeepCopy() *SNSTopicList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSTopicList.

func (*SNSTopicList) DeepCopyInto

func (in *SNSTopicList) DeepCopyInto(out *SNSTopicList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*SNSTopicList) DeepCopyObject

func (in *SNSTopicList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*SNSTopicList) GetItems

func (l *SNSTopicList) GetItems() []resource.Managed

GetItems of this SNSTopicList.

type SNSTopicObservation

type SNSTopicObservation struct {

	// Owner refers to owner of SNS Topic
	// +optional
	Owner *string `json:"owner,omitempty"`
	// ConfirmedSubscriptions - The no of confirmed subscriptions
	// +optional
	ConfirmedSubscriptions *int64 `json:"confirmedSubscriptions,omitempty"`

	// PendingSubscriptions - The no of pending subscriptions
	// +optional
	PendingSubscriptions *int64 `json:"pendingSubscriptions,omitempty"`

	// DeletedSubscriptions - The no of deleted subscriptions
	// +optional
	DeletedSubscriptions *int64 `json:"deletedSubscriptions,omitempty"`

	// ARN is the Amazon Resource Name (ARN) specifying the SNS Topic.
	ARN string `json:"arn"`
}

SNSTopicObservation represents the observed state of a AWS SNS Topic

func (*SNSTopicObservation) DeepCopy

func (in *SNSTopicObservation) DeepCopy() *SNSTopicObservation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSTopicObservation.

func (*SNSTopicObservation) DeepCopyInto

func (in *SNSTopicObservation) DeepCopyInto(out *SNSTopicObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SNSTopicParameters

type SNSTopicParameters struct {
	// Region is the region you'd like your SNSTopic to be created in.
	Region string `json:"region"`

	// Name refers to the name of the AWS SNS Topic
	// +immutable
	Name string `json:"name"`

	// The display name to use for a topic with SNS subscriptions.
	// +optional
	DisplayName *string `json:"displayName,omitempty"`

	// Setting this enables server side encryption at-rest to your topic.
	// The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK
	//
	// For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)
	// in the AWS Key Management Service API Reference.
	// +optional
	KMSMasterKeyID *string `json:"kmsMasterKeyId,omitempty"`

	// The policy that defines who can access your topic. By default,
	// only the topic owner can publish or subscribe to the topic.
	// +optional
	Policy *string `json:"policy,omitempty"`

	// DeliveryRetryPolicy - the JSON serialization of the effective
	// delivery policy, taking system defaults into account
	// +optional
	DeliveryPolicy *string `json:"deliveryPolicy,omitempty"`

	// Tags represetnt a list of user-provided metadata that can be associated with a
	// SNS Topic. For more information about tagging,
	// see Tagging SNS Topics (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html)
	// in the SNS User Guide.
	// +immutable
	// +optional
	Tags []Tag `json:"tags,omitempty"`
}

SNSTopicParameters define the desired state of a AWS SNS Topic

func (*SNSTopicParameters) DeepCopy

func (in *SNSTopicParameters) DeepCopy() *SNSTopicParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSTopicParameters.

func (*SNSTopicParameters) DeepCopyInto

func (in *SNSTopicParameters) DeepCopyInto(out *SNSTopicParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SNSTopicSpec

type SNSTopicSpec struct {
	xpv1.ResourceSpec `json:",inline"`
	ForProvider       SNSTopicParameters `json:"forProvider"`
}

SNSTopicSpec defined the desired state of a AWS SNS Topic

func (*SNSTopicSpec) DeepCopy

func (in *SNSTopicSpec) DeepCopy() *SNSTopicSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSTopicSpec.

func (*SNSTopicSpec) DeepCopyInto

func (in *SNSTopicSpec) DeepCopyInto(out *SNSTopicSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SNSTopicStatus

type SNSTopicStatus struct {
	xpv1.ResourceStatus `json:",inline"`
	AtProvider          SNSTopicObservation `json:"atProvider,omitempty"`
}

SNSTopicStatus is the status of AWS SNS Topic

func (*SNSTopicStatus) DeepCopy

func (in *SNSTopicStatus) DeepCopy() *SNSTopicStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SNSTopicStatus.

func (*SNSTopicStatus) DeepCopyInto

func (in *SNSTopicStatus) DeepCopyInto(out *SNSTopicStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Tag

type Tag struct {

	// The key name that can be used to look up or retrieve the associated value.
	// For example, Department or Cost Center are common choices.
	Key string `json:"key"`

	// The value associated with this tag. For example, tags with a key name of
	// Department could have values such as Human Resources, Accounting, and Support.
	// Tags with a key name of Cost Center might have values that consist of the
	// number associated with the different cost centers in your company. Typically,
	// many resources have tags with the same key name but with different values.
	//
	// AWS always interprets the tag Value as a single string. If you need to store
	// an array, you can store comma-separated values in the string. However, you
	// must interpret the value in your code.
	// +optional
	Value *string `json:"value,omitempty"`
}

Tag represent a user-provided metadata that can be associated with a SNS Topic. For more information about tagging, see Tagging SNS Topics (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) in the SNS User Guide.

func (*Tag) DeepCopy

func (in *Tag) DeepCopy() *Tag

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tag.

func (*Tag) DeepCopyInto

func (in *Tag) DeepCopyInto(out *Tag)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL