v1beta2

package
v1.11.0-rc.0 Latest Latest
Warning

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

 Go to latest Published: Jul 29, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

+kubebuilder:object:generate=true +groupName=kinesis.aws.upbound.io +versionName=v1beta2

Index

Constants

View Source 
const (
	CRDGroup   = "kinesis.aws.upbound.io"
	CRDVersion = "v1beta2"
)

Package type metadata.

Variables

View Source 
var (
	// CRDGroupVersion is the API Group Version used to register the objects
	CRDGroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: CRDGroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var (
	Stream_Kind             = "Stream"
	Stream_GroupKind        = schema.GroupKind{Group: CRDGroup, Kind: Stream_Kind}.String()
	Stream_KindAPIVersion   = Stream_Kind + "." + CRDGroupVersion.String()
	Stream_GroupVersionKind = CRDGroupVersion.WithKind(Stream_Kind)
)

Repository type metadata.

Functions

This section is empty.

Types

type Stream 

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

Stream is the Schema for the Streams API. Provides a AWS Kinesis Stream +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,aws}

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.

func (*Stream) GetCondition 

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

GetCondition of this Stream.

func (*Stream) GetConnectionDetailsMapping 

func (tr *Stream) GetConnectionDetailsMapping() map[string]string

GetConnectionDetailsMapping for this Stream

func (*Stream) GetDeletionPolicy 

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

GetDeletionPolicy of this Stream.

func (*Stream) GetID 

func (tr *Stream) GetID() string

GetID returns ID of underlying Terraform resource of this Stream

func (*Stream) GetInitParameters 

func (tr *Stream) GetInitParameters() (map[string]any, error)

GetInitParameters of this Stream

func (*Stream) GetManagementPolicies 

func (mg *Stream) GetManagementPolicies() xpv1.ManagementPolicies

GetManagementPolicies of this Stream.

func (*Stream) GetMergedParameters 

func (tr *Stream) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)

GetInitParameters of this Stream

func (*Stream) GetObservation 

func (tr *Stream) GetObservation() (map[string]any, error)

GetObservation of this Stream

func (*Stream) GetParameters 

func (tr *Stream) GetParameters() (map[string]any, error)

GetParameters of this Stream

func (*Stream) GetProviderConfigReference 

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

GetProviderConfigReference of this Stream.

func (*Stream) GetPublishConnectionDetailsTo 

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

GetPublishConnectionDetailsTo of this Stream.

func (*Stream) GetTerraformResourceType 

func (mg *Stream) GetTerraformResourceType() string

GetTerraformResourceType returns Terraform resource type for this Stream

func (*Stream) GetTerraformSchemaVersion 

func (tr *Stream) GetTerraformSchemaVersion() int

GetTerraformSchemaVersion returns the associated Terraform schema version

func (*Stream) GetWriteConnectionSecretToReference 

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

GetWriteConnectionSecretToReference of this Stream.

func (*Stream) Hub 

func (tr *Stream) Hub()

Hub marks this type as a conversion hub.

func (*Stream) LateInitialize 

func (tr *Stream) LateInitialize(attrs []byte) (bool, error)

LateInitialize this Stream using its observed tfState. returns True if there are any spec changes for the resource.

func (*Stream) ResolveReferences 

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

func (*Stream) SetConditions 

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

SetConditions of this Stream.

func (*Stream) SetDeletionPolicy 

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

SetDeletionPolicy of this Stream.

func (*Stream) SetManagementPolicies 

func (mg *Stream) SetManagementPolicies(r xpv1.ManagementPolicies)

SetManagementPolicies of this Stream.

func (*Stream) SetObservation 

func (tr *Stream) SetObservation(obs map[string]any) error

SetObservation for this Stream

func (*Stream) SetParameters 

func (tr *Stream) SetParameters(params map[string]any) error

SetParameters for this Stream

func (*Stream) SetProviderConfigReference 

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

SetProviderConfigReference of this Stream.

func (*Stream) SetPublishConnectionDetailsTo 

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

SetPublishConnectionDetailsTo of this Stream.

func (*Stream) SetWriteConnectionSecretToReference 

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

SetWriteConnectionSecretToReference of this Stream.

type StreamInitParameters 

