1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPartial
konnect 2.8.1 published on Thursday, May 22, 2025 by kong

konnect.getGatewayPartial

Explore with Pulumi AI

konnect logo
konnect 2.8.1 published on Thursday, May 22, 2025 by kong

    Using getGatewayPartial

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGatewayPartial(args: GetGatewayPartialArgs, opts?: InvokeOptions): Promise<GetGatewayPartialResult>
    function getGatewayPartialOutput(args: GetGatewayPartialOutputArgs, opts?: InvokeOptions): Output<GetGatewayPartialResult>
    def get_gateway_partial(control_plane_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetGatewayPartialResult
    def get_gateway_partial_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPartialResult]
    func LookupGatewayPartial(ctx *Context, args *LookupGatewayPartialArgs, opts ...InvokeOption) (*LookupGatewayPartialResult, error)
    func LookupGatewayPartialOutput(ctx *Context, args *LookupGatewayPartialOutputArgs, opts ...InvokeOption) LookupGatewayPartialResultOutput

    > Note: This function is named LookupGatewayPartial in the Go SDK.

    public static class GetGatewayPartial 
    {
        public static Task<GetGatewayPartialResult> InvokeAsync(GetGatewayPartialArgs args, InvokeOptions? opts = null)
        public static Output<GetGatewayPartialResult> Invoke(GetGatewayPartialInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGatewayPartialResult> getGatewayPartial(GetGatewayPartialArgs args, InvokeOptions options)
    public static Output<GetGatewayPartialResult> getGatewayPartial(GetGatewayPartialArgs args, InvokeOptions options)
    
    fn::invoke:
      function: konnect:index/getGatewayPartial:getGatewayPartial
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getGatewayPartial Result

    The following output properties are available:

    Supporting Types

    GetGatewayPartialRedisCe

    Config GetGatewayPartialRedisCeConfig
    Redis-CE configuration
    CreatedAt double
    Unix epoch when the resource was created.
    Id string
    Name string
    Tags List<string>
    UpdatedAt double
    Unix epoch when the resource was last updated.
    Config GetGatewayPartialRedisCeConfig
    Redis-CE configuration
    CreatedAt float64
    Unix epoch when the resource was created.
    Id string
    Name string
    Tags []string
    UpdatedAt float64
    Unix epoch when the resource was last updated.
    config GetGatewayPartialRedisCeConfig
    Redis-CE configuration
    createdAt Double
    Unix epoch when the resource was created.
    id String
    name String
    tags List<String>
    updatedAt Double
    Unix epoch when the resource was last updated.
    config GetGatewayPartialRedisCeConfig
    Redis-CE configuration
    createdAt number
    Unix epoch when the resource was created.
    id string
    name string
    tags string[]
    updatedAt number
    Unix epoch when the resource was last updated.
    config GetGatewayPartialRedisCeConfig
    Redis-CE configuration
    created_at float
    Unix epoch when the resource was created.
    id str
    name str
    tags Sequence[str]
    updated_at float
    Unix epoch when the resource was last updated.
    config Property Map
    Redis-CE configuration
    createdAt Number
    Unix epoch when the resource was created.
    id String
    name String
    tags List<String>
    updatedAt Number
    Unix epoch when the resource was last updated.

    GetGatewayPartialRedisCeConfig

    Database double
    Database to use for the Redis connection when using the redis strategy
    Host string
    Redis host.
    Password string
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    Port double
    Redis port.
    ServerName string
    Server name for SSL verification.
    Ssl bool
    If set to true, uses SSL to connect to Redis.
    SslVerify bool
    If set to true, verifies the validity of the server SSL certificate.
    Timeout double
    Connection timeout.
    Username string
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.
    Database float64
    Database to use for the Redis connection when using the redis strategy
    Host string
    Redis host.
    Password string
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    Port float64
    Redis port.
    ServerName string
    Server name for SSL verification.
    Ssl bool
    If set to true, uses SSL to connect to Redis.
    SslVerify bool
    If set to true, verifies the validity of the server SSL certificate.
    Timeout float64
    Connection timeout.
    Username string
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.
    database Double
    Database to use for the Redis connection when using the redis strategy
    host String
    Redis host.
    password String
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port Double
    Redis port.
    serverName String
    Server name for SSL verification.
    ssl Boolean
    If set to true, uses SSL to connect to Redis.
    sslVerify Boolean
    If set to true, verifies the validity of the server SSL certificate.
    timeout Double
    Connection timeout.
    username String
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.
    database number
    Database to use for the Redis connection when using the redis strategy
    host string
    Redis host.
    password string
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port number
    Redis port.
    serverName string
    Server name for SSL verification.
    ssl boolean
    If set to true, uses SSL to connect to Redis.
    sslVerify boolean
    If set to true, verifies the validity of the server SSL certificate.
    timeout number
    Connection timeout.
    username string
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.
    database float
    Database to use for the Redis connection when using the redis strategy
    host str
    Redis host.
    password str
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port float
    Redis port.
    server_name str
    Server name for SSL verification.
    ssl bool
    If set to true, uses SSL to connect to Redis.
    ssl_verify bool
    If set to true, verifies the validity of the server SSL certificate.
    timeout float
    Connection timeout.
    username str
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.
    database Number
    Database to use for the Redis connection when using the redis strategy
    host String
    Redis host.
    password String
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port Number
    Redis port.
    serverName String
    Server name for SSL verification.
    ssl Boolean
    If set to true, uses SSL to connect to Redis.
    sslVerify Boolean
    If set to true, verifies the validity of the server SSL certificate.
    timeout Number
    Connection timeout.
    username String
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.

    GetGatewayPartialRedisEe

    Config GetGatewayPartialRedisEeConfig
    Redis-EE configuration
    CreatedAt double
    Unix epoch when the resource was created.
    Id string
    Name string
    Tags List<string>
    UpdatedAt double
    Unix epoch when the resource was last updated.
    Config GetGatewayPartialRedisEeConfig
    Redis-EE configuration
    CreatedAt float64
    Unix epoch when the resource was created.
    Id string
    Name string
    Tags []string
    UpdatedAt float64
    Unix epoch when the resource was last updated.
    config GetGatewayPartialRedisEeConfig
    Redis-EE configuration
    createdAt Double
    Unix epoch when the resource was created.
    id String
    name String
    tags List<String>
    updatedAt Double
    Unix epoch when the resource was last updated.
    config GetGatewayPartialRedisEeConfig
    Redis-EE configuration
    createdAt number
    Unix epoch when the resource was created.
    id string
    name string
    tags string[]
    updatedAt number
    Unix epoch when the resource was last updated.
    config GetGatewayPartialRedisEeConfig
    Redis-EE configuration
    created_at float
    Unix epoch when the resource was created.
    id str
    name str
    tags Sequence[str]
    updated_at float
    Unix epoch when the resource was last updated.
    config Property Map
    Redis-EE configuration
    createdAt Number
    Unix epoch when the resource was created.
    id String
    name String
    tags List<String>
    updatedAt Number
    Unix epoch when the resource was last updated.

    GetGatewayPartialRedisEeConfig

    ClusterMaxRedirections double
    Maximum retry attempts for redirection.
    ClusterNodes List<GetGatewayPartialRedisEeConfigClusterNode>
    Cluster addresses for Redis connections using the redis strategy.
    ConnectTimeout double
    Connect timeout.
    ConnectionIsProxied bool
    If the connection to Redis is proxied, e.g., Envoy.
    Database double
    Database index.
    Host string
    Redis host.
    KeepaliveBacklog double
    Limits the total number of opened connections for a pool.
    KeepalivePoolSize double
    Size limit for cosocket connection pool per worker process.
    Password string
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    Port double
    The port is only used when the host is set.
    ReadTimeout double
    Read timeout.
    SendTimeout double
    Send timeout.
    SentinelMaster string
    Sentinel master to use for Redis connections. Defining this implies using Redis Sentinel.
    SentinelNodes List<GetGatewayPartialRedisEeConfigSentinelNode>
    Sentinel addresses for Redis connections using the redis strategy. Array must have at least 1 element.
    SentinelPassword string
    Sentinel password to authenticate with a Redis Sentinel instance.
    SentinelRole string
    Sentinel role to use for Redis connections when redis strategy is used, implies using Redis Sentinel.
    SentinelUsername string
    Sentinel username to authenticate with a Redis Sentinel instance. Requires Redis v6.2.0+.
    ServerName string
    Server name for SSL verification.
    Ssl bool
    If set to true, uses SSL to connect to Redis.
    SslVerify bool
    If set to true, verifies the validity of the server SSL certificate.
    Username string
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.
    ClusterMaxRedirections float64
    Maximum retry attempts for redirection.
    ClusterNodes []GetGatewayPartialRedisEeConfigClusterNode
    Cluster addresses for Redis connections using the redis strategy.
    ConnectTimeout float64
    Connect timeout.
    ConnectionIsProxied bool
    If the connection to Redis is proxied, e.g., Envoy.
    Database float64
    Database index.
    Host string
    Redis host.
    KeepaliveBacklog float64
    Limits the total number of opened connections for a pool.
    KeepalivePoolSize float64
    Size limit for cosocket connection pool per worker process.
    Password string
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    Port float64
    The port is only used when the host is set.
    ReadTimeout float64
    Read timeout.
    SendTimeout float64
    Send timeout.
    SentinelMaster string
    Sentinel master to use for Redis connections. Defining this implies using Redis Sentinel.
    SentinelNodes []GetGatewayPartialRedisEeConfigSentinelNode
    Sentinel addresses for Redis connections using the redis strategy. Array must have at least 1 element.
    SentinelPassword string
    Sentinel password to authenticate with a Redis Sentinel instance.
    SentinelRole string
    Sentinel role to use for Redis connections when redis strategy is used, implies using Redis Sentinel.
    SentinelUsername string
    Sentinel username to authenticate with a Redis Sentinel instance. Requires Redis v6.2.0+.
    ServerName string
    Server name for SSL verification.
    Ssl bool
    If set to true, uses SSL to connect to Redis.
    SslVerify bool
    If set to true, verifies the validity of the server SSL certificate.
    Username string
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.
    clusterMaxRedirections Double
    Maximum retry attempts for redirection.
    clusterNodes List<GetGatewayPartialRedisEeConfigClusterNode>
    Cluster addresses for Redis connections using the redis strategy.
    connectTimeout Double
    Connect timeout.
    connectionIsProxied Boolean
    If the connection to Redis is proxied, e.g., Envoy.
    database Double
    Database index.
    host String
    Redis host.
    keepaliveBacklog Double
    Limits the total number of opened connections for a pool.
    keepalivePoolSize Double
    Size limit for cosocket connection pool per worker process.
    password String
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port Double
    The port is only used when the host is set.
    readTimeout Double
    Read timeout.
    sendTimeout Double
    Send timeout.
    sentinelMaster String
    Sentinel master to use for Redis connections. Defining this implies using Redis Sentinel.
    sentinelNodes List<GetGatewayPartialRedisEeConfigSentinelNode>
    Sentinel addresses for Redis connections using the redis strategy. Array must have at least 1 element.
    sentinelPassword String
    Sentinel password to authenticate with a Redis Sentinel instance.
    sentinelRole String
    Sentinel role to use for Redis connections when redis strategy is used, implies using Redis Sentinel.
    sentinelUsername String
    Sentinel username to authenticate with a Redis Sentinel instance. Requires Redis v6.2.0+.
    serverName String
    Server name for SSL verification.
    ssl Boolean
    If set to true, uses SSL to connect to Redis.
    sslVerify Boolean
    If set to true, verifies the validity of the server SSL certificate.
    username String
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.
    clusterMaxRedirections number
    Maximum retry attempts for redirection.
    clusterNodes GetGatewayPartialRedisEeConfigClusterNode[]
    Cluster addresses for Redis connections using the redis strategy.
    connectTimeout number
    Connect timeout.
    connectionIsProxied boolean
    If the connection to Redis is proxied, e.g., Envoy.
    database number
    Database index.
    host string
    Redis host.
    keepaliveBacklog number
    Limits the total number of opened connections for a pool.
    keepalivePoolSize number
    Size limit for cosocket connection pool per worker process.
    password string
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port number
    The port is only used when the host is set.
    readTimeout number
    Read timeout.
    sendTimeout number
    Send timeout.
    sentinelMaster string
    Sentinel master to use for Redis connections. Defining this implies using Redis Sentinel.
    sentinelNodes GetGatewayPartialRedisEeConfigSentinelNode[]
    Sentinel addresses for Redis connections using the redis strategy. Array must have at least 1 element.
    sentinelPassword string
    Sentinel password to authenticate with a Redis Sentinel instance.
    sentinelRole string
    Sentinel role to use for Redis connections when redis strategy is used, implies using Redis Sentinel.
    sentinelUsername string
    Sentinel username to authenticate with a Redis Sentinel instance. Requires Redis v6.2.0+.
    serverName string
    Server name for SSL verification.
    ssl boolean
    If set to true, uses SSL to connect to Redis.
    sslVerify boolean
    If set to true, verifies the validity of the server SSL certificate.
    username string
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.
    cluster_max_redirections float
    Maximum retry attempts for redirection.
    cluster_nodes Sequence[GetGatewayPartialRedisEeConfigClusterNode]
    Cluster addresses for Redis connections using the redis strategy.
    connect_timeout float
    Connect timeout.
    connection_is_proxied bool
    If the connection to Redis is proxied, e.g., Envoy.
    database float
    Database index.
    host str
    Redis host.
    keepalive_backlog float
    Limits the total number of opened connections for a pool.
    keepalive_pool_size float
    Size limit for cosocket connection pool per worker process.
    password str
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port float
    The port is only used when the host is set.
    read_timeout float
    Read timeout.
    send_timeout float
    Send timeout.
    sentinel_master str
    Sentinel master to use for Redis connections. Defining this implies using Redis Sentinel.
    sentinel_nodes Sequence[GetGatewayPartialRedisEeConfigSentinelNode]
    Sentinel addresses for Redis connections using the redis strategy. Array must have at least 1 element.
    sentinel_password str
    Sentinel password to authenticate with a Redis Sentinel instance.
    sentinel_role str
    Sentinel role to use for Redis connections when redis strategy is used, implies using Redis Sentinel.
    sentinel_username str
    Sentinel username to authenticate with a Redis Sentinel instance. Requires Redis v6.2.0+.
    server_name str
    Server name for SSL verification.
    ssl bool
    If set to true, uses SSL to connect to Redis.
    ssl_verify bool
    If set to true, verifies the validity of the server SSL certificate.
    username str
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.
    clusterMaxRedirections Number
    Maximum retry attempts for redirection.
    clusterNodes List<Property Map>
    Cluster addresses for Redis connections using the redis strategy.
    connectTimeout Number
    Connect timeout.
    connectionIsProxied Boolean
    If the connection to Redis is proxied, e.g., Envoy.
    database Number
    Database index.
    host String
    Redis host.
    keepaliveBacklog Number
    Limits the total number of opened connections for a pool.
    keepalivePoolSize Number
    Size limit for cosocket connection pool per worker process.
    password String
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port Number
    The port is only used when the host is set.
    readTimeout Number
    Read timeout.
    sendTimeout Number
    Send timeout.
    sentinelMaster String
    Sentinel master to use for Redis connections. Defining this implies using Redis Sentinel.
    sentinelNodes List<Property Map>
    Sentinel addresses for Redis connections using the redis strategy. Array must have at least 1 element.
    sentinelPassword String
    Sentinel password to authenticate with a Redis Sentinel instance.
    sentinelRole String
    Sentinel role to use for Redis connections when redis strategy is used, implies using Redis Sentinel.
    sentinelUsername String
    Sentinel username to authenticate with a Redis Sentinel instance. Requires Redis v6.2.0+.
    serverName String
    Server name for SSL verification.
    ssl Boolean
    If set to true, uses SSL to connect to Redis.
    sslVerify Boolean
    If set to true, verifies the validity of the server SSL certificate.
    username String
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. Requires Redis v6.0.0+.

    GetGatewayPartialRedisEeConfigClusterNode

    Ip string
    Cluster node IP.
    Port double
    Cluster node port.
    Ip string
    Cluster node IP.
    Port float64
    Cluster node port.
    ip String
    Cluster node IP.
    port Double
    Cluster node port.
    ip string
    Cluster node IP.
    port number
    Cluster node port.
    ip str
    Cluster node IP.
    port float
    Cluster node port.
    ip String
    Cluster node IP.
    port Number
    Cluster node port.

    GetGatewayPartialRedisEeConfigSentinelNode

    Host string
    Sentinel node hostname.
    Port double
    Sentinel node port.
    Host string
    Sentinel node hostname.
    Port float64
    Sentinel node port.
    host String
    Sentinel node hostname.
    port Double
    Sentinel node port.
    host string
    Sentinel node hostname.
    port number
    Sentinel node port.
    host str
    Sentinel node hostname.
    port float
    Sentinel node port.
    host String
    Sentinel node hostname.
    port Number
    Sentinel node port.

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    konnect 2.8.1 published on Thursday, May 22, 2025 by kong