1. Packages
  2. Cyral Provider
  3. API Docs
  4. Sidecar
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
cyralinc/terraform-provider-cyral

cyral.Sidecar

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

    Manages sidecars.

    Example Usage

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

const someResourceName = new cyral.Sidecar("someResourceName", {
    bypassMode: "failover",
    deploymentMethod: "someValidMethod",
    labels: [
        "label1",
        "label2",
    ],
    userEndpoint: "",
});

    import pulumi
import pulumi_cyral as cyral

some_resource_name = cyral.Sidecar("someResourceName",
    bypass_mode="failover",
    deployment_method="someValidMethod",
    labels=[
        "label1",
        "label2",
    ],
    user_endpoint="")

    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 {
		_, err := cyral.NewSidecar(ctx, "someResourceName", &cyral.SidecarArgs{
			BypassMode:       pulumi.String("failover"),
			DeploymentMethod: pulumi.String("someValidMethod"),
			Labels: pulumi.StringArray{
				pulumi.String("label1"),
				pulumi.String("label2"),
			},
			UserEndpoint: pulumi.String(""),
		})
		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 someResourceName = new Cyral.Sidecar("someResourceName", new()
    {
        BypassMode = "failover",
        DeploymentMethod = "someValidMethod",
        Labels = new[]
        {
            "label1",
            "label2",
        },
        UserEndpoint = "",
    });

});

    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 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 someResourceName = new Sidecar("someResourceName", SidecarArgs.builder()
            .bypassMode("failover")
            .deploymentMethod("someValidMethod")
            .labels(            
                "label1",
                "label2")
            .userEndpoint("")
            .build());

    }
}

    resources:
  someResourceName:
    type: cyral:Sidecar
    properties:
      bypassMode: failover
      deploymentMethod: someValidMethod
      labels:
        - label1
        - label2
      userEndpoint: ""

    Create Sidecar Resource

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

    Constructor syntax

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

@overload
def Sidecar(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            deployment_method: Optional[str] = None,
            activity_log_integration_id: Optional[str] = None,
            bypass_mode: Optional[str] = None,
            certificate_bundle_secrets: Optional[SidecarCertificateBundleSecretsArgs] = None,
            diagnostic_log_integration_id: Optional[str] = None,
            labels: Optional[Sequence[str]] = None,
            log_integration_id: Optional[str] = None,
            name: Optional[str] = None,
            user_endpoint: Optional[str] = None,
            vault_integration_id: Optional[str] = None)
    func NewSidecar(ctx *Context, name string, args SidecarArgs, opts ...ResourceOption) (*Sidecar, error)
    public Sidecar(string name, SidecarArgs args, CustomResourceOptions? opts = null)
    public Sidecar(String name, SidecarArgs args)
public Sidecar(String name, SidecarArgs args, CustomResourceOptions options)

    type: cyral:Sidecar
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 SidecarArgs
    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 SidecarArgs
    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 SidecarArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SidecarArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SidecarArgs
    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 sidecarResource = new Cyral.Sidecar("sidecarResource", new()
{
    DeploymentMethod = "string",
    ActivityLogIntegrationId = "string",
    BypassMode = "string",
    DiagnosticLogIntegrationId = "string",
    Labels = new[]
    {
        "string",
    },
    Name = "string",
    UserEndpoint = "string",
    VaultIntegrationId = "string",
});

    example, err := cyral.NewSidecar(ctx, "sidecarResource", &cyral.SidecarArgs{
	DeploymentMethod:           pulumi.String("string"),
	ActivityLogIntegrationId:   pulumi.String("string"),
	BypassMode:                 pulumi.String("string"),
	DiagnosticLogIntegrationId: pulumi.String("string"),
	Labels: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:               pulumi.String("string"),
	UserEndpoint:       pulumi.String("string"),
	VaultIntegrationId: pulumi.String("string"),
})

    var sidecarResource = new Sidecar("sidecarResource", SidecarArgs.builder()
    .deploymentMethod("string")
    .activityLogIntegrationId("string")
    .bypassMode("string")
    .diagnosticLogIntegrationId("string")
    .labels("string")
    .name("string")
    .userEndpoint("string")
    .vaultIntegrationId("string")
    .build());

    sidecar_resource = cyral.Sidecar("sidecarResource",
    deployment_method="string",
    activity_log_integration_id="string",
    bypass_mode="string",
    diagnostic_log_integration_id="string",
    labels=["string"],
    name="string",
    user_endpoint="string",
    vault_integration_id="string")

    const sidecarResource = new cyral.Sidecar("sidecarResource", {
    deploymentMethod: "string",
    activityLogIntegrationId: "string",
    bypassMode: "string",
    diagnosticLogIntegrationId: "string",
    labels: ["string"],
    name: "string",
    userEndpoint: "string",
    vaultIntegrationId: "string",
});

    type: cyral:Sidecar
