Package com.pulumi.aws.rds.inputs

Class ProxyState

  • public final class ProxyState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ProxyState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static ProxyState Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<ProxyAuthArgs>>> auths()  
      static ProxyState.Builder builder()  
      static ProxyState.Builder builder​(ProxyState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> debugLogging()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> defaultAuthScheme()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpointNetworkType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineFamily()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> idleClientTimeout()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> requireTls()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> roleArn()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> targetConnectionNetworkType()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSecurityGroupIds()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSubnetIds()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN for the proxy.

      • auths

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ProxyAuthArgs>>> auths()
        Returns:
        Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Required when `defaultAuthScheme` is `NONE` or unspecified. See the `auth` block below.

      • debugLogging

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> debugLogging()
        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.

      • defaultAuthScheme

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> defaultAuthScheme()
        Returns:
        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`. Defaults to `NONE`.

      • endpoint

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()
        Returns:
        Endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.

      • endpointNetworkType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpointNetworkType()
        Returns:
        Network type of the DB proxy endpoint. Valid values are `IPV4`, `IPV6` and `DUAL`. Defaults to `IPV4`. If `IPV6` is specified, the subnets associated with the proxy must be IPv6-only, and `targetConnectionNetworkType` must be `IPV6`.

      • engineFamily

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineFamily()
        Returns:
        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`. Valid values are `MYSQL`, `POSTGRESQL`, and `SQLSERVER`.

      • idleClientTimeout

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> idleClientTimeout()
        Returns:
        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.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS 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.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • requireTls

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> requireTls()
        Returns:
        Whether TLS encryption is required for connections to the proxy. Enabling this setting enforces encrypted TLS connections to the proxy.

      • roleArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> roleArn()
        Returns:
        ARN of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • targetConnectionNetworkType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> targetConnectionNetworkType()
        Returns:
        Network type that the proxy uses to connect to the target database. Valid values are `IPV4` and `IPV6`. Defaults to `IPV4`.

      • vpcSecurityGroupIds

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSecurityGroupIds()
        Returns:
        One or more VPC security group IDs to associate with the new proxy.

      • vpcSubnetIds

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSubnetIds()
        Returns:
        One or more VPC subnet IDs to associate with the new proxy.