Cluster is the Schema for the Clusters API. Manages an RDS Aurora Cluster or a RDS Multi-AZ DB Cluster
Type
CRD
Group
rds.aws.upbound.io
Version
apiVersion: rds.aws.upbound.io/v1beta1
kind: Cluster
ClusterSpec defines the desired state of Cluster
No description provided.
List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. We recommend specifying 3 AZs or using the if necessary. A maximum of 3 AZs can be configured.
– List of RDS Instances that are a part of this cluster
Reference to a ClusterParameterGroup in rds to populate dbClusterParameterGroupName.
Policies for referencing.
Selector for a ClusterParameterGroup in rds to populate dbClusterParameterGroupName.
Policies for selection.
Reference to a ParameterGroup in rds to populate dbInstanceParameterGroupName.
Policies for referencing.
Selector for a ParameterGroup in rds to populate dbInstanceParameterGroupName.
Policies for selection.
Reference to a SubnetGroup in rds to populate dbSubnetGroupName.
Policies for referencing.
Selector for a SubnetGroup in rds to populate dbSubnetGroupName.
Policies for selection.
Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
Reference to a Key in kms to populate kmsKeyId.
Policies for referencing.
Selector for a Key in kms to populate kmsKeyId.
Policies for selection.
Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true. Password for the master DB user. If you set autoGeneratePassword to true, the Secret referenced here will be created or updated with generated password if it does not already contain one.
Reference to a Key in kms to populate masterUserSecretKmsKeyId.
Policies for referencing.
Selector for a Key in kms to populate masterUserSecretKmsKeyId.
Policies for selection.
Nested attribute for point in time restore. More details below.
Reference to a Cluster in rds to populate sourceClusterIdentifier.
Policies for referencing.
Selector for a Cluster in rds to populate sourceClusterIdentifier.
Policies for selection.
Port on which the DB accepts connections
Reference to a Bucket in s3 to populate bucketName.
Policies for referencing.
Selector for a Bucket in s3 to populate bucketName.
Policies for selection.
Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
References to SecurityGroup in ec2 to populate vpcSecurityGroupIds.
Policies for referencing.
Selector for a list of SecurityGroup in ec2 to populate vpcSecurityGroupIds.
Policies for selection.
List of VPC security groups to associate with the Cluster
THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.
List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. We recommend specifying 3 AZs or using the if necessary. A maximum of 3 AZs can be configured.
– List of RDS Instances that are a part of this cluster
Reference to a ClusterParameterGroup in rds to populate dbClusterParameterGroupName.
Policies for referencing.
Selector for a ClusterParameterGroup in rds to populate dbClusterParameterGroupName.
Policies for selection.
Reference to a ParameterGroup in rds to populate dbInstanceParameterGroupName.
Policies for referencing.
Selector for a ParameterGroup in rds to populate dbInstanceParameterGroupName.
Policies for selection.
Reference to a SubnetGroup in rds to populate dbSubnetGroupName.
Policies for referencing.
Selector for a SubnetGroup in rds to populate dbSubnetGroupName.
Policies for selection.
Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
Reference to a Key in kms to populate kmsKeyId.
Policies for referencing.
Selector for a Key in kms to populate kmsKeyId.
Policies for selection.
Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true. Password for the master DB user. If you set autoGeneratePassword to true, the Secret referenced here will be created or updated with generated password if it does not already contain one.
Reference to a Key in kms to populate masterUserSecretKmsKeyId.
Policies for referencing.
Selector for a Key in kms to populate masterUserSecretKmsKeyId.
Policies for selection.
Nested attribute for point in time restore. More details below.
Reference to a Cluster in rds to populate sourceClusterIdentifier.
Policies for referencing.
Selector for a Cluster in rds to populate sourceClusterIdentifier.
Policies for selection.
Port on which the DB accepts connections
Reference to a Bucket in s3 to populate bucketName.
Policies for referencing.
Selector for a Bucket in s3 to populate bucketName.
Policies for selection.
Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
References to SecurityGroup in ec2 to populate vpcSecurityGroupIds.
Policies for referencing.
Selector for a list of SecurityGroup in ec2 to populate vpcSecurityGroupIds.
Policies for selection.
List of VPC security groups to associate with the Cluster
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.
ClusterStatus defines the observed state of Cluster.
No description provided.
List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. We recommend specifying 3 AZs or using the if necessary. A maximum of 3 AZs can be configured.
– List of RDS Instances that are a part of this cluster
Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
List of ARNs for the IAM roles to associate to the RDS Cluster.
Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
Nested attribute for point in time restore. More details below.
Port on which the DB accepts connections
Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
List of VPC security groups to associate with the Cluster
Conditions of the resource.
example-ce
apiVersion: rds.aws.upbound.io/v1beta1
kind: Cluster
metadata:
annotations:
meta.upbound.io/example-id: rds/v1beta1/clusterendpoint
labels:
testing.upbound.io/example-name: default-ce
name: example-ce
spec:
forProvider:
engine: aurora-postgresql
masterPasswordSecretRef:
key: password
name: sample-cluster-password
namespace: upbound-system
masterUsername: cpadmin
region: us-west-1
skipFinalSnapshot: true
writeConnectionSecretToRef:
name: sample-rds-cluster-secret
namespace: upbound-system
example-cas
apiVersion: rds.aws.upbound.io/v1beta1
kind: Cluster
metadata:
annotations:
meta.upbound.io/example-id: rds/v1beta1/clusteractivitystream
labels:
testing.upbound.io/example-name: default-cas
name: example-cas
spec:
forProvider:
engine: aurora-postgresql
masterPasswordSecretRef:
key: password
name: sample-cluster-password
namespace: upbound-system
masterUsername: cpadmin
region: us-west-1
skipFinalSnapshot: true
writeConnectionSecretToRef:
name: sample-rds-cluster-secret
namespace: upbound-system
example-cluster-cra
apiVersion: rds.aws.upbound.io/v1beta1
kind: Cluster
metadata:
annotations:
meta.upbound.io/example-id: rds/v1beta1/clusterroleassociation
labels:
testing.upbound.io/example-name: example-cra
name: example-cluster-cra
spec:
forProvider:
engine: aurora-postgresql
masterPasswordSecretRef:
key: password
name: sample-cluster-password
namespace: upbound-system
masterUsername: cpadmin
region: us-west-1
skipFinalSnapshot: true
writeConnectionSecretToRef:
name: sample-rds-cluster-secret
namespace: upbound-system
example
apiVersion: rds.aws.upbound.io/v1beta1
kind: Cluster
metadata:
annotations:
meta.upbound.io/example-id: rds/v1beta1/cluster
name: example
spec:
forProvider:
autoGeneratePassword: true
dbClusterParameterGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example-ci-cluster
dbInstanceParameterGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example-ci-cluster-instance
engine: aurora-postgresql
masterPasswordSecretRef:
key: password
name: sample-cluster-password
namespace: upbound-system
masterUsername: cpadmin
region: us-west-1
skipFinalSnapshot: true
writeConnectionSecretToRef:
name: sample-rds-cluster-secret
namespace: upbound-system
example-ci
apiVersion: rds.aws.upbound.io/v1beta1
kind: Cluster
metadata:
annotations:
meta.upbound.io/example-id: rds/v1beta1/clusterinstance
labels:
testing.upbound.io/example-name: example-ci
name: example-ci
spec:
forProvider:
dbClusterParameterGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: example-ci
engine: aurora-postgresql
engineVersion: "15.6"
masterPasswordSecretRef:
key: password
name: sample-cluster-password
namespace: upbound-system
masterUsername: cpadmin
preferredBackupWindow: 04:00-05:00
region: us-west-1
skipFinalSnapshot: true
writeConnectionSecretToRef:
name: sample-rds-cluster-secret
namespace: upbound-system
example-cs
apiVersion: rds.aws.upbound.io/v1beta1
kind: Cluster
metadata:
annotations:
meta.upbound.io/example-id: rds/v1beta1/clustersnapshot
labels:
testing.upbound.io/example-name: example-cs
name: example-cs
spec:
forProvider:
engine: aurora-postgresql
masterPasswordSecretRef:
key: password
name: sample-cluster-password
namespace: upbound-system
masterUsername: cpadmin
region: us-west-1
skipFinalSnapshot: true
writeConnectionSecretToRef:
name: sample-rds-cluster-secret
namespace: upbound-system