GlobalCluster
rds.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | rds-controller/apis/v1alpha1#GlobalCluster |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | GlobalCluster |
| ListKind | GlobalClusterList |
| Plural | globalclusters |
| Singular | globalcluster |
A data type representing an Aurora global database.
Spec
databaseName: string
deletionProtection: boolean
engine: string
engineVersion: string
globalClusterIdentifier: string
sourceDBClusterIdentifier: string
storageEncrypted: boolean
| Field | Description |
|---|---|
| databaseName Optional | string The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating. |
| deletionProtection Optional | boolean The deletion protection setting for the new global database. The global database can’t be deleted when deletion protection is enabled. |
| engine Optional | string The name of the database engine to be used for this DB cluster. |
| engineVersion Optional | string The engine version of the Aurora global database. |
| globalClusterIdentifier Optional | string The cluster identifier of the new global database cluster. |
| sourceDBClusterIdentifier Optional | string The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. |
| storageEncrypted Optional | boolean The storage encryption setting for the new global database cluster. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
failoverState:
fromDBClusterARN: string
status: string
toDBClusterARN: string
globalClusterMembers:
- dbClusterARN: string
globalWriteForwardingStatus: string
isWriter: boolean
readers:
- string
globalClusterResourceID: 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. 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 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 |
| failoverState Optional | object A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster). |
| failoverState.fromDBClusterARN Optional | string |
| failoverState.status Optional | string |
| failoverState.toDBClusterARN Optional | string |
| globalClusterMembers Optional | array The list of primary and secondary clusters within the global database cluster. |
| globalClusterMembers.[] Required | object A data structure with information about any primary and secondary clusters |
| associated with an Aurora global database. | |
| globalClusterMembers.[].globalWriteForwardingStatus Optional | string |
| globalClusterMembers.[].isWriter Optional | boolean |
| globalClusterMembers.[].readers Optional | array |
| globalClusterMembers.[].readers.[] Required | string |
| status Optional | string Specifies the current state of this global database cluster. |