DBClusterEndpoint
rds.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | rds-controller/apis/v1alpha1#DBClusterEndpoint |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | DBClusterEndpoint |
| ListKind | DBClusterEndpointList |
| Plural | dbclusterendpoints |
| Singular | dbclusterendpoint |
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.
Spec
dbClusterEndpointIdentifier: string
dbClusterIdentifier: string
dbClusterIdentifierRef:
from:
name: string
namespace: string
endpointType: string
excludedMembers:
- string
staticMembers:
- string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| dbClusterEndpointIdentifier Required | string The identifier to use for the new endpoint. This parameter is stored as a lowercase string. |
| dbClusterIdentifier Optional | string The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. |
| dbClusterIdentifierRef 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 |
| dbClusterIdentifierRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| dbClusterIdentifierRef.from.name Optional | string |
| dbClusterIdentifierRef.from.namespace Optional | string |
| endpointType Optional | string The type of the endpoint, one of: READER, WRITER, ANY. |
| excludedMembers Optional | array List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty. |
| excludedMembers.[] Required | string |
| staticMembers.[] Required | string |
| tags.[] Required | object Metadata assigned to an Amazon RDS resource consisting of a key-value pair. |
For more information, see Tagging Amazon RDS resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources
(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html)
in the Amazon Aurora User 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
dbClusterEndpointResourceIdentifier: string
endpoint: 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.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 |
| dbClusterEndpointResourceIdentifier Optional | string A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint. |
| endpoint Optional | string The DNS address of the endpoint. |
| status Optional | string The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can’t be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database. |