published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a Coralogix connector and its configuration in a Descope project. Send audit events and troubleshooting logs to Coralogix.
Create CoralogixConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CoralogixConnector(name: string, args: CoralogixConnectorArgs, opts?: CustomResourceOptions);@overload
def CoralogixConnector(resource_name: str,
args: CoralogixConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CoralogixConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
bearer_token: Optional[str] = None,
endpoint: Optional[str] = None,
project_id: Optional[str] = None,
audit_enabled: Optional[bool] = None,
audit_filters: Optional[Sequence[CoralogixConnectorAuditFilterArgs]] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
mask_pii: Optional[bool] = None,
name: Optional[str] = None,
troubleshoot_log_enabled: Optional[bool] = None)func NewCoralogixConnector(ctx *Context, name string, args CoralogixConnectorArgs, opts ...ResourceOption) (*CoralogixConnector, error)public CoralogixConnector(string name, CoralogixConnectorArgs args, CustomResourceOptions? opts = null)
public CoralogixConnector(String name, CoralogixConnectorArgs args)
public CoralogixConnector(String name, CoralogixConnectorArgs args, CustomResourceOptions options)
type: descope:CoralogixConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_coralogix_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args CoralogixConnectorArgs
- 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 CoralogixConnectorArgs
- 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 CoralogixConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CoralogixConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CoralogixConnectorArgs
- 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 coralogixConnectorResource = new Descope.CoralogixConnector("coralogixConnectorResource", new()
{
BearerToken = "string",
Endpoint = "string",
ProjectId = "string",
AuditEnabled = false,
AuditFilters = new[]
{
new Descope.Inputs.CoralogixConnectorAuditFilterArgs
{
Key = "string",
Operator = "string",
Values = new[]
{
"string",
},
},
},
Description = "string",
Disabled = false,
MaskPii = false,
Name = "string",
TroubleshootLogEnabled = false,
});
example, err := descope.NewCoralogixConnector(ctx, "coralogixConnectorResource", &descope.CoralogixConnectorArgs{
BearerToken: pulumi.String("string"),
Endpoint: pulumi.String("string"),
ProjectId: pulumi.String("string"),
AuditEnabled: pulumi.Bool(false),
AuditFilters: descope.CoralogixConnectorAuditFilterArray{
&descope.CoralogixConnectorAuditFilterArgs{
Key: pulumi.String("string"),
Operator: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
MaskPii: pulumi.Bool(false),
Name: pulumi.String("string"),
TroubleshootLogEnabled: pulumi.Bool(false),
})
resource "descope_coralogix_connector" "coralogixConnectorResource" {
lifecycle {
create_before_destroy = true
}
bearer_token = "string"
endpoint = "string"
project_id = "string"
audit_enabled = false
audit_filters {
key = "string"
operator = "string"
values = ["string"]
}
description = "string"
disabled = false
mask_pii = false
name = "string"
troubleshoot_log_enabled = false
}
var coralogixConnectorResource = new CoralogixConnector("coralogixConnectorResource", CoralogixConnectorArgs.builder()
.bearerToken("string")
.endpoint("string")
.projectId("string")
.auditEnabled(false)
.auditFilters(CoralogixConnectorAuditFilterArgs.builder()
.key("string")
.operator("string")
.values("string")
.build())
.description("string")
.disabled(false)
.maskPii(false)
.name("string")
.troubleshootLogEnabled(false)
.build());
coralogix_connector_resource = descope.CoralogixConnector("coralogixConnectorResource",
bearer_token="string",
endpoint="string",
project_id="string",
audit_enabled=False,
audit_filters=[{
"key": "string",
"operator": "string",
"values": ["string"],
}],
description="string",
disabled=False,
mask_pii=False,
name="string",
troubleshoot_log_enabled=False)
const coralogixConnectorResource = new descope.CoralogixConnector("coralogixConnectorResource", {
bearerToken: "string",
endpoint: "string",
projectId: "string",
auditEnabled: false,
auditFilters: [{
key: "string",
operator: "string",
values: ["string"],
}],
description: "string",
disabled: false,
maskPii: false,
name: "string",
troubleshootLogEnabled: false,
});
type: descope:CoralogixConnector
properties:
auditEnabled: false
auditFilters:
- key: string
operator: string
values:
- string
bearerToken: string
description: string
disabled: false
endpoint: string
maskPii: false
name: string
projectId: string
troubleshootLogEnabled: false
CoralogixConnector 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 CoralogixConnector resource accepts the following input properties:
- Bearer
Token string - Bearer token issued by Coralogix as Send-Your-Data API key
- Endpoint string
- The ingress OpenTelemetry endpoint URL.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Audit
Enabled bool - Whether to enable streaming of audit events.
- Audit
Filters List<Descope.Coralogix Connector Audit Filter> - Specify which events will be sent to the external audit service (including tenant selection).
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Mask
Pii bool - Whether to mask personally identifiable information in the logs.
- Name string
- A custom name for your connector.
- Troubleshoot
Log boolEnabled - Whether to send troubleshooting events.
- Bearer
Token string - Bearer token issued by Coralogix as Send-Your-Data API key
- Endpoint string
- The ingress OpenTelemetry endpoint URL.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Audit
Enabled bool - Whether to enable streaming of audit events.
- Audit
Filters []CoralogixConnector Audit Filter Args - Specify which events will be sent to the external audit service (including tenant selection).
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Mask
Pii bool - Whether to mask personally identifiable information in the logs.
- Name string
- A custom name for your connector.
- Troubleshoot
Log boolEnabled - Whether to send troubleshooting events.
- bearer_
token string - Bearer token issued by Coralogix as Send-Your-Data API key
- endpoint string
- The ingress OpenTelemetry endpoint URL.
- project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- audit_
enabled bool - Whether to enable streaming of audit events.
- audit_
filters list(object) - Specify which events will be sent to the external audit service (including tenant selection).
- description string
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask_
pii bool - Whether to mask personally identifiable information in the logs.
- name string
- A custom name for your connector.
- troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- bearer
Token String - Bearer token issued by Coralogix as Send-Your-Data API key
- endpoint String
- The ingress OpenTelemetry endpoint URL.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- audit
Enabled Boolean - Whether to enable streaming of audit events.
- audit
Filters List<CoralogixConnector Audit Filter> - Specify which events will be sent to the external audit service (including tenant selection).
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask
Pii Boolean - Whether to mask personally identifiable information in the logs.
- name String
- A custom name for your connector.
- troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
- bearer
Token string - Bearer token issued by Coralogix as Send-Your-Data API key
- endpoint string
- The ingress OpenTelemetry endpoint URL.
- project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- audit
Enabled boolean - Whether to enable streaming of audit events.
- audit
Filters CoralogixConnector Audit Filter[] - Specify which events will be sent to the external audit service (including tenant selection).
- description string
- A description of what your connector is used for.
- disabled boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask
Pii boolean - Whether to mask personally identifiable information in the logs.
- name string
- A custom name for your connector.
- troubleshoot
Log booleanEnabled - Whether to send troubleshooting events.
- bearer_
token str - Bearer token issued by Coralogix as Send-Your-Data API key
- endpoint str
- The ingress OpenTelemetry endpoint URL.
- project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- audit_
enabled bool - Whether to enable streaming of audit events.
- audit_
filters Sequence[CoralogixConnector Audit Filter Args] - Specify which events will be sent to the external audit service (including tenant selection).
- description str
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask_
pii bool - Whether to mask personally identifiable information in the logs.
- name str
- A custom name for your connector.
- troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- bearer
Token String - Bearer token issued by Coralogix as Send-Your-Data API key
- endpoint String
- The ingress OpenTelemetry endpoint URL.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- audit
Enabled Boolean - Whether to enable streaming of audit events.
- audit
Filters List<Property Map> - Specify which events will be sent to the external audit service (including tenant selection).
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- mask
Pii Boolean - Whether to mask personally identifiable information in the logs.
- name String
- A custom name for your connector.
- troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
Outputs
All input properties are implicitly available as output properties. Additionally, the CoralogixConnector 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 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 CoralogixConnector Resource
Get an existing CoralogixConnector 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?: CoralogixConnectorState, opts?: CustomResourceOptions): CoralogixConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
audit_enabled: Optional[bool] = None,
audit_filters: Optional[Sequence[CoralogixConnectorAuditFilterArgs]] = None,
bearer_token: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
endpoint: Optional[str] = None,
mask_pii: Optional[bool] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
troubleshoot_log_enabled: Optional[bool] = None) -> CoralogixConnectorfunc GetCoralogixConnector(ctx *Context, name string, id IDInput, state *CoralogixConnectorState, opts ...ResourceOption) (*CoralogixConnector, error)public static CoralogixConnector Get(string name, Input<string> id, CoralogixConnectorState? state, CustomResourceOptions? opts = null)public static CoralogixConnector get(String name, Output<String> id, CoralogixConnectorState state, CustomResourceOptions options)resources: existingCoralogixConnector: type: descope:CoralogixConnector get: id: ${id}import {
to = descope_coralogix_connector.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state CoralogixConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state CoralogixConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state CoralogixConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state CoralogixConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Audit
Enabled bool - Whether to enable streaming of audit events.
- Audit
Filters List<Descope.Coralogix Connector Audit Filter> - Specify which events will be sent to the external audit service (including tenant selection).
- Bearer
Token string - Bearer token issued by Coralogix as Send-Your-Data API key
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Endpoint string
- The ingress OpenTelemetry endpoint URL.
- Mask
Pii bool - Whether to mask personally identifiable information in the logs.
- Name string
- A custom name for your connector.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Troubleshoot
Log boolEnabled - Whether to send troubleshooting events.
- Audit
Enabled bool - Whether to enable streaming of audit events.
- Audit
Filters []CoralogixConnector Audit Filter Args - Specify which events will be sent to the external audit service (including tenant selection).
- Bearer
Token string - Bearer token issued by Coralogix as Send-Your-Data API key
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Endpoint string
- The ingress OpenTelemetry endpoint URL.
- Mask
Pii bool - Whether to mask personally identifiable information in the logs.
- Name string
- A custom name for your connector.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Troubleshoot
Log boolEnabled - Whether to send troubleshooting events.
- audit_
enabled bool - Whether to enable streaming of audit events.
- audit_
filters list(object) - Specify which events will be sent to the external audit service (including tenant selection).
- bearer_
token string - Bearer token issued by Coralogix as Send-Your-Data API key
- description string
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- endpoint string
- The ingress OpenTelemetry endpoint URL.
- mask_
pii bool - Whether to mask personally identifiable information in the logs.
- name string
- A custom name for your connector.
- project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- audit
Enabled Boolean - Whether to enable streaming of audit events.
- audit
Filters List<CoralogixConnector Audit Filter> - Specify which events will be sent to the external audit service (including tenant selection).
- bearer
Token String - Bearer token issued by Coralogix as Send-Your-Data API key
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- endpoint String
- The ingress OpenTelemetry endpoint URL.
- mask
Pii Boolean - Whether to mask personally identifiable information in the logs.
- name String
- A custom name for your connector.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
- audit
Enabled boolean - Whether to enable streaming of audit events.
- audit
Filters CoralogixConnector Audit Filter[] - Specify which events will be sent to the external audit service (including tenant selection).
- bearer
Token string - Bearer token issued by Coralogix as Send-Your-Data API key
- description string
- A description of what your connector is used for.
- disabled boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- endpoint string
- The ingress OpenTelemetry endpoint URL.
- mask
Pii boolean - Whether to mask personally identifiable information in the logs.
- name string
- A custom name for your connector.
- project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- troubleshoot
Log booleanEnabled - Whether to send troubleshooting events.
- audit_
enabled bool - Whether to enable streaming of audit events.
- audit_
filters Sequence[CoralogixConnector Audit Filter Args] - Specify which events will be sent to the external audit service (including tenant selection).
- bearer_
token str - Bearer token issued by Coralogix as Send-Your-Data API key
- description str
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- endpoint str
- The ingress OpenTelemetry endpoint URL.
- mask_
pii bool - Whether to mask personally identifiable information in the logs.
- name str
- A custom name for your connector.
- project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- troubleshoot_
log_ boolenabled - Whether to send troubleshooting events.
- audit
Enabled Boolean - Whether to enable streaming of audit events.
- audit
Filters List<Property Map> - Specify which events will be sent to the external audit service (including tenant selection).
- bearer
Token String - Bearer token issued by Coralogix as Send-Your-Data API key
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- endpoint String
- The ingress OpenTelemetry endpoint URL.
- mask
Pii Boolean - Whether to mask personally identifiable information in the logs.
- name String
- A custom name for your connector.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- troubleshoot
Log BooleanEnabled - Whether to send troubleshooting events.
Supporting Types
CoralogixConnectorAuditFilter, CoralogixConnectorAuditFilterArgs
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope