1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. AmplitudeConnector
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 Amplitude connector and its configuration in a Descope project. Track user activity and traits at any point in your user journey with the Amplitude connector.

    Create AmplitudeConnector Resource

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

    Constructor syntax

    new AmplitudeConnector(name: string, args: AmplitudeConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def AmplitudeConnector(resource_name: str,
                           args: AmplitudeConnectorArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def AmplitudeConnector(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           api_key: Optional[str] = None,
                           project_id: Optional[str] = None,
                           description: Optional[str] = None,
                           disabled: Optional[bool] = None,
                           name: Optional[str] = None,
                           server_url: Optional[str] = None,
                           server_zone: Optional[str] = None)
    func NewAmplitudeConnector(ctx *Context, name string, args AmplitudeConnectorArgs, opts ...ResourceOption) (*AmplitudeConnector, error)
    public AmplitudeConnector(string name, AmplitudeConnectorArgs args, CustomResourceOptions? opts = null)
    public AmplitudeConnector(String name, AmplitudeConnectorArgs args)
    public AmplitudeConnector(String name, AmplitudeConnectorArgs args, CustomResourceOptions options)
    
    type: descope:AmplitudeConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_amplitude_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args AmplitudeConnectorArgs
    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 AmplitudeConnectorArgs
    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 AmplitudeConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AmplitudeConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AmplitudeConnectorArgs
    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 amplitudeConnectorResource = new Descope.AmplitudeConnector("amplitudeConnectorResource", new()
    {
        ApiKey = "string",
        ProjectId = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
        ServerUrl = "string",
        ServerZone = "string",
    });
    
    example, err := descope.NewAmplitudeConnector(ctx, "amplitudeConnectorResource", &descope.AmplitudeConnectorArgs{
    	ApiKey:      pulumi.String("string"),
    	ProjectId:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Disabled:    pulumi.Bool(false),
    	Name:        pulumi.String("string"),
    	ServerUrl:   pulumi.String("string"),
    	ServerZone:  pulumi.String("string"),
    })
    
    resource "descope_amplitude_connector" "amplitudeConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      api_key     = "string"
      project_id  = "string"
      description = "string"
      disabled    = false
      name        = "string"
      server_url  = "string"
      server_zone = "string"
    }
    
    var amplitudeConnectorResource = new AmplitudeConnector("amplitudeConnectorResource", AmplitudeConnectorArgs.builder()
        .apiKey("string")
        .projectId("string")
        .description("string")
        .disabled(false)
        .name("string")
        .serverUrl("string")
        .serverZone("string")
        .build());
    
    amplitude_connector_resource = descope.AmplitudeConnector("amplitudeConnectorResource",
        api_key="string",
        project_id="string",
        description="string",
        disabled=False,
        name="string",
        server_url="string",
        server_zone="string")
    
    const amplitudeConnectorResource = new descope.AmplitudeConnector("amplitudeConnectorResource", {
        apiKey: "string",
        projectId: "string",
        description: "string",
        disabled: false,
        name: "string",
        serverUrl: "string",
        serverZone: "string",
    });
    
    type: descope:AmplitudeConnector
    properties:
        apiKey: string
        description: string
        disabled: false
        name: string
        projectId: string
        serverUrl: string
        serverZone: string
    

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

    ApiKey string
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    Name string
    A custom name for your connector.
    ServerUrl string
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    ServerZone string
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    ApiKey string
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    Name string
    A custom name for your connector.
    ServerUrl string
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    ServerZone string
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    api_key string
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    name string
    A custom name for your connector.
    server_url string
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    server_zone string
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    apiKey String
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    name String
    A custom name for your connector.
    serverUrl String
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    serverZone String
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    apiKey string
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    name string
    A custom name for your connector.
    serverUrl string
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    serverZone string
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    api_key str
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    name str
    A custom name for your connector.
    server_url str
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    server_zone str
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    apiKey String
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    name String
    A custom name for your connector.
    serverUrl String
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    serverZone String
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.

    Outputs

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

    Get an existing AmplitudeConnector 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?: AmplitudeConnectorState, opts?: CustomResourceOptions): AmplitudeConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_key: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            server_url: Optional[str] = None,
            server_zone: Optional[str] = None) -> AmplitudeConnector
    func GetAmplitudeConnector(ctx *Context, name string, id IDInput, state *AmplitudeConnectorState, opts ...ResourceOption) (*AmplitudeConnector, error)
    public static AmplitudeConnector Get(string name, Input<string> id, AmplitudeConnectorState? state, CustomResourceOptions? opts = null)
    public static AmplitudeConnector get(String name, Output<String> id, AmplitudeConnectorState state, CustomResourceOptions options)
    resources:  existingAmplitudeConnector:    type: descope:AmplitudeConnector    get:      id: ${id}
    import {
      to = descope_amplitude_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 AmplitudeConnectorState
    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 AmplitudeConnectorState
    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 AmplitudeConnectorState
    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 AmplitudeConnectorState
    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:
    ApiKey string
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    ServerUrl string
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    ServerZone string
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    ApiKey string
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    ServerUrl string
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    ServerZone string
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    api_key string
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    server_url string
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    server_zone string
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    apiKey String
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    serverUrl String
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    serverZone String
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    apiKey string
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    serverUrl string
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    serverZone string
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    api_key str
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    server_url str
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    server_zone str
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.
    apiKey String
    The Amplitude API Key generated for the Descope service.
    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.
    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.
    serverUrl String
    The server URL of the Amplitude API, when using different api or a custom domain in Amplitude.
    serverZone String
    EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default is US.

    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