DBCluster

rds.services.k8s.aws/v1alpha1

Metadata#

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the Amazon RDS User Guide.

Spec#

allocatedStorage: integer
autoMinorVersionUpgrade: boolean
availabilityZones:
- string
backtrackWindow: integer
backupRetentionPeriod: integer
characterSetName: string
copyTagsToSnapshot: boolean
databaseName: string
dbClusterIdentifier: string
dbClusterInstanceClass: string
dbClusterParameterGroupName: string
dbClusterParameterGroupRef: 
  from: 
    name: string
    namespace: string
dbSubnetGroupName: string
dbSubnetGroupRef: 
  from: 
    name: string
    namespace: string
dbSystemID: string
deletionProtection: boolean
destinationRegion: string
domain: string
domainIAMRoleName: string
enableCloudwatchLogsExports:
- string
enableGlobalWriteForwarding: boolean
enableHTTPEndpoint: boolean
enableIAMDatabaseAuthentication: boolean
enablePerformanceInsights: boolean
engine: string
engineMode: string
engineVersion: string
globalClusterIdentifier: string
iops: integer
kmsKeyID: string
kmsKeyRef: 
  from: 
    name: string
    namespace: string
manageMasterUserPassword: boolean
masterUserPassword: 
  key: string
  name: string
  namespace: string
masterUserSecretKMSKeyID: string
masterUserSecretKMSKeyRef: 
  from: 
    name: string
    namespace: string
masterUsername: string
monitoringInterval: integer
monitoringRoleARN: string
networkType: string
optionGroupName: string
performanceInsightsKMSKeyID: string
performanceInsightsRetentionPeriod: integer
port: integer
preSignedURL: string
preferredBackupWindow: string
preferredMaintenanceWindow: string
publiclyAccessible: boolean
replicationSourceIdentifier: string
restoreToTime: string
restoreType: string
scalingConfiguration: 
  autoPause: boolean
  maxCapacity: integer
  minCapacity: integer
  secondsBeforeTimeout: integer
  secondsUntilAutoPause: integer
  timeoutAction: string
serverlessV2ScalingConfiguration: 
  maxCapacity: number
  minCapacity: number
snapshotIdentifier: string
sourceDBClusterIdentifier: string
sourceRegion: string
storageEncrypted: boolean
storageType: string
tags:
- key: string
  value: string
useLatestRestorableTime: boolean
vpcSecurityGroupIDs:
- string
vpcSecurityGroupRefs:
  from: 
    name: string
    namespace: string

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. || tags.[].key
Optional | string
| | tags.[].value
Optional | string
| | useLatestRestorableTime
Optional | boolean
A value that indicates whether to restore the DB cluster to the latest restorable
backup time. By default, the DB cluster isn’t restored to the latest restorable
backup time.

Constraints: Can’t be specified if RestoreToTime parameter is provided.

Valid for: Aurora DB clusters and Multi-AZ DB clusters | | vpcSecurityGroupIDs
Optional | array
A list of EC2 VPC security groups to associate with this DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters | | vpcSecurityGroupIDs.[]
Required | string
|| vpcSecurityGroupRefs
Optional | array
| | 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
| | vpcSecurityGroupRefs.[].from.namespace
Optional | string
|

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
activityStreamKMSKeyID: string
activityStreamKinesisStreamName: string
activityStreamMode: string
activityStreamStatus: string
associatedRoles:
- featureName: string
  roleARN: string
  status: string
automaticRestartTime: string
backtrackConsumedChangeRecords: integer
capacity: integer
cloneGroupID: string
clusterCreateTime: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
crossAccountClone: boolean
customEndpoints:
- string
dbClusterMembers:
- dbClusterParameterGroupStatus: string
  dbInstanceIdentifier: string
  isClusterWriter: boolean
  promotionTier: integer
dbClusterOptionGroupMemberships:
- dbClusterOptionGroupName: string
  status: string
dbClusterParameterGroup: string
dbClusterResourceID: string
dbSubnetGroup: string
domainMemberships:
- domain: string
  fQDN: string
  iamRoleName: string
  status: string
earliestBacktrackTime: string
earliestRestorableTime: string
enabledCloudwatchLogsExports:
- string
endpoint: string
globalWriteForwardingRequested: boolean
globalWriteForwardingStatus: string
hostedZoneID: string
httpEndpointEnabled: boolean
iamDatabaseAuthenticationEnabled: boolean
latestRestorableTime: string
masterUserSecret: 
  kmsKeyID: string
  secretARN: string
  secretStatus: string
multiAZ: boolean
pendingModifiedValues: 
  allocatedStorage: integer
  backupRetentionPeriod: integer
  dbClusterIdentifier: string
  engineVersion: string
  iamDatabaseAuthenticationEnabled: boolean
  iops: integer
  masterUserPassword: string
  pendingCloudwatchLogsExports: 
    logTypesToDisable:
    - string
    logTypesToEnable:
    - string
percentProgress: string
performanceInsightsEnabled: boolean
readReplicaIdentifiers:
- string
readerEndpoint: string
status: string
tagList:
- key: string
  value: string
vpcSecurityGroups:
- status: string
  vpcSecurityGroupID: string

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. || tagList.[].key
Optional | string
| | tagList.[].value
Optional | string
| | vpcSecurityGroups
Optional | array
Provides a list of VPC security groups that the DB cluster belongs to. | | vpcSecurityGroups.[]
Required | object
This data type is used as a response element for queries on VPC security group membership. || vpcSecurityGroups.[].status
Optional | string
| | vpcSecurityGroups.[].vpcSecurityGroupID
Optional | string
|