type StreamInitParameters struct {

	// The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.
	EncryptionType *string `json:"encryptionType,omitempty" tf:"encryption_type,omitempty"`

	// A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.
	EnforceConsumerDeletion *bool `json:"enforceConsumerDeletion,omitempty" tf:"enforce_consumer_deletion,omitempty"`

	// The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.
	// +crossplane:generate:reference:type=github.com/upbound/provider-aws/apis/kms/v1beta1.Key
	KMSKeyID *string `json:"kmsKeyId,omitempty" tf:"kms_key_id,omitempty"`

	// Reference to a Key in kms to populate kmsKeyId.
	// +kubebuilder:validation:Optional
	KMSKeyIDRef *v1.Reference `json:"kmsKeyIdRef,omitempty" tf:"-"`

	// Selector for a Key in kms to populate kmsKeyId.
	// +kubebuilder:validation:Optional
	KMSKeyIDSelector *v1.Selector `json:"kmsKeyIdSelector,omitempty" tf:"-"`

	// Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.
	RetentionPeriod *float64 `json:"retentionPeriod,omitempty" tf:"retention_period,omitempty"`

	// –  The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required.
	// Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.
	ShardCount *float64 `json:"shardCount,omitempty" tf:"shard_count,omitempty"`

	// A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.
	// +listType=set
	ShardLevelMetrics []*string `json:"shardLevelMetrics,omitempty" tf:"shard_level_metrics,omitempty"`

	// Indicates the capacity mode of the data stream. Detailed below.
	StreamModeDetails *StreamModeDetailsInitParameters `json:"streamModeDetails,omitempty" tf:"stream_mode_details,omitempty"`

	// Key-value map of resource tags.
	// +mapType=granular
	Tags map[string]*string `json:"tags,omitempty" tf:"tags,omitempty"`
}

func (*StreamInitParameters) DeepCopy 

func (in *StreamInitParameters) DeepCopy() *StreamInitParameters

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

func (*StreamInitParameters) DeepCopyInto 

func (in *StreamInitParameters) DeepCopyInto(out *StreamInitParameters)

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 Streams

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.

func (*StreamList) GetItems 

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

GetItems of this StreamList.

type StreamModeDetailsInitParameters 

type StreamModeDetailsInitParameters struct {

	// Specifies the capacity mode of the stream. Must be either PROVISIONED or ON_DEMAND.
	StreamMode *string `json:"streamMode,omitempty" tf:"stream_mode,omitempty"`
}

func (*StreamModeDetailsInitParameters) DeepCopy 

func (in *StreamModeDetailsInitParameters) DeepCopy() *StreamModeDetailsInitParameters

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

func (*StreamModeDetailsInitParameters) DeepCopyInto 

func (in *StreamModeDetailsInitParameters) DeepCopyInto(out *StreamModeDetailsInitParameters)

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

type StreamModeDetailsObservation 

type StreamModeDetailsObservation struct {

	// Specifies the capacity mode of the stream. Must be either PROVISIONED or ON_DEMAND.
	StreamMode *string `json:"streamMode,omitempty" tf:"stream_mode,omitempty"`
}

func (*StreamModeDetailsObservation) DeepCopy 

func (in *StreamModeDetailsObservation) DeepCopy() *StreamModeDetailsObservation

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

func (*StreamModeDetailsObservation) DeepCopyInto 

func (in *StreamModeDetailsObservation) DeepCopyInto(out *StreamModeDetailsObservation)

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

type StreamModeDetailsParameters 

type StreamModeDetailsParameters struct {

	// Specifies the capacity mode of the stream. Must be either PROVISIONED or ON_DEMAND.
	// +kubebuilder:validation:Optional
	StreamMode *string `json:"streamMode" tf:"stream_mode,omitempty"`
}

func (*StreamModeDetailsParameters) DeepCopy 

func (in *StreamModeDetailsParameters) DeepCopy() *StreamModeDetailsParameters

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

func (*StreamModeDetailsParameters) DeepCopyInto 

func (in *StreamModeDetailsParameters) DeepCopyInto(out *StreamModeDetailsParameters)

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

type StreamObservation 

