DBCluster
documentdb.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | documentdb-controller/apis/v1alpha1#DBCluster |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | DBCluster |
| ListKind | DBClusterList |
| Plural | dbclusters |
| Singular | dbcluster |
Detailed information about a cluster.
Spec
availabilityZones:
- string
backupRetentionPeriod: integer
dbClusterIdentifier: string
dbClusterParameterGroupName: string
dbSubnetGroupName: string
dbSubnetGroupRef:
from:
name: string
deletionProtection: boolean
destinationRegion: string
enableCloudwatchLogsExports:
- string
engine: string
engineVersion: string
globalClusterIdentifier: string
kmsKeyID: string
kmsKeyRef:
from:
name: string
masterUserPassword:
key: string
name: string
namespace: string
masterUsername: string
port: integer
preSignedURL: string
preferredBackupWindow: string
preferredMaintenanceWindow: string
snapshotIdentifier: string
sourceRegion: string
storageEncrypted: boolean
storageType: string
tags:
- key: string
value: string
vpcSecurityGroupIDs:
- string
vpcSecurityGroupRefs:
from:
name: string
| Field | Description |
|---|---|
| availabilityZones Optional | array A list of Amazon EC2 Availability Zones that instances in the cluster can be created in. |
| availabilityZones.[] Required | string |
| dbClusterIdentifier Required | string The cluster identifier. This parameter is stored as a lowercase string. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens. * The first character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster |
| dbClusterParameterGroupName Optional | string The name of the cluster parameter group to associate with this cluster. |
| dbSubnetGroupName Optional | string A subnet group to associate with this cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup |
| dbSubnetGroupRef 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 |
| dbSubnetGroupRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| dbSubnetGroupRef.from.name Optional | string |
| deletionProtection Optional | boolean Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted. |
| destinationRegion Optional | string DestinationRegion is used for presigning the request to a given region. |
| enableCloudwatchLogsExports Optional | array A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events (https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) and Profiling Amazon DocumentDB Operations (https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html). |
| enableCloudwatchLogsExports.[] Required | string |
| engineVersion Optional | string The version number of the database engine to use. The –engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version. |
| globalClusterIdentifier Optional | string The cluster identifier of the new global cluster. |
| kmsKeyID Optional | string The KMS key identifier for an encrypted cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key. If an encryption key is not specified in KmsKeyId: * If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions. |
| kmsKeyRef 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 |
| kmsKeyRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| kmsKeyRef.from.name Optional | string |
| masterUserPassword Optional | object The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the “at” symbol (@). Constraints: Must contain from 8 to 100 characters. |
| masterUserPassword.key Required | string Key is the key within the secret |
| masterUserPassword.name Optional | string name is unique within a namespace to reference a secret resource. |
| masterUserPassword.namespace Optional | string namespace defines the space within which the secret name must be unique. |
| masterUsername Optional | string The name of the master user for the cluster. Constraints: * Must be from 1 to 63 letters or numbers. * The first character must be a letter. * Cannot be a reserved word for the chosen database engine. |
| port Optional | integer The port number on which the instances in the cluster accept connections. |
| preSignedURL Optional | string Not currently supported. |
| preferredBackupWindow Optional | string The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. Constraints: * Must be in the format hh24:mi-hh24:mi. * Must be in Universal Coordinated Time (UTC). * Must not conflict with the preferred maintenance window. * Must be at least 30 minutes. |
| preferredMaintenanceWindow Optional | string The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. |
| snapshotIdentifier Optional | string The identifier for the snapshot or cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot. Constraints: * Must match the identifier of an existing snapshot. |
| sourceRegion Optional | string SourceRegion is the source region where the resource exists. This is not sent over the wire and is only used for presigning. This value should always have the same region as the source ARN. |
| storageEncrypted Optional | boolean Specifies whether the cluster is encrypted. |
| storageType Optional | string The storage type to associate with the DB cluster. For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide. Valid values for storage type - standard |
| tags Optional | array The tags to be assigned to the cluster. |
| tags.[] Required | object Metadata assigned to an Amazon DocumentDB resource consisting of a key-value |
| pair. | |
| tags.[].value Optional | string |
| vpcSecurityGroupIDs Optional | array A list of EC2 VPC security groups to associate with this cluster. |
| vpcSecurityGroupIDs.[] Required | string |
| vpcSecurityGroupRefs.[] Required | 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 || **vpcSecurityGroupRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| vpcSecurityGroupRefs.[].from.name
Optional | string
|
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
associatedRoles:
- roleARN: string
status: string
cloneGroupID: string
clusterCreateTime: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
dbClusterMembers:
- dbClusterParameterGroupStatus: string
dbInstanceIdentifier: string
isClusterWriter: boolean
promotionTier: integer
dbClusterParameterGroup: string
dbClusterResourceID: string
dbSubnetGroup: string
earliestRestorableTime: string
enabledCloudwatchLogsExports:
- string
endpoint: string
hostedZoneID: string
latestRestorableTime: string
multiAZ: boolean
percentProgress: string
readReplicaIdentifiers:
- string
readerEndpoint: string
replicationSourceIdentifier: string
status: string
vpcSecurityGroups:
- status: string
vpcSecurityGroupID: 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. |
| associatedRoles Optional | array Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf. |
| associatedRoles.[] Required | object Describes an Identity and Access Management (IAM) role that is associated |
| with a cluster. | |
| associatedRoles.[].status Optional | string |
| cloneGroupID Optional | string Identifies the clone group to which the DB cluster is associated. |
| clusterCreateTime Optional | string Specifies the time when the cluster was created, in Universal Coordinated Time (UTC). |
| 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 |
| dbClusterMembers Optional | array Provides the list of instances that make up the cluster. |
| dbClusterMembers.[] Required | object Contains information about an instance that is part of a cluster. |
| dbClusterMembers.[].dbInstanceIdentifier Optional | string |
| dbClusterMembers.[].isClusterWriter Optional | boolean |
| dbClusterMembers.[].promotionTier Optional | integer |
| dbClusterParameterGroup Optional | string Specifies the name of the cluster parameter group for the cluster. |
| dbClusterResourceID Optional | string The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed. |
| dbSubnetGroup Optional | string Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group. |
| earliestRestorableTime Optional | string The earliest time to which a database can be restored with point-in-time restore. |
| enabledCloudwatchLogsExports Optional | array A list of log types that this cluster is configured to export to Amazon CloudWatch Logs. |
| enabledCloudwatchLogsExports.[] Required | string |
| hostedZoneID Optional | string Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. |
| latestRestorableTime Optional | string Specifies the latest time to which a database can be restored with point-in-time restore. |
| multiAZ Optional | boolean Specifies whether the cluster has instances in multiple Availability Zones. |
| percentProgress Optional | string Specifies the progress of the operation as a percentage. |
| readReplicaIdentifiers Optional | array Contains one or more identifiers of the secondary clusters that are associated with this cluster. |
| readReplicaIdentifiers.[] Required | string |
| replicationSourceIdentifier Optional | string Contains the identifier of the source cluster if this cluster is a secondary cluster. |
| status Optional | string Specifies the current state of this cluster. |
| vpcSecurityGroups Optional | array Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to. |
| vpcSecurityGroups.[] Required | object Used as a response element for queries on virtual private cloud (VPC) security |
| group membership. | |
| vpcSecurityGroups.[].vpcSecurityGroupID Optional | string |