GatewayPluginBasicAuth Resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";
const myGatewaypluginbasicauth = new konnect.GatewayPluginBasicAuth("my_gatewaypluginbasicauth", {
config: {
anonymous: "...my_anonymous...",
bruteForceProtection: {
redis: {
cloudAuthentication: {
authProvider: "azure",
awsAccessKeyId: "...my_aws_access_key_id...",
awsAssumeRoleArn: "...my_aws_assume_role_arn...",
awsCacheName: "...my_aws_cache_name...",
awsIsServerless: true,
awsRegion: "...my_aws_region...",
awsRoleSessionName: "...my_aws_role_session_name...",
awsSecretAccessKey: "...my_aws_secret_access_key...",
azureClientId: "...my_azure_client_id...",
azureClientSecret: "...my_azure_client_secret...",
azureTenantId: "...my_azure_tenant_id...",
gcpServiceAccountJson: "...my_gcp_service_account_json...",
},
database: 2,
host: "...my_host...",
password: "...my_password...",
port: 18528,
serverName: "...my_server_name...",
ssl: true,
sslVerify: true,
timeout: 1835674936,
username: "...my_username...",
},
strategy: "redis",
},
hideCredentials: false,
realm: "...my_realm...",
},
controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
createdAt: 6,
enabled: false,
gatewayPluginBasicAuthId: "...my_id...",
instanceName: "...my_instance_name...",
ordering: {
after: {
accesses: ["..."],
},
before: {
accesses: ["..."],
},
},
partials: [{
id: "...my_id...",
name: "...my_name...",
path: "...my_path...",
}],
protocols: ["http"],
route: {
id: "...my_id...",
},
service: {
id: "...my_id...",
},
tags: ["..."],
updatedAt: 10,
});
import pulumi
import pulumi_konnect as konnect
my_gatewaypluginbasicauth = konnect.GatewayPluginBasicAuth("my_gatewaypluginbasicauth",
config={
"anonymous": "...my_anonymous...",
"brute_force_protection": {
"redis": {
"cloud_authentication": {
"auth_provider": "azure",
"aws_access_key_id": "...my_aws_access_key_id...",
"aws_assume_role_arn": "...my_aws_assume_role_arn...",
"aws_cache_name": "...my_aws_cache_name...",
"aws_is_serverless": True,
"aws_region": "...my_aws_region...",
"aws_role_session_name": "...my_aws_role_session_name...",
"aws_secret_access_key": "...my_aws_secret_access_key...",
"azure_client_id": "...my_azure_client_id...",
"azure_client_secret": "...my_azure_client_secret...",
"azure_tenant_id": "...my_azure_tenant_id...",
"gcp_service_account_json": "...my_gcp_service_account_json...",
},
"database": 2,
"host": "...my_host...",
"password": "...my_password...",
"port": 18528,
"server_name": "...my_server_name...",
"ssl": True,
"ssl_verify": True,
"timeout": 1835674936,
"username": "...my_username...",
},
"strategy": "redis",
},
"hide_credentials": False,
"realm": "...my_realm...",
},
control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
created_at=6,
enabled=False,
gateway_plugin_basic_auth_id="...my_id...",
instance_name="...my_instance_name...",
ordering={
"after": {
"accesses": ["..."],
},
"before": {
"accesses": ["..."],
},
},
partials=[{
"id": "...my_id...",
"name": "...my_name...",
"path": "...my_path...",
}],
protocols=["http"],
route={
"id": "...my_id...",
},
service={
"id": "...my_id...",
},
tags=["..."],
updated_at=10)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v3/konnect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := konnect.NewGatewayPluginBasicAuth(ctx, "my_gatewaypluginbasicauth", &konnect.GatewayPluginBasicAuthArgs{
Config: &konnect.GatewayPluginBasicAuthConfigArgs{
Anonymous: pulumi.String("...my_anonymous..."),
BruteForceProtection: &konnect.GatewayPluginBasicAuthConfigBruteForceProtectionArgs{
Redis: &konnect.GatewayPluginBasicAuthConfigBruteForceProtectionRedisArgs{
CloudAuthentication: &konnect.GatewayPluginBasicAuthConfigBruteForceProtectionRedisCloudAuthenticationArgs{
AuthProvider: pulumi.String("azure"),
AwsAccessKeyId: pulumi.String("...my_aws_access_key_id..."),
AwsAssumeRoleArn: pulumi.String("...my_aws_assume_role_arn..."),
AwsCacheName: pulumi.String("...my_aws_cache_name..."),
AwsIsServerless: pulumi.Bool(true),
AwsRegion: pulumi.String("...my_aws_region..."),
AwsRoleSessionName: pulumi.String("...my_aws_role_session_name..."),
AwsSecretAccessKey: pulumi.String("...my_aws_secret_access_key..."),
AzureClientId: pulumi.String("...my_azure_client_id..."),
AzureClientSecret: pulumi.String("...my_azure_client_secret..."),
AzureTenantId: pulumi.String("...my_azure_tenant_id..."),
GcpServiceAccountJson: pulumi.String("...my_gcp_service_account_json..."),
},
Database: pulumi.Float64(2),
Host: pulumi.String("...my_host..."),
Password: pulumi.String("...my_password..."),
Port: pulumi.Float64(18528),
ServerName: pulumi.String("...my_server_name..."),
Ssl: pulumi.Bool(true),
SslVerify: pulumi.Bool(true),
Timeout: pulumi.Float64(1835674936),
Username: pulumi.String("...my_username..."),
},
Strategy: pulumi.String("redis"),
},
HideCredentials: pulumi.Bool(false),
Realm: pulumi.String("...my_realm..."),
},
ControlPlaneId: pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
CreatedAt: pulumi.Float64(6),
Enabled: pulumi.Bool(false),
GatewayPluginBasicAuthId: pulumi.String("...my_id..."),
InstanceName: pulumi.String("...my_instance_name..."),
Ordering: &konnect.GatewayPluginBasicAuthOrderingArgs{
After: &konnect.GatewayPluginBasicAuthOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("..."),
},
},
Before: &konnect.GatewayPluginBasicAuthOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("..."),
},
},
},
Partials: konnect.GatewayPluginBasicAuthPartialArray{
&konnect.GatewayPluginBasicAuthPartialArgs{
Id: pulumi.String("...my_id..."),
Name: pulumi.String("...my_name..."),
Path: pulumi.String("...my_path..."),
},
},
Protocols: pulumi.StringArray{
pulumi.String("http"),
},
Route: &konnect.GatewayPluginBasicAuthRouteArgs{
Id: pulumi.String("...my_id..."),
},
Service: &konnect.GatewayPluginBasicAuthServiceArgs{
Id: pulumi.String("...my_id..."),
},
Tags: pulumi.StringArray{
pulumi.String("..."),
},
UpdatedAt: pulumi.Float64(10),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;
return await Deployment.RunAsync(() =>
{
var myGatewaypluginbasicauth = new Konnect.GatewayPluginBasicAuth("my_gatewaypluginbasicauth", new()
{
Config = new Konnect.Inputs.GatewayPluginBasicAuthConfigArgs
{
Anonymous = "...my_anonymous...",
BruteForceProtection = new Konnect.Inputs.GatewayPluginBasicAuthConfigBruteForceProtectionArgs
{
Redis = new Konnect.Inputs.GatewayPluginBasicAuthConfigBruteForceProtectionRedisArgs
{
CloudAuthentication = new Konnect.Inputs.GatewayPluginBasicAuthConfigBruteForceProtectionRedisCloudAuthenticationArgs
{
AuthProvider = "azure",
AwsAccessKeyId = "...my_aws_access_key_id...",
AwsAssumeRoleArn = "...my_aws_assume_role_arn...",
AwsCacheName = "...my_aws_cache_name...",
AwsIsServerless = true,
AwsRegion = "...my_aws_region...",
AwsRoleSessionName = "...my_aws_role_session_name...",
AwsSecretAccessKey = "...my_aws_secret_access_key...",
AzureClientId = "...my_azure_client_id...",
AzureClientSecret = "...my_azure_client_secret...",
AzureTenantId = "...my_azure_tenant_id...",
GcpServiceAccountJson = "...my_gcp_service_account_json...",
},
Database = 2,
Host = "...my_host...",
Password = "...my_password...",
Port = 18528,
ServerName = "...my_server_name...",
Ssl = true,
SslVerify = true,
Timeout = 1835674936,
Username = "...my_username...",
},
Strategy = "redis",
},
HideCredentials = false,
Realm = "...my_realm...",
},
ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
CreatedAt = 6,
Enabled = false,
GatewayPluginBasicAuthId = "...my_id...",
InstanceName = "...my_instance_name...",
Ordering = new Konnect.Inputs.GatewayPluginBasicAuthOrderingArgs
{
After = new Konnect.Inputs.GatewayPluginBasicAuthOrderingAfterArgs
{
Accesses = new[]
{
"...",
},
},
Before = new Konnect.Inputs.GatewayPluginBasicAuthOrderingBeforeArgs
{
Accesses = new[]
{
"...",
},
},
},
Partials = new[]
{
new Konnect.Inputs.GatewayPluginBasicAuthPartialArgs
{
Id = "...my_id...",
Name = "...my_name...",
Path = "...my_path...",
},
},
Protocols = new[]
{
"http",
},
Route = new Konnect.Inputs.GatewayPluginBasicAuthRouteArgs
{
Id = "...my_id...",
},
Service = new Konnect.Inputs.GatewayPluginBasicAuthServiceArgs
{
Id = "...my_id...",
},
Tags = new[]
{
"...",
},
UpdatedAt = 10,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginBasicAuth;
import com.pulumi.konnect.GatewayPluginBasicAuthArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthConfigBruteForceProtectionArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthConfigBruteForceProtectionRedisArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthConfigBruteForceProtectionRedisCloudAuthenticationArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthPartialArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthServiceArgs;
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 myGatewaypluginbasicauth = new GatewayPluginBasicAuth("myGatewaypluginbasicauth", GatewayPluginBasicAuthArgs.builder()
.config(GatewayPluginBasicAuthConfigArgs.builder()
.anonymous("...my_anonymous...")
.bruteForceProtection(GatewayPluginBasicAuthConfigBruteForceProtectionArgs.builder()
.redis(GatewayPluginBasicAuthConfigBruteForceProtectionRedisArgs.builder()
.cloudAuthentication(GatewayPluginBasicAuthConfigBruteForceProtectionRedisCloudAuthenticationArgs.builder()
.authProvider("azure")
.awsAccessKeyId("...my_aws_access_key_id...")
.awsAssumeRoleArn("...my_aws_assume_role_arn...")
.awsCacheName("...my_aws_cache_name...")
.awsIsServerless(true)
.awsRegion("...my_aws_region...")
.awsRoleSessionName("...my_aws_role_session_name...")
.awsSecretAccessKey("...my_aws_secret_access_key...")
.azureClientId("...my_azure_client_id...")
.azureClientSecret("...my_azure_client_secret...")
.azureTenantId("...my_azure_tenant_id...")
.gcpServiceAccountJson("...my_gcp_service_account_json...")
.build())
.database(2.0)
.host("...my_host...")
.password("...my_password...")
.port(18528.0)
.serverName("...my_server_name...")
.ssl(true)
.sslVerify(true)
.timeout(1835674936.0)
.username("...my_username...")
.build())
.strategy("redis")
.build())
.hideCredentials(false)
.realm("...my_realm...")
.build())
.controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
.createdAt(6.0)
.enabled(false)
.gatewayPluginBasicAuthId("...my_id...")
.instanceName("...my_instance_name...")
.ordering(GatewayPluginBasicAuthOrderingArgs.builder()
.after(GatewayPluginBasicAuthOrderingAfterArgs.builder()
.accesses("...")
.build())
.before(GatewayPluginBasicAuthOrderingBeforeArgs.builder()
.accesses("...")
.build())
.build())
.partials(GatewayPluginBasicAuthPartialArgs.builder()
.id("...my_id...")
.name("...my_name...")
.path("...my_path...")
.build())
.protocols("http")
.route(GatewayPluginBasicAuthRouteArgs.builder()
.id("...my_id...")
.build())
.service(GatewayPluginBasicAuthServiceArgs.builder()
.id("...my_id...")
.build())
.tags("...")
.updatedAt(10.0)
.build());
}
}
resources:
myGatewaypluginbasicauth:
type: konnect:GatewayPluginBasicAuth
name: my_gatewaypluginbasicauth
properties:
config:
anonymous: '...my_anonymous...'
bruteForceProtection:
redis:
cloudAuthentication:
authProvider: azure
awsAccessKeyId: '...my_aws_access_key_id...'
awsAssumeRoleArn: '...my_aws_assume_role_arn...'
awsCacheName: '...my_aws_cache_name...'
awsIsServerless: true
awsRegion: '...my_aws_region...'
awsRoleSessionName: '...my_aws_role_session_name...'
awsSecretAccessKey: '...my_aws_secret_access_key...'
azureClientId: '...my_azure_client_id...'
azureClientSecret: '...my_azure_client_secret...'
azureTenantId: '...my_azure_tenant_id...'
gcpServiceAccountJson: '...my_gcp_service_account_json...'
database: 2
host: '...my_host...'
password: '...my_password...'
port: 18528
serverName: '...my_server_name...'
ssl: true
sslVerify: true
timeout: 1.835674936e+09
username: '...my_username...'
strategy: redis
hideCredentials: false
realm: '...my_realm...'
controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
createdAt: 6
enabled: false
gatewayPluginBasicAuthId: '...my_id...'
instanceName: '...my_instance_name...'
ordering:
after:
accesses:
- '...'
before:
accesses:
- '...'
partials:
- id: '...my_id...'
name: '...my_name...'
path: '...my_path...'
protocols:
- http
route:
id: '...my_id...'
service:
id: '...my_id...'
tags:
- '...'
updatedAt: 10
Create GatewayPluginBasicAuth Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayPluginBasicAuth(name: string, args: GatewayPluginBasicAuthArgs, opts?: CustomResourceOptions);@overload
def GatewayPluginBasicAuth(resource_name: str,
args: GatewayPluginBasicAuthArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GatewayPluginBasicAuth(resource_name: str,
opts: Optional[ResourceOptions] = None,
control_plane_id: Optional[str] = None,
ordering: Optional[GatewayPluginBasicAuthOrderingArgs] = None,
created_at: Optional[float] = None,
enabled: Optional[bool] = None,
gateway_plugin_basic_auth_id: Optional[str] = None,
instance_name: Optional[str] = None,
config: Optional[GatewayPluginBasicAuthConfigArgs] = None,
partials: Optional[Sequence[GatewayPluginBasicAuthPartialArgs]] = None,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginBasicAuthRouteArgs] = None,
service: Optional[GatewayPluginBasicAuthServiceArgs] = None,
tags: Optional[Sequence[str]] = None,
updated_at: Optional[float] = None)func NewGatewayPluginBasicAuth(ctx *Context, name string, args GatewayPluginBasicAuthArgs, opts ...ResourceOption) (*GatewayPluginBasicAuth, error)public GatewayPluginBasicAuth(string name, GatewayPluginBasicAuthArgs args, CustomResourceOptions? opts = null)
public GatewayPluginBasicAuth(String name, GatewayPluginBasicAuthArgs args)
public GatewayPluginBasicAuth(String name, GatewayPluginBasicAuthArgs args, CustomResourceOptions options)
type: konnect:GatewayPluginBasicAuth
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 GatewayPluginBasicAuthArgs
- 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 GatewayPluginBasicAuthArgs
- 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 GatewayPluginBasicAuthArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayPluginBasicAuthArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayPluginBasicAuthArgs
- 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 gatewayPluginBasicAuthResource = new Konnect.GatewayPluginBasicAuth("gatewayPluginBasicAuthResource", new()
{
ControlPlaneId = "string",
Ordering = new Konnect.Inputs.GatewayPluginBasicAuthOrderingArgs
{
After = new Konnect.Inputs.GatewayPluginBasicAuthOrderingAfterArgs
{
Accesses = new[]
{
"string",
},
},
Before = new Konnect.Inputs.GatewayPluginBasicAuthOrderingBeforeArgs
{
Accesses = new[]
{
"string",
},
},
},
CreatedAt = 0,
Enabled = false,
GatewayPluginBasicAuthId = "string",
InstanceName = "string",
Config = new Konnect.Inputs.GatewayPluginBasicAuthConfigArgs
{
Anonymous = "string",
BruteForceProtection = new Konnect.Inputs.GatewayPluginBasicAuthConfigBruteForceProtectionArgs
{
Redis = new Konnect.Inputs.GatewayPluginBasicAuthConfigBruteForceProtectionRedisArgs
{
CloudAuthentication = new Konnect.Inputs.GatewayPluginBasicAuthConfigBruteForceProtectionRedisCloudAuthenticationArgs
{
AuthProvider = "string",
AwsAccessKeyId = "string",
AwsAssumeRoleArn = "string",
AwsCacheName = "string",
AwsIsServerless = false,
AwsRegion = "string",
AwsRoleSessionName = "string",
AwsSecretAccessKey = "string",
AzureClientId = "string",
AzureClientSecret = "string",
AzureTenantId = "string",
GcpServiceAccountJson = "string",
},
Database = 0,
Host = "string",
Password = "string",
Port = 0,
ServerName = "string",
Ssl = false,
SslVerify = false,
Timeout = 0,
Username = "string",
},
Strategy = "string",
},
HideCredentials = false,
Realm = "string",
},
Partials = new[]
{
new Konnect.Inputs.GatewayPluginBasicAuthPartialArgs
{
Id = "string",
Name = "string",
Path = "string",
},
},
Protocols = new[]
{
"string",
},
Route = new Konnect.Inputs.GatewayPluginBasicAuthRouteArgs
{
Id = "string",
},
Service = new Konnect.Inputs.GatewayPluginBasicAuthServiceArgs
{
Id = "string",
},
Tags = new[]
{
"string",
},
UpdatedAt = 0,
});
example, err := konnect.NewGatewayPluginBasicAuth(ctx, "gatewayPluginBasicAuthResource", &konnect.GatewayPluginBasicAuthArgs{
ControlPlaneId: pulumi.String("string"),
Ordering: &konnect.GatewayPluginBasicAuthOrderingArgs{
After: &konnect.GatewayPluginBasicAuthOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &konnect.GatewayPluginBasicAuthOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
CreatedAt: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
GatewayPluginBasicAuthId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Config: &konnect.GatewayPluginBasicAuthConfigArgs{
Anonymous: pulumi.String("string"),
BruteForceProtection: &konnect.GatewayPluginBasicAuthConfigBruteForceProtectionArgs{
Redis: &konnect.GatewayPluginBasicAuthConfigBruteForceProtectionRedisArgs{
CloudAuthentication: &konnect.GatewayPluginBasicAuthConfigBruteForceProtectionRedisCloudAuthenticationArgs{
AuthProvider: pulumi.String("string"),
AwsAccessKeyId: pulumi.String("string"),
AwsAssumeRoleArn: pulumi.String("string"),
AwsCacheName: pulumi.String("string"),
AwsIsServerless: pulumi.Bool(false),
AwsRegion: pulumi.String("string"),
AwsRoleSessionName: pulumi.String("string"),
AwsSecretAccessKey: pulumi.String("string"),
AzureClientId: pulumi.String("string"),
AzureClientSecret: pulumi.String("string"),
AzureTenantId: pulumi.String("string"),
GcpServiceAccountJson: pulumi.String("string"),
},
Database: pulumi.Float64(0),
Host: pulumi.String("string"),
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
ServerName: pulumi.String("string"),
Ssl: pulumi.Bool(false),
SslVerify: pulumi.Bool(false),
Timeout: pulumi.Float64(0),
Username: pulumi.String("string"),
},
Strategy: pulumi.String("string"),
},
HideCredentials: pulumi.Bool(false),
Realm: pulumi.String("string"),
},
Partials: konnect.GatewayPluginBasicAuthPartialArray{
&konnect.GatewayPluginBasicAuthPartialArgs{
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Path: pulumi.String("string"),
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &konnect.GatewayPluginBasicAuthRouteArgs{
Id: pulumi.String("string"),
},
Service: &konnect.GatewayPluginBasicAuthServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.Float64(0),
})
var gatewayPluginBasicAuthResource = new GatewayPluginBasicAuth("gatewayPluginBasicAuthResource", GatewayPluginBasicAuthArgs.builder()
.controlPlaneId("string")
.ordering(GatewayPluginBasicAuthOrderingArgs.builder()
.after(GatewayPluginBasicAuthOrderingAfterArgs.builder()
.accesses("string")
.build())
.before(GatewayPluginBasicAuthOrderingBeforeArgs.builder()
.accesses("string")
.build())
.build())
.createdAt(0.0)
.enabled(false)
.gatewayPluginBasicAuthId("string")
.instanceName("string")
.config(GatewayPluginBasicAuthConfigArgs.builder()
.anonymous("string")
.bruteForceProtection(GatewayPluginBasicAuthConfigBruteForceProtectionArgs.builder()
.redis(GatewayPluginBasicAuthConfigBruteForceProtectionRedisArgs.builder()
.cloudAuthentication(GatewayPluginBasicAuthConfigBruteForceProtectionRedisCloudAuthenticationArgs.builder()
.authProvider("string")
.awsAccessKeyId("string")
.awsAssumeRoleArn("string")
.awsCacheName("string")
.awsIsServerless(false)
.awsRegion("string")
.awsRoleSessionName("string")
.awsSecretAccessKey("string")
.azureClientId("string")
.azureClientSecret("string")
.azureTenantId("string")
.gcpServiceAccountJson("string")
.build())
.database(0.0)
.host("string")
.password("string")
.port(0.0)
.serverName("string")
.ssl(false)
.sslVerify(false)
.timeout(0.0)
.username("string")
.build())
.strategy("string")
.build())
.hideCredentials(false)
.realm("string")
.build())
.partials(GatewayPluginBasicAuthPartialArgs.builder()
.id("string")
.name("string")
.path("string")
.build())
.protocols("string")
.route(GatewayPluginBasicAuthRouteArgs.builder()
.id("string")
.build())
.service(GatewayPluginBasicAuthServiceArgs.builder()
.id("string")
.build())
.tags("string")
.updatedAt(0.0)
.build());
gateway_plugin_basic_auth_resource = konnect.GatewayPluginBasicAuth("gatewayPluginBasicAuthResource",
control_plane_id="string",
ordering={
"after": {
"accesses": ["string"],
},
"before": {
"accesses": ["string"],
},
},
created_at=0,
enabled=False,
gateway_plugin_basic_auth_id="string",
instance_name="string",
config={
"anonymous": "string",
"brute_force_protection": {
"redis": {
"cloud_authentication": {
"auth_provider": "string",
"aws_access_key_id": "string",
"aws_assume_role_arn": "string",
"aws_cache_name": "string",
"aws_is_serverless": False,
"aws_region": "string",
"aws_role_session_name": "string",
"aws_secret_access_key": "string",
"azure_client_id": "string",
"azure_client_secret": "string",
"azure_tenant_id": "string",
"gcp_service_account_json": "string",
},
"database": 0,
"host": "string",
"password": "string",
"port": 0,
"server_name": "string",
"ssl": False,
"ssl_verify": False,
"timeout": 0,
"username": "string",
},
"strategy": "string",
},
"hide_credentials": False,
"realm": "string",
},
partials=[{
"id": "string",
"name": "string",
"path": "string",
}],
protocols=["string"],
route={
"id": "string",
},
service={
"id": "string",
},
tags=["string"],
updated_at=0)
const gatewayPluginBasicAuthResource = new konnect.GatewayPluginBasicAuth("gatewayPluginBasicAuthResource", {
controlPlaneId: "string",
ordering: {
after: {
accesses: ["string"],
},
before: {
accesses: ["string"],
},
},
createdAt: 0,
enabled: false,
gatewayPluginBasicAuthId: "string",
instanceName: "string",
config: {
anonymous: "string",
bruteForceProtection: {
redis: {
cloudAuthentication: {
authProvider: "string",
awsAccessKeyId: "string",
awsAssumeRoleArn: "string",
awsCacheName: "string",
awsIsServerless: false,
awsRegion: "string",
awsRoleSessionName: "string",
awsSecretAccessKey: "string",
azureClientId: "string",
azureClientSecret: "string",
azureTenantId: "string",
gcpServiceAccountJson: "string",
},
database: 0,
host: "string",
password: "string",
port: 0,
serverName: "string",
ssl: false,
sslVerify: false,
timeout: 0,
username: "string",
},
strategy: "string",
},
hideCredentials: false,
realm: "string",
},
partials: [{
id: "string",
name: "string",
path: "string",
}],
protocols: ["string"],
route: {
id: "string",
},
service: {
id: "string",
},
tags: ["string"],
updatedAt: 0,
});
type: konnect:GatewayPluginBasicAuth
properties:
config:
anonymous: string
bruteForceProtection:
redis:
cloudAuthentication:
authProvider: string
awsAccessKeyId: string
awsAssumeRoleArn: string
awsCacheName: string
awsIsServerless: false
awsRegion: string
awsRoleSessionName: string
awsSecretAccessKey: string
azureClientId: string
azureClientSecret: string
azureTenantId: string
gcpServiceAccountJson: string
database: 0
host: string
password: string
port: 0
serverName: string
ssl: false
sslVerify: false
timeout: 0
username: string
strategy: string
hideCredentials: false
realm: string
controlPlaneId: string
createdAt: 0
enabled: false
gatewayPluginBasicAuthId: string
instanceName: string
ordering:
after:
accesses:
- string
before:
accesses:
- string
partials:
- id: string
name: string
path: string
protocols:
- string
route:
id: string
service:
id: string
tags:
- string
updatedAt: 0
GatewayPluginBasicAuth 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 GatewayPluginBasicAuth resource accepts the following input properties:
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Config
Gateway
Plugin Basic Auth Config - Created
At double - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied. Default: true
- Gateway
Plugin stringBasic Auth Id - A string representing a UUID (universally unique identifier).
- Instance
Name string - A unique string representing a UTF-8 encoded name.
- Ordering
Gateway
Plugin Basic Auth Ordering - Partials
List<Gateway
Plugin Basic Auth Partial> - A list of partials to be used by the plugin.
- Protocols List<string>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- Route
Gateway
Plugin Basic Auth Route - 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
Gateway
Plugin Basic Auth Service - 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.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At double - Unix epoch when the resource was last updated.
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Config
Gateway
Plugin Basic Auth Config Args - Created
At float64 - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied. Default: true
- Gateway
Plugin stringBasic Auth Id - A string representing a UUID (universally unique identifier).
- Instance
Name string - A unique string representing a UTF-8 encoded name.
- Ordering
Gateway
Plugin Basic Auth Ordering Args - Partials
[]Gateway
Plugin Basic Auth Partial Args - A list of partials to be used by the plugin.
- Protocols []string
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- Route
Gateway
Plugin Basic Auth Route Args - 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
Gateway
Plugin Basic Auth Service Args - 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.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At float64 - Unix epoch when the resource was last updated.
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- config
Gateway
Plugin Basic Auth Config - created
At Double - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin StringBasic Auth Id - A string representing a UUID (universally unique identifier).
- instance
Name String - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Basic Auth Ordering - partials
List<Gateway
Plugin Basic Auth Partial> - A list of partials to be used by the plugin.
- protocols List<String>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Basic Auth Route - 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
Gateway
Plugin Basic Auth Service - 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.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Double - Unix epoch when the resource was last updated.
- control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- config
Gateway
Plugin Basic Auth Config - created
At number - Unix epoch when the resource was created.
- enabled boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin stringBasic Auth Id - A string representing a UUID (universally unique identifier).
- instance
Name string - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Basic Auth Ordering - partials
Gateway
Plugin Basic Auth Partial[] - A list of partials to be used by the plugin.
- protocols string[]
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Basic Auth Route - 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
Gateway
Plugin Basic Auth Service - 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.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At number - Unix epoch when the resource was last updated.
- control_
plane_ strid - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- config
Gateway
Plugin Basic Auth Config Args - created_
at float - Unix epoch when the resource was created.
- enabled bool
- Whether the plugin is applied. Default: true
- gateway_
plugin_ strbasic_ auth_ id - A string representing a UUID (universally unique identifier).
- instance_
name str - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Basic Auth Ordering Args - partials
Sequence[Gateway
Plugin Basic Auth Partial Args] - A list of partials to be used by the plugin.
- protocols Sequence[str]
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Basic Auth Route Args - 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
Gateway
Plugin Basic Auth Service Args - 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.
- 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.
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- config Property Map
- created
At Number - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin StringBasic Auth Id - A string representing a UUID (universally unique identifier).
- instance
Name String - A unique string representing a UTF-8 encoded name.
- ordering Property Map
- partials List<Property Map>
- A list of partials to be used by the plugin.
- protocols List<String>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- 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.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Number - Unix epoch when the resource was last updated.
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayPluginBasicAuth resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing GatewayPluginBasicAuth Resource
Get an existing GatewayPluginBasicAuth 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?: GatewayPluginBasicAuthState, opts?: CustomResourceOptions): GatewayPluginBasicAuth@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
config: Optional[GatewayPluginBasicAuthConfigArgs] = None,
control_plane_id: Optional[str] = None,
created_at: Optional[float] = None,
enabled: Optional[bool] = None,
gateway_plugin_basic_auth_id: Optional[str] = None,
instance_name: Optional[str] = None,
ordering: Optional[GatewayPluginBasicAuthOrderingArgs] = None,
partials: Optional[Sequence[GatewayPluginBasicAuthPartialArgs]] = None,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginBasicAuthRouteArgs] = None,
service: Optional[GatewayPluginBasicAuthServiceArgs] = None,
tags: Optional[Sequence[str]] = None,
updated_at: Optional[float] = None) -> GatewayPluginBasicAuthfunc GetGatewayPluginBasicAuth(ctx *Context, name string, id IDInput, state *GatewayPluginBasicAuthState, opts ...ResourceOption) (*GatewayPluginBasicAuth, error)public static GatewayPluginBasicAuth Get(string name, Input<string> id, GatewayPluginBasicAuthState? state, CustomResourceOptions? opts = null)public static GatewayPluginBasicAuth get(String name, Output<String> id, GatewayPluginBasicAuthState state, CustomResourceOptions options)resources: _: type: konnect:GatewayPluginBasicAuth 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.
- Config
Gateway
Plugin Basic Auth Config - Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Created
At double - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied. Default: true
- Gateway
Plugin stringBasic Auth Id - A string representing a UUID (universally unique identifier).
- Instance
Name string - A unique string representing a UTF-8 encoded name.
- Ordering
Gateway
Plugin Basic Auth Ordering - Partials
List<Gateway
Plugin Basic Auth Partial> - A list of partials to be used by the plugin.
- Protocols List<string>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- Route
Gateway
Plugin Basic Auth Route - 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
Gateway
Plugin Basic Auth Service - 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.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At double - Unix epoch when the resource was last updated.
- Config
Gateway
Plugin Basic Auth Config Args - Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Created
At float64 - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied. Default: true
- Gateway
Plugin stringBasic Auth Id - A string representing a UUID (universally unique identifier).
- Instance
Name string - A unique string representing a UTF-8 encoded name.
- Ordering
Gateway
Plugin Basic Auth Ordering Args - Partials
[]Gateway
Plugin Basic Auth Partial Args - A list of partials to be used by the plugin.
- Protocols []string
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- Route
Gateway
Plugin Basic Auth Route Args - 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
Gateway
Plugin Basic Auth Service Args - 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.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At float64 - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Basic Auth Config - control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At Double - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin StringBasic Auth Id - A string representing a UUID (universally unique identifier).
- instance
Name String - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Basic Auth Ordering - partials
List<Gateway
Plugin Basic Auth Partial> - A list of partials to be used by the plugin.
- protocols List<String>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Basic Auth Route - 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
Gateway
Plugin Basic Auth Service - 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.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Double - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Basic Auth Config - control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At number - Unix epoch when the resource was created.
- enabled boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin stringBasic Auth Id - A string representing a UUID (universally unique identifier).
- instance
Name string - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Basic Auth Ordering - partials
Gateway
Plugin Basic Auth Partial[] - A list of partials to be used by the plugin.
- protocols string[]
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Basic Auth Route - 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
Gateway
Plugin Basic Auth Service - 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.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At number - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Basic Auth Config Args - control_
plane_ strid - 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. Default: true
- gateway_
plugin_ strbasic_ auth_ id - A string representing a UUID (universally unique identifier).
- instance_
name str - A unique string representing a UTF-8 encoded name.
- ordering
Gateway
Plugin Basic Auth Ordering Args - partials
Sequence[Gateway
Plugin Basic Auth Partial Args] - A list of partials to be used by the plugin.
- protocols Sequence[str]
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- route
Gateway
Plugin Basic Auth Route Args - 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
Gateway
Plugin Basic Auth Service Args - 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.
- 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
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At Number - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied. Default: true
- gateway
Plugin StringBasic Auth Id - A string representing a UUID (universally unique identifier).
- instance
Name String - A unique string representing a UTF-8 encoded name.
- ordering Property Map
- partials List<Property Map>
- A list of partials to be used by the plugin.
- protocols List<String>
- A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls. Default: ["grpc","grpcs","http","https","ws","wss"]
- 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.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Number - Unix epoch when the resource was last updated.
Supporting Types
GatewayPluginBasicAuthConfig, GatewayPluginBasicAuthConfigArgs
- Anonymous string
- An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure
4xx. Please note that this value must refer to the Consumeridorusernameattribute, and not itscustom_id. - Brute
Force GatewayProtection Plugin Basic Auth Config Brute Force Protection - Hide
Credentials bool - An optional boolean value telling the plugin to show or hide the credential from the upstream service. If
true, the plugin will strip the credential from the request (i.e. theAuthorizationheader) before proxying it. Default: false - Realm string
- When authentication fails the plugin sends
WWW-Authenticateheader withrealmattribute value. Default: "service"
- Anonymous string
- An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure
4xx. Please note that this value must refer to the Consumeridorusernameattribute, and not itscustom_id. - Brute
Force GatewayProtection Plugin Basic Auth Config Brute Force Protection - Hide
Credentials bool - An optional boolean value telling the plugin to show or hide the credential from the upstream service. If
true, the plugin will strip the credential from the request (i.e. theAuthorizationheader) before proxying it. Default: false - Realm string
- When authentication fails the plugin sends
WWW-Authenticateheader withrealmattribute value. Default: "service"
- anonymous String
- An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure
4xx. Please note that this value must refer to the Consumeridorusernameattribute, and not itscustom_id. - brute
Force GatewayProtection Plugin Basic Auth Config Brute Force Protection - hide
Credentials Boolean - An optional boolean value telling the plugin to show or hide the credential from the upstream service. If
true, the plugin will strip the credential from the request (i.e. theAuthorizationheader) before proxying it. Default: false - realm String
- When authentication fails the plugin sends
WWW-Authenticateheader withrealmattribute value. Default: "service"
- anonymous string
- An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure
4xx. Please note that this value must refer to the Consumeridorusernameattribute, and not itscustom_id. - brute
Force GatewayProtection Plugin Basic Auth Config Brute Force Protection - hide
Credentials boolean - An optional boolean value telling the plugin to show or hide the credential from the upstream service. If
true, the plugin will strip the credential from the request (i.e. theAuthorizationheader) before proxying it. Default: false - realm string
- When authentication fails the plugin sends
WWW-Authenticateheader withrealmattribute value. Default: "service"
- anonymous str
- An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure
4xx. Please note that this value must refer to the Consumeridorusernameattribute, and not itscustom_id. - brute_
force_ Gatewayprotection Plugin Basic Auth Config Brute Force Protection - hide_
credentials bool - An optional boolean value telling the plugin to show or hide the credential from the upstream service. If
true, the plugin will strip the credential from the request (i.e. theAuthorizationheader) before proxying it. Default: false - realm str
- When authentication fails the plugin sends
WWW-Authenticateheader withrealmattribute value. Default: "service"
- anonymous String
- An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure
4xx. Please note that this value must refer to the Consumeridorusernameattribute, and not itscustom_id. - brute
Force Property MapProtection - hide
Credentials Boolean - An optional boolean value telling the plugin to show or hide the credential from the upstream service. If
true, the plugin will strip the credential from the request (i.e. theAuthorizationheader) before proxying it. Default: false - realm String
- When authentication fails the plugin sends
WWW-Authenticateheader withrealmattribute value. Default: "service"
GatewayPluginBasicAuthConfigBruteForceProtection, GatewayPluginBasicAuthConfigBruteForceProtectionArgs
- Redis
Gateway
Plugin Basic Auth Config Brute Force Protection Redis - Redis configuration
- Strategy string
- The brute force protection strategy to use for retrieving and incrementing the limits. Available values are:
cluster,redis,memory, andoff. Default: "off"; must be one of ["cluster", "memory", "off", "redis"]
- Redis
Gateway
Plugin Basic Auth Config Brute Force Protection Redis - Redis configuration
- Strategy string
- The brute force protection strategy to use for retrieving and incrementing the limits. Available values are:
cluster,redis,memory, andoff. Default: "off"; must be one of ["cluster", "memory", "off", "redis"]
- redis
Gateway
Plugin Basic Auth Config Brute Force Protection Redis - Redis configuration
- strategy String
- The brute force protection strategy to use for retrieving and incrementing the limits. Available values are:
cluster,redis,memory, andoff. Default: "off"; must be one of ["cluster", "memory", "off", "redis"]
- redis
Gateway
Plugin Basic Auth Config Brute Force Protection Redis - Redis configuration
- strategy string
- The brute force protection strategy to use for retrieving and incrementing the limits. Available values are:
cluster,redis,memory, andoff. Default: "off"; must be one of ["cluster", "memory", "off", "redis"]
- redis
Gateway
Plugin Basic Auth Config Brute Force Protection Redis - Redis configuration
- strategy str
- The brute force protection strategy to use for retrieving and incrementing the limits. Available values are:
cluster,redis,memory, andoff. Default: "off"; must be one of ["cluster", "memory", "off", "redis"]
- redis Property Map
- Redis configuration
- strategy String
- The brute force protection strategy to use for retrieving and incrementing the limits. Available values are:
cluster,redis,memory, andoff. Default: "off"; must be one of ["cluster", "memory", "off", "redis"]
GatewayPluginBasicAuthConfigBruteForceProtectionRedis, GatewayPluginBasicAuthConfigBruteForceProtectionRedisArgs
- Cloud
Authentication GatewayPlugin Basic Auth Config Brute Force Protection Redis Cloud Authentication - Cloud auth related configs for connecting to a Cloud Provider's Redis instance.
- Database double
- Database to use for the Redis connection when using the
redisstrategy. Default: 0 - Host string
- A string representing a host name, such as example.com.
- 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. Default: 6379
- Server
Name string - A string representing an SNI (server name indication) value for TLS.
- Ssl bool
- If set to true, uses SSL to connect to Redis. Default: false
- Ssl
Verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. Default: false - Timeout double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000
- 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.
- Cloud
Authentication GatewayPlugin Basic Auth Config Brute Force Protection Redis Cloud Authentication - Cloud auth related configs for connecting to a Cloud Provider's Redis instance.
- Database float64
- Database to use for the Redis connection when using the
redisstrategy. Default: 0 - Host string
- A string representing a host name, such as example.com.
- 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. Default: 6379
- Server
Name string - A string representing an SNI (server name indication) value for TLS.
- Ssl bool
- If set to true, uses SSL to connect to Redis. Default: false
- Ssl
Verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. Default: false - Timeout float64
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000
- 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.
- cloud
Authentication GatewayPlugin Basic Auth Config Brute Force Protection Redis Cloud Authentication - Cloud auth related configs for connecting to a Cloud Provider's Redis instance.
- database Double
- Database to use for the Redis connection when using the
redisstrategy. Default: 0 - host String
- A string representing a host name, such as example.com.
- 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. Default: 6379
- server
Name String - A string representing an SNI (server name indication) value for TLS.
- ssl Boolean
- If set to true, uses SSL to connect to Redis. Default: false
- ssl
Verify Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. Default: false - timeout Double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000
- 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.
- cloud
Authentication GatewayPlugin Basic Auth Config Brute Force Protection Redis Cloud Authentication - Cloud auth related configs for connecting to a Cloud Provider's Redis instance.
- database number
- Database to use for the Redis connection when using the
redisstrategy. Default: 0 - host string
- A string representing a host name, such as example.com.
- 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. Default: 6379
- server
Name string - A string representing an SNI (server name indication) value for TLS.
- ssl boolean
- If set to true, uses SSL to connect to Redis. Default: false
- ssl
Verify boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. Default: false - timeout number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000
- 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.
- cloud_
authentication GatewayPlugin Basic Auth Config Brute Force Protection Redis Cloud Authentication - Cloud auth related configs for connecting to a Cloud Provider's Redis instance.
- database float
- Database to use for the Redis connection when using the
redisstrategy. Default: 0 - host str
- A string representing a host name, such as example.com.
- 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. Default: 6379
- 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. Default: false
- ssl_
verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. Default: false - timeout float
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000
- 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.
- cloud
Authentication Property Map - Cloud auth related configs for connecting to a Cloud Provider's Redis instance.
- database Number
- Database to use for the Redis connection when using the
redisstrategy. Default: 0 - host String
- A string representing a host name, such as example.com.
- 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. Default: 6379
- server
Name String - A string representing an SNI (server name indication) value for TLS.
- ssl Boolean
- If set to true, uses SSL to connect to Redis. Default: false
- ssl
Verify Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. Default: false - timeout Number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000
- 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.
GatewayPluginBasicAuthConfigBruteForceProtectionRedisCloudAuthentication, GatewayPluginBasicAuthConfigBruteForceProtectionRedisCloudAuthenticationArgs
- Auth
Provider string - Auth providers to be used to authenticate to a Cloud Provider's Redis instance. must be one of ["aws", "azure", "gcp"]
- Aws
Access stringKey Id - AWS Access Key ID to be used for authentication when
auth_provideris set toaws. - Aws
Assume stringRole Arn - The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens.
- Aws
Cache stringName - The name of the AWS Elasticache cluster when
auth_provideris set toaws. - Aws
Is boolServerless - This flag specifies whether the cluster is serverless when auth_provider is set to
aws. Default: true - Aws
Region string - The region of the AWS ElastiCache cluster when
auth_provideris set toaws. - Aws
Role stringSession Name - The session name for the temporary credentials when assuming the IAM role.
- Aws
Secret stringAccess Key - AWS Secret Access Key to be used for authentication when
auth_provideris set toaws. - Azure
Client stringId - Azure Client ID to be used for authentication when
auth_provideris set toazure. - Azure
Client stringSecret - Azure Client Secret to be used for authentication when
auth_provideris set toazure. - Azure
Tenant stringId - Azure Tenant ID to be used for authentication when
auth_provideris set toazure. - Gcp
Service stringAccount Json - GCP Service Account JSON to be used for authentication when
auth_provideris set togcp.
- Auth
Provider string - Auth providers to be used to authenticate to a Cloud Provider's Redis instance. must be one of ["aws", "azure", "gcp"]
- Aws
Access stringKey Id - AWS Access Key ID to be used for authentication when
auth_provideris set toaws. - Aws
Assume stringRole Arn - The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens.
- Aws
Cache stringName - The name of the AWS Elasticache cluster when
auth_provideris set toaws. - Aws
Is boolServerless - This flag specifies whether the cluster is serverless when auth_provider is set to
aws. Default: true - Aws
Region string - The region of the AWS ElastiCache cluster when
auth_provideris set toaws. - Aws
Role stringSession Name - The session name for the temporary credentials when assuming the IAM role.
- Aws
Secret stringAccess Key - AWS Secret Access Key to be used for authentication when
auth_provideris set toaws. - Azure
Client stringId - Azure Client ID to be used for authentication when
auth_provideris set toazure. - Azure
Client stringSecret - Azure Client Secret to be used for authentication when
auth_provideris set toazure. - Azure
Tenant stringId - Azure Tenant ID to be used for authentication when
auth_provideris set toazure. - Gcp
Service stringAccount Json - GCP Service Account JSON to be used for authentication when
auth_provideris set togcp.
- auth
Provider String - Auth providers to be used to authenticate to a Cloud Provider's Redis instance. must be one of ["aws", "azure", "gcp"]
- aws
Access StringKey Id - AWS Access Key ID to be used for authentication when
auth_provideris set toaws. - aws
Assume StringRole Arn - The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens.
- aws
Cache StringName - The name of the AWS Elasticache cluster when
auth_provideris set toaws. - aws
Is BooleanServerless - This flag specifies whether the cluster is serverless when auth_provider is set to
aws. Default: true - aws
Region String - The region of the AWS ElastiCache cluster when
auth_provideris set toaws. - aws
Role StringSession Name - The session name for the temporary credentials when assuming the IAM role.
- aws
Secret StringAccess Key - AWS Secret Access Key to be used for authentication when
auth_provideris set toaws. - azure
Client StringId - Azure Client ID to be used for authentication when
auth_provideris set toazure. - azure
Client StringSecret - Azure Client Secret to be used for authentication when
auth_provideris set toazure. - azure
Tenant StringId - Azure Tenant ID to be used for authentication when
auth_provideris set toazure. - gcp
Service StringAccount Json - GCP Service Account JSON to be used for authentication when
auth_provideris set togcp.
- auth
Provider string - Auth providers to be used to authenticate to a Cloud Provider's Redis instance. must be one of ["aws", "azure", "gcp"]
- aws
Access stringKey Id - AWS Access Key ID to be used for authentication when
auth_provideris set toaws. - aws
Assume stringRole Arn - The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens.
- aws
Cache stringName - The name of the AWS Elasticache cluster when
auth_provideris set toaws. - aws
Is booleanServerless - This flag specifies whether the cluster is serverless when auth_provider is set to
aws. Default: true - aws
Region string - The region of the AWS ElastiCache cluster when
auth_provideris set toaws. - aws
Role stringSession Name - The session name for the temporary credentials when assuming the IAM role.
- aws
Secret stringAccess Key - AWS Secret Access Key to be used for authentication when
auth_provideris set toaws. - azure
Client stringId - Azure Client ID to be used for authentication when
auth_provideris set toazure. - azure
Client stringSecret - Azure Client Secret to be used for authentication when
auth_provideris set toazure. - azure
Tenant stringId - Azure Tenant ID to be used for authentication when
auth_provideris set toazure. - gcp
Service stringAccount Json - GCP Service Account JSON to be used for authentication when
auth_provideris set togcp.
- auth_
provider str - Auth providers to be used to authenticate to a Cloud Provider's Redis instance. must be one of ["aws", "azure", "gcp"]
- aws_
access_ strkey_ id - AWS Access Key ID to be used for authentication when
auth_provideris set toaws. - aws_
assume_ strrole_ arn - The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens.
- aws_
cache_ strname - The name of the AWS Elasticache cluster when
auth_provideris set toaws. - aws_
is_ boolserverless - This flag specifies whether the cluster is serverless when auth_provider is set to
aws. Default: true - aws_
region str - The region of the AWS ElastiCache cluster when
auth_provideris set toaws. - aws_
role_ strsession_ name - The session name for the temporary credentials when assuming the IAM role.
- aws_
secret_ straccess_ key - AWS Secret Access Key to be used for authentication when
auth_provideris set toaws. - azure_
client_ strid - Azure Client ID to be used for authentication when
auth_provideris set toazure. - azure_
client_ strsecret - Azure Client Secret to be used for authentication when
auth_provideris set toazure. - azure_
tenant_ strid - Azure Tenant ID to be used for authentication when
auth_provideris set toazure. - gcp_
service_ straccount_ json - GCP Service Account JSON to be used for authentication when
auth_provideris set togcp.
- auth
Provider String - Auth providers to be used to authenticate to a Cloud Provider's Redis instance. must be one of ["aws", "azure", "gcp"]
- aws
Access StringKey Id - AWS Access Key ID to be used for authentication when
auth_provideris set toaws. - aws
Assume StringRole Arn - The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens.
- aws
Cache StringName - The name of the AWS Elasticache cluster when
auth_provideris set toaws. - aws
Is BooleanServerless - This flag specifies whether the cluster is serverless when auth_provider is set to
aws. Default: true - aws
Region String - The region of the AWS ElastiCache cluster when
auth_provideris set toaws. - aws
Role StringSession Name - The session name for the temporary credentials when assuming the IAM role.
- aws
Secret StringAccess Key - AWS Secret Access Key to be used for authentication when
auth_provideris set toaws. - azure
Client StringId - Azure Client ID to be used for authentication when
auth_provideris set toazure. - azure
Client StringSecret - Azure Client Secret to be used for authentication when
auth_provideris set toazure. - azure
Tenant StringId - Azure Tenant ID to be used for authentication when
auth_provideris set toazure. - gcp
Service StringAccount Json - GCP Service Account JSON to be used for authentication when
auth_provideris set togcp.
GatewayPluginBasicAuthOrdering, GatewayPluginBasicAuthOrderingArgs
GatewayPluginBasicAuthOrderingAfter, GatewayPluginBasicAuthOrderingAfterArgs
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginBasicAuthOrderingBefore, GatewayPluginBasicAuthOrderingBeforeArgs
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginBasicAuthPartial, GatewayPluginBasicAuthPartialArgs
GatewayPluginBasicAuthRoute, GatewayPluginBasicAuthRouteArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginBasicAuthService, GatewayPluginBasicAuthServiceArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
Import
In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:
terraform
import {
to = konnect_gateway_plugin_basic_auth.my_konnect_gateway_plugin_basic_auth
id = jsonencode({
control_plane_id = "9524ec7d-36d9-465d-a8c5-83a3c9390458"
id = "3473c251-5b6c-4f45-b1ff-7ede735a366d"
})
}
The pulumi import command can be used, for example:
$ pulumi import konnect:index/gatewayPluginBasicAuth:GatewayPluginBasicAuth my_konnect_gateway_plugin_basic_auth '{"control_plane_id": "9524ec7d-36d9-465d-a8c5-83a3c9390458", "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
konnectTerraform Provider.
