Kinesis

3 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

KinesisResourcePolicy # CLOUD CONTROL · AWS::Kinesis::ResourcePolicy

KinesisResourcePolicy manages AWS::Kinesis::ResourcePolicy through the AWS Cloud Control API.

kubectl get kinesisresourcepolicies · example on GitHub

Example

# KinesisResourcePolicy — Kinesis
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/kinesis.html#kinesisresourcepolicy
apiVersion: aws.konfig.io/v1alpha1
kind: KinesisResourcePolicy
metadata:
  name: example-kinesisresourcepolicy
  namespace: default
spec:
  providerRef:
    name: example-kinesisresourcepolicy
    region: us-east-1

Spec

Field	Type	Required	Description
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`resourceArn`	object	yes	The ARN of the AWS Kinesis resource to which the policy applies.
`resourcePolicy`	object	yes	A policy document containing permissions to add to the specified resource.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

KinesisStream # GA

KinesisStream is the Schema for managing Kinesis Data Streams.

kubectl get kinesisstreams · example on GitHub

Example

# KinesisStream — Kinesis
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/kinesis.html#kinesisstream
apiVersion: aws.konfig.io/v1alpha1
kind: KinesisStream
metadata:
  name: example-kinesisstream
  namespace: default
spec:
  providerRef:
    name: example-kinesisstream
    region: us-east-1
  retentionPeriodHours: 7
  shardCount: 2
  streamMode: ON_DEMAND
  streamName: example-kinesisstream
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`retentionPeriodHours`	integer	—	RetentionPeriodHours is the data retention period in hours (24–8760).
`shardCount`	integer	—	ShardCount is the number of shards for PROVISIONED mode.
`streamMode`	enum	—	StreamModeDetails specifies ON_DEMAND or PROVISIONED mode. Allowed: `ON_DEMAND, PROVISIONED`
`streamName`	string	yes	StreamName is the name of the stream.
`tags`	map<string>	—	Tags are metadata tags for the stream.

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`streamARN`	string	—	StreamARN is the ARN of the stream.
`streamStatus`	string	—	StreamStatus is the current status of the stream (CREATING, DELETING, ACTIVE, UPDATING).

KinesisStreamConsumer # GA

KinesisStreamConsumer is the Schema for managing Kinesis enhanced fan-out consumers.

kubectl get kinesisstreamconsumers · example on GitHub

Example

# KinesisStreamConsumer — Kinesis
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/kinesis.html#kinesisstreamconsumer
apiVersion: aws.konfig.io/v1alpha1
kind: KinesisStreamConsumer
metadata:
  name: example-kinesisstreamconsumer
  namespace: default
spec:
  consumerName: example-kinesisstreamconsumer
  providerRef:
    name: example-kinesisstreamconsumer
    region: us-east-1
  streamARN: arn:aws:iam::123456789012:role/example-role

Spec

Field	Type	Required	Description
`consumerName`	string	yes	ConsumerName is the name of the consumer.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`streamARN`	string	yes	StreamARN is the ARN of the Kinesis stream to register the consumer on.

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`consumerARN`	string	—	ConsumerARN is the ARN of the registered consumer.
`consumerStatus`	string	—	ConsumerStatus is the current status (CREATING, DELETING, ACTIVE).
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.