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

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

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

DBInstanceSpec defines the desired state of DBInstance

forProvider
requiredobject
requiredobject

DBInstanceParameters defines the desired state of DBInstance

object

DBClusterIdentifierRef is a reference to a DBCluster used to set DBClusterIdentifier.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

DBClusterIdentifierSelector selects a reference to a DBCluster used to set DBClusterIdentifier.

policy
object
object

Policies for selection.

resolve
string
dbInstanceClass
requiredstring
dbName
string
object

DBParameterGroupNameRef is a reference to a DBParameterGroup used to set DBParameterGroupName.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

DBParameterGroupNameSelector selects a reference to a DBParameterGroup used to set DBParameterGroupName.

policy
object
object

Policies for selection.

resolve
string
array

A list of database security groups to associate with this DB instance

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
array

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

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
domainOu
string
array

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

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 "@".

Constraints: Must contain from 8 to 41 characters.

key
requiredstring
name
requiredstring
namespace
requiredstring
object

MonitoringRoleARNRef is a reference to an IAMRole used to set MonitoringRoleARN.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

MonitoringRoleARNSelector selects a reference to an IAMRole used to set MonitoringRoleARN.

policy
object
object

Policies for selection.

resolve
string
multiAZ
boolean
port
integer
array

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

name
string
value
string
region
requiredstring
object

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

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
tags
array
array

Tags to assign to the DB instance.

key
string
value
string
timezone
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 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.
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

DBInstanceStatus defines the observed state of DBInstance.

object

DBInstanceObservation defines the observed state of DBInstance

array

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

roleARN
string
status
string
object

The details of the DB instance's server certificate.

array

The list of replicated automated backups associated with the DB instance.

array

The list of DB parameter groups applied to this DB instance.

array

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

object

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

subnets
array
array

No description provided.

object

Contains Availability Zone information.

This data type is used as an element in the OrderableDBInstanceOption data type.

name
string
object

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.

arn
string
array

No description provided.

vpcID
string
array

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

dnsIPs
array
array

No description provided.

domain
string
fQDN
string
oU
string
status
string
array

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.

endpoint
object
object

The connection endpoint for the DB instance.

The endpoint might not be shown for instances with the status of creating.

address
string
port
integer
object

The listener connection endpoint for SQL Server Always On.

address
string
port
integer
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.

array

The list of option group memberships for this DB instance.

object

Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

engine
string
iops
integer
multiAZ
boolean
object

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.

array

No description provided.

array

No description provided.

port
integer
array

No description provided.

name
string
value
string
array

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.

array

The identifiers of the read replicas associated with this DB instance.

array

The status of a read replica. If the DB instance isn't a read replica, the value is blank.

message
string
normal
boolean
status
string
tagList
array
array

No description provided.

key
string
value
string
array

The list of Amazon EC2 VPC security groups that the DB instance 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