Documentation
¶
Overview ¶
+kubebuilder:object:generate=true +groupName=kinesisvideo.aws.upbound.io +versionName=v1beta1
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 (tr *Stream) GetInitParameters() (map[string]any, error)
- func (mg *Stream) GetManagementPolicies() xpv1.ManagementPolicies
- func (tr *Stream) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)
- 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) 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) ResolveReferences(ctx context.Context, c client.Reader) error
- func (mg *Stream) SetConditions(c ...xpv1.Condition)
- func (mg *Stream) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *Stream) SetManagementPolicies(r xpv1.ManagementPolicies)
- 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) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Stream) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type StreamInitParameters
- type StreamList
- type StreamObservation
- type StreamParameters
- type StreamSpec
- type StreamStatus
Constants ¶
const ( CRDGroup = "kinesisvideo.aws.upbound.io" CRDVersion = "v1beta1" )
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="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.name) || (has(self.initProvider) && has(self.initProvider.name))",message="spec.forProvider.name 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 Video 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) GetInitParameters ¶ added in v0.38.0
GetInitParameters of this Stream
func (*Stream) GetManagementPolicies ¶ added in v0.38.0
func (mg *Stream) GetManagementPolicies() xpv1.ManagementPolicies
GetManagementPolicies of this Stream.
func (*Stream) GetMergedParameters ¶ added in v0.44.0
GetInitParameters 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) 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) ResolveReferences ¶
ResolveReferences of this Stream.
func (*Stream) SetConditions ¶
SetConditions of this Stream.
func (*Stream) SetDeletionPolicy ¶
func (mg *Stream) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Stream.
func (*Stream) SetManagementPolicies ¶ added in v0.38.0
func (mg *Stream) SetManagementPolicies(r xpv1.ManagementPolicies)
SetManagementPolicies 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) 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 ¶ added in v0.38.0
type StreamInitParameters struct { // – The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream. The default value is 0, indicating that the stream does not persist data. DataRetentionInHours *float64 `json:"dataRetentionInHours,omitempty" tf:"data_retention_in_hours,omitempty"` // The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name. DeviceName *string `json:"deviceName,omitempty" tf:"device_name,omitempty"` // The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines. MediaType *string `json:"mediaType,omitempty" tf:"media_type,omitempty"` // A name to identify the stream. This is unique to the // AWS account and region the Stream is created in. Name *string `json:"name,omitempty" tf:"name,omitempty"` // Key-value map of resource tags. Tags map[string]*string `json:"tags,omitempty" tf:"tags,omitempty"` }
func (*StreamInitParameters) DeepCopy ¶ added in v0.38.0
func (in *StreamInitParameters) DeepCopy() *StreamInitParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StreamInitParameters.
func (*StreamInitParameters) DeepCopyInto ¶ added in v0.38.0
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 StreamObservation ¶
type StreamObservation struct { // The Amazon Resource Name (ARN) specifying the Stream (same as id) Arn *string `json:"arn,omitempty" tf:"arn,omitempty"` // A time stamp that indicates when the stream was created. CreationTime *string `json:"creationTime,omitempty" tf:"creation_time,omitempty"` // – The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream. The default value is 0, indicating that the stream does not persist data. DataRetentionInHours *float64 `json:"dataRetentionInHours,omitempty" tf:"data_retention_in_hours,omitempty"` // The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name. DeviceName *string `json:"deviceName,omitempty" tf:"device_name,omitempty"` // The unique Stream id ID *string `json:"id,omitempty" tf:"id,omitempty"` // The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data. If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used. KMSKeyID *string `json:"kmsKeyId,omitempty" tf:"kms_key_id,omitempty"` // The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines. MediaType *string `json:"mediaType,omitempty" tf:"media_type,omitempty"` // A name to identify the stream. This is unique to the // AWS account and region the Stream is created in. Name *string `json:"name,omitempty" tf:"name,omitempty"` // Key-value map of resource tags. 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"` // The version of the stream. Version *string `json:"version,omitempty" tf:"version,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 number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream. The default value is 0, indicating that the stream does not persist data. // +kubebuilder:validation:Optional DataRetentionInHours *float64 `json:"dataRetentionInHours,omitempty" tf:"data_retention_in_hours,omitempty"` // The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name. // +kubebuilder:validation:Optional DeviceName *string `json:"deviceName,omitempty" tf:"device_name,omitempty"` // The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data. If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used. // +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:"-"` // The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines. // +kubebuilder:validation:Optional MediaType *string `json:"mediaType,omitempty" tf:"media_type,omitempty"` // A name to identify the stream. This is unique to the // AWS account and region the Stream is created in. // +kubebuilder:validation:Optional Name *string `json:"name,omitempty" tf:"name,omitempty"` // 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:"-"` // Key-value map of resource tags. // +kubebuilder:validation:Optional 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.