amazonka-rds-2.0: Amazon Relational Database Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RDS.ModifyDBProxy

Description

Changes the settings for an existing DB proxy.

Synopsis

Creating a Request

data ModifyDBProxy Source #

See: newModifyDBProxy smart constructor.

Constructors

ModifyDBProxy' 

Fields

  • auth :: Maybe [UserAuthConfig]

    The new authentication settings for the DBProxy.

  • debugLogging :: Maybe Bool

    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.

  • idleClientTimeout :: Maybe Int

    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.

  • newDBProxyName' :: Maybe Text

    The new identifier for the DBProxy. 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 :: Maybe Bool

    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, even if the associated database doesn't use TLS.

  • roleArn :: Maybe Text

    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

  • securityGroups :: Maybe [Text]

    The new list of security groups for the DBProxy.

  • dbProxyName :: Text

    The identifier for the DBProxy to modify.

Instances

Instances details
ToHeaders ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

ToPath ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

ToQuery ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

AWSRequest ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

Associated Types

type AWSResponse ModifyDBProxy #

Generic ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

Associated Types

type Rep ModifyDBProxy :: Type -> Type #

Read ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

Show ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

NFData ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

Methods

rnf :: ModifyDBProxy -> () #

Eq ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

Hashable ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

type AWSResponse ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

type Rep ModifyDBProxy Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

newModifyDBProxy Source #

Create a value of ModifyDBProxy 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:

ModifyDBProxy, modifyDBProxy_auth - The new authentication settings for the DBProxy.

ModifyDBProxy, modifyDBProxy_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.

ModifyDBProxy, modifyDBProxy_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:newDBProxyName':ModifyDBProxy', modifyDBProxy_newDBProxyName - The new identifier for the DBProxy. 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.

ModifyDBProxy, modifyDBProxy_requireTLS - 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, even if the associated database doesn't use TLS.

ModifyDBProxy, modifyDBProxy_roleArn - The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

$sel:securityGroups:ModifyDBProxy', modifyDBProxy_securityGroups - The new list of security groups for the DBProxy.

ModifyDBProxy, modifyDBProxy_dbProxyName - The identifier for the DBProxy to modify.

Request Lenses

modifyDBProxy_auth :: Lens' ModifyDBProxy (Maybe [UserAuthConfig]) Source #

The new authentication settings for the DBProxy.

modifyDBProxy_debugLogging :: Lens' ModifyDBProxy (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.

modifyDBProxy_idleClientTimeout :: Lens' ModifyDBProxy (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.

modifyDBProxy_newDBProxyName :: Lens' ModifyDBProxy (Maybe Text) Source #

The new identifier for the DBProxy. 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.

modifyDBProxy_requireTLS :: Lens' ModifyDBProxy (Maybe Bool) Source #

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, even if the associated database doesn't use TLS.

modifyDBProxy_roleArn :: Lens' ModifyDBProxy (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

modifyDBProxy_securityGroups :: Lens' ModifyDBProxy (Maybe [Text]) Source #

The new list of security groups for the DBProxy.

modifyDBProxy_dbProxyName :: Lens' ModifyDBProxy Text Source #

The identifier for the DBProxy to modify.

Destructuring the Response

data ModifyDBProxyResponse Source #

See: newModifyDBProxyResponse smart constructor.

Constructors

ModifyDBProxyResponse' 

Fields

Instances

Instances details
Generic ModifyDBProxyResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

Associated Types

type Rep ModifyDBProxyResponse :: Type -> Type #

Read ModifyDBProxyResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

Show ModifyDBProxyResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

NFData ModifyDBProxyResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

Methods

rnf :: ModifyDBProxyResponse -> () #

Eq ModifyDBProxyResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

type Rep ModifyDBProxyResponse Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBProxy

type Rep ModifyDBProxyResponse = D1 ('MetaData "ModifyDBProxyResponse" "Amazonka.RDS.ModifyDBProxy" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ModifyDBProxyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbProxy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBProxy)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyDBProxyResponse Source #

Create a value of ModifyDBProxyResponse 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:ModifyDBProxyResponse', modifyDBProxyResponse_dbProxy - The DBProxy object representing the new settings for the proxy.

$sel:httpStatus:ModifyDBProxyResponse', modifyDBProxyResponse_httpStatus - The response's http status code.

Response Lenses

modifyDBProxyResponse_dbProxy :: Lens' ModifyDBProxyResponse (Maybe DBProxy) Source #

The DBProxy object representing the new settings for the proxy.