Package 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("software.amazon.awssdk:codegen") public final class CreateDbProxyEndpointRequest extends RdsRequest implements ToCopyableBuilder<CreateDbProxyEndpointRequest.Builder,CreateDbProxyEndpointRequest>

  • Method Details

    • 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()

      The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read 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:
      The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
      See Also:

    • targetRoleAsString

      public final String targetRoleAsString()

      The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read 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:
      The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
      See Also:

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

    • endpointNetworkType

      public final EndpointNetworkType 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.

      Default: IPV4

      Constraints:

      • If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.

      • If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

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

      Returns:
      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.

      Default: IPV4

      Constraints:

      • If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.

      • If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

      See Also:

    • endpointNetworkTypeAsString

      public final String endpointNetworkTypeAsString()

      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.

      Default: IPV4

      Constraints:

      • If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.

      • If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

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

      Returns:
      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.

      Default: IPV4

      Constraints:

      • If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.

      • If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

      See Also:

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo