1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. RekognitionConnector
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 Rekognition connector and its configuration in a Descope project. Add image recognition capabilities for identity verification and fraud prevention with the Amazon Rekognition connector.

    Create RekognitionConnector Resource

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

    Constructor syntax

    new RekognitionConnector(name: string, args: RekognitionConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def RekognitionConnector(resource_name: str,
                             args: RekognitionConnectorArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def RekognitionConnector(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             access_key_id: Optional[str] = None,
                             collection_id: Optional[str] = None,
                             project_id: Optional[str] = None,
                             secret_access_key: Optional[str] = None,
                             description: Optional[str] = None,
                             disabled: Optional[bool] = None,
                             name: Optional[str] = None)
    func NewRekognitionConnector(ctx *Context, name string, args RekognitionConnectorArgs, opts ...ResourceOption) (*RekognitionConnector, error)
    public RekognitionConnector(string name, RekognitionConnectorArgs args, CustomResourceOptions? opts = null)
    public RekognitionConnector(String name, RekognitionConnectorArgs args)
    public RekognitionConnector(String name, RekognitionConnectorArgs args, CustomResourceOptions options)
    
    type: descope:RekognitionConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_rekognition_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args RekognitionConnectorArgs
    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 RekognitionConnectorArgs
    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 RekognitionConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RekognitionConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RekognitionConnectorArgs
    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 rekognitionConnectorResource = new Descope.RekognitionConnector("rekognitionConnectorResource", new()
    {
        AccessKeyId = "string",
        CollectionId = "string",
        ProjectId = "string",
        SecretAccessKey = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
    });
    
    example, err := descope.NewRekognitionConnector(ctx, "rekognitionConnectorResource", &descope.RekognitionConnectorArgs{
    	AccessKeyId:     pulumi.String("string"),
    	CollectionId:    pulumi.String("string"),
    	ProjectId:       pulumi.String("string"),
    	SecretAccessKey: pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	Disabled:        pulumi.Bool(false),
    	Name:            pulumi.String("string"),
    })
    
    resource "descope_rekognition_connector" "rekognitionConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      access_key_id     = "string"
      collection_id     = "string"
      project_id        = "string"
      secret_access_key = "string"
      description       = "string"
      disabled          = false
      name              = "string"
    }
    
    var rekognitionConnectorResource = new RekognitionConnector("rekognitionConnectorResource", RekognitionConnectorArgs.builder()
        .accessKeyId("string")
        .collectionId("string")
        .projectId("string")
        .secretAccessKey("string")
        .description("string")
        .disabled(false)
        .name("string")
        .build());
    
    rekognition_connector_resource = descope.RekognitionConnector("rekognitionConnectorResource",
        access_key_id="string",
        collection_id="string",
        project_id="string",
        secret_access_key="string",
        description="string",
        disabled=False,
        name="string")
    
    const rekognitionConnectorResource = new descope.RekognitionConnector("rekognitionConnectorResource", {
        accessKeyId: "string",
        collectionId: "string",
        projectId: "string",
        secretAccessKey: "string",
        description: "string",
        disabled: false,
        name: "string",
    });
    
    type: descope:RekognitionConnector
    properties:
        accessKeyId: string
        collectionId: string
        description: string
        disabled: false
        name: string
        projectId: string
        secretAccessKey: string
    

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

    AccessKeyId string
    The AWS access key ID
    CollectionId string
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    SecretAccessKey string
    The AWS secret access 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.
    Name string
    A custom name for your connector.
    AccessKeyId string
    The AWS access key ID
    CollectionId string
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    SecretAccessKey string
    The AWS secret access 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.
    Name string
    A custom name for your connector.
    access_key_id string
    The AWS access key ID
    collection_id string
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    secret_access_key string
    The AWS secret access 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.
    name string
    A custom name for your connector.
    accessKeyId String
    The AWS access key ID
    collectionId String
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    secretAccessKey String
    The AWS secret access 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.
    name String
    A custom name for your connector.
    accessKeyId string
    The AWS access key ID
    collectionId string
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    secretAccessKey string
    The AWS secret access 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.
    name string
    A custom name for your connector.
    access_key_id str
    The AWS access key ID
    collection_id str
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    secret_access_key str
    The AWS secret access 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.
    name str
    A custom name for your connector.
    accessKeyId String
    The AWS access key ID
    collectionId String
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    secretAccessKey String
    The AWS secret access 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.
    name String
    A custom name for your connector.

    Outputs

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

    Get an existing RekognitionConnector 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?: RekognitionConnectorState, opts?: CustomResourceOptions): RekognitionConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_key_id: Optional[str] = None,
            collection_id: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            secret_access_key: Optional[str] = None) -> RekognitionConnector
    func GetRekognitionConnector(ctx *Context, name string, id IDInput, state *RekognitionConnectorState, opts ...ResourceOption) (*RekognitionConnector, error)
    public static RekognitionConnector Get(string name, Input<string> id, RekognitionConnectorState? state, CustomResourceOptions? opts = null)
    public static RekognitionConnector get(String name, Output<String> id, RekognitionConnectorState state, CustomResourceOptions options)
    resources:  existingRekognitionConnector:    type: descope:RekognitionConnector    get:      id: ${id}
    import {
      to = descope_rekognition_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 RekognitionConnectorState
    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 RekognitionConnectorState
    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 RekognitionConnectorState
    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 RekognitionConnectorState
    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 AWS access key ID
    CollectionId string
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    SecretAccessKey string
    The AWS secret access key
    AccessKeyId string
    The AWS access key ID
    CollectionId string
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    SecretAccessKey string
    The AWS secret access key
    access_key_id string
    The AWS access key ID
    collection_id string
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    secret_access_key string
    The AWS secret access key
    accessKeyId String
    The AWS access key ID
    collectionId String
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    secretAccessKey String
    The AWS secret access key
    accessKeyId string
    The AWS access key ID
    collectionId string
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    secretAccessKey string
    The AWS secret access key
    access_key_id str
    The AWS access key ID
    collection_id str
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    secret_access_key str
    The AWS secret access key
    accessKeyId String
    The AWS access key ID
    collectionId String
    The collection to store registered users in. Should match [a-zA-Z0-9_.-]+ pattern. Changing this will cause losing existing users.
    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.
    secretAccessKey String
    The AWS secret access key

    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