software.amazon.awssdk.services.rds.model

Interface DBProxyEndpoint.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DBProxyEndpoint.Builder,DBProxyEndpoint>, SdkBuilder<DBProxyEndpoint.Builder,DBProxyEndpoint>, SdkPojo

Enclosing class:

DBProxyEndpoint

public static interface DBProxyEndpoint.Builder
extends SdkPojo, CopyableBuilder<DBProxyEndpoint.Builder,DBProxyEndpoint>

Method Summary

Modifier and Type	Method and Description
DBProxyEndpoint.Builder	createdDate(Instant createdDate) The date and time when the DB proxy endpoint was first created.
DBProxyEndpoint.Builder	dbProxyEndpointArn(String dbProxyEndpointArn) The Amazon Resource Name (ARN) for the DB proxy endpoint.
DBProxyEndpoint.Builder	dbProxyEndpointName(String dbProxyEndpointName) The name for the DB proxy endpoint.
DBProxyEndpoint.Builder	dbProxyName(String dbProxyName) The identifier for the DB proxy that is associated with this DB proxy endpoint.
DBProxyEndpoint.Builder	endpoint(String endpoint) The endpoint that you can use to connect to the DB proxy.
DBProxyEndpoint.Builder	isDefault(Boolean isDefault) A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.
DBProxyEndpoint.Builder	status(DBProxyEndpointStatus status) The current status of this DB proxy endpoint.
DBProxyEndpoint.Builder	status(String status) The current status of this DB proxy endpoint.
DBProxyEndpoint.Builder	targetRole(DBProxyEndpointTargetRole targetRole) A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
DBProxyEndpoint.Builder	targetRole(String targetRole) A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
DBProxyEndpoint.Builder	vpcId(String vpcId) Provides the VPC ID of the DB proxy endpoint.
DBProxyEndpoint.Builder	vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) Provides a list of VPC security groups that the DB proxy endpoint belongs to.
DBProxyEndpoint.Builder	vpcSecurityGroupIds(String... vpcSecurityGroupIds) Provides a list of VPC security groups that the DB proxy endpoint belongs to.
DBProxyEndpoint.Builder	vpcSubnetIds(Collection<String> vpcSubnetIds) The EC2 subnet IDs for the DB proxy endpoint.
DBProxyEndpoint.Builder	vpcSubnetIds(String... vpcSubnetIds) The EC2 subnet IDs for the DB proxy endpoint.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

dbProxyEndpointName

DBProxyEndpoint.Builder dbProxyEndpointName(String dbProxyEndpointName)

The name for the DB proxy endpoint. 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.

Parameters:

dbProxyEndpointName - The name for the DB proxy endpoint. 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:

Returns a reference to this object so that method calls can be chained together.

dbProxyEndpointArn

DBProxyEndpoint.Builder dbProxyEndpointArn(String dbProxyEndpointArn)

The Amazon Resource Name (ARN) for the DB proxy endpoint.

Parameters:

dbProxyEndpointArn - The Amazon Resource Name (ARN) for the DB proxy endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

dbProxyName

DBProxyEndpoint.Builder dbProxyName(String dbProxyName)

The identifier for the DB proxy that is associated with this DB proxy endpoint.

Parameters:

dbProxyName - The identifier for the DB proxy that is associated with this DB proxy endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

DBProxyEndpoint.Builder status(String status)

The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

Parameters:

status - The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DBProxyEndpointStatus, DBProxyEndpointStatus

status

DBProxyEndpoint.Builder status(DBProxyEndpointStatus status)

The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

Parameters:

status - The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DBProxyEndpointStatus, DBProxyEndpointStatus

vpcId

DBProxyEndpoint.Builder vpcId(String vpcId)

Provides the VPC ID of the DB proxy endpoint.

Parameters:

vpcId - Provides the VPC ID of the DB proxy endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcSecurityGroupIds

DBProxyEndpoint.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

Provides a list of VPC security groups that the DB proxy endpoint belongs to.

Parameters:

vpcSecurityGroupIds - Provides a list of VPC security groups that the DB proxy endpoint belongs to.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcSecurityGroupIds

DBProxyEndpoint.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

Provides a list of VPC security groups that the DB proxy endpoint belongs to.

Parameters:

vpcSecurityGroupIds - Provides a list of VPC security groups that the DB proxy endpoint belongs to.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcSubnetIds

DBProxyEndpoint.Builder vpcSubnetIds(Collection<String> vpcSubnetIds)

The EC2 subnet IDs for the DB proxy endpoint.

Parameters:

vpcSubnetIds - The EC2 subnet IDs for the DB proxy endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcSubnetIds

DBProxyEndpoint.Builder vpcSubnetIds(String... vpcSubnetIds)

The EC2 subnet IDs for the DB proxy endpoint.

Parameters:

vpcSubnetIds - The EC2 subnet IDs for the DB proxy endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpoint

DBProxyEndpoint.Builder endpoint(String endpoint)

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

Parameters:

endpoint - The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdDate

DBProxyEndpoint.Builder createdDate(Instant createdDate)

The date and time when the DB proxy endpoint was first created.

Parameters:

createdDate - The date and time when the DB proxy endpoint was first created.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetRole

DBProxyEndpoint.Builder targetRole(String targetRole)

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

Parameters:

targetRole - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DBProxyEndpointTargetRole, DBProxyEndpointTargetRole

targetRole

DBProxyEndpoint.Builder targetRole(DBProxyEndpointTargetRole targetRole)

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

Parameters:

targetRole - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DBProxyEndpointTargetRole, DBProxyEndpointTargetRole

isDefault

DBProxyEndpoint.Builder isDefault(Boolean isDefault)

A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

Parameters:

isDefault - A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

Returns:

Returns a reference to this object so that method calls can be chained together.