Package software.amazon.awscdk.services.rds

Class DatabaseProxyEndpoint.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static DatabaseProxyEndpoint.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of DatabaseProxyEndpoint.Builder.

    • vpc

      @Stability(Stable) public DatabaseProxyEndpoint.Builder vpc(IVpc vpc)
      The VPC of the DB proxy endpoint.

      Parameters:
      vpc - The VPC of the DB proxy endpoint. This parameter is required.
      Returns:
      this

    • dbProxyEndpointName

      @Stability(Stable) public DatabaseProxyEndpoint.Builder dbProxyEndpointName(String dbProxyEndpointName)
      The name of the DB proxy endpoint.

      Default: - a CDK generated name

      Parameters:
      dbProxyEndpointName - The name of the DB proxy endpoint. This parameter is required.
      Returns:
      this

    • securityGroups

      @Stability(Stable) public DatabaseProxyEndpoint.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
      The VPC security groups to associate with the new proxy endpoint.

      Default: - Default security group for the VPC

      Parameters:
      securityGroups - The VPC security groups to associate with the new proxy endpoint. This parameter is required.
      Returns:
      this

    • targetRole

      @Stability(Stable) public DatabaseProxyEndpoint.Builder targetRole(ProxyEndpointTargetRole targetRole)
      A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

      Default: - ProxyEndpointTargetRole.READ_WRITE

      Parameters:
      targetRole - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. This parameter is required.
      Returns:
      this

    • vpcSubnets

      @Stability(Stable) public DatabaseProxyEndpoint.Builder vpcSubnets(SubnetSelection vpcSubnets)
      The subnets of DB proxy endpoint.

      Default: - the VPC default strategy if not specified.

      Parameters:
      vpcSubnets - The subnets of DB proxy endpoint. This parameter is required.
      Returns:
      this

    • dbProxy

      @Stability(Stable) public DatabaseProxyEndpoint.Builder dbProxy(IDatabaseProxy dbProxy)
      The DB proxy associated with the DB proxy endpoint.

      Parameters:
      dbProxy - The DB proxy associated with the DB proxy endpoint. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public DatabaseProxyEndpoint build()
      Specified by:
      build in interface software.amazon.jsii.Builder<DatabaseProxyEndpoint>
      Returns:
      a newly built instance of DatabaseProxyEndpoint.