Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Creates a new DB proxy.
Synopsis
- data CreateDBProxy = CreateDBProxy' {
- debugLogging :: Maybe Bool
- requireTLS :: Maybe Bool
- idleClientTimeout :: Maybe Int
- vpcSecurityGroupIds :: Maybe [Text]
- tags :: Maybe [Tag]
- dbProxyName :: Text
- engineFamily :: EngineFamily
- auth :: [UserAuthConfig]
- roleArn :: Text
- vpcSubnetIds :: [Text]
- newCreateDBProxy :: Text -> EngineFamily -> Text -> CreateDBProxy
- createDBProxy_debugLogging :: Lens' CreateDBProxy (Maybe Bool)
- createDBProxy_requireTLS :: Lens' CreateDBProxy (Maybe Bool)
- createDBProxy_idleClientTimeout :: Lens' CreateDBProxy (Maybe Int)
- createDBProxy_vpcSecurityGroupIds :: Lens' CreateDBProxy (Maybe [Text])
- createDBProxy_tags :: Lens' CreateDBProxy (Maybe [Tag])
- createDBProxy_dbProxyName :: Lens' CreateDBProxy Text
- createDBProxy_engineFamily :: Lens' CreateDBProxy EngineFamily
- createDBProxy_auth :: Lens' CreateDBProxy [UserAuthConfig]
- createDBProxy_roleArn :: Lens' CreateDBProxy Text
- createDBProxy_vpcSubnetIds :: Lens' CreateDBProxy [Text]
- data CreateDBProxyResponse = CreateDBProxyResponse' {
- dbProxy :: Maybe DBProxy
- httpStatus :: Int
- newCreateDBProxyResponse :: Int -> CreateDBProxyResponse
- createDBProxyResponse_dbProxy :: Lens' CreateDBProxyResponse (Maybe DBProxy)
- createDBProxyResponse_httpStatus :: Lens' CreateDBProxyResponse Int
Creating a Request
data CreateDBProxy Source #
See: newCreateDBProxy
smart constructor.
CreateDBProxy' | |
|
Instances
:: Text | |
-> EngineFamily | |
-> Text | |
-> CreateDBProxy |
Create a value of CreateDBProxy
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:debugLogging:CreateDBProxy'
, createDBProxy_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:requireTLS:CreateDBProxy'
, createDBProxy_requireTLS
- 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.
$sel:idleClientTimeout:CreateDBProxy'
, createDBProxy_idleClientTimeout
- 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.
$sel:vpcSecurityGroupIds:CreateDBProxy'
, createDBProxy_vpcSecurityGroupIds
- One or more VPC security group IDs to associate with the new proxy.
$sel:tags:CreateDBProxy'
, createDBProxy_tags
- An optional set of key-value pairs to associate arbitrary data of your
choosing with the proxy.
$sel:dbProxyName:CreateDBProxy'
, createDBProxy_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. 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.
$sel:engineFamily:CreateDBProxy'
, createDBProxy_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. The engine family
applies to MySQL and PostgreSQL for both RDS and Aurora.
$sel:auth:CreateDBProxy'
, createDBProxy_auth
- The authorization mechanism that the proxy uses.
$sel:roleArn:CreateDBProxy'
, createDBProxy_roleArn
- The Amazon Resource Name (ARN) of the IAM role that the proxy uses to
access secrets in Amazon Web Services Secrets Manager.
$sel:vpcSubnetIds:CreateDBProxy'
, createDBProxy_vpcSubnetIds
- One or more VPC subnet IDs to associate with the new proxy.
Request Lenses
createDBProxy_debugLogging :: Lens' CreateDBProxy (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.
createDBProxy_requireTLS :: Lens' CreateDBProxy (Maybe Bool) Source #
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.
createDBProxy_idleClientTimeout :: Lens' CreateDBProxy (Maybe Int) Source #
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.
createDBProxy_vpcSecurityGroupIds :: Lens' CreateDBProxy (Maybe [Text]) Source #
One or more VPC security group IDs to associate with the new proxy.
createDBProxy_tags :: Lens' CreateDBProxy (Maybe [Tag]) Source #
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
createDBProxy_dbProxyName :: Lens' CreateDBProxy 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. 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.
createDBProxy_engineFamily :: Lens' CreateDBProxy EngineFamily 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. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
createDBProxy_auth :: Lens' CreateDBProxy [UserAuthConfig] Source #
The authorization mechanism that the proxy uses.
createDBProxy_roleArn :: Lens' CreateDBProxy Text Source #
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
createDBProxy_vpcSubnetIds :: Lens' CreateDBProxy [Text] Source #
One or more VPC subnet IDs to associate with the new proxy.
Destructuring the Response
data CreateDBProxyResponse Source #
See: newCreateDBProxyResponse
smart constructor.
CreateDBProxyResponse' | |
|
Instances
newCreateDBProxyResponse Source #
Create a value of CreateDBProxyResponse
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:dbProxy:CreateDBProxyResponse'
, createDBProxyResponse_dbProxy
- The DBProxy
structure corresponding to the new proxy.
$sel:httpStatus:CreateDBProxyResponse'
, createDBProxyResponse_httpStatus
- The response's http status code.
Response Lenses
createDBProxyResponse_dbProxy :: Lens' CreateDBProxyResponse (Maybe DBProxy) Source #
The DBProxy
structure corresponding to the new proxy.
createDBProxyResponse_httpStatus :: Lens' CreateDBProxyResponse Int Source #
The response's http status code.