1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. AwsEventbridgeConnector
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope
descope logo Descope
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope

    Manages a AWS EventBridge connector and its configuration in a Descope project. Stream authentication audit logs with the Amazon EventBridge connector.

    Create AwsEventbridgeConnector Resource

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

    Constructor syntax

    new AwsEventbridgeConnector(name: string, args: AwsEventbridgeConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def AwsEventbridgeConnector(resource_name: str,
                                args: AwsEventbridgeConnectorArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def AwsEventbridgeConnector(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                detail_type: Optional[str] = None,
                                source: Optional[str] = None,
                                region: Optional[str] = None,
                                project_id: Optional[str] = None,
                                event_bus_name: Optional[str] = None,
                                description: Optional[str] = None,
                                disabled: Optional[bool] = None,
                                access_key_id: Optional[str] = None,
                                external_id: Optional[str] = None,
                                mask_pii: Optional[bool] = None,
                                name: Optional[str] = None,
                                auth_type: Optional[str] = None,
                                audit_filters: Optional[Sequence[AwsEventbridgeConnectorAuditFilterArgs]] = None,
                                role_arn: Optional[str] = None,
                                secret_access_key: Optional[str] = None,
                                audit_enabled: Optional[bool] = None,
                                troubleshoot_log_enabled: Optional[bool] = None)
    func NewAwsEventbridgeConnector(ctx *Context, name string, args AwsEventbridgeConnectorArgs, opts ...ResourceOption) (*AwsEventbridgeConnector, error)
    public AwsEventbridgeConnector(string name, AwsEventbridgeConnectorArgs args, CustomResourceOptions? opts = null)
    public AwsEventbridgeConnector(String name, AwsEventbridgeConnectorArgs args)
    public AwsEventbridgeConnector(String name, AwsEventbridgeConnectorArgs args, CustomResourceOptions options)
    
    type: descope:AwsEventbridgeConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_aws_eventbridge_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args AwsEventbridgeConnectorArgs
    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 AwsEventbridgeConnectorArgs
    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 AwsEventbridgeConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AwsEventbridgeConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AwsEventbridgeConnectorArgs
    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 awsEventbridgeConnectorResource = new Descope.AwsEventbridgeConnector("awsEventbridgeConnectorResource", new()
    {
        DetailType = "string",
        Source = "string",
        Region = "string",
        ProjectId = "string",
        EventBusName = "string",
        Description = "string",
        Disabled = false,
        AccessKeyId = "string",
        ExternalId = "string",
        MaskPii = false,
        Name = "string",
        AuthType = "string",
        AuditFilters = new[]
        {
            new Descope.Inputs.AwsEventbridgeConnectorAuditFilterArgs
            {
                Key = "string",
                Operator = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        RoleArn = "string",
        SecretAccessKey = "string",
        AuditEnabled = false,
        TroubleshootLogEnabled = false,
    });
    
    example, err := descope.NewAwsEventbridgeConnector(ctx, "awsEventbridgeConnectorResource", &descope.AwsEventbridgeConnectorArgs{
    	DetailType:   pulumi.String("string"),
    	Source:       pulumi.String("string"),
    	Region:       pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	EventBusName: pulumi.String("string"),
    	Description:  pulumi.String("string"),
    	Disabled:     pulumi.Bool(false),
    	AccessKeyId:  pulumi.String("string"),
    	ExternalId:   pulumi.String("string"),
    	MaskPii:      pulumi.Bool(false),
    	Name:         pulumi.String("string"),
    	AuthType:     pulumi.String("string"),
    	AuditFilters: descope.AwsEventbridgeConnectorAuditFilterArray{
    		&descope.AwsEventbridgeConnectorAuditFilterArgs{
    			Key:      pulumi.String("string"),
    			Operator: pulumi.String("string"),
    			Values: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	RoleArn:                pulumi.String("string"),
    	SecretAccessKey:        pulumi.String("string"),
    	AuditEnabled:           pulumi.Bool(false),
    	TroubleshootLogEnabled: pulumi.Bool(false),
    })
    
    resource "descope_aws_eventbridge_connector" "awsEventbridgeConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      detail_type    = "string"
      source         = "string"
      region         = "string"
      project_id     = "string"
      event_bus_name = "string"
      description    = "string"
      disabled       = false
      access_key_id  = "string"
      external_id    = "string"
      mask_pii       = false
      name           = "string"
      auth_type      = "string"
      audit_filters {
        key      = "string"
        operator = "string"
        values   = ["string"]
      }
      role_arn                 = "string"
      secret_access_key        = "string"
      audit_enabled            = false
      troubleshoot_log_enabled = false
    }
    
    var awsEventbridgeConnectorResource = new AwsEventbridgeConnector("awsEventbridgeConnectorResource", AwsEventbridgeConnectorArgs.builder()
        .detailType("string")
        .source("string")
        .region("string")
        .projectId("string")
        .eventBusName("string")
        .description("string")
        .disabled(false)
        .accessKeyId("string")
        .externalId("string")
        .maskPii(false)
        .name("string")
        .authType("string")
        .auditFilters(AwsEventbridgeConnectorAuditFilterArgs.builder()
            .key("string")
            .operator("string")
            .values("string")
            .build())
        .roleArn("string")
        .secretAccessKey("string")
        .auditEnabled(false)
        .troubleshootLogEnabled(false)
        .build());
    
    aws_eventbridge_connector_resource = descope.AwsEventbridgeConnector("awsEventbridgeConnectorResource",
        detail_type="string",
        source="string",
        region="string",
        project_id="string",
        event_bus_name="string",
        description="string",
        disabled=False,
        access_key_id="string",
        external_id="string",
        mask_pii=False,
        name="string",
        auth_type="string",
        audit_filters=[{
            "key": "string",
            "operator": "string",
            "values": ["string"],
        }],
        role_arn="string",
        secret_access_key="string",
        audit_enabled=False,
        troubleshoot_log_enabled=False)
    
    const awsEventbridgeConnectorResource = new descope.AwsEventbridgeConnector("awsEventbridgeConnectorResource", {
        detailType: "string",
        source: "string",
        region: "string",
        projectId: "string",
        eventBusName: "string",
        description: "string",
        disabled: false,
        accessKeyId: "string",
        externalId: "string",
        maskPii: false,
        name: "string",
        authType: "string",
        auditFilters: [{
            key: "string",
            operator: "string",
            values: ["string"],
        }],
        roleArn: "string",
        secretAccessKey: "string",
        auditEnabled: false,
        troubleshootLogEnabled: false,
    });
    
    type: descope:AwsEventbridgeConnector
    properties:
        accessKeyId: string
        auditEnabled: false
        auditFilters:
            - key: string
              operator: string
              values:
                - string
        authType: string
        description: string
        detailType: string
        disabled: false
        eventBusName: string
        externalId: string
        maskPii: false
        name: string
        projectId: string
        region: string
        roleArn: string
        secretAccessKey: string
        source: string
        troubleshootLogEnabled: false
    

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

    DetailType string
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    EventBusName string
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    Region string
    The AWS EventBridge region, e.g. us-east-1.
    Source string
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    AccessKeyId string
    The unique AWS access key ID.
    AuditEnabled bool
    Whether to enable streaming of audit events.
    AuditFilters List<Descope.AwsEventbridgeConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    AuthType string
    The authentication type to use.
    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.
    ExternalId string
    The external ID to use when assuming the role.
    MaskPii bool
    Whether to mask personally identifiable information in the logs.
    Name string
    A custom name for your connector.
    RoleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    SecretAccessKey string
    The secret AWS access key.
    TroubleshootLogEnabled bool
    Whether to send troubleshooting events.
    DetailType string
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    EventBusName string
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    Region string
    The AWS EventBridge region, e.g. us-east-1.
    Source string
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    AccessKeyId string
    The unique AWS access key ID.
    AuditEnabled bool
    Whether to enable streaming of audit events.
    AuditFilters []AwsEventbridgeConnectorAuditFilterArgs
    Specify which events will be sent to the external audit service (including tenant selection).
    AuthType string
    The authentication type to use.
    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.
    ExternalId string
    The external ID to use when assuming the role.
    MaskPii bool
    Whether to mask personally identifiable information in the logs.
    Name string
    A custom name for your connector.
    RoleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    SecretAccessKey string
    The secret AWS access key.
    TroubleshootLogEnabled bool
    Whether to send troubleshooting events.
    detail_type string
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    event_bus_name string
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    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.
    region string
    The AWS EventBridge region, e.g. us-east-1.
    source string
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    access_key_id string
    The unique AWS access key ID.
    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).
    auth_type string
    The authentication type to use.
    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.
    external_id string
    The external ID to use when assuming the role.
    mask_pii bool
    Whether to mask personally identifiable information in the logs.
    name string
    A custom name for your connector.
    role_arn string
    The Amazon Resource Name (ARN) of the role to assume.
    secret_access_key string
    The secret AWS access key.
    troubleshoot_log_enabled bool
    Whether to send troubleshooting events.
    detailType String
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    eventBusName String
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    region String
    The AWS EventBridge region, e.g. us-east-1.
    source String
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    accessKeyId String
    The unique AWS access key ID.
    auditEnabled Boolean
    Whether to enable streaming of audit events.
    auditFilters List<AwsEventbridgeConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    authType String
    The authentication type to use.
    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.
    externalId String
    The external ID to use when assuming the role.
    maskPii Boolean
    Whether to mask personally identifiable information in the logs.
    name String
    A custom name for your connector.
    roleArn String
    The Amazon Resource Name (ARN) of the role to assume.
    secretAccessKey String
    The secret AWS access key.
    troubleshootLogEnabled Boolean
    Whether to send troubleshooting events.
    detailType string
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    eventBusName string
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    region string
    The AWS EventBridge region, e.g. us-east-1.
    source string
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    accessKeyId string
    The unique AWS access key ID.
    auditEnabled boolean
    Whether to enable streaming of audit events.
    auditFilters AwsEventbridgeConnectorAuditFilter[]
    Specify which events will be sent to the external audit service (including tenant selection).
    authType string
    The authentication type to use.
    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.
    externalId string
    The external ID to use when assuming the role.
    maskPii boolean
    Whether to mask personally identifiable information in the logs.
    name string
    A custom name for your connector.
    roleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    secretAccessKey string
    The secret AWS access key.
    troubleshootLogEnabled boolean
    Whether to send troubleshooting events.
    detail_type str
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    event_bus_name str
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    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.
    region str
    The AWS EventBridge region, e.g. us-east-1.
    source str
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    access_key_id str
    The unique AWS access key ID.
    audit_enabled bool
    Whether to enable streaming of audit events.
    audit_filters Sequence[AwsEventbridgeConnectorAuditFilterArgs]
    Specify which events will be sent to the external audit service (including tenant selection).
    auth_type str
    The authentication type to use.
    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.
    external_id str
    The external ID to use when assuming the role.
    mask_pii bool
    Whether to mask personally identifiable information in the logs.
    name str
    A custom name for your connector.
    role_arn str
    The Amazon Resource Name (ARN) of the role to assume.
    secret_access_key str
    The secret AWS access key.
    troubleshoot_log_enabled bool
    Whether to send troubleshooting events.
    detailType String
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    eventBusName String
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    region String
    The AWS EventBridge region, e.g. us-east-1.
    source String
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    accessKeyId String
    The unique AWS access key ID.
    auditEnabled Boolean
    Whether to enable streaming of audit events.
    auditFilters List<Property Map>
    Specify which events will be sent to the external audit service (including tenant selection).
    authType String
    The authentication type to use.
    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.
    externalId String
    The external ID to use when assuming the role.
    maskPii Boolean
    Whether to mask personally identifiable information in the logs.
    name String
    A custom name for your connector.
    roleArn String
    The Amazon Resource Name (ARN) of the role to assume.
    secretAccessKey String
    The secret AWS access key.
    troubleshootLogEnabled Boolean
    Whether to send troubleshooting events.

    Outputs

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

    Get an existing AwsEventbridgeConnector 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?: AwsEventbridgeConnectorState, opts?: CustomResourceOptions): AwsEventbridgeConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_key_id: Optional[str] = None,
            audit_enabled: Optional[bool] = None,
            audit_filters: Optional[Sequence[AwsEventbridgeConnectorAuditFilterArgs]] = None,
            auth_type: Optional[str] = None,
            description: Optional[str] = None,
            detail_type: Optional[str] = None,
            disabled: Optional[bool] = None,
            event_bus_name: Optional[str] = None,
            external_id: Optional[str] = None,
            mask_pii: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            region: Optional[str] = None,
            role_arn: Optional[str] = None,
            secret_access_key: Optional[str] = None,
            source: Optional[str] = None,
            troubleshoot_log_enabled: Optional[bool] = None) -> AwsEventbridgeConnector
    func GetAwsEventbridgeConnector(ctx *Context, name string, id IDInput, state *AwsEventbridgeConnectorState, opts ...ResourceOption) (*AwsEventbridgeConnector, error)
    public static AwsEventbridgeConnector Get(string name, Input<string> id, AwsEventbridgeConnectorState? state, CustomResourceOptions? opts = null)
    public static AwsEventbridgeConnector get(String name, Output<String> id, AwsEventbridgeConnectorState state, CustomResourceOptions options)
    resources:  existingAwsEventbridgeConnector:    type: descope:AwsEventbridgeConnector    get:      id: ${id}
    import {
      to = descope_aws_eventbridge_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 AwsEventbridgeConnectorState
    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 AwsEventbridgeConnectorState
    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 AwsEventbridgeConnectorState
    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 AwsEventbridgeConnectorState
    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.
    The following state arguments are supported:
    AccessKeyId string
    The unique AWS access key ID.
    AuditEnabled bool
    Whether to enable streaming of audit events.
    AuditFilters List<Descope.AwsEventbridgeConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    AuthType string
    The authentication type to use.
    Description string
    A description of what your connector is used for.
    DetailType string
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    EventBusName string
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    ExternalId string
    The external ID to use when assuming the role.
    MaskPii bool
    Whether to mask personally identifiable information in the logs.
    Name string
    A custom name for your connector.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    Region string
    The AWS EventBridge region, e.g. us-east-1.
    RoleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    SecretAccessKey string
    The secret AWS access key.
    Source string
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    TroubleshootLogEnabled bool
    Whether to send troubleshooting events.
    AccessKeyId string
    The unique AWS access key ID.
    AuditEnabled bool
    Whether to enable streaming of audit events.
    AuditFilters []AwsEventbridgeConnectorAuditFilterArgs
    Specify which events will be sent to the external audit service (including tenant selection).
    AuthType string
    The authentication type to use.
    Description string
    A description of what your connector is used for.
    DetailType string
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    EventBusName string
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    ExternalId string
    The external ID to use when assuming the role.
    MaskPii bool
    Whether to mask personally identifiable information in the logs.
    Name string
    A custom name for your connector.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    Region string
    The AWS EventBridge region, e.g. us-east-1.
    RoleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    SecretAccessKey string
    The secret AWS access key.
    Source string
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    TroubleshootLogEnabled bool
    Whether to send troubleshooting events.
    access_key_id string
    The unique AWS access key ID.
    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).
    auth_type string
    The authentication type to use.
    description string
    A description of what your connector is used for.
    detail_type string
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    event_bus_name string
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    external_id string
    The external ID to use when assuming the role.
    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.
    region string
    The AWS EventBridge region, e.g. us-east-1.
    role_arn string
    The Amazon Resource Name (ARN) of the role to assume.
    secret_access_key string
    The secret AWS access key.
    source string
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    troubleshoot_log_enabled bool
    Whether to send troubleshooting events.
    accessKeyId String
    The unique AWS access key ID.
    auditEnabled Boolean
    Whether to enable streaming of audit events.
    auditFilters List<AwsEventbridgeConnectorAuditFilter>
    Specify which events will be sent to the external audit service (including tenant selection).
    authType String
    The authentication type to use.
    description String
    A description of what your connector is used for.
    detailType String
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    eventBusName String
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    externalId String
    The external ID to use when assuming the role.
    maskPii Boolean
    Whether to mask personally identifiable information in the logs.
    name String
    A custom name for your connector.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    region String
    The AWS EventBridge region, e.g. us-east-1.
    roleArn String
    The Amazon Resource Name (ARN) of the role to assume.
    secretAccessKey String
    The secret AWS access key.
    source String
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    troubleshootLogEnabled Boolean
    Whether to send troubleshooting events.
    accessKeyId string
    The unique AWS access key ID.
    auditEnabled boolean
    Whether to enable streaming of audit events.
    auditFilters AwsEventbridgeConnectorAuditFilter[]
    Specify which events will be sent to the external audit service (including tenant selection).
    authType string
    The authentication type to use.
    description string
    A description of what your connector is used for.
    detailType string
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    disabled boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    eventBusName string
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    externalId string
    The external ID to use when assuming the role.
    maskPii boolean
    Whether to mask personally identifiable information in the logs.
    name string
    A custom name for your connector.
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    region string
    The AWS EventBridge region, e.g. us-east-1.
    roleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    secretAccessKey string
    The secret AWS access key.
    source string
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    troubleshootLogEnabled boolean
    Whether to send troubleshooting events.
    access_key_id str
    The unique AWS access key ID.
    audit_enabled bool
    Whether to enable streaming of audit events.
    audit_filters Sequence[AwsEventbridgeConnectorAuditFilterArgs]
    Specify which events will be sent to the external audit service (including tenant selection).
    auth_type str
    The authentication type to use.
    description str
    A description of what your connector is used for.
    detail_type str
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    event_bus_name str
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    external_id str
    The external ID to use when assuming the role.
    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.
    region str
    The AWS EventBridge region, e.g. us-east-1.
    role_arn str
    The Amazon Resource Name (ARN) of the role to assume.
    secret_access_key str
    The secret AWS access key.
    source str
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    troubleshoot_log_enabled bool
    Whether to send troubleshooting events.
    accessKeyId String
    The unique AWS access key ID.
    auditEnabled Boolean
    Whether to enable streaming of audit events.
    auditFilters List<Property Map>
    Specify which events will be sent to the external audit service (including tenant selection).
    authType String
    The authentication type to use.
    description String
    A description of what your connector is used for.
    detailType String
    The detail type for the EventBridge event. This is a free-form string used to identify the event type, e.g. descope.audit.event.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    eventBusName String
    The name or ARN of the EventBridge event bus. Use default for the default event bus or provide a custom event bus name/ARN.
    externalId String
    The external ID to use when assuming the role.
    maskPii Boolean
    Whether to mask personally identifiable information in the logs.
    name String
    A custom name for your connector.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    region String
    The AWS EventBridge region, e.g. us-east-1.
    roleArn String
    The Amazon Resource Name (ARN) of the role to assume.
    secretAccessKey String
    The secret AWS access key.
    source String
    The source of the EventBridge event. This identifies the application or service that is generating the event, e.g. descope.auth.
    troubleshootLogEnabled Boolean
    Whether to send troubleshooting events.

    Supporting Types

    AwsEventbridgeConnectorAuditFilter, AwsEventbridgeConnectorAuditFilterArgs

    Key string
    The field name to filter on (either 'actions' or 'tenants').
    Operator string
    The filter operation to apply ('includes' or 'excludes').
    Values List<string>
    The list of values to match against for the filter.
    Key string
    The field name to filter on (either 'actions' or 'tenants').
    Operator string
    The filter operation to apply ('includes' or 'excludes').
    Values []string
    The list of values to match against for the filter.
    key string
    The field name to filter on (either 'actions' or 'tenants').
    operator string
    The filter operation to apply ('includes' or 'excludes').
    values list(string)
    The list of values to match against for the filter.
    key String
    The field name to filter on (either 'actions' or 'tenants').
    operator String
    The filter operation to apply ('includes' or 'excludes').
    values List<String>
    The list of values to match against for the filter.
    key string
    The field name to filter on (either 'actions' or 'tenants').
    operator string
    The filter operation to apply ('includes' or 'excludes').
    values string[]
    The list of values to match against for the filter.
    key str
    The field name to filter on (either 'actions' or 'tenants').
    operator str
    The filter operation to apply ('includes' or 'excludes').
    values Sequence[str]
    The list of values to match against for the filter.
    key String
    The field name to filter on (either 'actions' or 'tenants').
    operator String
    The filter operation to apply ('includes' or 'excludes').
    values List<String>
    The list of values to match against for the filter.

    Package Details

    Repository
    descope descope/pulumi-descope
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the descope Terraform Provider.
    descope logo Descope
    Viewing docs for Descope v1.0.1
    published on Sunday, Oct 11, 2026 by Descope

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial