Package software.amazon.awscdk.services.rds

Class CfnDBProxyProps.Builder

java.lang.Object
software.amazon.awscdk.services.rds.CfnDBProxyProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDBProxyProps>
Enclosing interface:
CfnDBProxyProps
@Stability(Stable) public static final class CfnDBProxyProps.Builder extends Object implements software.amazon.jsii.Builder<CfnDBProxyProps>
A builder for CfnDBProxyProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • auth

      @Stability(Stable) public CfnDBProxyProps.Builder auth(IResolvable auth)
      Sets the value of CfnDBProxyProps.getAuth()
      Parameters:
      auth - The authorization mechanism that the proxy uses. This parameter is required.
      Returns:
      this

    • auth

      @Stability(Stable) public CfnDBProxyProps.Builder auth(List<? extends Object> auth)
      Sets the value of CfnDBProxyProps.getAuth()
      Parameters:
      auth - The authorization mechanism that the proxy uses. This parameter is required.
      Returns:
      this

    • dbProxyName

      @Stability(Stable) public CfnDBProxyProps.Builder dbProxyName(String dbProxyName)
      Sets the value of CfnDBProxyProps.getDbProxyName()
      Parameters:
      dbProxyName - The identifier for the proxy. This parameter is required. This name must be unique for all proxies owned by your AWS account in the specified AWS 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.
      Returns:
      this

    • engineFamily

      @Stability(Stable) public CfnDBProxyProps.Builder engineFamily(String engineFamily)
      Sets the value of CfnDBProxyProps.getEngineFamily()
      Parameters:
      engineFamily - The kinds of databases that the proxy can connect to. This parameter is required. 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 .

      Valid values : MYSQL | POSTGRESQL | SQLSERVER

      Returns:
      this

    • roleArn

      @Stability(Stable) public CfnDBProxyProps.Builder roleArn(String roleArn)
      Sets the value of CfnDBProxyProps.getRoleArn()
      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager. This parameter is required.
      Returns:
      this

    • vpcSubnetIds

      @Stability(Stable) public CfnDBProxyProps.Builder vpcSubnetIds(List<String> vpcSubnetIds)
      Sets the value of CfnDBProxyProps.getVpcSubnetIds()
      Parameters:
      vpcSubnetIds - One or more VPC subnet IDs to associate with the new proxy. This parameter is required.
      Returns:
      this

    • debugLogging

      @Stability(Stable) public CfnDBProxyProps.Builder debugLogging(Boolean debugLogging)
      Sets the value of CfnDBProxyProps.getDebugLogging()
      Parameters:
      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.
      Returns:
      this

    • debugLogging

      @Stability(Stable) public CfnDBProxyProps.Builder debugLogging(IResolvable debugLogging)
      Sets the value of CfnDBProxyProps.getDebugLogging()
      Parameters:
      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.
      Returns:
      this

    • idleClientTimeout

      @Stability(Stable) public CfnDBProxyProps.Builder idleClientTimeout(Number idleClientTimeout)
      Sets the value of CfnDBProxyProps.getIdleClientTimeout()
      Parameters:
      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.
      Returns:
      this

    • requireTls

      @Stability(Stable) public CfnDBProxyProps.Builder requireTls(Boolean requireTls)
      Sets the value of CfnDBProxyProps.getRequireTls()
      Parameters:
      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.
      Returns:
      this

    • requireTls

      @Stability(Stable) public CfnDBProxyProps.Builder requireTls(IResolvable requireTls)
      Sets the value of CfnDBProxyProps.getRequireTls()
      Parameters:
      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.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnDBProxyProps.Builder tags(List<? extends CfnDBProxy.TagFormatProperty> tags)
      Sets the value of CfnDBProxyProps.getTags()
      Parameters:
      tags - An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
      Returns:
      this

    • vpcSecurityGroupIds

      @Stability(Stable) public CfnDBProxyProps.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)
      Sets the value of CfnDBProxyProps.getVpcSecurityGroupIds()
      Parameters:
      vpcSecurityGroupIds - One or more VPC security group IDs to associate with the new proxy. If you plan to update the resource, don't specify VPC security groups in a shared VPC.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDBProxyProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDBProxyProps>
      Returns:
      a new instance of CfnDBProxyProps
      Throws:
      NullPointerException - if any required attribute was not provided