v1alpha1

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Oct 31, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the kinesis.services.k8s.aws API. +groupName=kinesis.services.k8s.aws

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is the API Group Version used to register the objects
	GroupVersion = schema.GroupVersion{Group: "kinesis.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 Consumer 

type Consumer struct {
	ConsumerCreationTimestamp *metav1.Time `json:"consumerCreationTimestamp,omitempty"`
}

An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.

func (*Consumer) DeepCopy 

func (in *Consumer) DeepCopy() *Consumer

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

func (*Consumer) DeepCopyInto 

func (in *Consumer) DeepCopyInto(out *Consumer)

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

type ConsumerDescription 

type ConsumerDescription struct {
	ConsumerCreationTimestamp *metav1.Time `json:"consumerCreationTimestamp,omitempty"`
	StreamARN                 *string      `json:"streamARN,omitempty"`
}

An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.

func (*ConsumerDescription) DeepCopy 

func (in *ConsumerDescription) DeepCopy() *ConsumerDescription

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

func (*ConsumerDescription) DeepCopyInto 

func (in *ConsumerDescription) DeepCopyInto(out *ConsumerDescription)

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

type ConsumerStatus 

type ConsumerStatus string
const (
	ConsumerStatus_CREATING ConsumerStatus = "CREATING"
	ConsumerStatus_DELETING ConsumerStatus = "DELETING"
	ConsumerStatus_ACTIVE   ConsumerStatus = "ACTIVE"
)

type EncryptionType 

type EncryptionType string
const (
	EncryptionType_NONE EncryptionType = "NONE"
	EncryptionType_KMS  EncryptionType = "KMS"
)

type EnhancedMetrics 

type EnhancedMetrics struct {
	ShardLevelMetrics []*string `json:"shardLevelMetrics,omitempty"`
}

Represents enhanced metrics types.

func (*EnhancedMetrics) DeepCopy 

func (in *EnhancedMetrics) DeepCopy() *EnhancedMetrics

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

func (*EnhancedMetrics) DeepCopyInto 

func (in *EnhancedMetrics) DeepCopyInto(out *EnhancedMetrics)

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

type MetricsName 

type MetricsName string
const (
	MetricsName_IncomingBytes                      MetricsName = "IncomingBytes"
	MetricsName_IncomingRecords                    MetricsName = "IncomingRecords"
	MetricsName_OutgoingBytes                      MetricsName = "OutgoingBytes"
	MetricsName_OutgoingRecords                    MetricsName = "OutgoingRecords"
	MetricsName_WriteProvisionedThroughputExceeded MetricsName = "WriteProvisionedThroughputExceeded"
	MetricsName_ReadProvisionedThroughputExceeded  MetricsName = "ReadProvisionedThroughputExceeded"
	MetricsName_IteratorAgeMilliseconds            MetricsName = "IteratorAgeMilliseconds"
	MetricsName_ALL                                MetricsName = "ALL"
)

type Record 

type Record struct {
	ApproximateArrivalTimestamp *metav1.Time `json:"approximateArrivalTimestamp,omitempty"`
	EncryptionType              *string      `json:"encryptionType,omitempty"`
}

The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.

func (*Record) DeepCopy 

func (in *Record) DeepCopy() *Record

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

func (*Record) DeepCopyInto 

func (in *Record) DeepCopyInto(out *Record)

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

type ScalingType 

type ScalingType string
const (
	ScalingType_UNIFORM_SCALING ScalingType = "UNIFORM_SCALING"
)

type ShardFilter 

type ShardFilter struct {
	Timestamp *metav1.Time `json:"timestamp,omitempty"`
}

The request parameter used to filter out the response of the ListShards API.

func (*ShardFilter) DeepCopy 

func (in *ShardFilter) DeepCopy() *ShardFilter

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

func (*ShardFilter) DeepCopyInto 

func (in *ShardFilter) DeepCopyInto(out *ShardFilter)

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

type ShardFilterType 

type ShardFilterType string
const (
	ShardFilterType_AFTER_SHARD_ID    ShardFilterType = "AFTER_SHARD_ID"
	ShardFilterType_AT_TRIM_HORIZON   ShardFilterType = "AT_TRIM_HORIZON"
	ShardFilterType_FROM_TRIM_HORIZON ShardFilterType = "FROM_TRIM_HORIZON"
	ShardFilterType_AT_LATEST         ShardFilterType = "AT_LATEST"
	ShardFilterType_AT_TIMESTAMP      ShardFilterType = "AT_TIMESTAMP"
	ShardFilterType_FROM_TIMESTAMP    ShardFilterType = "FROM_TIMESTAMP"
)

type ShardIteratorType 

type ShardIteratorType string
const (
	ShardIteratorType_AT_SEQUENCE_NUMBER    ShardIteratorType = "AT_SEQUENCE_NUMBER"
	ShardIteratorType_AFTER_SEQUENCE_NUMBER ShardIteratorType = "AFTER_SEQUENCE_NUMBER"
	ShardIteratorType_TRIM_HORIZON          ShardIteratorType = "TRIM_HORIZON"
	ShardIteratorType_LATEST                ShardIteratorType = "LATEST"
	ShardIteratorType_AT_TIMESTAMP          ShardIteratorType = "AT_TIMESTAMP"
)

type StartingPosition 

type StartingPosition struct {
	Timestamp *metav1.Time `json:"timestamp,omitempty"`
}

The starting position in the data stream from which to start streaming.

func (*StartingPosition) DeepCopy 

func (in *StartingPosition) DeepCopy() *StartingPosition

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

func (*StartingPosition) DeepCopyInto 

func (in *StartingPosition) DeepCopyInto(out *StartingPosition)

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

type Stream 

type Stream struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              StreamSpec   `json:"spec,omitempty"`
	Status            StreamStatus `json:"status,omitempty"`
}

