software.amazon.awssdk.services.rds.model

Class CreateDbProxyEndpointRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rds.model.RdsRequest

software.amazon.awssdk.services.rds.model.CreateDbProxyEndpointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDbProxyEndpointRequest.Builder,CreateDbProxyEndpointRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDbProxyEndpointRequest
extends RdsRequest
implements ToCopyableBuilder<CreateDbProxyEndpointRequest.Builder,CreateDbProxyEndpointRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDbProxyEndpointRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDbProxyEndpointRequest.Builder	builder()
String	dbProxyEndpointName() The name of the DB proxy endpoint to create.
String	dbProxyName() The name of the DB proxy associated with the DB proxy endpoint that you create.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasVpcSecurityGroupIds() For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
boolean	hasVpcSubnetIds() For responses, this returns true if the service returned a value for the VpcSubnetIds property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDbProxyEndpointRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Returns the value of the Tags property for this object.
DBProxyEndpointTargetRole	targetRole() A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
String	targetRoleAsString() A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
CreateDbProxyEndpointRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	vpcSecurityGroupIds() The VPC security group IDs for the DB proxy endpoint that you create.
List<String>	vpcSubnetIds() The VPC subnet IDs for the DB proxy endpoint that you create.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

dbProxyName

public final String dbProxyName()

The name of the DB proxy associated with the DB proxy endpoint that you create.

Returns:

The name of the DB proxy associated with the DB proxy endpoint that you create.

dbProxyEndpointName

public final String dbProxyEndpointName()

The name of the DB proxy endpoint to create.

Returns:

The name of the DB proxy endpoint to create.

hasVpcSubnetIds

public final boolean hasVpcSubnetIds()

For responses, this returns true if the service returned a value for the VpcSubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

vpcSubnetIds

public final List<String> vpcSubnetIds()

The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSubnetIds() method.

Returns:

The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.

hasVpcSecurityGroupIds

public final boolean hasVpcSecurityGroupIds()

For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

vpcSecurityGroupIds

public final List<String> vpcSecurityGroupIds()

The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.

Returns:

The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

targetRole

public final DBProxyEndpointTargetRole targetRole()

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

If the service returns an enum value that is not available in the current SDK version, targetRole will return DBProxyEndpointTargetRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetRoleAsString().

Returns:

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

See Also:

DBProxyEndpointTargetRole

targetRoleAsString

public final String targetRoleAsString()

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

If the service returns an enum value that is not available in the current SDK version, targetRole will return DBProxyEndpointTargetRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetRoleAsString().

Returns:

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

See Also:

DBProxyEndpointTargetRole

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

Returns the value of the Tags property for this object.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The value of the Tags property for this object.

toBuilder

public CreateDbProxyEndpointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDbProxyEndpointRequest.Builder,CreateDbProxyEndpointRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static CreateDbProxyEndpointRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDbProxyEndpointRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo