Documentation ¶
Overview ¶
+kubebuilder:object:generate=true +groupName=kinesis.aws.kubeform.com +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type Stream
- func (in *Stream) DeepCopy() *Stream
- func (in *Stream) DeepCopyInto(out *Stream)
- func (in *Stream) DeepCopyObject() runtime.Object
- func (mg *Stream) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Stream) GetConnectionDetailsMapping() map[string]string
- func (mg *Stream) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *Stream) GetID() string
- func (mg *Stream) GetManagementPolicy() xpv1.ManagementPolicy
- func (tr *Stream) GetObservation() (map[string]any, error)
- func (tr *Stream) GetParameters() (map[string]any, error)
- func (mg *Stream) GetProviderConfigReference() *xpv1.Reference
- func (mg *Stream) GetProviderReference() *xpv1.Reference
- func (mg *Stream) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Stream) GetTerraformResourceType() string
- func (tr *Stream) GetTerraformSchemaVersion() int
- func (mg *Stream) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *Stream) LateInitialize(attrs []byte) (bool, error)
- func (mg *Stream) SetConditions(c ...xpv1.Condition)
- func (mg *Stream) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *Stream) SetManagementPolicy(r xpv1.ManagementPolicy)
- func (tr *Stream) SetObservation(obs map[string]any) error
- func (tr *Stream) SetParameters(params map[string]any) error
- func (mg *Stream) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Stream) SetProviderReference(r *xpv1.Reference)
- func (mg *Stream) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Stream) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type StreamList
- type StreamModeDetailsObservation
- type StreamModeDetailsParameters
- type StreamObservation
- type StreamParameters
- type StreamSpec
- type StreamStatus
Constants ¶
const ( CRDGroup = "kinesis.aws.kubeform.com" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
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 )
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"` // +kubebuilder:validation:XValidation:rule="self.managementPolicy == 'ObserveOnly' || has(self.forProvider.region)",message="region is a required parameter" 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="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].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:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,aws}
func (*Stream) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Stream.
func (*Stream) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Stream) DeepCopyObject ¶
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 ¶
GetConnectionDetailsMapping for this Stream
func (*Stream) GetDeletionPolicy ¶
func (mg *Stream) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Stream.
func (*Stream) GetManagementPolicy ¶
func (mg *Stream) GetManagementPolicy() xpv1.ManagementPolicy
GetManagementPolicy of this Stream.
func (*Stream) GetObservation ¶
GetObservation of this Stream
func (*Stream) GetParameters ¶
GetParameters of this Stream
func (*Stream) GetProviderConfigReference ¶
GetProviderConfigReference of this Stream.
func (*Stream) GetProviderReference ¶
GetProviderReference of this Stream. Deprecated: Use GetProviderConfigReference.
func (*Stream) GetPublishConnectionDetailsTo ¶
func (mg *Stream) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Stream.
func (*Stream) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Stream
func (*Stream) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Stream) GetWriteConnectionSecretToReference ¶
func (mg *Stream) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Stream.
func (*Stream) LateInitialize ¶
LateInitialize this Stream using its observed tfState. returns True if there are any spec changes for the resource.
func (*Stream) SetConditions ¶
SetConditions of this Stream.
func (*Stream) SetDeletionPolicy ¶
func (mg *Stream) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Stream.
func (*Stream) SetManagementPolicy ¶
func (mg *Stream) SetManagementPolicy(r xpv1.ManagementPolicy)
SetManagementPolicy of this Stream.
func (*Stream) SetObservation ¶
SetObservation for this Stream
func (*Stream) SetParameters ¶
SetParameters for this Stream
func (*Stream) SetProviderConfigReference ¶
SetProviderConfigReference of this Stream.
func (*Stream) SetProviderReference ¶
SetProviderReference of this Stream. Deprecated: Use SetProviderConfigReference.
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 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 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:Required 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. 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"` // A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. 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. 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. // +kubebuilder:validation:Optional KMSKeyID *string `json:"kmsKeyId,omitempty" tf:"kms_key_id,omitempty"` // Region is the region you'd like your resource to be created in. // +upjet:crd:field:TFTag=- // +kubebuilder:validation:Optional Region *string `json:"region,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. // +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 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"` // A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. // +kubebuilder:validation:Optional 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. // +kubebuilder:validation:Optional TagsAll map[string]*string `json:"tagsAll,omitempty" tf:"tags_all,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"` }
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.