DBInstance is the Schema for the DBInstances API
Type
CRD
Group
rds.aws.crossplane.io
Version
v1alpha1
apiVersion: rds.aws.crossplane.io/v1alpha1
kind: DBInstance
DBInstanceSpec defines the desired state of DBInstance
DBInstanceParameters defines the desired state of DBInstance
DBClusterIdentifierRef is a reference to a DBCluster used to set DBClusterIdentifier.
Policies for referencing.
DBClusterIdentifierSelector selects a reference to a DBCluster used to set DBClusterIdentifier.
Policies for selection.
DBParameterGroupNameRef is a reference to a DBParameterGroup used to set DBParameterGroupName.
Policies for referencing.
DBParameterGroupNameSelector selects a reference to a DBParameterGroup used to set DBParameterGroupName.
Policies for selection.
A list of database security groups to associate with this DB instance
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.
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
- Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
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. For more information, 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.
This setting doesn't apply to the following DB instances:
-
Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
-
RDS Custom
The following values are valid for each DB engine:
-
RDS for MariaDB - audit | error | general | slowquery
-
RDS for Microsoft SQL Server - agent | error
-
RDS for MySQL - audit | error | general | slowquery
-
RDS for Oracle - alert | audit | listener | trace | oemagent
-
RDS for PostgreSQL - postgresql | upgrade
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.
MonitoringRoleARNRef is a reference to an IAMRole used to set MonitoringRoleARN.
Policies for referencing.
MonitoringRoleARNSelector selects a reference to an IAMRole used to set MonitoringRoleARN.
Policies for selection.
RestoreFrom specifies the details of the backup to restore when creating a new DBInstance.
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.
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 Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
- If supplied, must match existing VpcSecurityGroupIds.
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.
DBInstanceStatus defines the observed state of DBInstance.
DBInstanceObservation defines the observed state of DBInstance
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
The details of the DB instance's server certificate.
The list of replicated automated backups associated with the DB instance.
The list of DB parameter groups applied to this DB instance.
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
No description provided.
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
A data type that represents an Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the Amazon RDS User Guide.
No description provided.
The Active Directory Domain membership records associated with the DB instance.
No description provided.
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) in the Amazon RDS User Guide.
The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating.
The listener connection endpoint for SQL Server Always On.
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.
The list of option group memberships for this DB instance.
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
No description provided.
No description provided.
The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
The identifiers of the read replicas associated with this DB instance.
The status of a read replica. If the DB instance isn't a read replica, the value is blank.
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
Conditions of the resource.
test-cluster-eu-west-2-0
apiVersion: rds.aws.crossplane.io/v1alpha1
kind: DBInstance
metadata:
name: test-cluster-eu-west-2-0
spec:
forProvider:
dbClusterIdentifier: test-cluster-eu-west-2
dbInstanceClass: db.r5.large
enablePerformanceInsights: true
engine: aurora-mysql
publiclyAccessible: true
region: eu-west-2
providerConfigRef:
name: default
example-dbinstance
apiVersion: rds.aws.crossplane.io/v1alpha1
kind: DBInstance
metadata:
name: example-dbinstance
spec:
forProvider:
allocatedStorage: 20
allowMajorVersionUpgrade: true
applyImmediately: true
autoMinorVersionUpgrade: true
autogeneratePassword: true
backupRetentionPeriod: 14
dbInstanceClass: db.t3.micro
dbName: example
dbParameterGroupName: example-dbparametergroup
deleteAutomatedBackups: false
engine: postgres
engineVersion: "12.9"
masterUserPasswordSecretRef:
key: password
name: example-dbinstance
namespace: crossplane-system
masterUsername: adminuser
preferredBackupWindow: 7:00-8:00
preferredMaintenanceWindow: Sat:8:00-Sat:11:00
publiclyAccessible: false
region: us-east-1
skipFinalSnapshot: true
storageEncrypted: false
storageType: gp2
providerConfigRef:
name: example
writeConnectionSecretToRef:
name: example-dbinstance-out
namespace: default
test-cluster-us-west-2-0
apiVersion: rds.aws.crossplane.io/v1alpha1
kind: DBInstance
metadata:
name: test-cluster-us-west-2-0
spec:
forProvider:
dbClusterIdentifier: test-cluster-us-west-2
dbInstanceClass: db.r5.large
enablePerformanceInsights: true
engine: aurora-mysql
publiclyAccessible: true
region: us-west-2
providerConfigRef:
name: default
example-aurora-mysql-instance
apiVersion: rds.aws.crossplane.io/v1alpha1
kind: DBInstance
metadata:
name: example-aurora-mysql-instance
spec:
forProvider:
dbClusterIdentifier: example-aurora-mysql-cluster
dbInstanceClass: db.t3.small
engine: aurora-mysql
region: us-east-1
providerConfigRef:
name: example
writeConnectionSecretToRef:
name: example-aurora-mysql-instance
namespace: default
test-cluster-eu-west-2-1
apiVersion: rds.aws.crossplane.io/v1alpha1
kind: DBInstance
metadata:
name: test-cluster-eu-west-2-1
spec:
forProvider:
dbClusterIdentifier: test-cluster-eu-west-2
dbInstanceClass: db.r5.large
enablePerformanceInsights: true
engine: aurora-mysql
publiclyAccessible: true
region: eu-west-2
providerConfigRef:
name: default