Package software.amazon.awscdk.cfnpropertymixins.services.rds

Class CfnDBProxyMixinProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • auth

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

    • auth

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

    • dbProxyName

      @Stability(Stable) public CfnDBProxyMixinProps.Builder dbProxyName(String dbProxyName)
      Sets the value of CfnDBProxyMixinProps.getDbProxyName()
      Parameters:
      dbProxyName - The identifier for the proxy. 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

    • debugLogging

      @Stability(Stable) public CfnDBProxyMixinProps.Builder debugLogging(Boolean debugLogging)
      Sets the value of CfnDBProxyMixinProps.getDebugLogging()
      Parameters:
      debugLogging - Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging , the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.
      Returns:
      this

    • debugLogging

      @Stability(Stable) public CfnDBProxyMixinProps.Builder debugLogging(IResolvable debugLogging)
      Sets the value of CfnDBProxyMixinProps.getDebugLogging()
      Parameters:
      debugLogging - Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging , the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.
      Returns:
      this

    • defaultAuthScheme

      @Stability(Stable) public CfnDBProxyMixinProps.Builder defaultAuthScheme(String defaultAuthScheme)
      Sets the value of CfnDBProxyMixinProps.getDefaultAuthScheme()
      Parameters:
      defaultAuthScheme - The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH . When set to IAM_AUTH , the proxy uses end-to-end IAM authentication to connect to the database.
      Returns:
      this

    • endpointNetworkType

      @Stability(Stable) public CfnDBProxyMixinProps.Builder endpointNetworkType(String endpointNetworkType)
      Sets the value of CfnDBProxyMixinProps.getEndpointNetworkType()
      Parameters:
      endpointNetworkType - The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

      Valid values:

      • IPV4 - The proxy endpoint supports IPv4 only.
      • IPV6 - The proxy endpoint supports IPv6 only.
      • DUAL - The proxy endpoint supports both IPv4 and IPv6.
      Returns:
      this

    • engineFamily

      @Stability(Stable) public CfnDBProxyMixinProps.Builder engineFamily(String engineFamily)
      Sets the value of CfnDBProxyMixinProps.getEngineFamily()
      Parameters:
      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. 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 .
      Returns:
      this

    • idleClientTimeout

      @Stability(Stable) public CfnDBProxyMixinProps.Builder idleClientTimeout(Number idleClientTimeout)
      Sets the value of CfnDBProxyMixinProps.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 CfnDBProxyMixinProps.Builder requireTls(Boolean requireTls)
      Sets the value of CfnDBProxyMixinProps.getRequireTls()
      Parameters:
      requireTls - 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 CfnDBProxyMixinProps.Builder requireTls(IResolvable requireTls)
      Sets the value of CfnDBProxyMixinProps.getRequireTls()
      Parameters:
      requireTls - 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

    • roleArn

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

    • roleArn

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

    • tags

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

    • targetConnectionNetworkType

      @Stability(Stable) public CfnDBProxyMixinProps.Builder targetConnectionNetworkType(String targetConnectionNetworkType)
      Sets the value of CfnDBProxyMixinProps.getTargetConnectionNetworkType()
      Parameters:
      targetConnectionNetworkType - The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.

      Valid values:

      • IPV4 - The proxy connects to the database using IPv4 only.
      • IPV6 - The proxy connects to the database using IPv6 only.
      Returns:
      this

    • vpcSecurityGroupIds

      @Stability(Stable) public CfnDBProxyMixinProps.Builder vpcSecurityGroupIds(List<? extends Object> vpcSecurityGroupIds)
      Sets the value of CfnDBProxyMixinProps.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

    • vpcSubnetIds

      @Stability(Stable) public CfnDBProxyMixinProps.Builder vpcSubnetIds(List<? extends Object> vpcSubnetIds)
      Sets the value of CfnDBProxyMixinProps.getVpcSubnetIds()
      Parameters:
      vpcSubnetIds - One or more VPC subnet IDs to associate with the new proxy.
      Returns:
      this

    • build

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