Keyspace

keyspaces.services.k8s.aws/v1alpha1

TypeLink
GoDockeyspaces-controller/apis/v1alpha1#Keyspace

Metadata

PropertyValue
ScopeNamespaced
KindKeyspace
ListKindKeyspaceList
Pluralkeyspaces
Singularkeyspace

Spec

keyspaceName: string
replicationSpecification: 
  regionList:
  - string
  replicationStrategy: string
tags:
- key: string
  value: string
FieldDescription
keyspaceName
Required
string
The name of the keyspace to be created.
replicationSpecification
Optional
object
The replication specification of the keyspace includes:


* replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.


* regionList - if the replicationStrategy is MULTI_REGION, the regionList
requires the current Region and at least one additional Amazon Web Services
Region where the keyspace is going to be replicated in. The maximum number
of supported replication Regions including the current Region is six.
replicationSpecification.regionList
Optional
array
replicationSpecification.regionList.[]
Required
string
tags
Optional
array
A list of key-value pair tags to be attached to the keyspace.


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
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
resourceARN: string
FieldDescription
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
resourceARN
Optional
string
The unique identifier of the keyspace in the format of an Amazon Resource
Name (ARN).