Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-aws.Go to Latest
crossplane-contrib/provider-aws@v0.38.0
RDSInstance
database.aws.crossplane.io
RDSInstance
crossplane-contrib/provider-aws@v0.38.0database.aws.crossplane.io

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

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

An RDSInstanceSpec defines the desired state of an RDSInstance.

forProvider
requiredobject
requiredobject

RDSInstanceParameters define the desired state of an AWS Relational Database Service instance.

object

CloudwatchLogsExportConfiguration is the configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

array

DisableLogTypes is the list of log types to disable.

array

EnableLogTypes is the list of log types to enable.

dbInstanceClass
requiredstring
dbName
string
array

DBSecurityGroups is a list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.

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

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.

engine
requiredstring
iops
integer
kmsKeyId
string
object

MasterPasswordSecretRef references the secret that contains the password used in the creation of this RDS instance. If no reference is given, a password will be auto-generated.

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

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

name
requiredstring
value
requiredstring
region
string
object

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.)

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.

object

BucketNameRef is a reference to a Bucket used to set BucketName.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

BucketNameSelector selects a reference to a Bucket used to set BucketName.

policy
object
object

Policies for selection.

resolve
string
object

IngestionRoleARNRef is a reference to a IAM Role used to set IngestionRoleARN.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

IngestionRoleARNSelector selects a reference to a IAM Role used to set IngestionRoleARN.

policy
object
object

Policies for selection.

resolve
string
prefix
string
sourceEngine
requiredstring
sourceEngineVersion
requiredstring
snapshot
object
object

Snapshot specifies the details of the database snapshot to restore from.

snapshotIdentifier
requiredstring
source
requiredstring
object

ScalingConfiguration is the scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

tags
array
array

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.

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

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.

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

ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef

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

An RDSInstanceStatus represents the observed state of an RDSInstance.

object

RDSInstanceObservation is the representation of the current state that is observed.

array

DBParameterGroups provides the list of DB parameter groups applied to this DB instance.

array

DBSecurityGroups provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

object

DBSubnetGroup specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

subnets
array
array

Subnets contains a list of Subnet elements.

object

SubnetAvailabilityZone contains Availability Zone information. This data type is used as an element in the following data type: * OrderableDBInstanceOption

name
string
vpcId
string
array

DomainMemberships is the Active Directory Domain membership records associated with the DB instance.

domain
string
fqdn
string
status
string
endpoint
object
object

Endpoint specifies the connection endpoint.

address
string
port
integer
array

OptionGroupMemberships provides the list of option group memberships for this DB instance.

object

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.

iops
integer
multiAZ
boolean
object

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.

array

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.

array

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.

port
integer
array

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

name
requiredstring
value
requiredstring
array

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.

array

ReadReplicaDBInstanceIdentifiers contains one or more identifiers of the Read Replicas associated with this DB instance.

array

StatusInfos is the status of a Read Replica. If the instance is not a Read Replica, this is blank.

message
string
normal
boolean
status
string
array

VPCSecurityGroups provides a list of VPC security group elements that the DB instance belongs to.

array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.