CreateDbProxyRequest (AWS Java SDK :: Services

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.CreateDbProxyRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateDbProxyRequest.Builder,CreateDbProxyRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateDbProxyRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateDbProxyRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<UserAuthConfig>`	`auth()` The authorization mechanism that the proxy uses.
`static CreateDbProxyRequest.Builder`	`builder()`
`String`	`dbProxyName()` The identifier for the proxy.
`Boolean`	`debugLogging()` Whether the proxy includes detailed information about SQL statements in its logs.
`EngineFamily`	`engineFamily()` The kinds of databases that the proxy can connect to.
`String`	`engineFamilyAsString()` The kinds of databases that the proxy can connect to.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAuth()` For responses, this returns true if the service returned a value for the Auth property.
`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.
`Integer`	`idleClientTimeout()` The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
`Boolean`	`requireTLS()` A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
`String`	`roleArn()` The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateDbProxyRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
`CreateDbProxyRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`vpcSecurityGroupIds()` One or more VPC security group IDs to associate with the new proxy.
`List<String>`	`vpcSubnetIds()` One or more VPC subnet IDs to associate with the new proxy.

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 identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services 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:
    
    The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services 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.
  - engineFamily
```
public final EngineFamily 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.
    
    If the service returns an enum value that is not available in the current SDK version, engineFamily will return EngineFamily.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineFamilyAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    EngineFamily
  - engineFamilyAsString
```
public final String engineFamilyAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, engineFamily will return EngineFamily.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineFamilyAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    EngineFamily
  - hasAuth
```
public final boolean hasAuth()
```
    For responses, this returns true if the service returned a value for the Auth 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.
  - auth
```
public final List<UserAuthConfig> auth()
```
    The authorization mechanism that the proxy uses.
    
    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 hasAuth() method.
    
    Returns:
    
    The authorization mechanism that the proxy uses.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
  - 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()
```
    One or more VPC subnet IDs to associate with the new 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:
    
    One or more VPC subnet IDs to associate with the new 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()
```
    One or more VPC security group IDs to associate with the new 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 hasVpcSecurityGroupIds() method.
    
    Returns:
    
    One or more VPC security group IDs to associate with the new proxy.
  - requireTLS
```
public final Boolean 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:
    
    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.
  - idleClientTimeout
```
public final Integer 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:
    
    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.
  - debugLogging
```
public final Boolean 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:
    
    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.
  - 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()
```
    An optional set of key-value pairs to associate arbitrary data of your choosing with the 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 hasTags() method.
    
    Returns:
    
    An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
  - toBuilder
```
public CreateDbProxyRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDbProxyRequest.Builder,CreateDbProxyRequest>
    
    Specified by:
    
    toBuilder in class RdsRequest
  - builder
```
public static CreateDbProxyRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDbProxyRequest.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

Class CreateDbProxyRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

dbProxyName

engineFamily

engineFamilyAsString

hasAuth

auth

roleArn

hasVpcSubnetIds

vpcSubnetIds

hasVpcSecurityGroupIds

vpcSecurityGroupIds

requireTLS

idleClientTimeout

debugLogging

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields