Keyspaces

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

API Group: aws.konfig.io/v1alpha1

CassandraKeyspace # CLOUD CONTROL · AWS::Cassandra::Keyspace

CassandraKeyspace manages AWS::Cassandra::Keyspace through the AWS Cloud Control API.

kubectl get cassandrakeyspaces · example on GitHub

Example

# CassandraKeyspace — Keyspaces
# 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/cassandra.html#cassandrakeyspace
apiVersion: aws.konfig.io/v1alpha1
kind: CassandraKeyspace
metadata:
  name: example-cassandrakeyspace
  namespace: default
spec:
  clientSideTimestampsEnabled: true
  keyspaceName: example-cassandrakeyspace
  providerRef:
    name: example-cassandrakeyspace
    region: us-east-1
  replicationSpecification:
    regionList:
    - example
    replicationStrategy: SINGLE_REGION
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`clientSideTimestampsEnabled`	boolean	—	Indicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace.
`keyspaceName`	string	—	Name for Cassandra keyspace Create-only in AWS: changing it requires replacing the resource.
`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.
`replicationSpecification`	object	—	CassandraKeyspaceReplicationSpecification is a nested property type of AWS::Cassandra::Keyspace.
`replicationSpecification.regionList`	array<string>	—
`replicationSpecification.replicationStrategy`	enum	—	Allowed: `SINGLE_REGION, MULTI_REGION`
`tags`	array<object>	—
`tags[].key`	string	yes
`tags[].value`	string	yes

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.

CassandraTable # CLOUD CONTROL · AWS::Cassandra::Table

CassandraTable manages AWS::Cassandra::Table through the AWS Cloud Control API.

kubectl get cassandratables · example on GitHub

Example

# CassandraTable — Keyspaces
# 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/cassandra.html#cassandratable
apiVersion: aws.konfig.io/v1alpha1
kind: CassandraTable
metadata:
  name: example-cassandratable
  namespace: default
spec:
  autoScalingSpecifications:
    readCapacityAutoScaling:
      autoScalingDisabled: false
      maximumUnits: 1
      minimumUnits: 1
    writeCapacityAutoScaling:
      autoScalingDisabled: false
      maximumUnits: 1
      minimumUnits: 1
  billingMode:
    mode: PROVISIONED
    provisionedThroughput:
      readCapacityUnits: 1
      writeCapacityUnits: 1
  cdcSpecification:
    status: ENABLED
    tags:
    - key: example
      value: example
    viewType: NEW_IMAGE
  clientSideTimestampsEnabled: true
  clusteringKeyColumns:
  - column:
      columnName: example-cassandratable
      columnType: example
    orderBy: ASC
  defaultTimeToLive: 1
  encryptionSpecification:
    encryptionType: AWS_OWNED_KMS_KEY
    kmsKeyIdentifier: example
  keyspaceName: example-cassandratable
  partitionKeyColumns:
  - columnName: example-cassandratable
    columnType: example
  pointInTimeRecoveryEnabled: true
  providerRef:
    name: example-cassandratable
    region: us-east-1
  regularColumns:
  - columnName: example-cassandratable
    columnType: example
  replicaSpecifications:
  - readCapacityAutoScaling:
      autoScalingDisabled: false
      maximumUnits: 1
      minimumUnits: 1
    readCapacityUnits: 2
    region: us-east-1
  tableName: example-cassandratable
  tags:
  - key: example
    value: example
  warmThroughput:
    readUnitsPerSecond: 1
    writeUnitsPerSecond: 1

Spec

Field	Type	Required	Description
`autoScalingSpecifications`	object	—	CassandraTableAutoScalingSpecification is a nested property type of AWS::Cassandra::Table.
`autoScalingSpecifications.readCapacityAutoScaling`	object	—	CassandraTableAutoScalingSetting is a nested property type of AWS::Cassandra::Table.
`autoScalingSpecifications.readCapacityAutoScaling.autoScalingDisabled`	boolean	—
`autoScalingSpecifications.readCapacityAutoScaling.maximumUnits`	integer	—
`autoScalingSpecifications.readCapacityAutoScaling.minimumUnits`	integer	—
`autoScalingSpecifications.readCapacityAutoScaling.scalingPolicy`	object	—	CassandraTableScalingPolicy is a nested property type of AWS::Cassandra::Table.
`autoScalingSpecifications.readCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration`	object	—	CassandraTableTargetTrackingScalingPolicyConfiguration is a nested property type of AWS::Cassandra::Table.
`autoScalingSpecifications.readCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.disableScaleIn`	boolean	—
`autoScalingSpecifications.readCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.scaleInCooldown`	integer	—
`autoScalingSpecifications.readCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.scaleOutCooldown`	integer	—
`autoScalingSpecifications.readCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.targetValue`	integer	yes
`autoScalingSpecifications.writeCapacityAutoScaling`	object	—	CassandraTableAutoScalingSetting is a nested property type of AWS::Cassandra::Table.
`autoScalingSpecifications.writeCapacityAutoScaling.autoScalingDisabled`	boolean	—
`autoScalingSpecifications.writeCapacityAutoScaling.maximumUnits`	integer	—
`autoScalingSpecifications.writeCapacityAutoScaling.minimumUnits`	integer	—
`autoScalingSpecifications.writeCapacityAutoScaling.scalingPolicy`	object	—	CassandraTableScalingPolicy is a nested property type of AWS::Cassandra::Table.
`autoScalingSpecifications.writeCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration`	object	—	CassandraTableTargetTrackingScalingPolicyConfiguration is a nested property type of AWS::Cassandra::Table.
`autoScalingSpecifications.writeCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.disableScaleIn`	boolean	—
`autoScalingSpecifications.writeCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.scaleInCooldown`	integer	—
`autoScalingSpecifications.writeCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.scaleOutCooldown`	integer	—
`autoScalingSpecifications.writeCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.targetValue`	integer	yes
`billingMode`	object	—	CassandraTableBillingMode is a nested property type of AWS::Cassandra::Table.
`billingMode.mode`	enum	yes	Allowed: `PROVISIONED, ON_DEMAND`
`billingMode.provisionedThroughput`	object	—	CassandraTableProvisionedThroughput is a nested property type of AWS::Cassandra::Table.
`billingMode.provisionedThroughput.readCapacityUnits`	integer	yes
`billingMode.provisionedThroughput.writeCapacityUnits`	integer	yes
`cdcSpecification`	object	—	CassandraTableCdcSpecification is a nested property type of AWS::Cassandra::Table.
`cdcSpecification.status`	enum	yes	Allowed: `ENABLED, DISABLED`
`cdcSpecification.tags`	array<object>	—	An array of key-value pairs to apply to the CDC stream resource
`cdcSpecification.tags[].key`	string	yes
`cdcSpecification.tags[].value`	string	yes
`cdcSpecification.viewType`	enum	—	Allowed: `NEW_IMAGE, OLD_IMAGE, KEYS_ONLY, NEW_AND_OLD_IMAGES`
`clientSideTimestampsEnabled`	boolean	—	Indicates whether client side timestamps are enabled (true) or disabled (false) on the table.
`clusteringKeyColumns`	array<object>	—	Clustering key columns of the table Create-only in AWS: changing it requires replacing the resource.
`clusteringKeyColumns[].column`	object	yes	CassandraTableColumn is a nested property type of AWS::Cassandra::Table.
`clusteringKeyColumns[].column.columnName`	string	yes
`clusteringKeyColumns[].column.columnType`	string	yes
`clusteringKeyColumns[].orderBy`	enum	—	Allowed: `ASC, DESC`
`defaultTimeToLive`	integer	—	Default TTL (Time To Live) in seconds, where zero is disabled.
`encryptionSpecification`	object	—	CassandraTableEncryptionSpecification is a nested property type of AWS::Cassandra::Table.
`encryptionSpecification.encryptionType`	enum	yes	Allowed: `AWS_OWNED_KMS_KEY, CUSTOMER_MANAGED_KMS_KEY`
`encryptionSpecification.kmsKeyIdentifier`	string	—
`keyspaceName`	string	yes	Name for Cassandra keyspace Create-only in AWS: changing it requires replacing the resource.
`partitionKeyColumns`	array<object>	yes	Partition key columns of the table Create-only in AWS: changing it requires replacing the resource.
`partitionKeyColumns[].columnName`	string	yes
`partitionKeyColumns[].columnType`	string	yes
`pointInTimeRecoveryEnabled`	boolean	—	Indicates whether point in time recovery is enabled (true) or disabled (false) on the table
`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.
`regularColumns`	array<object>	—	Non-key columns of the table
`regularColumns[].columnName`	string	yes
`regularColumns[].columnType`	string	yes
`replicaSpecifications`	array<object>	—
`replicaSpecifications[].readCapacityAutoScaling`	object	—	CassandraTableAutoScalingSetting is a nested property type of AWS::Cassandra::Table.
`replicaSpecifications[].readCapacityAutoScaling.autoScalingDisabled`	boolean	—
`replicaSpecifications[].readCapacityAutoScaling.maximumUnits`	integer	—
`replicaSpecifications[].readCapacityAutoScaling.minimumUnits`	integer	—
`replicaSpecifications[].readCapacityAutoScaling.scalingPolicy`	object	—	CassandraTableScalingPolicy is a nested property type of AWS::Cassandra::Table.
`replicaSpecifications[].readCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration`	object	—	CassandraTableTargetTrackingScalingPolicyConfiguration is a nested property type of AWS::Cassandra::Table.
`replicaSpecifications[].readCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.disableScaleIn`	boolean	—
`replicaSpecifications[].readCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.scaleInCooldown`	integer	—
`replicaSpecifications[].readCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.scaleOutCooldown`	integer	—
`replicaSpecifications[].readCapacityAutoScaling.scalingPolicy.targetTrackingScalingPolicyConfiguration.targetValue`	integer	yes
`replicaSpecifications[].readCapacityUnits`	integer	—
`replicaSpecifications[].region`	string	yes
`tableName`	string	—	Name for Cassandra table Create-only in AWS: changing it requires replacing the resource.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource
`tags[].key`	string	yes
`tags[].value`	string	yes
`warmThroughput`	object	—	CassandraTableWarmThroughput is a nested property type of AWS::Cassandra::Table.
`warmThroughput.readUnitsPerSecond`	integer	—
`warmThroughput.writeUnitsPerSecond`	integer	—

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.

CassandraType # CLOUD CONTROL · AWS::Cassandra::Type

CassandraType manages AWS::Cassandra::Type through the AWS Cloud Control API.

kubectl get cassandratypes · example on GitHub

Example

# CassandraType — Keyspaces
# 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/cassandra.html#cassandratype
apiVersion: aws.konfig.io/v1alpha1
kind: CassandraType
metadata:
  name: example-cassandratype
  namespace: default
spec:
  fields:
  - fieldName: example-cassandratype
    fieldType: example
  keyspaceName: example-cassandratype
  providerRef:
    name: example-cassandratype
    region: us-east-1
  typeName: example-cassandratype

Spec

Field	Type	Required	Description
`fields`	array<object>	yes	Field definitions of the User-Defined Type Create-only in AWS: changing it requires replacing the resource.
`fields[].fieldName`	string	yes
`fields[].fieldType`	string	yes
`keyspaceName`	string	yes	Name of the Keyspace which contains the User-Defined Type.
`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.
`typeName`	string	yes	Name of the User-Defined Type.

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.
`directParentTypes`	array<string>	—	List of parent User-Defined Types that directly reference the User-Defined Type in their fields.
`directReferringTables`	array<string>	—	List of Tables that directly reference the User-Defined Type in their columns.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`keyspaceArn`	string	—	ARN of the Keyspace which contains the User-Defined Type.
`lastModifiedTimestamp`	number	—	Timestamp of the last time the User-Defined Type's meta data was modified.
`lastSyncTime`	string	—
`maxNestingDepth`	integer	—	Maximum nesting depth of the User-Defined Type across the field types.
`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.