Cluster
dsql.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | dsql-controller/apis/v1alpha1#Cluster |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Cluster |
| ListKind | ClusterList |
| Plural | clusters |
| Singular | cluster |
Spec
deletionProtectionEnabled: boolean
kmsEncryptionKey: string
kmsEncryptionKeyRef:
from:
name: string
namespace: string
multiRegionProperties:
clusters:
- string
witnessRegion: string
policy: string
tags: {}
| Field | Description |
|---|---|
| deletionProtectionEnabled Optional | boolean If enabled, you can’t delete your cluster. You must first disable this property before you can delete your cluster. |
| kmsEncryptionKey Optional | string The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you. Regex Pattern: ^[a-zA-Z0-9:/_-]+$ |
| kmsEncryptionKeyRef Optional | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api |
| kmsEncryptionKeyRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| kmsEncryptionKeyRef.from.name Optional | string |
| kmsEncryptionKeyRef.from.namespace Optional | string |
| multiRegionProperties Optional | object The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties. |
| multiRegionProperties.clusters Optional | array A list of the Amazon Resource Names of the cluster. |
| multiRegionProperties.clusters.[] Required | string |
| policy Optional | string An optional resource-based policy document in JSON format that defines access permissions for the cluster. |
| tags Optional | object A map of key and value pairs to use to tag your cluster. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
creationTime: string
encryptionDetails:
encryptionStatus: string
encryptionType: string
kmsKeyARN: string
endpoint: string
identifier: string
status: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat 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. 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.partition Optional | string Partition is the AWS partition in which the resource exists or will exist |
| 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 thatcontains a collection of ackv1alpha1.Condition objects that describethe 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 |
| creationTime Optional | string The time of when created the cluster. |
| encryptionDetails Optional | object The encryption configuration for the cluster that was specified during the creation process, including the KMS key identifier and encryption state. |
| encryptionDetails.encryptionStatus Optional | string |
| encryptionDetails.encryptionType Optional | string |
| encryptionDetails.kmsKeyARN Optional | string |
| endpoint Optional | string The connection endpoint for the created cluster. Regex Pattern: ^[a-zA-Z0-9.-]+$ |
| identifier Optional | string The ID of the created cluster. Regex Pattern: ^[a-z0-9]{26}$ |
| status Optional | string The status of the created cluster. |