type StreamObservation struct {

	// The Amazon Resource Name (ARN) specifying the Stream (same as id)
	Arn *string `json:"arn,omitempty" tf:"arn,omitempty"`

	// The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.
	EncryptionType *string `json:"encryptionType,omitempty" tf:"encryption_type,omitempty"`

	// A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.
	EnforceConsumerDeletion *bool `json:"enforceConsumerDeletion,omitempty" tf:"enforce_consumer_deletion,omitempty"`

	// The unique Stream id
	ID *string `json:"id,omitempty" tf:"id,omitempty"`

	// The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.
	KMSKeyID *string `json:"kmsKeyId,omitempty" tf:"kms_key_id,omitempty"`

	// Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.
	RetentionPeriod *float64 `json:"retentionPeriod,omitempty" tf:"retention_period,omitempty"`

	// –  The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required.
	// Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.
	ShardCount *float64 `json:"shardCount,omitempty" tf:"shard_count,omitempty"`

	// A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.
	// +listType=set
	ShardLevelMetrics []*string `json:"shardLevelMetrics,omitempty" tf:"shard_level_metrics,omitempty"`

	// Indicates the capacity mode of the data stream. Detailed below.
	StreamModeDetails *StreamModeDetailsObservation `json:"streamModeDetails,omitempty" tf:"stream_mode_details,omitempty"`

	// Key-value map of resource tags.
	// +mapType=granular
	Tags map[string]*string `json:"tags,omitempty" tf:"tags,omitempty"`

	// A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
	// +mapType=granular
	TagsAll map[string]*string `json:"tagsAll,omitempty" tf:"tags_all,omitempty"`
}

func (*StreamObservation) DeepCopy 

func (in *StreamObservation) DeepCopy() *StreamObservation

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

func (*StreamObservation) DeepCopyInto 

func (in *StreamObservation) DeepCopyInto(out *StreamObservation)

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

type StreamParameters 

type StreamParameters struct {

	// The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.
	// +kubebuilder:validation:Optional
	EncryptionType *string `json:"encryptionType,omitempty" tf:"encryption_type,omitempty"`

	// A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.
	// +kubebuilder:validation:Optional
	EnforceConsumerDeletion *bool `json:"enforceConsumerDeletion,omitempty" tf:"enforce_consumer_deletion,omitempty"`

	// The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.
	// +crossplane:generate:reference:type=github.com/upbound/provider-aws/apis/kms/v1beta1.Key
	// +kubebuilder:validation:Optional
	KMSKeyID *string `json:"kmsKeyId,omitempty" tf:"kms_key_id,omitempty"`

	// Reference to a Key in kms to populate kmsKeyId.
	// +kubebuilder:validation:Optional
	KMSKeyIDRef *v1.Reference `json:"kmsKeyIdRef,omitempty" tf:"-"`

	// Selector for a Key in kms to populate kmsKeyId.
	// +kubebuilder:validation:Optional
	KMSKeyIDSelector *v1.Selector `json:"kmsKeyIdSelector,omitempty" tf:"-"`

	// Region is the region you'd like your resource to be created in.
	// +upjet:crd:field:TFTag=-
	// +kubebuilder:validation:Required
	Region *string `json:"region" tf:"-"`

	// Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.
	// +kubebuilder:validation:Optional
	RetentionPeriod *float64 `json:"retentionPeriod,omitempty" tf:"retention_period,omitempty"`

	// –  The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required.
	// Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.
	// +kubebuilder:validation:Optional
	ShardCount *float64 `json:"shardCount,omitempty" tf:"shard_count,omitempty"`

	// A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.
	// +kubebuilder:validation:Optional
	// +listType=set
	ShardLevelMetrics []*string `json:"shardLevelMetrics,omitempty" tf:"shard_level_metrics,omitempty"`

	// Indicates the capacity mode of the data stream. Detailed below.
	// +kubebuilder:validation:Optional
	StreamModeDetails *StreamModeDetailsParameters `json:"streamModeDetails,omitempty" tf:"stream_mode_details,omitempty"`

	// Key-value map of resource tags.
	// +kubebuilder:validation:Optional
	// +mapType=granular
	Tags map[string]*string `json:"tags,omitempty" tf:"tags,omitempty"`
}

func (*StreamParameters) DeepCopy 

func (in *StreamParameters) DeepCopy() *StreamParameters

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

func (*StreamParameters) DeepCopyInto 

func (in *StreamParameters) DeepCopyInto(out *StreamParameters)

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

type StreamSpec 

type StreamSpec struct {
	v1.ResourceSpec `json:",inline"`
	ForProvider     StreamParameters `json:"forProvider"`
	// THIS IS A BETA FIELD. It will be honored
	// unless the Management Policies feature flag is disabled.
	// InitProvider holds the same fields as ForProvider, with the exception
	// of Identifier and other resource reference fields. The fields that are
	// in InitProvider are merged into ForProvider when the resource is created.
	// The same fields are also added to the terraform ignore_changes hook, to
	// avoid updating them after creation. This is useful for fields that are
	// required on creation, but we do not desire to update them after creation,
	// for example because of an external controller is managing them, like an
	// autoscaler.
	InitProvider StreamInitParameters `json:"initProvider,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 {
	v1.ResourceStatus `json:",inline"`
	AtProvider        StreamObservation `json:"atProvider,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.

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.