DBProxy

rds.services.k8s.aws/v1alpha1

Type	Link
GoDoc	rds-controller/apis/v1alpha1#DBProxy

Metadata

Property	Value
Scope	Namespaced
Kind	`DBProxy`
ListKind	`DBProxyList`
Plural	`dbproxies`
Singular	`dbproxy`

The data structure representing a proxy managed by the RDS Proxy.

This data type is used as a response element in the DescribeDBProxies action.

Spec

auth:
- authScheme: string
  clientPasswordAuthType: string
  description: string
  iamAuth: string
  secretARN: string
  userName: string
debugLogging: boolean
engineFamily: string
idleClientTimeout: integer
name: string
requireTLS: boolean
roleARN: string
tags:
- key: string
  value: string
vpcSecurityGroupIDs:
- string
vpcSubnetIDs:
- string

Field	Description
auth Required	array The authorization mechanism that the proxy uses.
auth.[] Required	object Specifies the details of authentication used by a proxy to log in as a specific
database user.
auth.[].clientPasswordAuthType Optional	string
auth.[].description Optional	string
auth.[].iamAuth Optional	string
auth.[].secretARN Optional	string
auth.[].userName Optional	string
debugLogging Optional	boolean Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
engineFamily Required	string The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.
idleClientTimeout Optional	integer The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
name Required	string The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can’t end with a hyphen or contain two consecutive hyphens.
requireTLS Optional	boolean A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
roleARN Required	string The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
tags Optional	array An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
tags.[] Required	object Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the Amazon RDS User Guide. || tags.[].key
Optional | string
| | tags.[].value
Optional | string
| | vpcSecurityGroupIDs
Optional | array
One or more VPC security group IDs to associate with the new proxy. | | vpcSecurityGroupIDs.[]
Required | string
|| vpcSubnetIDs
Required | array
One or more VPC subnet IDs to associate with the new proxy. | | vpcSubnetIDs.[]
Required | string
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createdDate: string
endpoint: string
status: string
updatedDate: string
vpcID: string

Field	Description
ackResourceMetadata Optional	object All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn Optional	string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
conditions Optional	array All CRS managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[] Required	object Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition
createdDate Optional	string The date and time when the proxy was first created.
endpoint Optional	string The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
status Optional	string The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
updatedDate Optional	string The date and time when the proxy was last updated.
vpcID Optional	string Provides the VPC ID of the DB proxy.

DBProxy

Metadata#

Spec#

Status#

Metadata

Spec

Status