Stream is the Schema for the Streams API +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*Stream) DeepCopy 

func (in *Stream) DeepCopy() *Stream

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

func (*Stream) DeepCopyInto 

func (in *Stream) DeepCopyInto(out *Stream)

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

func (*Stream) DeepCopyObject 

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

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

type StreamDescription 

type StreamDescription struct {
	EncryptionType          *string            `json:"encryptionType,omitempty"`
	EnhancedMonitoring      []*EnhancedMetrics `json:"enhancedMonitoring,omitempty"`
	HasMoreShards           *bool              `json:"hasMoreShards,omitempty"`
	KeyID                   *string            `json:"keyID,omitempty"`
	RetentionPeriodHours    *int64             `json:"retentionPeriodHours,omitempty"`
	StreamARN               *string            `json:"streamARN,omitempty"`
	StreamCreationTimestamp *metav1.Time       `json:"streamCreationTimestamp,omitempty"`
	// Specifies the capacity mode to which you want to set your data stream. Currently,
	// in Kinesis Data Streams, you can choose between an on-demand capacity mode
	// and a provisioned capacity mode for your data streams.
	StreamModeDetails *StreamModeDetails `json:"streamModeDetails,omitempty"`
	StreamName        *string            `json:"streamName,omitempty"`
	StreamStatus      *string            `json:"streamStatus,omitempty"`
}

Represents the output for DescribeStream.

func (*StreamDescription) DeepCopy 

func (in *StreamDescription) DeepCopy() *StreamDescription

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

func (*StreamDescription) DeepCopyInto 

func (in *StreamDescription) DeepCopyInto(out *StreamDescription)

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

type StreamDescriptionSummary 

type StreamDescriptionSummary struct {
	ConsumerCount           *int64             `json:"consumerCount,omitempty"`
	EncryptionType          *string            `json:"encryptionType,omitempty"`
	EnhancedMonitoring      []*EnhancedMetrics `json:"enhancedMonitoring,omitempty"`
	KeyID                   *string            `json:"keyID,omitempty"`
	OpenShardCount          *int64             `json:"openShardCount,omitempty"`
	RetentionPeriodHours    *int64             `json:"retentionPeriodHours,omitempty"`
	StreamARN               *string            `json:"streamARN,omitempty"`
	StreamCreationTimestamp *metav1.Time       `json:"streamCreationTimestamp,omitempty"`
	// Specifies the capacity mode to which you want to set your data stream. Currently,
	// in Kinesis Data Streams, you can choose between an on-demand capacity mode
	// and a provisioned capacity mode for your data streams.
	StreamModeDetails *StreamModeDetails `json:"streamModeDetails,omitempty"`
	StreamName        *string            `json:"streamName,omitempty"`
	StreamStatus      *string            `json:"streamStatus,omitempty"`
}

Represents the output for DescribeStreamSummary

func (*StreamDescriptionSummary) DeepCopy 

func (in *StreamDescriptionSummary) DeepCopy() *StreamDescriptionSummary

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

func (*StreamDescriptionSummary) DeepCopyInto 

func (in *StreamDescriptionSummary) DeepCopyInto(out *StreamDescriptionSummary)

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

type StreamList 

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

StreamList contains a list of Stream +kubebuilder:object:root=true

func (*StreamList) DeepCopy 

func (in *StreamList) DeepCopy() *StreamList

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

func (*StreamList) DeepCopyInto 

func (in *StreamList) DeepCopyInto(out *StreamList)

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

func (*StreamList) DeepCopyObject 

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

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

type StreamMode 

type StreamMode string
const (
	StreamMode_PROVISIONED StreamMode = "PROVISIONED"
	StreamMode_ON_DEMAND   StreamMode = "ON_DEMAND"
)

type StreamModeDetails 

type StreamModeDetails struct {
	StreamMode *string `json:"streamMode,omitempty"`
}

Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

