Table

keyspaces.services.k8s.aws/v1alpha1

Type	Link
GoDoc	keyspaces-controller/apis/v1alpha1#Table

Metadata

Property	Value
Scope	Namespaced
Kind	`Table`
ListKind	`TableList`
Plural	`tables`
Singular	`table`

Spec

capacitySpecification: 
  readCapacityUnits: integer
  throughputMode: string
  writeCapacityUnits: integer
clientSideTimestamps: 
  status: string
comment: 
  message: string
defaultTimeToLive: integer
encryptionSpecification: 
  kmsKeyIdentifier: string
  type_: string
keyspaceName: string
pointInTimeRecovery: 
  status: string
schemaDefinition: 
  allColumns:
  - name: string
    type_: string
  clusteringKeys:
  - name: string
    orderBy: string
  partitionKeys:
  - name: string
  staticColumns:
  - name: string
tableName: string
tags:
- key: string
  value: string
ttl: 
  status: string

Field	Description
capacitySpecification Optional	object Specifies the read/write throughput capacity mode for the table. The options are: * throughputMode:PAY_PER_REQUEST and * throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input. The default is throughput_mode:PAY_PER_REQUEST. For more information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) in the Amazon Keyspaces Developer Guide.
capacitySpecification.readCapacityUnits Optional	integer
capacitySpecification.throughputMode Optional	string
capacitySpecification.writeCapacityUnits Optional	integer
clientSideTimestamps Optional	object Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option: * status: “enabled” Once client-side timestamps are enabled for a table, this setting cannot be disabled.
clientSideTimestamps.status Optional	string
comment Optional	object This parameter allows to enter a description of the table.
comment.message Optional	string
defaultTimeToLive Optional	integer The default Time to Live setting in seconds for the table. For more information, see Setting the default TTL value for a table (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl) in the Amazon Keyspaces Developer Guide.
encryptionSpecification Optional	object Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key): * type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces. * type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input. The default is type:AWS_OWNED_KMS_KEY. For more information, see Encryption at rest (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) in the Amazon Keyspaces Developer Guide.
encryptionSpecification.kmsKeyIdentifier Optional	string
encryptionSpecification.type_ Optional	string
keyspaceName Required	string The name of the keyspace that the table is going to be created in.
pointInTimeRecovery Optional	object Specifies if pointInTimeRecovery is enabled or disabled for the table. The options are: * status=ENABLED * status=DISABLED If it’s not specified, the default is status=DISABLED. For more information, see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) in the Amazon Keyspaces Developer Guide.
pointInTimeRecovery.status Optional	string
schemaDefinition Required	object The schemaDefinition consists of the following parameters. For each column to be created: * name - The name of the column. * type - An Amazon Keyspaces data type. For more information, see Data types (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) in the Amazon Keyspaces Developer Guide. The primary key of the table consists of the following columns: * partitionKeys - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data. * name - The name of each partition key column. * clusteringKeys - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition. * name - The name of the clustering column. * orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier. To define a column as static use staticColumns - Static columns store values that are shared by all rows in the same partition: * name - The name of the column. * type - An Amazon Keyspaces data type.
schemaDefinition.allColumns Optional	array
schemaDefinition.allColumns.[] Required	object The names and data types of regular columns.
schemaDefinition.allColumns.[].type_ Optional	string
schemaDefinition.clusteringKeys Optional	array
schemaDefinition.clusteringKeys.[] Required	object The optional clustering column portion of your primary key determines how
the data is clustered and sorted within each partition.
schemaDefinition.clusteringKeys.[].orderBy Optional	string
schemaDefinition.partitionKeys Optional	array
schemaDefinition.partitionKeys.[] Required	object The partition key portion of the primary key is required and determines how
Amazon Keyspaces stores the data. The partition key can be a single column,
or it can be a compound value composed of two or more columns.
schemaDefinition.staticColumns Optional	array
schemaDefinition.staticColumns.[] Required	object The static columns of the table. Static columns store values that are shared
by all rows in the same partition.
tableName Required	string The name of the table.
tags Optional	array A list of key-value pair tags to be attached to the resource. For more information, see Adding tags and labels to Amazon Keyspaces resources (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) in the Amazon Keyspaces Developer Guide.
tags.[] Required	object Describes a tag. A tag is a key-value pair. You can add up to 50 tags to
a single Amazon Keyspaces resource.

Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.

For more information, see Adding tags and labels to Amazon Keyspaces resources (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) in the Amazon Keyspaces Developer Guide. || tags.[].key
Optional | string
| | tags.[].value
Optional | string
| | ttl
Optional | object
Enables Time to Live custom settings for the table. The options are:

* status:enabled

* status:disabled

The default is status:disabled. After ttl is enabled, you can’t disable it
for the table.

For more information, see Expiring data by using Amazon Keyspaces Time to
Live (TTL) (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html)
in the Amazon Keyspaces Developer Guide. | | ttl.status
Optional | string
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
status: 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
status Optional	string

Table

Metadata#

Spec#

Status#

Metadata

Spec

Status