properties:
    activityLogIntegrationId: string
    bypassMode: string
    deploymentMethod: string
    diagnosticLogIntegrationId: string
    labels:
        - string
    name: string
    userEndpoint: string
    vaultIntegrationId: string

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

    DeploymentMethod string
    ActivityLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    BypassMode string
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    CertificateBundleSecrets SidecarCertificateBundleSecrets
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    DiagnosticLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    Labels List<string>
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    LogIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    Name string
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    UserEndpoint string
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    VaultIntegrationId string
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.
    DeploymentMethod string
    ActivityLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    BypassMode string
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    CertificateBundleSecrets SidecarCertificateBundleSecretsArgs
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    DiagnosticLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    Labels []string
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    LogIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    Name string
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    UserEndpoint string
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    VaultIntegrationId string
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.
    deploymentMethod String
    activityLogIntegrationId String
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    bypassMode String
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    certificateBundleSecrets SidecarCertificateBundleSecrets
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    diagnosticLogIntegrationId String
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    labels List<String>
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    logIntegrationId String
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    name String
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    userEndpoint String
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    vaultIntegrationId String
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.
    deploymentMethod string
    activityLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    bypassMode string
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    certificateBundleSecrets SidecarCertificateBundleSecrets
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    diagnosticLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    labels string[]
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    logIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    name string
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    userEndpoint string
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    vaultIntegrationId string
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.
    deployment_method str
    activity_log_integration_id str
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    bypass_mode str
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    certificate_bundle_secrets SidecarCertificateBundleSecretsArgs
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    diagnostic_log_integration_id str
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    labels Sequence[str]
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    log_integration_id str
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    name str
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    user_endpoint str
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    vault_integration_id str
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.
    deploymentMethod String
    activityLogIntegrationId String
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    bypassMode String
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    certificateBundleSecrets Property Map
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    diagnosticLogIntegrationId String
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    labels List<String>
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    logIntegrationId String
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    name String
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    userEndpoint String
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    vaultIntegrationId String
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Sidecar 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 Sidecar Resource

    Get an existing Sidecar 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?: SidecarState, opts?: CustomResourceOptions): Sidecar
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activity_log_integration_id: Optional[str] = None,
        bypass_mode: Optional[str] = None,
        certificate_bundle_secrets: Optional[SidecarCertificateBundleSecretsArgs] = None,
        deployment_method: Optional[str] = None,
        diagnostic_log_integration_id: Optional[str] = None,
        labels: Optional[Sequence[str]] = None,
        log_integration_id: Optional[str] = None,
        name: Optional[str] = None,
        user_endpoint: Optional[str] = None,
        vault_integration_id: Optional[str] = None) -> Sidecar
    func GetSidecar(ctx *Context, name string, id IDInput, state *SidecarState, opts ...ResourceOption) (*Sidecar, error)
    public static Sidecar Get(string name, Input<string> id, SidecarState? state, CustomResourceOptions? opts = null)
    public static Sidecar get(String name, Output<String> id, SidecarState state, CustomResourceOptions options)
    resources:  _:    type: cyral:Sidecar    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:
    ActivityLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    BypassMode string
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    CertificateBundleSecrets SidecarCertificateBundleSecrets
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    DeploymentMethod string
    DiagnosticLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    Labels List<string>
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    LogIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    Name string
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    UserEndpoint string
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    VaultIntegrationId string
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.
    ActivityLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    BypassMode string
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    CertificateBundleSecrets SidecarCertificateBundleSecretsArgs
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    DeploymentMethod string
    DiagnosticLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    Labels []string
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    LogIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    Name string
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    UserEndpoint string
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    VaultIntegrationId string
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.
    activityLogIntegrationId String
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    bypassMode String
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    certificateBundleSecrets SidecarCertificateBundleSecrets
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    deploymentMethod String
    diagnosticLogIntegrationId String
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    labels List<String>
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    logIntegrationId String
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    name String
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    userEndpoint String
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    vaultIntegrationId String
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.
    activityLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    bypassMode string
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    certificateBundleSecrets SidecarCertificateBundleSecrets
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    deploymentMethod string
    diagnosticLogIntegrationId string
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    labels string[]
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    logIntegrationId string
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    name string
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    userEndpoint string
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    vaultIntegrationId string
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.
    activity_log_integration_id str
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    bypass_mode str
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    certificate_bundle_secrets SidecarCertificateBundleSecretsArgs
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    deployment_method str
    diagnostic_log_integration_id str
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    labels Sequence[str]
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    log_integration_id str
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    name str
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    user_endpoint str
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    vault_integration_id str
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.
    activityLogIntegrationId String
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.
    bypassMode String
    This argument lets you specify how to handle the connection in the event of an error in the sidecar during a user’s session. Valid modes are: always, failover or never. Defaults to failover. If always is specified, the sidecar will run in passthrough mode. If failover is specified, the sidecar will run in resiliency mode. If never is specified and there is an error in the sidecar, connections to bound repositories will fail.
    certificateBundleSecrets Property Map
    Certificate Bundle Secret is a configuration that holds data about the location of a particular TLS certificate bundle in a secrets manager.

    Deprecated: Deprecated

    deploymentMethod String
    diagnosticLogIntegrationId String
    ID of the log integration mapped to this sidecar, used for sidecar diagnostic logs.
    labels List<String>
    Labels that can be attached to the sidecar and shown in the Tags field in the UI.
    logIntegrationId String
    ID of the log integration mapped to this sidecar, used for Cyral activity logs.

    Deprecated: Deprecated

    name String
    Sidecar name that will be used internally in Control Plane (ex: your_sidecar_name).
    userEndpoint String
    User-defined endpoint (also referred as alias) that can be used to override the sidecar DNS endpoint shown in the UI.
    vaultIntegrationId String
    ID of the HashiCorp Vault integration to associate to this sidecar to be used for database account authentication.

    Supporting Types

    SidecarCertificateBundleSecrets, SidecarCertificateBundleSecretsArgs

    Sidecar SidecarCertificateBundleSecretsSidecar
    Certificate Bundle Secret for sidecar.
    Sidecar SidecarCertificateBundleSecretsSidecar
    Certificate Bundle Secret for sidecar.
    sidecar SidecarCertificateBundleSecretsSidecar
    Certificate Bundle Secret for sidecar.
    sidecar SidecarCertificateBundleSecretsSidecar
    Certificate Bundle Secret for sidecar.
    sidecar SidecarCertificateBundleSecretsSidecar
    Certificate Bundle Secret for sidecar.
    sidecar Property Map
    Certificate Bundle Secret for sidecar.

    SidecarCertificateBundleSecretsSidecar, SidecarCertificateBundleSecretsSidecarArgs

    SecretId string
    Secret ID is the identifier or location for the secret that holds the certificate bundle.
    Type string
    Type identifies the secret manager used to store the secret. Valid values are: aws and k8s.
    Engine string
    Engine is the name of the engine used with the given secrets manager type, when applicable.
    SecretId string
    Secret ID is the identifier or location for the secret that holds the certificate bundle.
    Type string
    Type identifies the secret manager used to store the secret. Valid values are: aws and k8s.
    Engine string
    Engine is the name of the engine used with the given secrets manager type, when applicable.
    secretId String
    Secret ID is the identifier or location for the secret that holds the certificate bundle.
    type String
    Type identifies the secret manager used to store the secret. Valid values are: aws and k8s.
    engine String
    Engine is the name of the engine used with the given secrets manager type, when applicable.
    secretId string
    Secret ID is the identifier or location for the secret that holds the certificate bundle.
    type string
    Type identifies the secret manager used to store the secret. Valid values are: aws and k8s.
    engine string
    Engine is the name of the engine used with the given secrets manager type, when applicable.
    secret_id str
    Secret ID is the identifier or location for the secret that holds the certificate bundle.
    type str
    Type identifies the secret manager used to store the secret. Valid values are: aws and k8s.
    engine str
    Engine is the name of the engine used with the given secrets manager type, when applicable.
    secretId String
    Secret ID is the identifier or location for the secret that holds the certificate bundle.
    type String
    Type identifies the secret manager used to store the secret. Valid values are: aws and k8s.
    engine String
    Engine is the name of the engine used with the given secrets manager type, when applicable.

    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
      Meet Neo: Your AI Platform Teammate