Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cyral Provider
  3. API Docs
  4. SidecarListener
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
cyralinc/terraform-provider-cyral

cyral.SidecarListener

Explore with Pulumi AI

cyral logo
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
cyralinc/terraform-provider-cyral

    # cyral.SidecarListener (Resource)

    Manages sidecar listeners.

    Warning Multiple listeners can be associated to a single sidecar as long as host and port are unique. If host is omitted, then port must be unique.

    Import ID syntax is {sidecar_id}/{listener_id}.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cyral from "@pulumi/cyral";

const sidecar = new cyral.Sidecar("sidecar", {deploymentMethod: "docker"});
// Plain listener
const listener = new cyral.SidecarListener("listener", {
    sidecarId: sidecar.id,
    repoTypes: ["mongodb"],
    networkAddress: {
        port: 27017,
    },
});
// Listener with MySQL Settings
const listenerMysql = new cyral.SidecarListener("listenerMysql", {
    sidecarId: sidecar.id,
    repoTypes: ["mysql"],
    networkAddress: {
        port: 3306,
    },
    mysqlSettings: {
        dbVersion: "8.0.4",
        characterSet: "utf8mb4_0900_ai_ci",
    },
});
// Listener for S3 CLI and AWS SDK
const listenerS3CliSidecarListener = new cyral.SidecarListener("listenerS3CliSidecarListener", {
    sidecarId: sidecar.id,
    repoTypes: ["s3"],
    networkAddress: {
        port: 443,
    },
    s3Settings: {
        proxyMode: true,
    },
});
// Listener for S3 browser (using port 444 assuming port
// 443 is used for CLI)
const listenerS3CliIndex_sidecarListenerSidecarListener = new cyral.SidecarListener("listenerS3CliIndex/sidecarListenerSidecarListener", {
    sidecarId: sidecar.id,
    repoTypes: ["s3"],
    networkAddress: {
        port: 444,
    },
    s3Settings: {
        proxyMode: false,
    },
});
// Listener with DynamoDB Settings
const listenerDynamodb = new cyral.SidecarListener("listenerDynamodb", {
    sidecarId: sidecar.id,
    repoTypes: ["dynamodb"],
    networkAddress: {
        port: 8000,
    },
    dynamodbSettings: {
        proxyMode: true,
    },
});

    import pulumi
import pulumi_cyral as cyral

sidecar = cyral.Sidecar("sidecar", deployment_method="docker")
# Plain listener
listener = cyral.SidecarListener("listener",
    sidecar_id=sidecar.id,
    repo_types=["mongodb"],
    network_address={
        "port": 27017,
    })
# Listener with MySQL Settings
listener_mysql = cyral.SidecarListener("listenerMysql",
    sidecar_id=sidecar.id,
    repo_types=["mysql"],
    network_address={
        "port": 3306,
    },
    mysql_settings={
        "db_version": "8.0.4",
        "character_set": "utf8mb4_0900_ai_ci",
    })
# Listener for S3 CLI and AWS SDK
listener_s3_cli_sidecar_listener = cyral.SidecarListener("listenerS3CliSidecarListener",
    sidecar_id=sidecar.id,
    repo_types=["s3"],
    network_address={
        "port": 443,
    },
    s3_settings={
        "proxy_mode": True,
    })
# Listener for S3 browser (using port 444 assuming port
# 443 is used for CLI)
listener_s3_cli_index_sidecar_listener_sidecar_listener = cyral.SidecarListener("listenerS3CliIndex/sidecarListenerSidecarListener",
    sidecar_id=sidecar.id,
    repo_types=["s3"],
    network_address={
        "port": 444,
    },
    s3_settings={
        "proxy_mode": False,
    })
