JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.rds.model

Class CreateDBProxyRequest

    • Constructor Detail

      • CreateDBProxyRequest

        public CreateDBProxyRequest()
    • Method Detail

      • setDBProxyName

        public void setDBProxyName(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.

        Parameters:
        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.
      • getDBProxyName

        public String getDBProxyName()

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

        public CreateDBProxyRequest withDBProxyName(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • setEngineFamily

        public void setEngineFamily(String 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.

        Parameters:
        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.
        See Also:
        EngineFamily
      • getEngineFamily

        public String getEngineFamily()

        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.

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

        public CreateDBProxyRequest withEngineFamily(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EngineFamily
      • withEngineFamily

        public CreateDBProxyRequest withEngineFamily(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EngineFamily
      • getAuth

        public List<UserAuthConfig> getAuth()

        The authorization mechanism that the proxy uses.

        Returns:
        The authorization mechanism that the proxy uses.
      • setAuth

        public void setAuth(Collection<UserAuthConfig> auth)

        The authorization mechanism that the proxy uses.

        Parameters:
        auth - The authorization mechanism that the proxy uses.
      • withAuth

        public CreateDBProxyRequest withAuth(Collection<UserAuthConfig> auth)

        The authorization mechanism that the proxy uses.

        Parameters:
        auth - The authorization mechanism that the proxy uses.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setRoleArn

        public void setRoleArn(String roleArn)

        The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
      • getRoleArn

        public String getRoleArn()

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

        public CreateDBProxyRequest withRoleArn(String roleArn)

        The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getVpcSubnetIds

        public List<String> getVpcSubnetIds()

        One or more VPC subnet IDs to associate with the new proxy.

        Returns:
        One or more VPC subnet IDs to associate with the new proxy.
      • setVpcSubnetIds

        public void setVpcSubnetIds(Collection<String> vpcSubnetIds)

        One or more VPC subnet IDs to associate with the new proxy.

        Parameters:
        vpcSubnetIds - One or more VPC subnet IDs to associate with the new proxy.
      • withVpcSubnetIds

        public CreateDBProxyRequest withVpcSubnetIds(String... vpcSubnetIds)

        One or more VPC subnet IDs to associate with the new proxy.

        NOTE: This method appends the values to the existing list (if any). Use setVpcSubnetIds(java.util.Collection) or withVpcSubnetIds(java.util.Collection) if you want to override the existing values.

        Parameters:
        vpcSubnetIds - One or more VPC subnet IDs to associate with the new proxy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withVpcSubnetIds

        public CreateDBProxyRequest withVpcSubnetIds(Collection<String> vpcSubnetIds)

        One or more VPC subnet IDs to associate with the new proxy.

        Parameters:
        vpcSubnetIds - One or more VPC subnet IDs to associate with the new proxy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getVpcSecurityGroupIds

        public List<String> getVpcSecurityGroupIds()

        One or more VPC security group IDs to associate with the new proxy.

        Returns:
        One or more VPC security group IDs to associate with the new proxy.
      • setVpcSecurityGroupIds

        public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

        One or more VPC security group IDs to associate with the new proxy.

        Parameters:
        vpcSecurityGroupIds - One or more VPC security group IDs to associate with the new proxy.
      • withVpcSecurityGroupIds

        public CreateDBProxyRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)

        One or more VPC security group IDs to associate with the new proxy.

        NOTE: This method appends the values to the existing list (if any). Use setVpcSecurityGroupIds(java.util.Collection) or withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.

        Parameters:
        vpcSecurityGroupIds - One or more VPC security group IDs to associate with the new proxy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withVpcSecurityGroupIds

        public CreateDBProxyRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

        One or more VPC security group IDs to associate with the new proxy.

        Parameters:
        vpcSecurityGroupIds - One or more VPC security group IDs to associate with the new proxy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setRequireTLS

        public void setRequireTLS(Boolean requireTLS)

        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.

        Parameters:
        requireTLS - 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.
      • getRequireTLS

        public Boolean getRequireTLS()

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

        public CreateDBProxyRequest withRequireTLS(Boolean requireTLS)

        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.

        Parameters:
        requireTLS - 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:
        Returns a reference to this object so that method calls can be chained together.
      • isRequireTLS

        public Boolean isRequireTLS()

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

        public void setIdleClientTimeout(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.

        Parameters:
        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.
      • getIdleClientTimeout

        public Integer getIdleClientTimeout()

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

        public CreateDBProxyRequest withIdleClientTimeout(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • setDebugLogging

        public void setDebugLogging(Boolean debugLogging)

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

        Parameters:
        debugLogging - Specifies 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.
      • getDebugLogging

        public Boolean getDebugLogging()

        Specifies 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:
        Specifies 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.
      • withDebugLogging

        public CreateDBProxyRequest withDebugLogging(Boolean debugLogging)

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

        Parameters:
        debugLogging - Specifies 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:
        Returns a reference to this object so that method calls can be chained together.
      • isDebugLogging

        public Boolean isDebugLogging()

        Specifies 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:
        Specifies 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.
      • getTags

        public List<Tag> getTags()

        An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

        Returns:
        An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
      • setTags

        public void setTags(Collection<Tag> tags)

        An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

        Parameters:
        tags - An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
      • withTags

        public CreateDBProxyRequest withTags(Tag... tags)

        An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

        NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

        Parameters:
        tags - An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withTags

        public CreateDBProxyRequest withTags(Collection<Tag> tags)

        An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

        Parameters:
        tags - An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public 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
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /