Package software.amazon.awssdk.services.rds.model

Class ModifyDbProxyRequest

    • Method Detail

      • dbProxyName

        public final String dbProxyName()

        The identifier for the DBProxy to modify.

        Returns:
        The identifier for the DBProxy to modify.

      • newDBProxyName

        public final String newDBProxyName()

        The new identifier for the DBProxy. 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 new identifier for the DBProxy. 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.

      • defaultAuthScheme

        public final DefaultAuthScheme defaultAuthScheme()

        The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.

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

        Returns:
        The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.
        See Also:
        DefaultAuthScheme

      • defaultAuthSchemeAsString

        public final String defaultAuthSchemeAsString()

        The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.

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

        Returns:
        The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.
        See Also:
        DefaultAuthScheme

      • 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 new authentication settings for the DBProxy.

        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 new authentication settings for the DBProxy.

      • requireTLS

        public final Boolean requireTLS()

        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, even if the associated database doesn't use TLS.

        Returns:
        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, even if the associated database doesn't use TLS.

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

        Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.

        Returns:
        Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.

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

      • hasSecurityGroups

        public final boolean hasSecurityGroups()
        For responses, this returns true if the service returned a value for the SecurityGroups 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.

      • securityGroups

        public final List<String> securityGroups()

        The new list of security groups for the DBProxy.

        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 hasSecurityGroups() method.

        Returns:
        The new list of security groups for the DBProxy.

      • 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