Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginUpstreamOauth
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayPluginUpstreamOauth

Explore with Pulumi AI

konnect logo
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

    GatewayPluginUpstreamOauth Resource

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginUpstreamOauth;
import com.pulumi.konnect.GatewayPluginUpstreamOauthArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthConfigBehaviorArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthConfigCacheArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthConfigCacheMemoryArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthConfigCacheRedisArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthConfigClientArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthConfigOauthArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthConsumerGroupArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginUpstreamOauthServiceArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myGatewaypluginupstreamoauth = new GatewayPluginUpstreamOauth("myGatewaypluginupstreamoauth", GatewayPluginUpstreamOauthArgs.builder()
            .config(GatewayPluginUpstreamOauthConfigArgs.builder()
                .behavior(GatewayPluginUpstreamOauthConfigBehaviorArgs.builder()
                    .idpErrorResponseBodyTemplate("...my_idp_error_response_body_template...")
                    .idpErrorResponseContentType("...my_idp_error_response_content_type...")
                    .idpErrorResponseMessage("...my_idp_error_response_message...")
                    .idpErrorResponseStatusCode(576)
                    .purgeTokenOnUpstreamStatusCodes(373)
                    .upstreamAccessTokenHeaderName("...my_upstream_access_token_header_name...")
                    .build())
                .cache(GatewayPluginUpstreamOauthConfigCacheArgs.builder()
                    .defaultTtl(7.94)
                    .eagerlyExpire(9)
                    .memory(GatewayPluginUpstreamOauthConfigCacheMemoryArgs.builder()
                        .dictionaryName("...my_dictionary_name...")
                        .build())
                    .redis(GatewayPluginUpstreamOauthConfigCacheRedisArgs.builder()
                        .clusterMaxRedirections(10)
                        .clusterNodes(GatewayPluginUpstreamOauthConfigCacheRedisClusterNodeArgs.builder()
                            .ip("...my_ip...")
                            .port(20643)
                            .build())
                        .connectTimeout(305131733)
                        .connectionIsProxied(true)
                        .database(10)
                        .host("...my_host...")
                        .keepaliveBacklog(1047987263)
                        .keepalivePoolSize(459234090)
                        .password("...my_password...")
                        .port(35119)
                        .readTimeout(245223357)
                        .sendTimeout(1142057358)
                        .sentinelMaster("...my_sentinel_master...")
                        .sentinelNodes(GatewayPluginUpstreamOauthConfigCacheRedisSentinelNodeArgs.builder()
                            .host("...my_host...")
                            .port(31719)
                            .build())
                        .sentinelPassword("...my_sentinel_password...")
                        .sentinelRole("any")
                        .sentinelUsername("...my_sentinel_username...")
                        .serverName("...my_server_name...")
                        .ssl(true)
                        .sslVerify(true)
                        .username("...my_username...")
                        .build())
                    .strategy("memory")
                    .build())
                .client(GatewayPluginUpstreamOauthConfigClientArgs.builder()
                    .authMethod("none")
                    .clientSecretJwtAlg("HS256")
                    .httpProxy("...my_http_proxy...")
                    .httpProxyAuthorization("...my_http_proxy_authorization...")
                    .httpVersion(6.12)
                    .httpsProxy("...my_https_proxy...")
                    .httpsProxyAuthorization("...my_https_proxy_authorization...")
                    .keepAlive(true)
                    .noProxy("...my_no_proxy...")
                    .sslVerify(false)
                    .timeout(1421616738)
                    .build())
                .oauth(GatewayPluginUpstreamOauthConfigOauthArgs.builder()
                    .audience("...")
                    .clientId("...my_client_id...")
                    .clientSecret("...my_client_secret...")
                    .grantType("password")
                    .password("...my_password...")
                    .scopes("...")
                    .tokenEndpoint("...my_token_endpoint...")
                    .tokenHeaders(Map.of("key", serializeJson(
                        "value")))
                    .tokenPostArgs(Map.of("key", serializeJson(
                        "value")))
                    .username("...my_username...")
                    .build())
                .build())
            .consumer(GatewayPluginUpstreamOauthConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .consumerGroup(GatewayPluginUpstreamOauthConsumerGroupArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(false)
            .gatewayPluginUpstreamOauthId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginUpstreamOauthOrderingArgs.builder()
                .after(GatewayPluginUpstreamOauthOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginUpstreamOauthOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("http")
            .route(GatewayPluginUpstreamOauthRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginUpstreamOauthServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

    resources:
  myGatewaypluginupstreamoauth:
    type: konnect:GatewayPluginUpstreamOauth
    properties:
      config:
        behavior:
          idpErrorResponseBodyTemplate: '...my_idp_error_response_body_template...'
          idpErrorResponseContentType: '...my_idp_error_response_content_type...'
          idpErrorResponseMessage: '...my_idp_error_response_message...'
          idpErrorResponseStatusCode: 576
          purgeTokenOnUpstreamStatusCodes:
            - 373
          upstreamAccessTokenHeaderName: '...my_upstream_access_token_header_name...'
        cache:
          defaultTtl: 7.94
          eagerlyExpire: 9
          memory:
            dictionaryName: '...my_dictionary_name...'
          redis:
            clusterMaxRedirections: 10
            clusterNodes:
              - ip: '...my_ip...'
                port: 20643
            connectTimeout: 3.05131733e+08
            connectionIsProxied: true
            database: 10
            host: '...my_host...'
            keepaliveBacklog: 1.047987263e+09
            keepalivePoolSize: 4.5923409e+08
            password: '...my_password...'
            port: 35119
            readTimeout: 2.45223357e+08
            sendTimeout: 1.142057358e+09
            sentinelMaster: '...my_sentinel_master...'
            sentinelNodes:
              - host: '...my_host...'
                port: 31719
            sentinelPassword: '...my_sentinel_password...'
            sentinelRole: any
            sentinelUsername: '...my_sentinel_username...'
            serverName: '...my_server_name...'
            ssl: true
            sslVerify: true
            username: '...my_username...'
          strategy: memory
        client:
          authMethod: none
          clientSecretJwtAlg: HS256
          httpProxy: '...my_http_proxy...'
          httpProxyAuthorization: '...my_http_proxy_authorization...'
          httpVersion: 6.12
          httpsProxy: '...my_https_proxy...'
          httpsProxyAuthorization: '...my_https_proxy_authorization...'
          keepAlive: true
          noProxy: '...my_no_proxy...'
          sslVerify: false
          timeout: 1.421616738e+09
        oauth:
          audience:
            - '...'
          clientId: '...my_client_id...'
          clientSecret: '...my_client_secret...'
          grantType: password
          password: '...my_password...'
          scopes:
            - '...'
          tokenEndpoint: '...my_token_endpoint...'
          tokenHeaders:
            key:
              fn::toJSON: value
          tokenPostArgs:
            key:
              fn::toJSON: value
          username: '...my_username...'
      consumer:
        id: '...my_id...'
      consumerGroup:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: false
      gatewayPluginUpstreamOauthId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - http
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

    Create GatewayPluginUpstreamOauth Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GatewayPluginUpstreamOauth(name: string, args: GatewayPluginUpstreamOauthArgs, opts?: CustomResourceOptions);
    @overload
def GatewayPluginUpstreamOauth(resource_name: str,
                               args: GatewayPluginUpstreamOauthArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def GatewayPluginUpstreamOauth(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               config: Optional[GatewayPluginUpstreamOauthConfigArgs] = None,
                               control_plane_id: Optional[str] = None,
                               consumer: Optional[GatewayPluginUpstreamOauthConsumerArgs] = None,
                               consumer_group: Optional[GatewayPluginUpstreamOauthConsumerGroupArgs] = None,
                               enabled: Optional[bool] = None,
                               gateway_plugin_upstream_oauth_id: Optional[str] = None,
                               instance_name: Optional[str] = None,
                               ordering: Optional[GatewayPluginUpstreamOauthOrderingArgs] = None,
                               protocols: Optional[Sequence[str]] = None,
                               route: Optional[GatewayPluginUpstreamOauthRouteArgs] = None,
                               service: Optional[GatewayPluginUpstreamOauthServiceArgs] = None,
                               tags: Optional[Sequence[str]] = None)
    func NewGatewayPluginUpstreamOauth(ctx *Context, name string, args GatewayPluginUpstreamOauthArgs, opts ...ResourceOption) (*GatewayPluginUpstreamOauth, error)
    public GatewayPluginUpstreamOauth(string name, GatewayPluginUpstreamOauthArgs args, CustomResourceOptions? opts = null)
    public GatewayPluginUpstreamOauth(String name, GatewayPluginUpstreamOauthArgs args)
public GatewayPluginUpstreamOauth(String name, GatewayPluginUpstreamOauthArgs args, CustomResourceOptions options)

    type: konnect:GatewayPluginUpstreamOauth
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GatewayPluginUpstreamOauthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GatewayPluginUpstreamOauthArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GatewayPluginUpstreamOauthArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayPluginUpstreamOauthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayPluginUpstreamOauthArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gatewayPluginUpstreamOauthResource = new Konnect.GatewayPluginUpstreamOauth("gatewayPluginUpstreamOauthResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginUpstreamOauthConfigArgs
    {
        Behavior = new Konnect.Inputs.GatewayPluginUpstreamOauthConfigBehaviorArgs
        {
            IdpErrorResponseBodyTemplate = "string",
            IdpErrorResponseContentType = "string",
            IdpErrorResponseMessage = "string",
            IdpErrorResponseStatusCode = 0,
            PurgeTokenOnUpstreamStatusCodes = new[]
            {
                0,
            },
            UpstreamAccessTokenHeaderName = "string",
        },
        Cache = new Konnect.Inputs.GatewayPluginUpstreamOauthConfigCacheArgs
        {
            DefaultTtl = 0,
            EagerlyExpire = 0,
            Memory = new Konnect.Inputs.GatewayPluginUpstreamOauthConfigCacheMemoryArgs
            {
                DictionaryName = "string",
            },
            Redis = new Konnect.Inputs.GatewayPluginUpstreamOauthConfigCacheRedisArgs
            {
                ClusterMaxRedirections = 0,
                ClusterNodes = new[]
                {
                    new Konnect.Inputs.GatewayPluginUpstreamOauthConfigCacheRedisClusterNodeArgs
                    {
                        Ip = "string",
                        Port = 0,
                    },
                },
                ConnectTimeout = 0,
                ConnectionIsProxied = false,
                Database = 0,
                Host = "string",
                KeepaliveBacklog = 0,
                KeepalivePoolSize = 0,
                Password = "string",
                Port = 0,
                ReadTimeout = 0,
                SendTimeout = 0,
                SentinelMaster = "string",
                SentinelNodes = new[]
                {
                    new Konnect.Inputs.GatewayPluginUpstreamOauthConfigCacheRedisSentinelNodeArgs
                    {
                        Host = "string",
                        Port = 0,
                    },
                },
                SentinelPassword = "string",
                SentinelRole = "string",
                SentinelUsername = "string",
                ServerName = "string",
                Ssl = false,
                SslVerify = false,
                Username = "string",
            },
            Strategy = "string",
        },
        Client = new Konnect.Inputs.GatewayPluginUpstreamOauthConfigClientArgs
        {
            AuthMethod = "string",
            ClientSecretJwtAlg = "string",
            HttpProxy = "string",
            HttpProxyAuthorization = "string",
            HttpVersion = 0,
            HttpsProxy = "string",
            HttpsProxyAuthorization = "string",
            KeepAlive = false,
            NoProxy = "string",
            SslVerify = false,
            Timeout = 0,
        },
        Oauth = new Konnect.Inputs.GatewayPluginUpstreamOauthConfigOauthArgs
        {
            Audiences = new[]
            {
                "string",
            },
            ClientId = "string",
            ClientSecret = "string",
            GrantType = "string",
            Password = "string",
            Scopes = new[]
            {
                "string",
            },
            TokenEndpoint = "string",
            TokenHeaders = 
            {
                { "string", "string" },
            },
            TokenPostArgs = 
            {
                { "string", "string" },
            },
            Username = "string",
        },
    },
    ControlPlaneId = "string",
    Consumer = new Konnect.Inputs.GatewayPluginUpstreamOauthConsumerArgs
    {
        Id = "string",
    },
    ConsumerGroup = new Konnect.Inputs.GatewayPluginUpstreamOauthConsumerGroupArgs
    {
        Id = "string",
    },
    Enabled = false,
    GatewayPluginUpstreamOauthId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginUpstreamOauthOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginUpstreamOauthOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginUpstreamOauthOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginUpstreamOauthRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginUpstreamOauthServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

    example, err := konnect.NewGatewayPluginUpstreamOauth(ctx, "gatewayPluginUpstreamOauthResource", &konnect.GatewayPluginUpstreamOauthArgs{
Config: &.GatewayPluginUpstreamOauthConfigArgs{
Behavior: &.GatewayPluginUpstreamOauthConfigBehaviorArgs{
IdpErrorResponseBodyTemplate: pulumi.String("string"),
IdpErrorResponseContentType: pulumi.String("string"),
IdpErrorResponseMessage: pulumi.String("string"),
IdpErrorResponseStatusCode: pulumi.Float64(0),
PurgeTokenOnUpstreamStatusCodes: pulumi.Float64Array{
pulumi.Float64(0),
},
UpstreamAccessTokenHeaderName: pulumi.String("string"),
},
Cache: &.GatewayPluginUpstreamOauthConfigCacheArgs{
DefaultTtl: pulumi.Float64(0),
EagerlyExpire: pulumi.Float64(0),
Memory: &.GatewayPluginUpstreamOauthConfigCacheMemoryArgs{
DictionaryName: pulumi.String("string"),
},
Redis: &.GatewayPluginUpstreamOauthConfigCacheRedisArgs{
ClusterMaxRedirections: pulumi.Float64(0),
ClusterNodes: .GatewayPluginUpstreamOauthConfigCacheRedisClusterNodeArray{
&.GatewayPluginUpstreamOauthConfigCacheRedisClusterNodeArgs{
Ip: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
ConnectTimeout: pulumi.Float64(0),
ConnectionIsProxied: pulumi.Bool(false),
Database: pulumi.Float64(0),
Host: pulumi.String("string"),
KeepaliveBacklog: pulumi.Float64(0),
KeepalivePoolSize: pulumi.Float64(0),
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
ReadTimeout: pulumi.Float64(0),
SendTimeout: pulumi.Float64(0),
SentinelMaster: pulumi.String("string"),
SentinelNodes: .GatewayPluginUpstreamOauthConfigCacheRedisSentinelNodeArray{
&.GatewayPluginUpstreamOauthConfigCacheRedisSentinelNodeArgs{
Host: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
SentinelPassword: pulumi.String("string"),
SentinelRole: pulumi.String("string"),
SentinelUsername: pulumi.String("string"),
ServerName: pulumi.String("string"),
Ssl: pulumi.Bool(false),
SslVerify: pulumi.Bool(false),
Username: pulumi.String("string"),
},
Strategy: pulumi.String("string"),
},
Client: &.GatewayPluginUpstreamOauthConfigClientArgs{
AuthMethod: pulumi.String("string"),
ClientSecretJwtAlg: pulumi.String("string"),
HttpProxy: pulumi.String("string"),
HttpProxyAuthorization: pulumi.String("string"),
HttpVersion: pulumi.Float64(0),
HttpsProxy: pulumi.String("string"),
HttpsProxyAuthorization: pulumi.String("string"),
KeepAlive: pulumi.Bool(false),
NoProxy: pulumi.String("string"),
SslVerify: pulumi.Bool(false),
Timeout: pulumi.Float64(0),
},
Oauth: &.GatewayPluginUpstreamOauthConfigOauthArgs{
Audiences: pulumi.StringArray{
pulumi.String("string"),
},
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
GrantType: pulumi.String("string"),
Password: pulumi.String("string"),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
TokenEndpoint: pulumi.String("string"),
TokenHeaders: pulumi.StringMap{
"string": pulumi.String("string"),
},
TokenPostArgs: pulumi.StringMap{
"string": pulumi.String("string"),
},
Username: pulumi.String("string"),
},
},
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayPluginUpstreamOauthConsumerArgs{
Id: pulumi.String("string"),
},
ConsumerGroup: &.GatewayPluginUpstreamOauthConsumerGroupArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
GatewayPluginUpstreamOauthId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginUpstreamOauthOrderingArgs{
After: &.GatewayPluginUpstreamOauthOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginUpstreamOauthOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginUpstreamOauthRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginUpstreamOauthServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

    var gatewayPluginUpstreamOauthResource = new GatewayPluginUpstreamOauth("gatewayPluginUpstreamOauthResource", GatewayPluginUpstreamOauthArgs.builder()
    .config(GatewayPluginUpstreamOauthConfigArgs.builder()
        .behavior(GatewayPluginUpstreamOauthConfigBehaviorArgs.builder()
            .idpErrorResponseBodyTemplate("string")
            .idpErrorResponseContentType("string")
            .idpErrorResponseMessage("string")
            .idpErrorResponseStatusCode(0)
            .purgeTokenOnUpstreamStatusCodes(0)
            .upstreamAccessTokenHeaderName("string")
            .build())
        .cache(GatewayPluginUpstreamOauthConfigCacheArgs.builder()
            .defaultTtl(0)
            .eagerlyExpire(0)
            .memory(GatewayPluginUpstreamOauthConfigCacheMemoryArgs.builder()
                .dictionaryName("string")
                .build())
            .redis(GatewayPluginUpstreamOauthConfigCacheRedisArgs.builder()
                .clusterMaxRedirections(0)
                .clusterNodes(GatewayPluginUpstreamOauthConfigCacheRedisClusterNodeArgs.builder()
                    .ip("string")
                    .port(0)
                    .build())
                .connectTimeout(0)
                .connectionIsProxied(false)
                .database(0)
                .host("string")
                .keepaliveBacklog(0)
                .keepalivePoolSize(0)
                .password("string")
                .port(0)
                .readTimeout(0)
                .sendTimeout(0)
                .sentinelMaster("string")
                .sentinelNodes(GatewayPluginUpstreamOauthConfigCacheRedisSentinelNodeArgs.builder()
                    .host("string")
                    .port(0)
                    .build())
                .sentinelPassword("string")
                .sentinelRole("string")
                .sentinelUsername("string")
                .serverName("string")
                .ssl(false)
                .sslVerify(false)
                .username("string")
                .build())
            .strategy("string")
            .build())
        .client(GatewayPluginUpstreamOauthConfigClientArgs.builder()
            .authMethod("string")
            .clientSecretJwtAlg("string")
            .httpProxy("string")
            .httpProxyAuthorization("string")
            .httpVersion(0)
            .httpsProxy("string")
            .httpsProxyAuthorization("string")
            .keepAlive(false)
            .noProxy("string")
            .sslVerify(false)
            .timeout(0)
            .build())
        .oauth(GatewayPluginUpstreamOauthConfigOauthArgs.builder()
            .audiences("string")
            .clientId("string")
            .clientSecret("string")
            .grantType("string")
            .password("string")
            .scopes("string")
            .tokenEndpoint("string")
            .tokenHeaders(Map.of("string", "string"))
            .tokenPostArgs(Map.of("string", "string"))
            .username("string")
            .build())
        .build())
    .controlPlaneId("string")
    .consumer(GatewayPluginUpstreamOauthConsumerArgs.builder()
        .id("string")
        .build())
    .consumerGroup(GatewayPluginUpstreamOauthConsumerGroupArgs.builder()
        .id("string")
        .build())
    .enabled(false)
    .gatewayPluginUpstreamOauthId("string")
    .instanceName("string")
    .ordering(GatewayPluginUpstreamOauthOrderingArgs.builder()
        .after(GatewayPluginUpstreamOauthOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginUpstreamOauthOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginUpstreamOauthRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginUpstreamOauthServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

    gateway_plugin_upstream_oauth_resource = konnect.GatewayPluginUpstreamOauth("gatewayPluginUpstreamOauthResource",
    config={
        "behavior": {
            "idp_error_response_body_template": "string",
            "idp_error_response_content_type": "string",
            "idp_error_response_message": "string",
            "idp_error_response_status_code": 0,
            "purge_token_on_upstream_status_codes": [0],
            "upstream_access_token_header_name": "string",
        },
        "cache": {
            "default_ttl": 0,
            "eagerly_expire": 0,
            "memory": {
                "dictionary_name": "string",
            },
            "redis": {
                "cluster_max_redirections": 0,
                "cluster_nodes": [{
                    "ip": "string",
                    "port": 0,
                }],
                "connect_timeout": 0,
                "connection_is_proxied": False,
                "database": 0,
                "host": "string",
                "keepalive_backlog": 0,
                "keepalive_pool_size": 0,
                "password": "string",
                "port": 0,
                "read_timeout": 0,
                "send_timeout": 0,
                "sentinel_master": "string",
                "sentinel_nodes": [{
                    "host": "string",
                    "port": 0,
                }],
                "sentinel_password": "string",
                "sentinel_role": "string",
                "sentinel_username": "string",
                "server_name": "string",
                "ssl": False,
                "ssl_verify": False,
                "username": "string",
            },
            "strategy": "string",
        },
        "client": {
            "auth_method": "string",
            "client_secret_jwt_alg": "string",
            "http_proxy": "string",
            "http_proxy_authorization": "string",
            "http_version": 0,
            "https_proxy": "string",
            "https_proxy_authorization": "string",
            "keep_alive": False,
            "no_proxy": "string",
            "ssl_verify": False,
            "timeout": 0,
        },
        "oauth": {
            "audiences": ["string"],
            "client_id": "string",
            "client_secret": "string",
            "grant_type": "string",
            "password": "string",
            "scopes": ["string"],
            "token_endpoint": "string",
            "token_headers": {
                "string": "string",
            },
            "token_post_args": {
                "string": "string",
            },
            "username": "string",
        },
    },
    control_plane_id="string",
    consumer={
        "id": "string",
    },
    consumer_group={
        "id": "string",
    },
    enabled=False,
    gateway_plugin_upstream_oauth_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

    const gatewayPluginUpstreamOauthResource = new konnect.GatewayPluginUpstreamOauth("gatewayPluginUpstreamOauthResource", {
    config: {
        behavior: {
            idpErrorResponseBodyTemplate: "string",
            idpErrorResponseContentType: "string",
            idpErrorResponseMessage: "string",
            idpErrorResponseStatusCode: 0,
            purgeTokenOnUpstreamStatusCodes: [0],
            upstreamAccessTokenHeaderName: "string",
        },
        cache: {
            defaultTtl: 0,
            eagerlyExpire: 0,
            memory: {
                dictionaryName: "string",
            },
            redis: {
                clusterMaxRedirections: 0,
                clusterNodes: [{
                    ip: "string",
                    port: 0,
                }],
                connectTimeout: 0,
                connectionIsProxied: false,
                database: 0,
                host: "string",
                keepaliveBacklog: 0,
                keepalivePoolSize: 0,
                password: "string",
                port: 0,
                readTimeout: 0,
                sendTimeout: 0,
                sentinelMaster: "string",
                sentinelNodes: [{
                    host: "string",
                    port: 0,
                }],
                sentinelPassword: "string",
                sentinelRole: "string",
                sentinelUsername: "string",
                serverName: "string",
                ssl: false,
                sslVerify: false,
                username: "string",
            },
            strategy: "string",
        },
        client: {
            authMethod: "string",
            clientSecretJwtAlg: "string",
            httpProxy: "string",
            httpProxyAuthorization: "string",
            httpVersion: 0,
            httpsProxy: "string",
            httpsProxyAuthorization: "string",
            keepAlive: false,
            noProxy: "string",
            sslVerify: false,
            timeout: 0,
        },
        oauth: {
            audiences: ["string"],
            clientId: "string",
            clientSecret: "string",
            grantType: "string",
            password: "string",
            scopes: ["string"],
            tokenEndpoint: "string",
            tokenHeaders: {
                string: "string",
            },
            tokenPostArgs: {
                string: "string",
            },
            username: "string",
        },
    },
    controlPlaneId: "string",
    consumer: {
        id: "string",
    },
    consumerGroup: {
        id: "string",
    },
    enabled: false,
    gatewayPluginUpstreamOauthId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

    type: konnect:GatewayPluginUpstreamOauth
properties:
    config:
        behavior:
            idpErrorResponseBodyTemplate: string
            idpErrorResponseContentType: string
            idpErrorResponseMessage: string
            idpErrorResponseStatusCode: 0
            purgeTokenOnUpstreamStatusCodes:
                - 0
            upstreamAccessTokenHeaderName: string
        cache:
            defaultTtl: 0
            eagerlyExpire: 0
            memory:
                dictionaryName: string
            redis:
                clusterMaxRedirections: 0
                clusterNodes:
                    - ip: string
                      port: 0
                connectTimeout: 0
                connectionIsProxied: false
                database: 0
                host: string
                keepaliveBacklog: 0
                keepalivePoolSize: 0
                password: string
                port: 0
                readTimeout: 0
                sendTimeout: 0
                sentinelMaster: string
                sentinelNodes:
                    - host: string
                      port: 0
                sentinelPassword: string
                sentinelRole: string
                sentinelUsername: string
                serverName: string
                ssl: false
                sslVerify: false
                username: string
            strategy: string
        client:
            authMethod: string
            clientSecretJwtAlg: string
            httpProxy: string
            httpProxyAuthorization: string
            httpVersion: 0
            httpsProxy: string
            httpsProxyAuthorization: string
            keepAlive: false
            noProxy: string
            sslVerify: false
            timeout: 0
        oauth:
            audiences:
                - string
            clientId: string
            clientSecret: string
            grantType: string
            password: string
            scopes:
                - string
            tokenEndpoint: string
            tokenHeaders:
                string: string
            tokenPostArgs:
                string: string
            username: string
    consumer:
        id: string
    consumerGroup:
        id: string
    controlPlaneId: string
    enabled: false
    gatewayPluginUpstreamOauthId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

    GatewayPluginUpstreamOauth Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GatewayPluginUpstreamOauth resource accepts the following input properties:

    Config GatewayPluginUpstreamOauthConfig
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Consumer GatewayPluginUpstreamOauthConsumer
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    ConsumerGroup GatewayPluginUpstreamOauthConsumerGroup
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    Enabled bool
    Whether the plugin is applied.
    GatewayPluginUpstreamOauthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginUpstreamOauthOrdering
    Protocols List<string>
    A set of strings representing HTTP protocols.
    Route GatewayPluginUpstreamOauthRoute
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    Service GatewayPluginUpstreamOauthService
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    Tags List<string>
    An optional set of strings associated with the Plugin for grouping and filtering.
    Config GatewayPluginUpstreamOauthConfigArgs
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Consumer GatewayPluginUpstreamOauthConsumerArgs
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    ConsumerGroup GatewayPluginUpstreamOauthConsumerGroupArgs
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    Enabled bool
    Whether the plugin is applied.
    GatewayPluginUpstreamOauthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginUpstreamOauthOrderingArgs
    Protocols []string
    A set of strings representing HTTP protocols.
    Route GatewayPluginUpstreamOauthRouteArgs
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    Service GatewayPluginUpstreamOauthServiceArgs
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    Tags []string
    An optional set of strings associated with the Plugin for grouping and filtering.
    config GatewayPluginUpstreamOauthConfig
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginUpstreamOauthConsumer
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    consumerGroup GatewayPluginUpstreamOauthConsumerGroup
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    enabled Boolean
    Whether the plugin is applied.
    gatewayPluginUpstreamOauthId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginUpstreamOauthOrdering
    protocols List<String>
    A set of strings representing HTTP protocols.
    route GatewayPluginUpstreamOauthRoute
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    service GatewayPluginUpstreamOauthService
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    tags List<String>
    An optional set of strings associated with the Plugin for grouping and filtering.
    config GatewayPluginUpstreamOauthConfig
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginUpstreamOauthConsumer
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    consumerGroup GatewayPluginUpstreamOauthConsumerGroup
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    enabled boolean
    Whether the plugin is applied.
    gatewayPluginUpstreamOauthId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginUpstreamOauthOrdering
    protocols string[]
    A set of strings representing HTTP protocols.
    route GatewayPluginUpstreamOauthRoute
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    service GatewayPluginUpstreamOauthService
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    tags string[]
    An optional set of strings associated with the Plugin for grouping and filtering.
    config GatewayPluginUpstreamOauthConfigArgs
    control_plane_id str
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginUpstreamOauthConsumerArgs
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    consumer_group GatewayPluginUpstreamOauthConsumerGroupArgs
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    enabled bool
    Whether the plugin is applied.
    gateway_plugin_upstream_oauth_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginUpstreamOauthOrderingArgs
    protocols Sequence[str]
    A set of strings representing HTTP protocols.
    route GatewayPluginUpstreamOauthRouteArgs
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    service GatewayPluginUpstreamOauthServiceArgs
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    tags Sequence[str]
    An optional set of strings associated with the Plugin for grouping and filtering.
    config Property Map
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer Property Map
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    consumerGroup Property Map
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    enabled Boolean
    Whether the plugin is applied.
    gatewayPluginUpstreamOauthId String
    The ID of this resource.
    instanceName String
    ordering Property Map
    protocols List<String>
    A set of strings representing HTTP protocols.
    route Property Map
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    service Property Map
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    tags List<String>
    An optional set of strings associated with the Plugin for grouping and filtering.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GatewayPluginUpstreamOauth resource produces the following output properties:

    CreatedAt double
    Unix epoch when the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt double
    Unix epoch when the resource was last updated.
    CreatedAt float64
    Unix epoch when the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt float64
    Unix epoch when the resource was last updated.
    createdAt Double
    Unix epoch when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt Double
    Unix epoch when the resource was last updated.
    createdAt number
    Unix epoch when the resource was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt number
    Unix epoch when the resource was last updated.
    created_at float
    Unix epoch when the resource was created.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at float
    Unix epoch when the resource was last updated.
    createdAt Number
    Unix epoch when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt Number
    Unix epoch when the resource was last updated.

    Look up Existing GatewayPluginUpstreamOauth Resource

    Get an existing GatewayPluginUpstreamOauth resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GatewayPluginUpstreamOauthState, opts?: CustomResourceOptions): GatewayPluginUpstreamOauth
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginUpstreamOauthConfigArgs] = None,
        consumer: Optional[GatewayPluginUpstreamOauthConsumerArgs] = None,
        consumer_group: Optional[GatewayPluginUpstreamOauthConsumerGroupArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_upstream_oauth_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginUpstreamOauthOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginUpstreamOauthRouteArgs] = None,
        service: Optional[GatewayPluginUpstreamOauthServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginUpstreamOauth
    func GetGatewayPluginUpstreamOauth(ctx *Context, name string, id IDInput, state *GatewayPluginUpstreamOauthState, opts ...ResourceOption) (*GatewayPluginUpstreamOauth, error)
    public static GatewayPluginUpstreamOauth Get(string name, Input<string> id, GatewayPluginUpstreamOauthState? state, CustomResourceOptions? opts = null)
    public static GatewayPluginUpstreamOauth get(String name, Output<String> id, GatewayPluginUpstreamOauthState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayPluginUpstreamOauth    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Config GatewayPluginUpstreamOauthConfig
    Consumer GatewayPluginUpstreamOauthConsumer
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    ConsumerGroup GatewayPluginUpstreamOauthConsumerGroup
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    CreatedAt double
    Unix epoch when the resource was created.
    Enabled bool
    Whether the plugin is applied.
    GatewayPluginUpstreamOauthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginUpstreamOauthOrdering
    Protocols List<string>
    A set of strings representing HTTP protocols.
    Route GatewayPluginUpstreamOauthRoute
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    Service GatewayPluginUpstreamOauthService
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    Tags List<string>
    An optional set of strings associated with the Plugin for grouping and filtering.
    UpdatedAt double
    Unix epoch when the resource was last updated.
    Config GatewayPluginUpstreamOauthConfigArgs
    Consumer GatewayPluginUpstreamOauthConsumerArgs
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    ConsumerGroup GatewayPluginUpstreamOauthConsumerGroupArgs
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    CreatedAt float64
    Unix epoch when the resource was created.
    Enabled bool
    Whether the plugin is applied.
    GatewayPluginUpstreamOauthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginUpstreamOauthOrderingArgs
    Protocols []string
    A set of strings representing HTTP protocols.
    Route GatewayPluginUpstreamOauthRouteArgs
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    Service GatewayPluginUpstreamOauthServiceArgs
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    Tags []string
    An optional set of strings associated with the Plugin for grouping and filtering.
    UpdatedAt float64
    Unix epoch when the resource was last updated.
    config GatewayPluginUpstreamOauthConfig
    consumer GatewayPluginUpstreamOauthConsumer
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    consumerGroup GatewayPluginUpstreamOauthConsumerGroup
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    createdAt Double
    Unix epoch when the resource was created.
    enabled Boolean
    Whether the plugin is applied.
    gatewayPluginUpstreamOauthId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginUpstreamOauthOrdering
    protocols List<String>
    A set of strings representing HTTP protocols.
    route GatewayPluginUpstreamOauthRoute
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    service GatewayPluginUpstreamOauthService
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    tags List<String>
    An optional set of strings associated with the Plugin for grouping and filtering.
    updatedAt Double
    Unix epoch when the resource was last updated.
    config GatewayPluginUpstreamOauthConfig
    consumer GatewayPluginUpstreamOauthConsumer
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    consumerGroup GatewayPluginUpstreamOauthConsumerGroup
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    createdAt number
    Unix epoch when the resource was created.
    enabled boolean
    Whether the plugin is applied.
    gatewayPluginUpstreamOauthId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginUpstreamOauthOrdering
    protocols string[]
    A set of strings representing HTTP protocols.
    route GatewayPluginUpstreamOauthRoute
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    service GatewayPluginUpstreamOauthService
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    tags string[]
    An optional set of strings associated with the Plugin for grouping and filtering.
    updatedAt number
    Unix epoch when the resource was last updated.
    config GatewayPluginUpstreamOauthConfigArgs
    consumer GatewayPluginUpstreamOauthConsumerArgs
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    consumer_group GatewayPluginUpstreamOauthConsumerGroupArgs
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    control_plane_id str
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    created_at float
    Unix epoch when the resource was created.
    enabled bool
    Whether the plugin is applied.
    gateway_plugin_upstream_oauth_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginUpstreamOauthOrderingArgs
    protocols Sequence[str]
    A set of strings representing HTTP protocols.
    route GatewayPluginUpstreamOauthRouteArgs
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    service GatewayPluginUpstreamOauthServiceArgs
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    tags Sequence[str]
    An optional set of strings associated with the Plugin for grouping and filtering.
    updated_at float
    Unix epoch when the resource was last updated.
    config Property Map
    consumer Property Map
    If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    consumerGroup Property Map
    If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    createdAt Number
    Unix epoch when the resource was created.
    enabled Boolean
    Whether the plugin is applied.
    gatewayPluginUpstreamOauthId String
    The ID of this resource.
    instanceName String
    ordering Property Map
    protocols List<String>
    A set of strings representing HTTP protocols.
    route Property Map
    If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    service Property Map
    If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    tags List<String>
    An optional set of strings associated with the Plugin for grouping and filtering.
    updatedAt Number
    Unix epoch when the resource was last updated.

    Supporting Types

    GatewayPluginUpstreamOauthConfig, GatewayPluginUpstreamOauthConfigArgs

    GatewayPluginUpstreamOauthConfigBehavior, GatewayPluginUpstreamOauthConfigBehaviorArgs

    IdpErrorResponseBodyTemplate string
    The template to use to create the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    IdpErrorResponseContentType string
    The Content-Type of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    IdpErrorResponseMessage string
    The message to embed in the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    IdpErrorResponseStatusCode double
    The response code to return to the consumer if Kong fails to obtain a token from the IdP.
    PurgeTokenOnUpstreamStatusCodes List<double>
    An array of status codes which will force an access token to be purged when returned by the upstream. An empty array will disable this functionality.
    UpstreamAccessTokenHeaderName string
    The name of the header used to send the access token (obtained from the IdP) to the upstream service.
    IdpErrorResponseBodyTemplate string
    The template to use to create the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    IdpErrorResponseContentType string
    The Content-Type of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    IdpErrorResponseMessage string
    The message to embed in the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    IdpErrorResponseStatusCode float64
    The response code to return to the consumer if Kong fails to obtain a token from the IdP.
    PurgeTokenOnUpstreamStatusCodes []float64
    An array of status codes which will force an access token to be purged when returned by the upstream. An empty array will disable this functionality.
    UpstreamAccessTokenHeaderName string
    The name of the header used to send the access token (obtained from the IdP) to the upstream service.
    idpErrorResponseBodyTemplate String
    The template to use to create the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idpErrorResponseContentType String
    The Content-Type of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idpErrorResponseMessage String
    The message to embed in the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idpErrorResponseStatusCode Double
    The response code to return to the consumer if Kong fails to obtain a token from the IdP.
    purgeTokenOnUpstreamStatusCodes List<Double>
    An array of status codes which will force an access token to be purged when returned by the upstream. An empty array will disable this functionality.
    upstreamAccessTokenHeaderName String
    The name of the header used to send the access token (obtained from the IdP) to the upstream service.
    idpErrorResponseBodyTemplate string
    The template to use to create the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idpErrorResponseContentType string
    The Content-Type of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idpErrorResponseMessage string
    The message to embed in the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idpErrorResponseStatusCode number
    The response code to return to the consumer if Kong fails to obtain a token from the IdP.
    purgeTokenOnUpstreamStatusCodes number[]
    An array of status codes which will force an access token to be purged when returned by the upstream. An empty array will disable this functionality.
    upstreamAccessTokenHeaderName string
    The name of the header used to send the access token (obtained from the IdP) to the upstream service.
    idp_error_response_body_template str
    The template to use to create the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idp_error_response_content_type str
    The Content-Type of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idp_error_response_message str
    The message to embed in the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idp_error_response_status_code float
    The response code to return to the consumer if Kong fails to obtain a token from the IdP.
    purge_token_on_upstream_status_codes Sequence[float]
    An array of status codes which will force an access token to be purged when returned by the upstream. An empty array will disable this functionality.
    upstream_access_token_header_name str
    The name of the header used to send the access token (obtained from the IdP) to the upstream service.
    idpErrorResponseBodyTemplate String
    The template to use to create the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idpErrorResponseContentType String
    The Content-Type of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idpErrorResponseMessage String
    The message to embed in the body of the response to return to the consumer if Kong fails to obtain a token from the IdP.
    idpErrorResponseStatusCode Number
    The response code to return to the consumer if Kong fails to obtain a token from the IdP.
    purgeTokenOnUpstreamStatusCodes List<Number>
    An array of status codes which will force an access token to be purged when returned by the upstream. An empty array will disable this functionality.
    upstreamAccessTokenHeaderName String
    The name of the header used to send the access token (obtained from the IdP) to the upstream service.

    GatewayPluginUpstreamOauthConfigCache, GatewayPluginUpstreamOauthConfigCacheArgs

    DefaultTtl double
    The lifetime of a token without an explicit expires_in value.
    EagerlyExpire double
    The number of seconds to eagerly expire a cached token. By default, a cached token expires 5 seconds before its lifetime as defined in expires_in.
    Memory GatewayPluginUpstreamOauthConfigCacheMemory
    Redis GatewayPluginUpstreamOauthConfigCacheRedis
    Strategy string
    The method Kong should use to cache tokens issued by the IdP. must be one of ["memory", "redis"]
    DefaultTtl float64
    The lifetime of a token without an explicit expires_in value.
    EagerlyExpire float64
    The number of seconds to eagerly expire a cached token. By default, a cached token expires 5 seconds before its lifetime as defined in expires_in.
    Memory GatewayPluginUpstreamOauthConfigCacheMemory
    Redis GatewayPluginUpstreamOauthConfigCacheRedis
    Strategy string
    The method Kong should use to cache tokens issued by the IdP. must be one of ["memory", "redis"]
    defaultTtl Double
    The lifetime of a token without an explicit expires_in value.
    eagerlyExpire Double
    The number of seconds to eagerly expire a cached token. By default, a cached token expires 5 seconds before its lifetime as defined in expires_in.
    memory GatewayPluginUpstreamOauthConfigCacheMemory
    redis GatewayPluginUpstreamOauthConfigCacheRedis
    strategy String
    The method Kong should use to cache tokens issued by the IdP. must be one of ["memory", "redis"]
    defaultTtl number
    The lifetime of a token without an explicit expires_in value.
    eagerlyExpire number
    The number of seconds to eagerly expire a cached token. By default, a cached token expires 5 seconds before its lifetime as defined in expires_in.
    memory GatewayPluginUpstreamOauthConfigCacheMemory
    redis GatewayPluginUpstreamOauthConfigCacheRedis
    strategy string
    The method Kong should use to cache tokens issued by the IdP. must be one of ["memory", "redis"]
    default_ttl float
    The lifetime of a token without an explicit expires_in value.
    eagerly_expire float
    The number of seconds to eagerly expire a cached token. By default, a cached token expires 5 seconds before its lifetime as defined in expires_in.
    memory GatewayPluginUpstreamOauthConfigCacheMemory
    redis GatewayPluginUpstreamOauthConfigCacheRedis
    strategy str
    The method Kong should use to cache tokens issued by the IdP. must be one of ["memory", "redis"]
    defaultTtl Number
    The lifetime of a token without an explicit expires_in value.
    eagerlyExpire Number
    The number of seconds to eagerly expire a cached token. By default, a cached token expires 5 seconds before its lifetime as defined in expires_in.
    memory Property Map
    redis Property Map
    strategy String
    The method Kong should use to cache tokens issued by the IdP. must be one of ["memory", "redis"]

    GatewayPluginUpstreamOauthConfigCacheMemory, GatewayPluginUpstreamOauthConfigCacheMemoryArgs

    DictionaryName string
    The shared dictionary used by the plugin to cache tokens if config.cache.strategy is set to memory.
    DictionaryName string
    The shared dictionary used by the plugin to cache tokens if config.cache.strategy is set to memory.
    dictionaryName String
    The shared dictionary used by the plugin to cache tokens if config.cache.strategy is set to memory.
    dictionaryName string
    The shared dictionary used by the plugin to cache tokens if config.cache.strategy is set to memory.
    dictionary_name str
    The shared dictionary used by the plugin to cache tokens if config.cache.strategy is set to memory.
    dictionaryName String
    The shared dictionary used by the plugin to cache tokens if config.cache.strategy is set to memory.

    GatewayPluginUpstreamOauthConfigCacheRedis, GatewayPluginUpstreamOauthConfigCacheRedisArgs

    ClusterMaxRedirections double
    Maximum retry attempts for redirection.
    ClusterNodes List<GatewayPluginUpstreamOauthConfigCacheRedisClusterNode>
    Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
    ConnectTimeout double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    ConnectionIsProxied bool
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    Database double
    Database to use for the Redis connection when using the redis strategy
    Host string
    A string representing a host name, such as example.com.
    KeepaliveBacklog double
    Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    KeepalivePoolSize double
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
    Password string
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    Port double
    An integer representing a port number between 0 and 65535, inclusive.
    ReadTimeout double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    SendTimeout double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    SentinelMaster string
    Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
    SentinelNodes List<GatewayPluginUpstreamOauthConfigCacheRedisSentinelNode>
    Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
    SentinelPassword string
    Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
    SentinelRole string
    Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
    SentinelUsername string
    Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
    ServerName string
    A string representing an SNI (server name indication) value for TLS.
    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. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    Username string
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
    ClusterMaxRedirections float64
    Maximum retry attempts for redirection.
    ClusterNodes []GatewayPluginUpstreamOauthConfigCacheRedisClusterNode
    Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
    ConnectTimeout float64
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    ConnectionIsProxied bool
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    Database float64
    Database to use for the Redis connection when using the redis strategy
    Host string
    A string representing a host name, such as example.com.
    KeepaliveBacklog float64
    Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    KeepalivePoolSize float64
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
    Password string
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    Port float64
    An integer representing a port number between 0 and 65535, inclusive.
    ReadTimeout float64
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    SendTimeout float64
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    SentinelMaster string
    Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
    SentinelNodes []GatewayPluginUpstreamOauthConfigCacheRedisSentinelNode
    Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
    SentinelPassword string
    Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
    SentinelRole string
    Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
    SentinelUsername string
    Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
    ServerName string
    A string representing an SNI (server name indication) value for TLS.
    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. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    Username string
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
    clusterMaxRedirections Double
    Maximum retry attempts for redirection.
    clusterNodes List<GatewayPluginUpstreamOauthConfigCacheRedisClusterNode>
    Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
    connectTimeout Double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    connectionIsProxied Boolean
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    database Double
    Database to use for the Redis connection when using the redis strategy
    host String
    A string representing a host name, such as example.com.
    keepaliveBacklog Double
    Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    keepalivePoolSize Double
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
    password String
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port Double
    An integer representing a port number between 0 and 65535, inclusive.
    readTimeout Double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sendTimeout Double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sentinelMaster String
    Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
    sentinelNodes List<GatewayPluginUpstreamOauthConfigCacheRedisSentinelNode>
    Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
    sentinelPassword String
    Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
    sentinelRole String
    Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
    sentinelUsername String
    Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
    serverName String
    A string representing an SNI (server name indication) value for TLS.
    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. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    username String
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
    clusterMaxRedirections number
    Maximum retry attempts for redirection.
    clusterNodes GatewayPluginUpstreamOauthConfigCacheRedisClusterNode[]
    Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
    connectTimeout number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    connectionIsProxied boolean
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    database number
    Database to use for the Redis connection when using the redis strategy
    host string
    A string representing a host name, such as example.com.
    keepaliveBacklog number
    Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    keepalivePoolSize number
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
    password string
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port number
    An integer representing a port number between 0 and 65535, inclusive.
    readTimeout number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sendTimeout number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sentinelMaster string
    Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
    sentinelNodes GatewayPluginUpstreamOauthConfigCacheRedisSentinelNode[]
    Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
    sentinelPassword string
    Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
    sentinelRole string
    Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
    sentinelUsername string
    Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
    serverName string
    A string representing an SNI (server name indication) value for TLS.
    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. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    username string
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
    cluster_max_redirections float
    Maximum retry attempts for redirection.
    cluster_nodes Sequence[GatewayPluginUpstreamOauthConfigCacheRedisClusterNode]
    Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
    connect_timeout float
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    connection_is_proxied bool
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    database float
    Database to use for the Redis connection when using the redis strategy
    host str
    A string representing a host name, such as example.com.
    keepalive_backlog float
    Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    keepalive_pool_size float
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
    password str
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port float
    An integer representing a port number between 0 and 65535, inclusive.
    read_timeout float
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    send_timeout float
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sentinel_master str
    Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
    sentinel_nodes Sequence[GatewayPluginUpstreamOauthConfigCacheRedisSentinelNode]
    Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
    sentinel_password str
    Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
    sentinel_role str
    Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
    sentinel_username str
    Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
    server_name str
    A string representing an SNI (server name indication) value for TLS.
    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. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    username str
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
    clusterMaxRedirections Number
    Maximum retry attempts for redirection.
    clusterNodes List<Property Map>
    Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
    connectTimeout Number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    connectionIsProxied Boolean
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    database Number
    Database to use for the Redis connection when using the redis strategy
    host String
    A string representing a host name, such as example.com.
    keepaliveBacklog Number
    Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    keepalivePoolSize Number
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
    password String
    Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
    port Number
    An integer representing a port number between 0 and 65535, inclusive.
    readTimeout Number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sendTimeout Number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sentinelMaster String
    Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
    sentinelNodes List<Property Map>
    Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
    sentinelPassword String
    Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
    sentinelRole String
    Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
    sentinelUsername String
    Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
    serverName String
    A string representing an SNI (server name indication) value for TLS.
    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. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    username String
    Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.

    GatewayPluginUpstreamOauthConfigCacheRedisClusterNode, GatewayPluginUpstreamOauthConfigCacheRedisClusterNodeArgs

    Ip string
    A string representing a host name, such as example.com.
    Port double
    An integer representing a port number between 0 and 65535, inclusive.
    Ip string
    A string representing a host name, such as example.com.
    Port float64
    An integer representing a port number between 0 and 65535, inclusive.
    ip String
    A string representing a host name, such as example.com.
    port Double
    An integer representing a port number between 0 and 65535, inclusive.
    ip string
    A string representing a host name, such as example.com.
    port number
    An integer representing a port number between 0 and 65535, inclusive.
    ip str
    A string representing a host name, such as example.com.
    port float
    An integer representing a port number between 0 and 65535, inclusive.
    ip String
    A string representing a host name, such as example.com.
    port Number
    An integer representing a port number between 0 and 65535, inclusive.

    GatewayPluginUpstreamOauthConfigCacheRedisSentinelNode, GatewayPluginUpstreamOauthConfigCacheRedisSentinelNodeArgs

    Host string
    A string representing a host name, such as example.com.
    Port double
    An integer representing a port number between 0 and 65535, inclusive.
    Host string
    A string representing a host name, such as example.com.
    Port float64
    An integer representing a port number between 0 and 65535, inclusive.
    host String
    A string representing a host name, such as example.com.
    port Double
    An integer representing a port number between 0 and 65535, inclusive.
    host string
    A string representing a host name, such as example.com.
    port number
    An integer representing a port number between 0 and 65535, inclusive.
    host str
    A string representing a host name, such as example.com.
    port float
    An integer representing a port number between 0 and 65535, inclusive.
    host String
    A string representing a host name, such as example.com.
    port Number
    An integer representing a port number between 0 and 65535, inclusive.

    GatewayPluginUpstreamOauthConfigClient, GatewayPluginUpstreamOauthConfigClientArgs

    AuthMethod string
    The authentication method used in client requests to the IdP. Supported values are: client_secret_basic to send client_id and client_secret in the Authorization: Basic header, client_secret_post to send client_id and client_secret as part of the request body, or client_secret_jwt to send a JWT signed with the client_secret using the client assertion as part of the body. must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"]
    ClientSecretJwtAlg string
    The algorithm to use with JWT when using client_secret_jwt authentication. must be one of ["HS256", "HS512"]
    HttpProxy string
    The proxy to use when making HTTP requests to the IdP.
    HttpProxyAuthorization string
    The Proxy-Authorization header value to be used with http_proxy.
    HttpVersion double
    The HTTP version used for requests made by this plugin. Supported values: 1.1 for HTTP 1.1 and 1.0 for HTTP 1.0.
    HttpsProxy string
    The proxy to use when making HTTPS requests to the IdP.
    HttpsProxyAuthorization string
    The Proxy-Authorization header value to be used with https_proxy.
    KeepAlive bool
    Whether to use keepalive connections to the IdP.
    NoProxy string
    A comma-separated list of hosts that should not be proxied.
    SslVerify bool
    Whether to verify the certificate presented by the IdP when using HTTPS.
    Timeout double
    Network I/O timeout for requests to the IdP in milliseconds.
    AuthMethod string
    The authentication method used in client requests to the IdP. Supported values are: client_secret_basic to send client_id and client_secret in the Authorization: Basic header, client_secret_post to send client_id and client_secret as part of the request body, or client_secret_jwt to send a JWT signed with the client_secret using the client assertion as part of the body. must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"]
    ClientSecretJwtAlg string
    The algorithm to use with JWT when using client_secret_jwt authentication. must be one of ["HS256", "HS512"]
    HttpProxy string
    The proxy to use when making HTTP requests to the IdP.
    HttpProxyAuthorization string
    The Proxy-Authorization header value to be used with http_proxy.
    HttpVersion float64
    The HTTP version used for requests made by this plugin. Supported values: 1.1 for HTTP 1.1 and 1.0 for HTTP 1.0.
    HttpsProxy string
    The proxy to use when making HTTPS requests to the IdP.
    HttpsProxyAuthorization string
    The Proxy-Authorization header value to be used with https_proxy.
    KeepAlive bool
    Whether to use keepalive connections to the IdP.
    NoProxy string
    A comma-separated list of hosts that should not be proxied.
    SslVerify bool
    Whether to verify the certificate presented by the IdP when using HTTPS.
    Timeout float64
    Network I/O timeout for requests to the IdP in milliseconds.
    authMethod String
    The authentication method used in client requests to the IdP. Supported values are: client_secret_basic to send client_id and client_secret in the Authorization: Basic header, client_secret_post to send client_id and client_secret as part of the request body, or client_secret_jwt to send a JWT signed with the client_secret using the client assertion as part of the body. must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"]
    clientSecretJwtAlg String
    The algorithm to use with JWT when using client_secret_jwt authentication. must be one of ["HS256", "HS512"]
    httpProxy String
    The proxy to use when making HTTP requests to the IdP.
    httpProxyAuthorization String
    The Proxy-Authorization header value to be used with http_proxy.
    httpVersion Double
    The HTTP version used for requests made by this plugin. Supported values: 1.1 for HTTP 1.1 and 1.0 for HTTP 1.0.
    httpsProxy String
    The proxy to use when making HTTPS requests to the IdP.
    httpsProxyAuthorization String
    The Proxy-Authorization header value to be used with https_proxy.
    keepAlive Boolean
    Whether to use keepalive connections to the IdP.
    noProxy String
    A comma-separated list of hosts that should not be proxied.
    sslVerify Boolean
    Whether to verify the certificate presented by the IdP when using HTTPS.
    timeout Double
    Network I/O timeout for requests to the IdP in milliseconds.
    authMethod string
    The authentication method used in client requests to the IdP. Supported values are: client_secret_basic to send client_id and client_secret in the Authorization: Basic header, client_secret_post to send client_id and client_secret as part of the request body, or client_secret_jwt to send a JWT signed with the client_secret using the client assertion as part of the body. must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"]
    clientSecretJwtAlg string
    The algorithm to use with JWT when using client_secret_jwt authentication. must be one of ["HS256", "HS512"]
    httpProxy string
    The proxy to use when making HTTP requests to the IdP.
    httpProxyAuthorization string
    The Proxy-Authorization header value to be used with http_proxy.
    httpVersion number
    The HTTP version used for requests made by this plugin. Supported values: 1.1 for HTTP 1.1 and 1.0 for HTTP 1.0.
    httpsProxy string
    The proxy to use when making HTTPS requests to the IdP.
    httpsProxyAuthorization string
    The Proxy-Authorization header value to be used with https_proxy.
    keepAlive boolean
    Whether to use keepalive connections to the IdP.
    noProxy string
    A comma-separated list of hosts that should not be proxied.
    sslVerify boolean
    Whether to verify the certificate presented by the IdP when using HTTPS.
    timeout number
    Network I/O timeout for requests to the IdP in milliseconds.
    auth_method str
    The authentication method used in client requests to the IdP. Supported values are: client_secret_basic to send client_id and client_secret in the Authorization: Basic header, client_secret_post to send client_id and client_secret as part of the request body, or client_secret_jwt to send a JWT signed with the client_secret using the client assertion as part of the body. must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"]
    client_secret_jwt_alg str
    The algorithm to use with JWT when using client_secret_jwt authentication. must be one of ["HS256", "HS512"]
    http_proxy str
    The proxy to use when making HTTP requests to the IdP.
    http_proxy_authorization str
    The Proxy-Authorization header value to be used with http_proxy.
    http_version float
    The HTTP version used for requests made by this plugin. Supported values: 1.1 for HTTP 1.1 and 1.0 for HTTP 1.0.
    https_proxy str
    The proxy to use when making HTTPS requests to the IdP.
    https_proxy_authorization str
    The Proxy-Authorization header value to be used with https_proxy.
    keep_alive bool
    Whether to use keepalive connections to the IdP.
    no_proxy str
    A comma-separated list of hosts that should not be proxied.
    ssl_verify bool
    Whether to verify the certificate presented by the IdP when using HTTPS.
    timeout float
    Network I/O timeout for requests to the IdP in milliseconds.
    authMethod String
    The authentication method used in client requests to the IdP. Supported values are: client_secret_basic to send client_id and client_secret in the Authorization: Basic header, client_secret_post to send client_id and client_secret as part of the request body, or client_secret_jwt to send a JWT signed with the client_secret using the client assertion as part of the body. must be one of ["clientsecretbasic", "clientsecretjwt", "clientsecretpost", "none"]
    clientSecretJwtAlg String
    The algorithm to use with JWT when using client_secret_jwt authentication. must be one of ["HS256", "HS512"]
    httpProxy String
    The proxy to use when making HTTP requests to the IdP.
    httpProxyAuthorization String
    The Proxy-Authorization header value to be used with http_proxy.
    httpVersion Number
    The HTTP version used for requests made by this plugin. Supported values: 1.1 for HTTP 1.1 and 1.0 for HTTP 1.0.
    httpsProxy String
    The proxy to use when making HTTPS requests to the IdP.
    httpsProxyAuthorization String
    The Proxy-Authorization header value to be used with https_proxy.
    keepAlive Boolean
    Whether to use keepalive connections to the IdP.
    noProxy String
    A comma-separated list of hosts that should not be proxied.
    sslVerify Boolean
    Whether to verify the certificate presented by the IdP when using HTTPS.
    timeout Number
    Network I/O timeout for requests to the IdP in milliseconds.

    GatewayPluginUpstreamOauthConfigOauth, GatewayPluginUpstreamOauthConfigOauthArgs

    Audiences List<string>
    List of audiences passed to the IdP when obtaining a new token.
    ClientId string
    The client ID for the application registration in the IdP.
    ClientSecret string
    The client secret for the application registration in the IdP.
    GrantType string
    The OAuth grant type to be used. must be one of ["client_credentials", "password"]
    Password string
    The password to use if config.oauth.grant_type is set to password.
    Scopes List<string>
    List of scopes to request from the IdP when obtaining a new token.
    TokenEndpoint string
    The token endpoint URI.
    TokenHeaders Dictionary<string, string>
    Extra headers to be passed in the token endpoint request.
    TokenPostArgs Dictionary<string, string>
    Extra post arguments to be passed in the token endpoint request.
    Username string
    The username to use if config.oauth.grant_type is set to password.
    Audiences []string
    List of audiences passed to the IdP when obtaining a new token.
    ClientId string
    The client ID for the application registration in the IdP.
    ClientSecret string
    The client secret for the application registration in the IdP.
    GrantType string
    The OAuth grant type to be used. must be one of ["client_credentials", "password"]
    Password string
    The password to use if config.oauth.grant_type is set to password.
    Scopes []string
    List of scopes to request from the IdP when obtaining a new token.
    TokenEndpoint string
    The token endpoint URI.
    TokenHeaders map[string]string
    Extra headers to be passed in the token endpoint request.
    TokenPostArgs map[string]string
    Extra post arguments to be passed in the token endpoint request.
    Username string
    The username to use if config.oauth.grant_type is set to password.
    audiences List<String>
    List of audiences passed to the IdP when obtaining a new token.
    clientId String
    The client ID for the application registration in the IdP.
    clientSecret String
    The client secret for the application registration in the IdP.
    grantType String
    The OAuth grant type to be used. must be one of ["client_credentials", "password"]
    password String
    The password to use if config.oauth.grant_type is set to password.
    scopes List<String>
    List of scopes to request from the IdP when obtaining a new token.
    tokenEndpoint String
    The token endpoint URI.
    tokenHeaders Map<String,String>
    Extra headers to be passed in the token endpoint request.
    tokenPostArgs Map<String,String>
    Extra post arguments to be passed in the token endpoint request.
    username String
    The username to use if config.oauth.grant_type is set to password.
    audiences string[]
    List of audiences passed to the IdP when obtaining a new token.
    clientId string
    The client ID for the application registration in the IdP.
    clientSecret string
    The client secret for the application registration in the IdP.
    grantType string
    The OAuth grant type to be used. must be one of ["client_credentials", "password"]
    password string
    The password to use if config.oauth.grant_type is set to password.
    scopes string[]
    List of scopes to request from the IdP when obtaining a new token.
    tokenEndpoint string
    The token endpoint URI.
    tokenHeaders {[key: string]: string}
    Extra headers to be passed in the token endpoint request.
    tokenPostArgs {[key: string]: string}
    Extra post arguments to be passed in the token endpoint request.
    username string
    The username to use if config.oauth.grant_type is set to password.
    audiences Sequence[str]
    List of audiences passed to the IdP when obtaining a new token.
    client_id str
    The client ID for the application registration in the IdP.
    client_secret str
    The client secret for the application registration in the IdP.
    grant_type str
    The OAuth grant type to be used. must be one of ["client_credentials", "password"]
    password str
    The password to use if config.oauth.grant_type is set to password.
    scopes Sequence[str]
    List of scopes to request from the IdP when obtaining a new token.
    token_endpoint str
    The token endpoint URI.
    token_headers Mapping[str, str]
    Extra headers to be passed in the token endpoint request.
    token_post_args Mapping[str, str]
    Extra post arguments to be passed in the token endpoint request.
    username str
    The username to use if config.oauth.grant_type is set to password.
    audiences List<String>
    List of audiences passed to the IdP when obtaining a new token.
    clientId String
    The client ID for the application registration in the IdP.
    clientSecret String
    The client secret for the application registration in the IdP.
    grantType String
    The OAuth grant type to be used. must be one of ["client_credentials", "password"]
    password String
    The password to use if config.oauth.grant_type is set to password.
    scopes List<String>
    List of scopes to request from the IdP when obtaining a new token.
    tokenEndpoint String
    The token endpoint URI.
    tokenHeaders Map<String>
    Extra headers to be passed in the token endpoint request.
    tokenPostArgs Map<String>
    Extra post arguments to be passed in the token endpoint request.
    username String
    The username to use if config.oauth.grant_type is set to password.

    GatewayPluginUpstreamOauthConsumer, GatewayPluginUpstreamOauthConsumerArgs

    Id string
    Id string
    id String
    id string
    id str
    id String

    GatewayPluginUpstreamOauthConsumerGroup, GatewayPluginUpstreamOauthConsumerGroupArgs

    Id string
    Id string
    id String
    id string
    id str
    id String

    GatewayPluginUpstreamOauthOrdering, GatewayPluginUpstreamOauthOrderingArgs

    GatewayPluginUpstreamOauthOrderingAfter, GatewayPluginUpstreamOauthOrderingAfterArgs

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GatewayPluginUpstreamOauthOrderingBefore, GatewayPluginUpstreamOauthOrderingBeforeArgs

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GatewayPluginUpstreamOauthRoute, GatewayPluginUpstreamOauthRouteArgs

    Id string
    Id string
    id String
    id string
    id str
    id String

    GatewayPluginUpstreamOauthService, GatewayPluginUpstreamOauthServiceArgs

    Id string
    Id string
    id String
    id string
    id str
    id String

    Import

    $ pulumi import konnect:index/gatewayPluginUpstreamOauth:GatewayPluginUpstreamOauth my_konnect_gateway_plugin_upstream_oauth "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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