DBCluster is the Schema for the DBClusters API
Type
CRD
Group
rds.aws.crossplane.io
Version
v1alpha1
apiVersion: rds.aws.crossplane.io/v1alpha1
kind: DBCluster
DBClusterSpec defines the desired state of DBCluster
DBClusterParameters defines the desired state of DBCluster
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
DBClusterParameterGroupNameRef is a reference to a DBClusterParameterGroup used to set DBClusterParameterGroupName.
Policies for referencing.
DBClusterParameterGroupNameSelector selects a reference to a DBClusterParameterGroup used to set DBClusterParameterGroupName.
Policies for selection.
DBSubnetGroupNameRef is a reference to a DBSubnetGroup used to set DBSubnetGroupName.
Policies for referencing.
DBSubnetGroupNameSelector selects a reference to a DBSubnetGroup used to set DBSubnetGroupName.
Policies for selection.
DomainIAMRoleNameRef is a reference to an IAMRole used to set DomainIAMRoleName.
Policies for referencing.
DomainIAMRoleNameSelector selects a reference to an IAMRole used to set DomainIAMRoleName.
Policies for selection.
The list of log types that need to be enabled for exporting to CloudWatch Logs.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
-
Aurora MySQL - audit | error | general | slowquery
-
Aurora PostgreSQL - postgresql
-
RDS for MySQL - error | general | slowquery
-
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon Aurora User Guide.
KMSKeyIDRef is a reference to a KMS Key used to set KMSKeyID.
Policies for referencing.
KMSKeyIDSelector selects a reference to a KMS Key used to set KMSKeyID.
Policies for selection.
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
This parameter will be required in the following scenarios:
- The first cluster for a global Aurora cluster
- Any cluster as long as it doesn't belong to a global Aurora cluster
This parameter is required for creation of a primary cluster. However, it is not required when attaching a secondary regional cluster to an existing global cluster.
Constraints: Must contain from 8 to 41 characters.
RestoreFrom specifies the details of the backup to restore when creating a new DBCluster.
PointInTime specifies the details of the point in time restore.
S3 specifies the details of the S3 backup to restore from.
Snapshot specifies the details of the snapshot to restore from.
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for Cluster Type: Aurora DB clusters only
No description provided.
VPCSecurityGroupIDRefs are references to VPCSecurityGroups used to set the VPCSecurityGroupIDs.
Policies for referencing.
VPCSecurityGroupIDSelector selects references to VPCSecurityGroups used to set the VPCSecurityGroupIDs.
Policies for selection.
A list of VPC security groups that the DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.
DBClusterStatus defines the observed state of DBCluster.
DBClusterObservation defines the observed state of DBCluster
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
The custom endpoints associated with the DB cluster.
The list of DB instances that make up the DB cluster.
The list of option group memberships for this DB cluster.
The Active Directory Domain membership records associated with the DB cluster.
No description provided.
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html) in the Amazon Aurora User Guide.
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the Amazon Aurora User Guide.
Contains one or more identifiers of the read replicas associated with this DB cluster.
No description provided.
The list of VPC security groups that the DB cluster belongs to.
Conditions of the resource.
example-aurora-mysql-cluster
apiVersion: rds.aws.crossplane.io/v1alpha1
kind: DBCluster
metadata:
name: example-aurora-mysql-cluster
spec:
forProvider:
allowMajorVersionUpgrade: true
applyImmediately: true
databaseName: auroradb
dbClusterParameterGroupName: example-clusterparametergroup
engine: aurora-mysql
masterUserPasswordSecretRef:
key: password
name: example-aurora-mysql-cluster
namespace: crossplane-system
masterUsername: adminuser
region: us-east-1
skipFinalSnapshot: true
providerConfigRef:
name: example
writeConnectionSecretToRef:
name: example-aurora-mysql-cluster
namespace: default
test-cluster-eu-west-2
apiVersion: rds.aws.crossplane.io/v1alpha1
kind: DBCluster
metadata:
name: test-cluster-eu-west-2
spec:
forProvider:
applyImmediately: true
availabilityZones:
- eu-west-2a
- eu-west-2b
- eu-west-2c
backupRetentionPeriod: 10
dbClusterParameterGroupName: test-cluster-eu-west-2-aurora-pg
dbSubnetGroupName: db-subnet-group-name
enableCloudwatchLogsExports:
- audit
- error
- general
- slowquery
enablePerformanceInsights: true
engine: aurora-mysql
engineMode: provisioned
engineVersion: 8.0.mysql_aurora.3.03.0
globalClusterIdentifier: test-cluster
kmsKeyID: mrk-test-kms-id
masterUserPasswordSecretRef:
key: password
name: test-cluster-db-password
masterUsername: admin
region: eu-west-2
skipFinalSnapshot: true
storageEncrypted: true
vpcSecurityGroupIDs:
- vpc-sg-id
providerConfigRef:
name: default
writeConnectionSecretToRef:
name: test-cluster-eu-west-2-db-conn
test-cluster-us-west-2
apiVersion: rds.aws.crossplane.io/v1alpha1
kind: DBCluster
metadata:
name: test-cluster-us-west-2
spec:
forProvider:
applyImmediately: true
availabilityZones:
- us-west-2a
- us-west-2b
- us-west-2c
backupRetentionPeriod: 10
dbClusterParameterGroupName: test-cluster-us-west-2-aurora-pg
dbSubnetGroupName: moneywise_aurora_sg
enableCloudwatchLogsExports:
- audit
- error
- general
- slowquery
enablePerformanceInsights: true
engine: aurora-mysql
engineMode: provisioned
engineVersion: 8.0.mysql_aurora.3.03.0
globalClusterIdentifier: test-cluster
kmsKeyID: mrk-test-kms-id
region: us-west-2
skipFinalSnapshot: true
storageEncrypted: true
vpcSecurityGroupIDs:
- sg-081a9633ca227cac3
providerConfigRef:
name: default
writeConnectionSecretToRef:
name: test-cluster-us-west-2-db-conn