Cluster is the Schema for the Clusters API. Manages a DocumentDB Aurora Cluster
Type
CRD
Group
docdb.aws.upbound.io
Version
v1beta1
apiVersion: docdb.aws.upbound.io/v1beta1
kind: Cluster
ClusterSpec defines the desired state of Cluster
No description provided.
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
Reference to a ClusterParameterGroup in docdb to populate dbClusterParameterGroupName.
Policies for referencing.
Selector for a ClusterParameterGroup in docdb to populate dbClusterParameterGroupName.
Policies for selection.
List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
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 DocumentDB Naming Constraints. 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.
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.
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
Reference to a ClusterParameterGroup in docdb to populate dbClusterParameterGroupName.
Policies for referencing.
Selector for a ClusterParameterGroup in docdb to populate dbClusterParameterGroupName.
Policies for selection.
List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
Reference to a Key in kms to populate kmsKeyId.
Policies for referencing.
Selector for a Key in kms to populate kmsKeyId.
Policies for selection.
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.
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
– List of DocumentDB Instances that are a part of this cluster
List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
List of VPC security groups to associate with the Cluster
Conditions of the resource.
my-docdb-cluster
apiVersion: docdb.aws.upbound.io/v1beta1
kind: Cluster
metadata:
annotations:
meta.upbound.io/example-id: docdb/v1beta1/clustersnapshot
labels:
testing.upbound.io/example-name: example
name: my-docdb-cluster
spec:
forProvider:
backupRetentionPeriod: 5
engine: docdb
masterPasswordSecretRef:
key: secret
name: docdb-creds
namespace: upbound-system
masterUsername: foo
preferredBackupWindow: 07:00-09:00
region: us-west-2
skipFinalSnapshot: true
my-docdb-cluster
apiVersion: docdb.aws.upbound.io/v1beta1
kind: Cluster
metadata:
annotations:
meta.upbound.io/example-id: docdb/v1beta1/clusterinstance
labels:
testing.upbound.io/example-name: default
name: my-docdb-cluster
spec:
forProvider:
backupRetentionPeriod: 5
engine: docdb
masterPasswordSecretRef:
key: password
name: docdb-creds
namespace: upbound-system
masterUsername: foo
preferredBackupWindow: 07:00-09:00
preferredMaintenanceWindow: sun:10:30-sun:14:30
region: us-west-2
skipFinalSnapshot: true
my-docdb-cluster
apiVersion: docdb.aws.upbound.io/v1beta1
kind: Cluster
metadata:
annotations:
meta.upbound.io/example-id: docdb/v1beta1/eventsubscription
labels:
testing.upbound.io/example-name: example
name: my-docdb-cluster
spec:
forProvider:
backupRetentionPeriod: 5
engine: docdb
masterPasswordSecretRef:
key: secret
name: docdb-creds
namespace: upbound-system
masterUsername: foo
preferredBackupWindow: 07:00-09:00
region: us-west-2
skipFinalSnapshot: true
my-docdb-cluster
apiVersion: docdb.aws.upbound.io/v1beta1
kind: Cluster
metadata:
annotations:
meta.upbound.io/example-id: docdb/v1beta1/cluster
labels:
testing.upbound.io/example-name: docdb
name: my-docdb-cluster
spec:
forProvider:
autoGeneratePassword: true
backupRetentionPeriod: 5
dbClusterParameterGroupNameSelector:
matchLabels:
testing.upbound.io/example-name: docdb-cluster-test
engine: docdb
masterPasswordSecretRef:
key: password
name: docdb-creds
namespace: upbound-system
masterUsername: foo
preferredBackupWindow: 07:00-09:00
region: us-west-2
skipFinalSnapshot: true
writeConnectionSecretToRef:
name: docdb-cluster-secret
namespace: upbound-system
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.