An RDSInstance is a managed resource that represents an AWS Relational Database Service instance.
Type
CRD
Group
database.aws.crossplane.io
Version
v1beta1
apiVersion: database.aws.crossplane.io/v1beta1
kind: RDSInstance
An RDSInstanceSpec defines the desired state of an RDSInstance.
RDSInstanceParameters define the desired state of an AWS Relational Database Service instance.
Deprecated: This field will be removed. Use enableCloudwatchLogsExports instead.
CloudwatchLogsExportConfiguration is the configuration setting for the log types to be enabled for export to CloudWatch
Logs for a specific DB instance.
DisableLogTypes is the list of log types to disable.
EnableLogTypes is the list of log types to enable.
DBSecurityGroups is a list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
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.
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.
EnableCloudwatchLogsExports is the list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs (http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon Relational Database Service User Guide.
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 RDS instance. (If the RDS instance already exists, this property will be ignored.)
PointInTime specifies the details of the point in time restore.
S3 specifies the details of the S3 backup to restore from.
BucketNameRef is a reference to a Bucket used to set BucketName.
Policies for referencing.
BucketNameSelector selects a reference to a Bucket used to set BucketName.
Policies for selection.
IngestionRoleARNRef is a reference to a IAM Role used to set IngestionRoleARN.
Policies for referencing.
IngestionRoleARNSelector selects a reference to a IAM Role used to set IngestionRoleARN.
Policies for selection.
Snapshot specifies the details of the database snapshot to restore from.
ScalingConfiguration is the scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Tags. For more information, see Tagging Amazon RDS Resources (http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the Amazon RDS User Guide.
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.
VPCSecurityGroupIDs is a list of EC2 VPC security groups to associate with this DB instance. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster. Default: The default EC2 VPC security group for the DB subnet group's VPC.
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.
An RDSInstanceStatus represents the observed state of an RDSInstance.
RDSInstanceObservation is the representation of the current state that is observed.
DBParameterGroups provides the list of DB parameter groups applied to this DB instance.
DBSecurityGroups provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
DBSubnetGroup specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
Subnets contains a list of Subnet elements.
SubnetAvailabilityZone contains Availability Zone information. This data type is used as an element in the following data type:
- OrderableDBInstanceOption
DomainMemberships is the Active Directory Domain membership records associated with the DB instance.
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 Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) in the Amazon RDS User Guide.
Endpoint specifies the connection endpoint.
OptionGroupMemberships provides the list of option group memberships for this DB instance.
PendingModifiedValues specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
PendingCloudwatchLogsExports is 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.
LogTypesToDisable is list of log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
LogTypesToEnable is the log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
ReadReplicaDBClusterIdentifiers contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
ReadReplicaDBInstanceIdentifiers contains one or more identifiers of the Read Replicas associated with this DB instance.
StatusInfos is the status of a Read Replica. If the instance is not a Read Replica, this is blank.
VPCSecurityGroups provides a list of VPC security group elements that the DB instance belongs to.
Conditions of the resource.
example-rds
apiVersion: database.aws.crossplane.io/v1beta1
kind: RDSInstance
metadata:
name: example-rds
spec:
forProvider:
allocatedStorage: 20
applyModificationsImmediately: true
autoMinorVersionUpgrade: true
backupRetentionPeriod: 0
caCertificateIdentifier: rds-ca-2019
copyTagsToSnapshot: false
dbInstanceClass: db.t3.small
deletionProtection: false
enableIAMDatabaseAuthentication: false
enablePerformanceInsights: false
engine: mysql
engineVersion: 8.0.28
finalDBSnapshotIdentifier: muvaf-test
licenseModel: general-public-license
masterUsername: admin
multiAZ: true
port: 3306
publiclyAccessible: false
region: us-east-1
storageEncrypted: false
storageType: gp2
providerConfigRef:
name: example
writeConnectionSecretToRef:
name: 66258c8a-24ad-45e6-a79e-1d54c19d908c-mysqlserver
namespace: crossplane-system