Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data DBProxy = DBProxy' {
- auth :: Maybe [UserAuthConfigInfo]
- createdDate :: Maybe ISO8601
- dbProxyArn :: Maybe Text
- dbProxyName :: Maybe Text
- debugLogging :: Maybe Bool
- endpoint :: Maybe Text
- engineFamily :: Maybe Text
- idleClientTimeout :: Maybe Int
- requireTLS :: Maybe Bool
- roleArn :: Maybe Text
- status :: Maybe DBProxyStatus
- updatedDate :: Maybe ISO8601
- vpcId :: Maybe Text
- vpcSecurityGroupIds :: Maybe [Text]
- vpcSubnetIds :: Maybe [Text]
- newDBProxy :: DBProxy
- dbProxy_auth :: Lens' DBProxy (Maybe [UserAuthConfigInfo])
- dbProxy_createdDate :: Lens' DBProxy (Maybe UTCTime)
- dbProxy_dbProxyArn :: Lens' DBProxy (Maybe Text)
- dbProxy_dbProxyName :: Lens' DBProxy (Maybe Text)
- dbProxy_debugLogging :: Lens' DBProxy (Maybe Bool)
- dbProxy_endpoint :: Lens' DBProxy (Maybe Text)
- dbProxy_engineFamily :: Lens' DBProxy (Maybe Text)
- dbProxy_idleClientTimeout :: Lens' DBProxy (Maybe Int)
- dbProxy_requireTLS :: Lens' DBProxy (Maybe Bool)
- dbProxy_roleArn :: Lens' DBProxy (Maybe Text)
- dbProxy_status :: Lens' DBProxy (Maybe DBProxyStatus)
- dbProxy_updatedDate :: Lens' DBProxy (Maybe UTCTime)
- dbProxy_vpcId :: Lens' DBProxy (Maybe Text)
- dbProxy_vpcSecurityGroupIds :: Lens' DBProxy (Maybe [Text])
- dbProxy_vpcSubnetIds :: Lens' DBProxy (Maybe [Text])
Documentation
The data structure representing a proxy managed by the RDS Proxy.
This data type is used as a response element in the DescribeDBProxies
action.
See: newDBProxy
smart constructor.
DBProxy' | |
|
Instances
newDBProxy :: DBProxy Source #
Create a value of DBProxy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:auth:DBProxy'
, dbProxy_auth
- One or more data structures specifying the authorization mechanism to
connect to the associated RDS DB instance or Aurora DB cluster.
$sel:createdDate:DBProxy'
, dbProxy_createdDate
- The date and time when the proxy was first created.
$sel:dbProxyArn:DBProxy'
, dbProxy_dbProxyArn
- The Amazon Resource Name (ARN) for the proxy.
$sel:dbProxyName:DBProxy'
, dbProxy_dbProxyName
- 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.
$sel:debugLogging:DBProxy'
, dbProxy_debugLogging
- 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.
$sel:endpoint:DBProxy'
, dbProxy_endpoint
- 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.
$sel:engineFamily:DBProxy'
, dbProxy_engineFamily
- 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. MYSQL
supports
Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL
supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER
supports RDS for Microsoft SQL Server databases.
$sel:idleClientTimeout:DBProxy'
, dbProxy_idleClientTimeout
- The number of seconds a connection to the proxy can have no activity
before the proxy drops the client connection. The proxy keeps the
underlying database connection open and puts it back into the connection
pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
$sel:requireTLS:DBProxy'
, dbProxy_requireTLS
- Indicates whether Transport Layer Security (TLS) encryption is required
for connections to the proxy.
$sel:roleArn:DBProxy'
, dbProxy_roleArn
- The Amazon Resource Name (ARN) for the IAM role that the proxy uses to
access Amazon Secrets Manager.
$sel:status:DBProxy'
, dbProxy_status
- 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.
$sel:updatedDate:DBProxy'
, dbProxy_updatedDate
- The date and time when the proxy was last updated.
$sel:vpcId:DBProxy'
, dbProxy_vpcId
- Provides the VPC ID of the DB proxy.
$sel:vpcSecurityGroupIds:DBProxy'
, dbProxy_vpcSecurityGroupIds
- Provides a list of VPC security groups that the proxy belongs to.
$sel:vpcSubnetIds:DBProxy'
, dbProxy_vpcSubnetIds
- The EC2 subnet IDs for the proxy.
dbProxy_auth :: Lens' DBProxy (Maybe [UserAuthConfigInfo]) Source #
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
dbProxy_createdDate :: Lens' DBProxy (Maybe UTCTime) Source #
The date and time when the proxy was first created.
dbProxy_dbProxyArn :: Lens' DBProxy (Maybe Text) Source #
The Amazon Resource Name (ARN) for the proxy.
dbProxy_dbProxyName :: Lens' DBProxy (Maybe Text) Source #
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.
dbProxy_debugLogging :: Lens' DBProxy (Maybe Bool) Source #
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.
dbProxy_endpoint :: Lens' DBProxy (Maybe Text) Source #
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.
dbProxy_engineFamily :: Lens' DBProxy (Maybe Text) Source #
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. MYSQL
supports
Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL
supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER
supports RDS for Microsoft SQL Server databases.
dbProxy_idleClientTimeout :: Lens' DBProxy (Maybe Int) Source #
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
dbProxy_requireTLS :: Lens' DBProxy (Maybe Bool) Source #
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
dbProxy_roleArn :: Lens' DBProxy (Maybe Text) Source #
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
dbProxy_status :: Lens' DBProxy (Maybe DBProxyStatus) Source #
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.
dbProxy_updatedDate :: Lens' DBProxy (Maybe UTCTime) Source #
The date and time when the proxy was last updated.