func (*StreamModeDetails) DeepCopy 

func (in *StreamModeDetails) DeepCopy() *StreamModeDetails

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

func (*StreamModeDetails) DeepCopyInto 

func (in *StreamModeDetails) DeepCopyInto(out *StreamModeDetails)

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

type StreamSpec 

type StreamSpec struct {

	// A name to identify the stream. The stream name is scoped to the Amazon Web
	// Services account used by the application that creates the stream. It is also
	// scoped by Amazon Web Services Region. That is, two streams in two different
	// Amazon Web Services accounts can have the same name. Two streams in the same
	// Amazon Web Services account but in two different Regions can also have the
	// same name.
	// +kubebuilder:validation:Required
	Name *string `json:"name"`
	// The number of shards that the stream will use. The throughput of the stream
	// is a function of the number of shards; more shards are required for greater
	// provisioned throughput.
	ShardCount *int64 `json:"shardCount,omitempty"`
	// Indicates the capacity mode of the data stream. Currently, in Kinesis Data
	// Streams, you can choose between an on-demand capacity mode and a provisioned
	// capacity mode for your data streams.
	StreamModeDetails *StreamModeDetails `json:"streamModeDetails,omitempty"`
}

StreamSpec defines the desired state of Stream.

func (*StreamSpec) DeepCopy 

func (in *StreamSpec) DeepCopy() *StreamSpec

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

func (*StreamSpec) DeepCopyInto 

func (in *StreamSpec) DeepCopyInto(out *StreamSpec)

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

type StreamStatus 

type StreamStatus 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"`
	// The number of enhanced fan-out consumers registered with the stream.
	// +kubebuilder:validation:Optional
	ConsumerCount *int64 `json:"consumerCount,omitempty"`
	// The encryption type used. This value is one of the following:
	//
	//    * KMS
	//
	//    * NONE
	// +kubebuilder:validation:Optional
	EncryptionType *string `json:"encryptionType,omitempty"`
	// Represents the current enhanced monitoring settings of the stream.
	// +kubebuilder:validation:Optional
	EnhancedMonitoring []*EnhancedMetrics `json:"enhancedMonitoring,omitempty"`
	// The GUID for the customer-managed Amazon Web Services KMS key to use for
	// encryption. This value can be a globally unique identifier, a fully specified
	// ARN to either an alias or a key, or an alias name prefixed by "alias/".You
	// can also use a master key owned by Kinesis Data Streams by specifying the
	// alias aws/kinesis.
	//
	//    * Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
	//
	//    * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
	//
	//    * Globally unique key ID example: 12345678-1234-1234-1234-123456789012
	//
	//    * Alias name example: alias/MyAliasName
	//
	//    * Master key owned by Kinesis Data Streams: alias/aws/kinesis
	// +kubebuilder:validation:Optional
	KeyID *string `json:"keyID,omitempty"`
	// The number of open shards in the stream.
	// +kubebuilder:validation:Optional
	OpenShardCount *int64 `json:"openShardCount,omitempty"`
	// The current retention period, in hours.
	// +kubebuilder:validation:Optional
	RetentionPeriodHours *int64 `json:"retentionPeriodHours,omitempty"`
	// The approximate time that the stream was created.
	// +kubebuilder:validation:Optional
	StreamCreationTimestamp *metav1.Time `json:"streamCreationTimestamp,omitempty"`
	// The current status of the stream being described. The stream status is one
	// of the following states:
	//
	//    * CREATING - The stream is being created. Kinesis Data Streams immediately
	//    returns and sets StreamStatus to CREATING.
	//
	//    * DELETING - The stream is being deleted. The specified stream is in the
	//    DELETING state until Kinesis Data Streams completes the deletion.
	//
	//    * ACTIVE - The stream exists and is ready for read and write operations
	//    or deletion. You should perform read and write operations only on an ACTIVE
	//    stream.
	//
	//    * UPDATING - Shards in the stream are being merged or split. Read and
	//    write operations continue to work while the stream is in the UPDATING
	//    state.
	// +kubebuilder:validation:Optional
	StreamStatus *string `json:"streamStatus,omitempty"`
}

StreamStatus defines the observed state of Stream

func (*StreamStatus) DeepCopy 

func (in *StreamStatus) DeepCopy() *StreamStatus

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

func (*StreamStatus) DeepCopyInto 

func (in *StreamStatus) DeepCopyInto(out *StreamStatus)

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

type StreamStatus_SDK 

type StreamStatus_SDK string
const (
	StreamStatus_SDK_CREATING StreamStatus_SDK = "CREATING"
	StreamStatus_SDK_DELETING StreamStatus_SDK = "DELETING"
	StreamStatus_SDK_ACTIVE   StreamStatus_SDK = "ACTIVE"
	StreamStatus_SDK_UPDATING StreamStatus_SDK = "UPDATING"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.