# Listener with DynamoDB Settings
listener_dynamodb = cyral.SidecarListener("listenerDynamodb",
    sidecar_id=sidecar.id,
    repo_types=["dynamodb"],
    network_address={
        "port": 8000,
    },
    dynamodb_settings={
        "proxy_mode": True,
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/cyral/v4/cyral"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		sidecar, err := cyral.NewSidecar(ctx, "sidecar", &cyral.SidecarArgs{
			DeploymentMethod: pulumi.String("docker"),
		})
		if err != nil {
			return err
		}
		// Plain listener
		_, err = cyral.NewSidecarListener(ctx, "listener", &cyral.SidecarListenerArgs{
			SidecarId: sidecar.ID(),
			RepoTypes: pulumi.StringArray{
				pulumi.String("mongodb"),
			},
			NetworkAddress: &cyral.SidecarListenerNetworkAddressArgs{
				Port: pulumi.Float64(27017),
			},
		})
		if err != nil {
			return err
		}
		// Listener with MySQL Settings
		_, err = cyral.NewSidecarListener(ctx, "listenerMysql", &cyral.SidecarListenerArgs{
			SidecarId: sidecar.ID(),
			RepoTypes: pulumi.StringArray{
				pulumi.String("mysql"),
			},
			NetworkAddress: &cyral.SidecarListenerNetworkAddressArgs{
				Port: pulumi.Float64(3306),
			},
			MysqlSettings: &cyral.SidecarListenerMysqlSettingsArgs{
				DbVersion:    pulumi.String("8.0.4"),
				CharacterSet: pulumi.String("utf8mb4_0900_ai_ci"),
			},
		})
		if err != nil {
			return err
		}
		// Listener for S3 CLI and AWS SDK
		_, err = cyral.NewSidecarListener(ctx, "listenerS3CliSidecarListener", &cyral.SidecarListenerArgs{
			SidecarId: sidecar.ID(),
			RepoTypes: pulumi.StringArray{
				pulumi.String("s3"),
			},
			NetworkAddress: &cyral.SidecarListenerNetworkAddressArgs{
				Port: pulumi.Float64(443),
			},
			S3Settings: &cyral.SidecarListenerS3SettingsArgs{
				ProxyMode: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		// Listener for S3 browser (using port 444 assuming port
		// 443 is used for CLI)
		_, err = cyral.NewSidecarListener(ctx, "listenerS3CliIndex/sidecarListenerSidecarListener", &cyral.SidecarListenerArgs{
			SidecarId: sidecar.ID(),
			RepoTypes: pulumi.StringArray{
				pulumi.String("s3"),
			},
			NetworkAddress: &cyral.SidecarListenerNetworkAddressArgs{
				Port: pulumi.Float64(444),
			},
			S3Settings: &cyral.SidecarListenerS3SettingsArgs{
				ProxyMode: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		// Listener with DynamoDB Settings
		_, err = cyral.NewSidecarListener(ctx, "listenerDynamodb", &cyral.SidecarListenerArgs{
			SidecarId: sidecar.ID(),
			RepoTypes: pulumi.StringArray{
				pulumi.String("dynamodb"),
			},
			NetworkAddress: &cyral.SidecarListenerNetworkAddressArgs{
				Port: pulumi.Float64(8000),
			},
			DynamodbSettings: &cyral.SidecarListenerDynamodbSettingsArgs{
				ProxyMode: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cyral = Pulumi.Cyral;

return await Deployment.RunAsync(() => 
{
    var sidecar = new Cyral.Sidecar("sidecar", new()
    {
        DeploymentMethod = "docker",
    });

    // Plain listener
    var listener = new Cyral.SidecarListener("listener", new()
    {
        SidecarId = sidecar.Id,
        RepoTypes = new[]
        {
            "mongodb",
        },
        NetworkAddress = new Cyral.Inputs.SidecarListenerNetworkAddressArgs
        {
            Port = 27017,
        },
    });

    // Listener with MySQL Settings
    var listenerMysql = new Cyral.SidecarListener("listenerMysql", new()
    {
        SidecarId = sidecar.Id,
        RepoTypes = new[]
        {
            "mysql",
        },
        NetworkAddress = new Cyral.Inputs.SidecarListenerNetworkAddressArgs
        {
            Port = 3306,
        },
        MysqlSettings = new Cyral.Inputs.SidecarListenerMysqlSettingsArgs
        {
            DbVersion = "8.0.4",
            CharacterSet = "utf8mb4_0900_ai_ci",
        },
    });

    // Listener for S3 CLI and AWS SDK
    var listenerS3CliSidecarListener = new Cyral.SidecarListener("listenerS3CliSidecarListener", new()
    {
        SidecarId = sidecar.Id,
        RepoTypes = new[]
        {
            "s3",
        },
        NetworkAddress = new Cyral.Inputs.SidecarListenerNetworkAddressArgs
        {
            Port = 443,
        },
        S3Settings = new Cyral.Inputs.SidecarListenerS3SettingsArgs
        {
            ProxyMode = true,
        },
    });

    // Listener for S3 browser (using port 444 assuming port
    // 443 is used for CLI)
    var listenerS3CliIndex_sidecarListenerSidecarListener = new Cyral.SidecarListener("listenerS3CliIndex/sidecarListenerSidecarListener", new()
    {
        SidecarId = sidecar.Id,
        RepoTypes = new[]
        {
            "s3",
        },
        NetworkAddress = new Cyral.Inputs.SidecarListenerNetworkAddressArgs
        {
            Port = 444,
        },
        S3Settings = new Cyral.Inputs.SidecarListenerS3SettingsArgs
        {
            ProxyMode = false,
        },
    });

    // Listener with DynamoDB Settings
    var listenerDynamodb = new Cyral.SidecarListener("listenerDynamodb", new()
    {
        SidecarId = sidecar.Id,
        RepoTypes = new[]
        {
            "dynamodb",
        },
        NetworkAddress = new Cyral.Inputs.SidecarListenerNetworkAddressArgs
        {
            Port = 8000,
        },
        DynamodbSettings = new Cyral.Inputs.SidecarListenerDynamodbSettingsArgs
        {
            ProxyMode = true,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cyral.Sidecar;
import com.pulumi.cyral.SidecarArgs;
import com.pulumi.cyral.SidecarListener;
import com.pulumi.cyral.SidecarListenerArgs;
import com.pulumi.cyral.inputs.SidecarListenerNetworkAddressArgs;
import com.pulumi.cyral.inputs.SidecarListenerMysqlSettingsArgs;
import com.pulumi.cyral.inputs.SidecarListenerS3SettingsArgs;
import com.pulumi.cyral.inputs.SidecarListenerDynamodbSettingsArgs;
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 sidecar = new Sidecar("sidecar", SidecarArgs.builder()
            .deploymentMethod("docker")
            .build());

        // Plain listener
        var listener = new SidecarListener("listener", SidecarListenerArgs.builder()
            .sidecarId(sidecar.id())
            .repoTypes("mongodb")
            .networkAddress(SidecarListenerNetworkAddressArgs.builder()
                .port(27017)
                .build())
            .build());

        // Listener with MySQL Settings
        var listenerMysql = new SidecarListener("listenerMysql", SidecarListenerArgs.builder()
            .sidecarId(sidecar.id())
            .repoTypes("mysql")
            .networkAddress(SidecarListenerNetworkAddressArgs.builder()
                .port(3306)
                .build())
            .mysqlSettings(SidecarListenerMysqlSettingsArgs.builder()
                .dbVersion("8.0.4")
                .characterSet("utf8mb4_0900_ai_ci")
                .build())
            .build());

        // Listener for S3 CLI and AWS SDK
        var listenerS3CliSidecarListener = new SidecarListener("listenerS3CliSidecarListener", SidecarListenerArgs.builder()
            .sidecarId(sidecar.id())
            .repoTypes("s3")
            .networkAddress(SidecarListenerNetworkAddressArgs.builder()
                .port(443)
                .build())
            .s3Settings(SidecarListenerS3SettingsArgs.builder()
                .proxyMode(true)
                .build())
            .build());

        // Listener for S3 browser (using port 444 assuming port
        // 443 is used for CLI)
        var listenerS3CliIndex_sidecarListenerSidecarListener = new SidecarListener("listenerS3CliIndex/sidecarListenerSidecarListener", SidecarListenerArgs.builder()
            .sidecarId(sidecar.id())
            .repoTypes("s3")
            .networkAddress(SidecarListenerNetworkAddressArgs.builder()
                .port(444)
                .build())
            .s3Settings(SidecarListenerS3SettingsArgs.builder()
                .proxyMode(false)
                .build())
            .build());

        // Listener with DynamoDB Settings
        var listenerDynamodb = new SidecarListener("listenerDynamodb", SidecarListenerArgs.builder()
            .sidecarId(sidecar.id())
            .repoTypes("dynamodb")
            .networkAddress(SidecarListenerNetworkAddressArgs.builder()
                .port(8000)
                .build())
            .dynamodbSettings(SidecarListenerDynamodbSettingsArgs.builder()
                .proxyMode(true)
                .build())
            .build());

    }
}

    resources:
  sidecar:
    type: cyral:Sidecar
    properties:
      deploymentMethod: docker
  # Plain listener
  listener:
    type: cyral:SidecarListener
    properties:
      sidecarId: ${sidecar.id}
      repoTypes:
        - mongodb
      networkAddress:
        port: 27017
  # Listener with MySQL Settings
  listenerMysql:
    type: cyral:SidecarListener
    properties:
      sidecarId: ${sidecar.id}
      repoTypes:
        - mysql
      networkAddress:
        port: 3306
      mysqlSettings:
        dbVersion: 8.0.4
        characterSet: utf8mb4_0900_ai_ci
  # Listener for S3 CLI and AWS SDK
  listenerS3CliSidecarListener:
    type: cyral:SidecarListener
    properties:
      sidecarId: ${sidecar.id}
      repoTypes:
        - s3
      networkAddress:
        port: 443
      s3Settings:
        proxyMode: true
  # Listener for S3 browser (using port 444 assuming port
  # 443 is used for CLI)
  listenerS3CliIndex/sidecarListenerSidecarListener:
    type: cyral:SidecarListener
    properties:
      sidecarId: ${sidecar.id}
      repoTypes:
        - s3
      networkAddress:
        port: 444
      s3Settings:
        proxyMode: false
  # Listener with DynamoDB Settings
  listenerDynamodb:
    type: cyral:SidecarListener
    properties:
      sidecarId: ${sidecar.id}
      repoTypes:
        - dynamodb
      networkAddress:
        port: 8000
      dynamodbSettings:
        proxyMode: true

    Create SidecarListener Resource

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

    Constructor syntax

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

@overload
def SidecarListener(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    network_address: Optional[SidecarListenerNetworkAddressArgs] = None,
                    repo_types: Optional[Sequence[str]] = None,
                    sidecar_id: Optional[str] = None,
                    dynamodb_settings: Optional[SidecarListenerDynamodbSettingsArgs] = None,
                    mysql_settings: Optional[SidecarListenerMysqlSettingsArgs] = None,
                    s3_settings: Optional[SidecarListenerS3SettingsArgs] = None,
                    sidecar_listener_id: Optional[str] = None,
                    sqlserver_settings: Optional[SidecarListenerSqlserverSettingsArgs] = None)
    func NewSidecarListener(ctx *Context, name string, args SidecarListenerArgs, opts ...ResourceOption) (*SidecarListener, error)
    public SidecarListener(string name, SidecarListenerArgs args, CustomResourceOptions? opts = null)
    public SidecarListener(String name, SidecarListenerArgs args)
public SidecarListener(String name, SidecarListenerArgs args, CustomResourceOptions options)

    type: cyral:SidecarListener
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 SidecarListenerArgs
    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 SidecarListenerArgs
    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 SidecarListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SidecarListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SidecarListenerArgs
    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 sidecarListenerResource = new Cyral.SidecarListener("sidecarListenerResource", new()
{
    NetworkAddress = new Cyral.Inputs.SidecarListenerNetworkAddressArgs
    {
        Port = 0,
        Host = "string",
    },
    RepoTypes = new[]
    {
        "string",
    },
    SidecarId = "string",
    DynamodbSettings = new Cyral.Inputs.SidecarListenerDynamodbSettingsArgs
    {
        ProxyMode = false,
    },
    MysqlSettings = new Cyral.Inputs.SidecarListenerMysqlSettingsArgs
    {
        CharacterSet = "string",
        DbVersion = "string",
    },
    S3Settings = new Cyral.Inputs.SidecarListenerS3SettingsArgs
    {
        ProxyMode = false,
    },
    SidecarListenerId = "string",
    SqlserverSettings = new Cyral.Inputs.SidecarListenerSqlserverSettingsArgs
    {
        Version = "string",
    },
});

    example, err := cyral.NewSidecarListener(ctx, "sidecarListenerResource", &cyral.SidecarListenerArgs{
	NetworkAddress: &cyral.SidecarListenerNetworkAddressArgs{
		Port: pulumi.Float64(0),
		Host: pulumi.String("string"),
	},
	RepoTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	SidecarId: pulumi.String("string"),
	DynamodbSettings: &cyral.SidecarListenerDynamodbSettingsArgs{
		ProxyMode: pulumi.Bool(false),
	},
	MysqlSettings: &cyral.SidecarListenerMysqlSettingsArgs{
		CharacterSet: pulumi.String("string"),
		DbVersion:    pulumi.String("string"),
	},
	S3Settings: &cyral.SidecarListenerS3SettingsArgs{
		ProxyMode: pulumi.Bool(false),
	},
	SidecarListenerId: pulumi.String("string"),
	SqlserverSettings: &cyral.SidecarListenerSqlserverSettingsArgs{
		Version: pulumi.String("string"),
	},
})

    var sidecarListenerResource = new SidecarListener("sidecarListenerResource", SidecarListenerArgs.builder()
    .networkAddress(SidecarListenerNetworkAddressArgs.builder()
        .port(0.0)
        .host("string")
        .build())
    .repoTypes("string")
    .sidecarId("string")
    .dynamodbSettings(SidecarListenerDynamodbSettingsArgs.builder()
        .proxyMode(false)
        .build())
    .mysqlSettings(SidecarListenerMysqlSettingsArgs.builder()
        .characterSet("string")
        .dbVersion("string")
        .build())
    .s3Settings(SidecarListenerS3SettingsArgs.builder()
        .proxyMode(false)
        .build())
    .sidecarListenerId("string")
    .sqlserverSettings(SidecarListenerSqlserverSettingsArgs.builder()
        .version("string")
        .build())
    .build());

    sidecar_listener_resource = cyral.SidecarListener("sidecarListenerResource",
    network_address={
        "port": 0,
        "host": "string",
    },
    repo_types=["string"],
    sidecar_id="string",
    dynamodb_settings={
        "proxy_mode": False,
    },
    mysql_settings={
        "character_set": "string",
        "db_version": "string",
    },
    s3_settings={
        "proxy_mode": False,
    },
    sidecar_listener_id="string",
    sqlserver_settings={
        "version": "string",
    })

    const sidecarListenerResource = new cyral.SidecarListener("sidecarListenerResource", {
    networkAddress: {
        port: 0,
        host: "string",
    },
    repoTypes: ["string"],
    sidecarId: "string",
    dynamodbSettings: {
        proxyMode: false,
    },
    mysqlSettings: {
        characterSet: "string",
        dbVersion: "string",
    },
    s3Settings: {
        proxyMode: false,
    },
    sidecarListenerId: "string",
    sqlserverSettings: {
        version: "string",
    },
});

    type: cyral:SidecarListener
properties:
    dynamodbSettings:
        proxyMode: false
    mysqlSettings:
        characterSet: string
        dbVersion: string
    networkAddress:
        host: string
        port: 0
    repoTypes:
        - string
    s3Settings:
        proxyMode: false
    sidecarId: string
    sidecarListenerId: string
    sqlserverSettings:
        version: string

    SidecarListener 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 SidecarListener resource accepts the following input properties:

    NetworkAddress SidecarListenerNetworkAddress
    The network address that the sidecar listens on.
    RepoTypes List<string>
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    SidecarId string
    ID of the sidecar that the listener will be bound to.
    DynamodbSettings SidecarListenerDynamodbSettings
    DynamoDB settings.
    MysqlSettings SidecarListenerMysqlSettings
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    S3Settings SidecarListenerS3Settings
    S3 settings.
    SidecarListenerId string
    SqlserverSettings SidecarListenerSqlserverSettings
    SQL Server settings.
    NetworkAddress SidecarListenerNetworkAddressArgs
    The network address that the sidecar listens on.
    RepoTypes []string
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    SidecarId string
    ID of the sidecar that the listener will be bound to.
    DynamodbSettings SidecarListenerDynamodbSettingsArgs
    DynamoDB settings.
    MysqlSettings SidecarListenerMysqlSettingsArgs
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    S3Settings SidecarListenerS3SettingsArgs
    S3 settings.
    SidecarListenerId string
    SqlserverSettings SidecarListenerSqlserverSettingsArgs
    SQL Server settings.
    networkAddress SidecarListenerNetworkAddress
    The network address that the sidecar listens on.
    repoTypes List<String>
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    sidecarId String
    ID of the sidecar that the listener will be bound to.
    dynamodbSettings SidecarListenerDynamodbSettings
    DynamoDB settings.
    mysqlSettings SidecarListenerMysqlSettings
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    s3Settings SidecarListenerS3Settings
    S3 settings.
    sidecarListenerId String
    sqlserverSettings SidecarListenerSqlserverSettings
    SQL Server settings.
    networkAddress SidecarListenerNetworkAddress
    The network address that the sidecar listens on.
    repoTypes string[]
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    sidecarId string
    ID of the sidecar that the listener will be bound to.
    dynamodbSettings SidecarListenerDynamodbSettings
    DynamoDB settings.
    mysqlSettings SidecarListenerMysqlSettings
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    s3Settings SidecarListenerS3Settings
    S3 settings.
    sidecarListenerId string
    sqlserverSettings SidecarListenerSqlserverSettings
    SQL Server settings.
    network_address SidecarListenerNetworkAddressArgs
    The network address that the sidecar listens on.
    repo_types Sequence[str]
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    sidecar_id str
    ID of the sidecar that the listener will be bound to.
    dynamodb_settings SidecarListenerDynamodbSettingsArgs
    DynamoDB settings.
    mysql_settings SidecarListenerMysqlSettingsArgs
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    s3_settings SidecarListenerS3SettingsArgs
    S3 settings.
    sidecar_listener_id str
    sqlserver_settings SidecarListenerSqlserverSettingsArgs
    SQL Server settings.
    networkAddress Property Map
    The network address that the sidecar listens on.
    repoTypes List<String>
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    sidecarId String
    ID of the sidecar that the listener will be bound to.
    dynamodbSettings Property Map
    DynamoDB settings.
    mysqlSettings Property Map
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    s3Settings Property Map
    S3 settings.
    sidecarListenerId String
    sqlserverSettings Property Map
    SQL Server settings.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    ID of the listener that will be bound to the sidecar.
    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    ID of the listener that will be bound to the sidecar.
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    ID of the listener that will be bound to the sidecar.
    id string
    The provider-assigned unique ID for this managed resource.
    listenerId string
    ID of the listener that will be bound to the sidecar.
    id str
    The provider-assigned unique ID for this managed resource.
    listener_id str
    ID of the listener that will be bound to the sidecar.
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    ID of the listener that will be bound to the sidecar.

    Look up Existing SidecarListener Resource

    Get an existing SidecarListener 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?: SidecarListenerState, opts?: CustomResourceOptions): SidecarListener
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamodb_settings: Optional[SidecarListenerDynamodbSettingsArgs] = None,
        listener_id: Optional[str] = None,
        mysql_settings: Optional[SidecarListenerMysqlSettingsArgs] = None,
        network_address: Optional[SidecarListenerNetworkAddressArgs] = None,
        repo_types: Optional[Sequence[str]] = None,
        s3_settings: Optional[SidecarListenerS3SettingsArgs] = None,
        sidecar_id: Optional[str] = None,
        sidecar_listener_id: Optional[str] = None,
        sqlserver_settings: Optional[SidecarListenerSqlserverSettingsArgs] = None) -> SidecarListener
    func GetSidecarListener(ctx *Context, name string, id IDInput, state *SidecarListenerState, opts ...ResourceOption) (*SidecarListener, error)
    public static SidecarListener Get(string name, Input<string> id, SidecarListenerState? state, CustomResourceOptions? opts = null)
    public static SidecarListener get(String name, Output<String> id, SidecarListenerState state, CustomResourceOptions options)
    resources:  _:    type: cyral:SidecarListener    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:
    DynamodbSettings SidecarListenerDynamodbSettings
    DynamoDB settings.
    ListenerId string
    ID of the listener that will be bound to the sidecar.
    MysqlSettings SidecarListenerMysqlSettings
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    NetworkAddress SidecarListenerNetworkAddress
    The network address that the sidecar listens on.
    RepoTypes List<string>
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    S3Settings SidecarListenerS3Settings
    S3 settings.
    SidecarId string
    ID of the sidecar that the listener will be bound to.
    SidecarListenerId string
    SqlserverSettings SidecarListenerSqlserverSettings
    SQL Server settings.
    DynamodbSettings SidecarListenerDynamodbSettingsArgs
    DynamoDB settings.
    ListenerId string
    ID of the listener that will be bound to the sidecar.
    MysqlSettings SidecarListenerMysqlSettingsArgs
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    NetworkAddress SidecarListenerNetworkAddressArgs
    The network address that the sidecar listens on.
    RepoTypes []string
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    S3Settings SidecarListenerS3SettingsArgs
    S3 settings.
    SidecarId string
    ID of the sidecar that the listener will be bound to.
    SidecarListenerId string
    SqlserverSettings SidecarListenerSqlserverSettingsArgs
    SQL Server settings.
    dynamodbSettings SidecarListenerDynamodbSettings
    DynamoDB settings.
    listenerId String
    ID of the listener that will be bound to the sidecar.
    mysqlSettings SidecarListenerMysqlSettings
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    networkAddress SidecarListenerNetworkAddress
    The network address that the sidecar listens on.
    repoTypes List<String>
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    s3Settings SidecarListenerS3Settings
    S3 settings.
    sidecarId String
    ID of the sidecar that the listener will be bound to.
    sidecarListenerId String
    sqlserverSettings SidecarListenerSqlserverSettings
    SQL Server settings.
    dynamodbSettings SidecarListenerDynamodbSettings
    DynamoDB settings.
    listenerId string
    ID of the listener that will be bound to the sidecar.
    mysqlSettings SidecarListenerMysqlSettings
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    networkAddress SidecarListenerNetworkAddress
    The network address that the sidecar listens on.
    repoTypes string[]
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    s3Settings SidecarListenerS3Settings
    S3 settings.
    sidecarId string
    ID of the sidecar that the listener will be bound to.
    sidecarListenerId string
    sqlserverSettings SidecarListenerSqlserverSettings
    SQL Server settings.
    dynamodb_settings SidecarListenerDynamodbSettingsArgs
    DynamoDB settings.
    listener_id str
    ID of the listener that will be bound to the sidecar.
    mysql_settings SidecarListenerMysqlSettingsArgs
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    network_address SidecarListenerNetworkAddressArgs
    The network address that the sidecar listens on.
    repo_types Sequence[str]
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    s3_settings SidecarListenerS3SettingsArgs
    S3 settings.
    sidecar_id str
    ID of the sidecar that the listener will be bound to.
    sidecar_listener_id str
    sqlserver_settings SidecarListenerSqlserverSettingsArgs
    SQL Server settings.
    dynamodbSettings Property Map
    DynamoDB settings.
    listenerId String
    ID of the listener that will be bound to the sidecar.
    mysqlSettings Property Map
    MySQL settings represents the listener settings for a [mysql, galera, mariadb] data repository.
    networkAddress Property Map
    The network address that the sidecar listens on.
    repoTypes List<String>
    List of repository types that the listener supports. Currently limited to one repo type from supported repo types: - denodo - dremio - dynamodb - dynamodbstreams - galera - mariadb - mongodb - mysql - oracle - postgresql - redshift - s3 - snowflake - sqlserver
    s3Settings Property Map
    S3 settings.
    sidecarId String
    ID of the sidecar that the listener will be bound to.
    sidecarListenerId String
    sqlserverSettings Property Map
    SQL Server settings.

    Supporting Types

    SidecarListenerDynamodbSettings, SidecarListenerDynamodbSettingsArgs

    ProxyMode bool
    DynamoDB proxy mode. Only relevant for listeners of type dynamodb or dynamodbstreams and must always be set to true for these listener types. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the DynamoDB listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK.Setting this value to false for the dynamodb and dynamodbstreams listeners types is currently not allowed and is reserved for future use.
    ProxyMode bool
    DynamoDB proxy mode. Only relevant for listeners of type dynamodb or dynamodbstreams and must always be set to true for these listener types. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the DynamoDB listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK.Setting this value to false for the dynamodb and dynamodbstreams listeners types is currently not allowed and is reserved for future use.
    proxyMode Boolean
    DynamoDB proxy mode. Only relevant for listeners of type dynamodb or dynamodbstreams and must always be set to true for these listener types. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the DynamoDB listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK.Setting this value to false for the dynamodb and dynamodbstreams listeners types is currently not allowed and is reserved for future use.
    proxyMode boolean
    DynamoDB proxy mode. Only relevant for listeners of type dynamodb or dynamodbstreams and must always be set to true for these listener types. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the DynamoDB listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK.Setting this value to false for the dynamodb and dynamodbstreams listeners types is currently not allowed and is reserved for future use.
    proxy_mode bool
    DynamoDB proxy mode. Only relevant for listeners of type dynamodb or dynamodbstreams and must always be set to true for these listener types. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the DynamoDB listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK.Setting this value to false for the dynamodb and dynamodbstreams listeners types is currently not allowed and is reserved for future use.
    proxyMode Boolean
    DynamoDB proxy mode. Only relevant for listeners of type dynamodb or dynamodbstreams and must always be set to true for these listener types. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the DynamoDB listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK.Setting this value to false for the dynamodb and dynamodbstreams listeners types is currently not allowed and is reserved for future use.

    SidecarListenerMysqlSettings, SidecarListenerMysqlSettingsArgs

    CharacterSet string
    MySQL character set. Optional (and only relevant) for listeners of types mysql and mariadb. The sidecar automatically derives this value out of the server version specified in the dbVersion field. This field should only be populated if the database was configured, at deployment time, to use a global character set different from the database default. The char set is extracted from the collation informed. The list of possible collations can be extracted from the column collation by running the command SHOW COLLATION in the target database.
    DbVersion string
    MySQL advertised DB version. Required (and only relevant) for listeners of types mysql and mariadb. This value represents the MySQL/MariaDB server version that the Cyral sidecar will use to present itself to client applications. Different applications, especially JDBC-based ones, may behave differently according to the version of the database they are connecting to. It is crucial that version value specified in this field to be either the same value as the underlying database version, or to be a compatible one. For a compatibility reference, refer to our public docs. Example values: "5.7.3", "8.0.4" or "10.2.1".
    CharacterSet string
    MySQL character set. Optional (and only relevant) for listeners of types mysql and mariadb. The sidecar automatically derives this value out of the server version specified in the dbVersion field. This field should only be populated if the database was configured, at deployment time, to use a global character set different from the database default. The char set is extracted from the collation informed. The list of possible collations can be extracted from the column collation by running the command SHOW COLLATION in the target database.
    DbVersion string
    MySQL advertised DB version. Required (and only relevant) for listeners of types mysql and mariadb. This value represents the MySQL/MariaDB server version that the Cyral sidecar will use to present itself to client applications. Different applications, especially JDBC-based ones, may behave differently according to the version of the database they are connecting to. It is crucial that version value specified in this field to be either the same value as the underlying database version, or to be a compatible one. For a compatibility reference, refer to our public docs. Example values: "5.7.3", "8.0.4" or "10.2.1".
    characterSet String
    MySQL character set. Optional (and only relevant) for listeners of types mysql and mariadb. The sidecar automatically derives this value out of the server version specified in the dbVersion field. This field should only be populated if the database was configured, at deployment time, to use a global character set different from the database default. The char set is extracted from the collation informed. The list of possible collations can be extracted from the column collation by running the command SHOW COLLATION in the target database.
    dbVersion String
    MySQL advertised DB version. Required (and only relevant) for listeners of types mysql and mariadb. This value represents the MySQL/MariaDB server version that the Cyral sidecar will use to present itself to client applications. Different applications, especially JDBC-based ones, may behave differently according to the version of the database they are connecting to. It is crucial that version value specified in this field to be either the same value as the underlying database version, or to be a compatible one. For a compatibility reference, refer to our public docs. Example values: "5.7.3", "8.0.4" or "10.2.1".
    characterSet string
    MySQL character set. Optional (and only relevant) for listeners of types mysql and mariadb. The sidecar automatically derives this value out of the server version specified in the dbVersion field. This field should only be populated if the database was configured, at deployment time, to use a global character set different from the database default. The char set is extracted from the collation informed. The list of possible collations can be extracted from the column collation by running the command SHOW COLLATION in the target database.
    dbVersion string
    MySQL advertised DB version. Required (and only relevant) for listeners of types mysql and mariadb. This value represents the MySQL/MariaDB server version that the Cyral sidecar will use to present itself to client applications. Different applications, especially JDBC-based ones, may behave differently according to the version of the database they are connecting to. It is crucial that version value specified in this field to be either the same value as the underlying database version, or to be a compatible one. For a compatibility reference, refer to our public docs. Example values: "5.7.3", "8.0.4" or "10.2.1".
    character_set str
    MySQL character set. Optional (and only relevant) for listeners of types mysql and mariadb. The sidecar automatically derives this value out of the server version specified in the dbVersion field. This field should only be populated if the database was configured, at deployment time, to use a global character set different from the database default. The char set is extracted from the collation informed. The list of possible collations can be extracted from the column collation by running the command SHOW COLLATION in the target database.
    db_version str
    MySQL advertised DB version. Required (and only relevant) for listeners of types mysql and mariadb. This value represents the MySQL/MariaDB server version that the Cyral sidecar will use to present itself to client applications. Different applications, especially JDBC-based ones, may behave differently according to the version of the database they are connecting to. It is crucial that version value specified in this field to be either the same value as the underlying database version, or to be a compatible one. For a compatibility reference, refer to our public docs. Example values: "5.7.3", "8.0.4" or "10.2.1".
    characterSet String
    MySQL character set. Optional (and only relevant) for listeners of types mysql and mariadb. The sidecar automatically derives this value out of the server version specified in the dbVersion field. This field should only be populated if the database was configured, at deployment time, to use a global character set different from the database default. The char set is extracted from the collation informed. The list of possible collations can be extracted from the column collation by running the command SHOW COLLATION in the target database.
    dbVersion String
    MySQL advertised DB version. Required (and only relevant) for listeners of types mysql and mariadb. This value represents the MySQL/MariaDB server version that the Cyral sidecar will use to present itself to client applications. Different applications, especially JDBC-based ones, may behave differently according to the version of the database they are connecting to. It is crucial that version value specified in this field to be either the same value as the underlying database version, or to be a compatible one. For a compatibility reference, refer to our public docs. Example values: "5.7.3", "8.0.4" or "10.2.1".

    SidecarListenerNetworkAddress, SidecarListenerNetworkAddressArgs

    Port double
    Port where the sidecar will listen for the given repository.
    Host string
    Host where the sidecar will listen for the given repository, in the case where the sidecar is deployed on a host with multiple network interfaces. If omitted, the sidecar will assume the default "0.0.0.0" and listen on all network interfaces.
    Port float64
    Port where the sidecar will listen for the given repository.
    Host string
    Host where the sidecar will listen for the given repository, in the case where the sidecar is deployed on a host with multiple network interfaces. If omitted, the sidecar will assume the default "0.0.0.0" and listen on all network interfaces.
    port Double
    Port where the sidecar will listen for the given repository.
    host String
    Host where the sidecar will listen for the given repository, in the case where the sidecar is deployed on a host with multiple network interfaces. If omitted, the sidecar will assume the default "0.0.0.0" and listen on all network interfaces.
    port number
    Port where the sidecar will listen for the given repository.
    host string
    Host where the sidecar will listen for the given repository, in the case where the sidecar is deployed on a host with multiple network interfaces. If omitted, the sidecar will assume the default "0.0.0.0" and listen on all network interfaces.
    port float
    Port where the sidecar will listen for the given repository.
    host str
    Host where the sidecar will listen for the given repository, in the case where the sidecar is deployed on a host with multiple network interfaces. If omitted, the sidecar will assume the default "0.0.0.0" and listen on all network interfaces.
    port Number
    Port where the sidecar will listen for the given repository.
    host String
    Host where the sidecar will listen for the given repository, in the case where the sidecar is deployed on a host with multiple network interfaces. If omitted, the sidecar will assume the default "0.0.0.0" and listen on all network interfaces.

    SidecarListenerS3Settings, SidecarListenerS3SettingsArgs

    ProxyMode bool
    S3 proxy mode. Only relevant for S3 listeners. Allowed values: [true, false]. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the S3 listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK. This listener mode is functional for client applications using either AWS native credentials, e.g. Access Key ID/Secret Access Key, or Cyral-Provided access tokens (Single Sign-On connections). When false, instructs the sidecar to mimic the actual behavior of AWS S3, meaning client applications will not be aware of a middleware HTTP proxy in the path to S3. This listener mode is only compatible with applications using Cyral-Provided access tokens and is must used when configuring the Cyral S3 Browser. This mode is currently not recommended for any other use besides the Cyral S3 Browser.
    ProxyMode bool
    S3 proxy mode. Only relevant for S3 listeners. Allowed values: [true, false]. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the S3 listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK. This listener mode is functional for client applications using either AWS native credentials, e.g. Access Key ID/Secret Access Key, or Cyral-Provided access tokens (Single Sign-On connections). When false, instructs the sidecar to mimic the actual behavior of AWS S3, meaning client applications will not be aware of a middleware HTTP proxy in the path to S3. This listener mode is only compatible with applications using Cyral-Provided access tokens and is must used when configuring the Cyral S3 Browser. This mode is currently not recommended for any other use besides the Cyral S3 Browser.
    proxyMode Boolean
    S3 proxy mode. Only relevant for S3 listeners. Allowed values: [true, false]. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the S3 listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK. This listener mode is functional for client applications using either AWS native credentials, e.g. Access Key ID/Secret Access Key, or Cyral-Provided access tokens (Single Sign-On connections). When false, instructs the sidecar to mimic the actual behavior of AWS S3, meaning client applications will not be aware of a middleware HTTP proxy in the path to S3. This listener mode is only compatible with applications using Cyral-Provided access tokens and is must used when configuring the Cyral S3 Browser. This mode is currently not recommended for any other use besides the Cyral S3 Browser.
    proxyMode boolean
    S3 proxy mode. Only relevant for S3 listeners. Allowed values: [true, false]. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the S3 listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK. This listener mode is functional for client applications using either AWS native credentials, e.g. Access Key ID/Secret Access Key, or Cyral-Provided access tokens (Single Sign-On connections). When false, instructs the sidecar to mimic the actual behavior of AWS S3, meaning client applications will not be aware of a middleware HTTP proxy in the path to S3. This listener mode is only compatible with applications using Cyral-Provided access tokens and is must used when configuring the Cyral S3 Browser. This mode is currently not recommended for any other use besides the Cyral S3 Browser.
    proxy_mode bool
    S3 proxy mode. Only relevant for S3 listeners. Allowed values: [true, false]. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the S3 listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK. This listener mode is functional for client applications using either AWS native credentials, e.g. Access Key ID/Secret Access Key, or Cyral-Provided access tokens (Single Sign-On connections). When false, instructs the sidecar to mimic the actual behavior of AWS S3, meaning client applications will not be aware of a middleware HTTP proxy in the path to S3. This listener mode is only compatible with applications using Cyral-Provided access tokens and is must used when configuring the Cyral S3 Browser. This mode is currently not recommended for any other use besides the Cyral S3 Browser.
    proxyMode Boolean
    S3 proxy mode. Only relevant for S3 listeners. Allowed values: [true, false]. Defaults to false. When true, instructs the sidecar to operate as an HTTP Proxy server. Client applications need to be explicitly configured to send the traffic through an HTTP proxy server, represented by the Cyral sidecar endpoint + the S3 listening port. It is indicated when connecting from CLI applications, such as aws cli, or through the AWS SDK. This listener mode is functional for client applications using either AWS native credentials, e.g. Access Key ID/Secret Access Key, or Cyral-Provided access tokens (Single Sign-On connections). When false, instructs the sidecar to mimic the actual behavior of AWS S3, meaning client applications will not be aware of a middleware HTTP proxy in the path to S3. This listener mode is only compatible with applications using Cyral-Provided access tokens and is must used when configuring the Cyral S3 Browser. This mode is currently not recommended for any other use besides the Cyral S3 Browser.

    SidecarListenerSqlserverSettings, SidecarListenerSqlserverSettingsArgs

    Version string
    Advertised SQL Server version. Required (and only relevant) for Listeners of type 'sqlserver' The format of the version should be ..<build_number> API will validate that the version is a valid version number. Major version is an integer in range 0-255. Minor version is an integer in range 0-255. Build number is an integer in range 0-65535. Example: 16.0.1000 To get the version of the SQL Server runtime, run the following query: SELECT SERVERPROPERTY('productversion') Note: If the query returns a four part version number, only the first three parts should be used. Example: 16.0.1000.6 > 16.0.1000
    Version string
    Advertised SQL Server version. Required (and only relevant) for Listeners of type 'sqlserver' The format of the version should be ..<build_number> API will validate that the version is a valid version number. Major version is an integer in range 0-255. Minor version is an integer in range 0-255. Build number is an integer in range 0-65535. Example: 16.0.1000 To get the version of the SQL Server runtime, run the following query: SELECT SERVERPROPERTY('productversion') Note: If the query returns a four part version number, only the first three parts should be used. Example: 16.0.1000.6 > 16.0.1000
    version String
    Advertised SQL Server version. Required (and only relevant) for Listeners of type 'sqlserver' The format of the version should be ..<build_number> API will validate that the version is a valid version number. Major version is an integer in range 0-255. Minor version is an integer in range 0-255. Build number is an integer in range 0-65535. Example: 16.0.1000 To get the version of the SQL Server runtime, run the following query: SELECT SERVERPROPERTY('productversion') Note: If the query returns a four part version number, only the first three parts should be used. Example: 16.0.1000.6 > 16.0.1000
    version string
    Advertised SQL Server version. Required (and only relevant) for Listeners of type 'sqlserver' The format of the version should be ..<build_number> API will validate that the version is a valid version number. Major version is an integer in range 0-255. Minor version is an integer in range 0-255. Build number is an integer in range 0-65535. Example: 16.0.1000 To get the version of the SQL Server runtime, run the following query: SELECT SERVERPROPERTY('productversion') Note: If the query returns a four part version number, only the first three parts should be used. Example: 16.0.1000.6 > 16.0.1000
    version str
    Advertised SQL Server version. Required (and only relevant) for Listeners of type 'sqlserver' The format of the version should be ..<build_number> API will validate that the version is a valid version number. Major version is an integer in range 0-255. Minor version is an integer in range 0-255. Build number is an integer in range 0-65535. Example: 16.0.1000 To get the version of the SQL Server runtime, run the following query: SELECT SERVERPROPERTY('productversion') Note: If the query returns a four part version number, only the first three parts should be used. Example: 16.0.1000.6 > 16.0.1000
    version String
    Advertised SQL Server version. Required (and only relevant) for Listeners of type 'sqlserver' The format of the version should be ..<build_number> API will validate that the version is a valid version number. Major version is an integer in range 0-255. Minor version is an integer in range 0-255. Build number is an integer in range 0-65535. Example: 16.0.1000 To get the version of the SQL Server runtime, run the following query: SELECT SERVERPROPERTY('productversion') Note: If the query returns a four part version number, only the first three parts should be used. Example: 16.0.1000.6 > 16.0.1000

    Package Details

    Repository
    cyral cyralinc/terraform-provider-cyral
    License
    Notes
    This Pulumi package is based on the cyral Terraform Provider.
    cyral logo
    cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
    cyralinc/terraform-provider-cyral