DBCluster - crossplane-contrib/provider-aws@v0.49.1

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events (https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) and Profiling Amazon DocumentDB Operations (https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).

engine

requiredstring

engineVersion

string

finalDBSnapshotIdentifier

string

globalClusterIdentifier

string

kmsKeyID

string

kmsKeyIDRef

object

TODO(haarchri): when resource is bumped to beta we will convert this field to kmsKeyIdRef

name

requiredstring

policy

object

Policies for referencing.

resolution

string

resolve

string

kmsKeyIDSelector

object

TODO(haarchri): when resource is bumped to beta we will convert this field to kmsKeyIdSelector

matchControllerRef

boolean

matchLabels

object

policy

object

Policies for selection.

resolution

string

resolve

string

masterUserPasswordSecretRef

object

MasterUserPasswordSecretRef references the secret that contains the password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

requiredstring

requiredstring

requiredstring

string

integer

string

preferredBackupWindow

string

preferredMaintenanceWindow

string

region

requiredstring

restoreFrom

object

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

pointInTime

object

PointInTime specifies the details of the point in time restore.

restoreTime

string

restoreType

string

sourceDBClusterIdentifier

string

useLatestRestorableTime

boolean

snapshot

object

Snapshot specifies the details of the snapshot to restore from.

requiredstring

requiredstring

boolean

string

boolean

array

The tags to be assigned to the cluster.

key

string

value

string

vpcSecurityGroupIDs

array

A list of EC2 VPC security groups to associate with this cluster.

vpcSecurityGroupIDsRefs

array

TODO(haarchri): when resource is bumped to beta we will convert this field to vpcSecurityGroupIdRefs

name

requiredstring

policy

object

Policies for referencing.

resolution

string

resolve

string

vpcSecurityGroupIDsSelector

object

TODO(haarchri): when resource is bumped to beta we will convert this field to vpcSecurityGroupIdSelector

matchControllerRef

boolean

matchLabels

object

policy

object

Policies for selection.

resolution

string

resolve

string

managementPolicies

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

providerConfigRef

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

Policies for referencing.

resolution

string

resolve

string

publishConnectionDetailsTo

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

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

name

requiredstring

policy

object

Policies for referencing.

resolution

string

resolve

string

metadata

object

Metadata is the metadata for connection secret.

object

object

string

requiredstring

writeConnectionSecretToRef

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

DBClusterStatus defines the observed state of DBCluster.

atProvider

object

DBClusterObservation defines the observed state of DBCluster

associatedRoles

array

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

string

string

string

string

string

string

array

Provides the list of instances that make up the cluster.

dbClusterParameterGroupStatus

string

dbInstanceIdentifier

string

isClusterWriter

boolean

promotionTier

integer

dbClusterParameterGroup

string

dbClusterResourceID

string

dbSubnetGroup

string

earliestRestorableTime

string

enabledCloudwatchLogsExports

array

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

string

string

string

string

boolean

string

readReplicaIdentifiers

array

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

readerEndpoint

string

replicationSourceIdentifier

string

status

string

vpcSecurityGroups

array

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

status

string

vpcSecurityGroupID

string

conditions

array

Conditions of the resource.

requiredstring

string

integer

requiredstring

requiredstring

requiredstring

integer

example-cluster-autogen-password

apiVersion: docdb.aws.crossplane.io/v1alpha1
kind: DBCluster
metadata:
  name: example-cluster-autogen-password
spec:
  forProvider:
    autogeneratePassword: true
    availabilityZones:
      - us-east-1b
      - us-east-1c
    dbClusterParameterGroupName: example-parameter-group
    dbSubnetGroupName: example-subnet-group
    engine: docdb
    masterUserPasswordSecretRef:
      key: password
      name: my-docdb-creds
      namespace: crossplane-system
    masterUsername: master
    region: us-east-1
    skipFinalSnapshot: true
    tags:
      - key: cluster
        value: my-cluster
    vpcSecurityGroupIDsRefs:
      - name: sample-cluster-sg
  providerConfigRef:
    name: example

example-cluster

apiVersion: docdb.aws.crossplane.io/v1alpha1
kind: DBCluster
metadata:
  name: example-cluster
spec:
  forProvider:
    availabilityZones:
      - us-east-1b
      - us-east-1c
    dbClusterParameterGroupName: example-parameter-group
    dbSubnetGroupName: example-subnet-group
    engine: docdb
    masterUserPasswordSecretRef:
      key: password
      name: my-docdb-creds
      namespace: crossplane-system
    masterUsername: master
    region: us-east-1
    skipFinalSnapshot: true
    tags:
      - key: cluster
        value: my-cluster
    vpcSecurityGroupIDsRefs:
      - name: sample-cluster-sg
  providerConfigRef:
    name: example

Marketplace

Discover the building blocks for your internal cloud platform.

Solutions

Learn

Company

More