Stream
kinesis.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | kinesis-controller/apis/v1alpha1#Stream |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Stream |
| ListKind | StreamList |
| Plural | streams |
| Singular | stream |
Spec
name: string
shardCount: integer
streamModeDetails:
streamMode: string
| Field | Description |
|---|---|
| name Required | string 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. |
| shardCount Optional | integer 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. |
| streamModeDetails Optional | object 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.streamMode Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
consumerCount: integer
encryptionType: string
enhancedMonitoring:
shardLevelMetrics:
- string
keyID: string
openShardCount: integer
retentionPeriodHours: integer
streamCreationTimestamp: string
streamStatus: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object 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 |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array 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 |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| consumerCount Optional | integer The number of enhanced fan-out consumers registered with the stream. |
| encryptionType Optional | string The encryption type used. This value is one of the following: * KMS * NONE |
| enhancedMonitoring Optional | array Represents the current enhanced monitoring settings of the stream. |
| enhancedMonitoring.[] Required | object Represents enhanced metrics types. |
| enhancedMonitoring.[].shardLevelMetrics.[] Required | string |
| openShardCount Optional | integer The number of open shards in the stream. |
| retentionPeriodHours Optional | integer The current retention period, in hours. |
| streamCreationTimestamp Optional | string The approximate time that the stream was created. |
| streamStatus Optional | string 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. |