You are viewing an outdated version of provider-aws.Go to Latest
crossplane-contrib/provider-aws@v0.49.1
DBCluster
rds.aws.crossplane.io
DBCluster
crossplane-contrib/provider-aws@v0.49.1rds.aws.crossplane.io

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

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

DBClusterSpec defines the desired state of DBCluster

forProvider
requiredobject
requiredobject

DBClusterParameters defines the desired state of DBCluster

array

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

object

DBClusterParameterGroupNameRef is a reference to a DBClusterParameterGroup used to set DBClusterParameterGroupName.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

DBClusterParameterGroupNameSelector selects a reference to a DBClusterParameterGroup used to set DBClusterParameterGroupName.

policy
object
object

Policies for selection.

resolve
string
object

DBSubnetGroupNameRef is a reference to a DBSubnetGroup used to set DBSubnetGroupName.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

DBSubnetGroupNameSelector selects a reference to a DBSubnetGroup used to set DBSubnetGroupName.

policy
object
object

Policies for selection.

resolve
string
domain
string
object

DomainIAMRoleNameRef is a reference to an IAMRole used to set DomainIAMRoleName.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

DomainIAMRoleNameSelector selects a reference to an IAMRole used to set DomainIAMRoleName.

policy
object
object

Policies for selection.

resolve
string
array

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.

engine
requiredstring
iops
integer
kmsKeyID
string
object

KMSKeyIDRef is a reference to a KMS Key used to set KMSKeyID.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

KMSKeyIDSelector selects a reference to a KMS Key used to set KMSKeyID.

policy
object
object

Policies for selection.

resolve
string
object

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.

key
requiredstring
name
requiredstring
namespace
requiredstring
port
integer
region
requiredstring
object

RestoreFrom specifies the details of the backup to restore when creating a new DBCluster.

object

PointInTime specifies the details of the point in time restore.

s3
object
object

S3 specifies the details of the S3 backup to restore from.

bucketName
requiredstring
ingestionRoleARN
requiredstring
prefix
string
sourceEngine
requiredstring
sourceEngineVersion
requiredstring
snapshot
object
object

Snapshot specifies the details of the snapshot to restore from.

snapshotIdentifier
requiredstring
source
requiredstring
object

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for Cluster Type: Aurora DB clusters only

object

No description provided.

tags
array
array

Tags to assign to the DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

key
string
value
string
array

VPCSecurityGroupIDRefs are references to VPCSecurityGroups used to set the VPCSecurityGroupIDs.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

VPCSecurityGroupIDSelector selects references to VPCSecurityGroups used to set the VPCSecurityGroupIDs.

policy
object
object

Policies for selection.

resolve
string
array

A list of VPC security groups that the DB cluster will belong to.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

array

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

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

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.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

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.

name
requiredstring
namespace
requiredstring
status
object
object

DBClusterStatus defines the observed state of DBCluster.

object

DBClusterObservation defines the observed state of DBCluster

array

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.

roleARN
string
status
string
capacity
integer
array

The custom endpoints associated with the DB cluster.

array

The list of DB instances that make up the DB cluster.

array

The list of option group memberships for this DB cluster.

array

The Active Directory Domain membership records associated with the DB cluster.

dnsIPs
array
array

No description provided.

domain
string
fQDN
string
oU
string
status
string
array

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.

endpoint
string
object

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.

multiAZ
boolean
array

Contains one or more identifiers of the read replicas associated with this DB cluster.

object

No description provided.

status
string
tagList
array
array

No description provided.

key
string
value
string
array

The list of VPC security groups that the DB cluster belongs to.

array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Discover the building blocks for your internal cloud platform.
© 2024 Upbound, Inc.
Solutions