1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. SesConnector
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 SES connector and its configuration in a Descope project. Send emails through Amazon Simple Email Service (SES).

    Create SesConnector Resource

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

    Constructor syntax

    new SesConnector(name: string, args: SesConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def SesConnector(resource_name: str,
                     args: SesConnectorArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def SesConnector(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     project_id: Optional[str] = None,
                     sender_email: Optional[str] = None,
                     region: Optional[str] = None,
                     endpoint: Optional[str] = None,
                     external_id: Optional[str] = None,
                     name: Optional[str] = None,
                     access_key_id: Optional[str] = None,
                     description: Optional[str] = None,
                     role_arn: Optional[str] = None,
                     secret_access_key: Optional[str] = None,
                     auth_type: Optional[str] = None,
                     sender_name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewSesConnector(ctx *Context, name string, args SesConnectorArgs, opts ...ResourceOption) (*SesConnector, error)
    public SesConnector(string name, SesConnectorArgs args, CustomResourceOptions? opts = null)
    public SesConnector(String name, SesConnectorArgs args)
    public SesConnector(String name, SesConnectorArgs args, CustomResourceOptions options)
    
    type: descope:SesConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_ses_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args SesConnectorArgs
    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 SesConnectorArgs
    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 SesConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SesConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SesConnectorArgs
    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 sesConnectorResource = new Descope.SesConnector("sesConnectorResource", new()
    {
        ProjectId = "string",
        SenderEmail = "string",
        Region = "string",
        Endpoint = "string",
        ExternalId = "string",
        Name = "string",
        AccessKeyId = "string",
        Description = "string",
        RoleArn = "string",
        SecretAccessKey = "string",
        AuthType = "string",
        SenderName = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := descope.NewSesConnector(ctx, "sesConnectorResource", &descope.SesConnectorArgs{
    	ProjectId:       pulumi.String("string"),
    	SenderEmail:     pulumi.String("string"),
    	Region:          pulumi.String("string"),
    	Endpoint:        pulumi.String("string"),
    	ExternalId:      pulumi.String("string"),
    	Name:            pulumi.String("string"),
    	AccessKeyId:     pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	RoleArn:         pulumi.String("string"),
    	SecretAccessKey: pulumi.String("string"),
    	AuthType:        pulumi.String("string"),
    	SenderName:      pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    resource "descope_ses_connector" "sesConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id        = "string"
      sender_email      = "string"
      region            = "string"
      endpoint          = "string"
      external_id       = "string"
      name              = "string"
      access_key_id     = "string"
      description       = "string"
      role_arn          = "string"
      secret_access_key = "string"
      auth_type         = "string"
      sender_name       = "string"
      tags = {
        "string" = "string"
      }
    }
    
    var sesConnectorResource = new SesConnector("sesConnectorResource", SesConnectorArgs.builder()
        .projectId("string")
        .senderEmail("string")
        .region("string")
        .endpoint("string")
        .externalId("string")
        .name("string")
        .accessKeyId("string")
        .description("string")
        .roleArn("string")
        .secretAccessKey("string")
        .authType("string")
        .senderName("string")
        .tags(Map.of("string", "string"))
        .build());
    
    ses_connector_resource = descope.SesConnector("sesConnectorResource",
        project_id="string",
        sender_email="string",
        region="string",
        endpoint="string",
        external_id="string",
        name="string",
        access_key_id="string",
        description="string",
        role_arn="string",
        secret_access_key="string",
        auth_type="string",
        sender_name="string",
        tags={
            "string": "string",
        })
    
    const sesConnectorResource = new descope.SesConnector("sesConnectorResource", {
        projectId: "string",
        senderEmail: "string",
        region: "string",
        endpoint: "string",
        externalId: "string",
        name: "string",
        accessKeyId: "string",
        description: "string",
        roleArn: "string",
        secretAccessKey: "string",
        authType: "string",
        senderName: "string",
        tags: {
            string: "string",
        },
    });
    
    type: descope:SesConnector
    properties:
        accessKeyId: string
        authType: string
        description: string
        endpoint: string
        externalId: string
        name: string
        projectId: string
        region: string
        roleArn: string
        secretAccessKey: string
        senderEmail: string
        senderName: string
        tags:
            string: string
    

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

    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 region the SES service is configured in.
    SenderEmail string
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    AccessKeyId string
    The AWS access key ID. Required when the authentication type is 'credentials'.
    AuthType string
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    Description string
    A description of what your connector is used for.
    Endpoint string
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    ExternalId string
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    Name string
    A custom name for your connector.
    RoleArn string
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    SecretAccessKey string
    The AWS secret access key. Required when the authentication type is 'credentials'.
    SenderName string
    The name shown as the sender of the emails.
    Tags Dictionary<string, string>
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    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 region the SES service is configured in.
    SenderEmail string
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    AccessKeyId string
    The AWS access key ID. Required when the authentication type is 'credentials'.
    AuthType string
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    Description string
    A description of what your connector is used for.
    Endpoint string
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    ExternalId string
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    Name string
    A custom name for your connector.
    RoleArn string
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    SecretAccessKey string
    The AWS secret access key. Required when the authentication type is 'credentials'.
    SenderName string
    The name shown as the sender of the emails.
    Tags map[string]string
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    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 region the SES service is configured in.
    sender_email string
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    access_key_id string
    The AWS access key ID. Required when the authentication type is 'credentials'.
    auth_type string
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    description string
    A description of what your connector is used for.
    endpoint string
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    external_id string
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    name string
    A custom name for your connector.
    role_arn string
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    secret_access_key string
    The AWS secret access key. Required when the authentication type is 'credentials'.
    sender_name string
    The name shown as the sender of the emails.
    tags map(string)
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    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 region the SES service is configured in.
    senderEmail String
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    accessKeyId String
    The AWS access key ID. Required when the authentication type is 'credentials'.
    authType String
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    description String
    A description of what your connector is used for.
    endpoint String
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    externalId String
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    name String
    A custom name for your connector.
    roleArn String
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    secretAccessKey String
    The AWS secret access key. Required when the authentication type is 'credentials'.
    senderName String
    The name shown as the sender of the emails.
    tags Map<String,String>
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    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 region the SES service is configured in.
    senderEmail string
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    accessKeyId string
    The AWS access key ID. Required when the authentication type is 'credentials'.
    authType string
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    description string
    A description of what your connector is used for.
    endpoint string
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    externalId string
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    name string
    A custom name for your connector.
    roleArn string
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    secretAccessKey string
    The AWS secret access key. Required when the authentication type is 'credentials'.
    senderName string
    The name shown as the sender of the emails.
    tags {[key: string]: string}
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    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 region the SES service is configured in.
    sender_email str
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    access_key_id str
    The AWS access key ID. Required when the authentication type is 'credentials'.
    auth_type str
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    description str
    A description of what your connector is used for.
    endpoint str
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    external_id str
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    name str
    A custom name for your connector.
    role_arn str
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    secret_access_key str
    The AWS secret access key. Required when the authentication type is 'credentials'.
    sender_name str
    The name shown as the sender of the emails.
    tags Mapping[str, str]
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    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 region the SES service is configured in.
    senderEmail String
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    accessKeyId String
    The AWS access key ID. Required when the authentication type is 'credentials'.
    authType String
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    description String
    A description of what your connector is used for.
    endpoint String
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    externalId String
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    name String
    A custom name for your connector.
    roleArn String
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    secretAccessKey String
    The AWS secret access key. Required when the authentication type is 'credentials'.
    senderName String
    The name shown as the sender of the emails.
    tags Map<String>
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.

    Outputs

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

    Get an existing SesConnector 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?: SesConnectorState, opts?: CustomResourceOptions): SesConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_key_id: Optional[str] = None,
            auth_type: Optional[str] = None,
            description: Optional[str] = None,
            endpoint: Optional[str] = None,
            external_id: Optional[str] = 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,
            sender_email: Optional[str] = None,
            sender_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> SesConnector
    func GetSesConnector(ctx *Context, name string, id IDInput, state *SesConnectorState, opts ...ResourceOption) (*SesConnector, error)
    public static SesConnector Get(string name, Input<string> id, SesConnectorState? state, CustomResourceOptions? opts = null)
    public static SesConnector get(String name, Output<String> id, SesConnectorState state, CustomResourceOptions options)
    resources:  existingSesConnector:    type: descope:SesConnector    get:      id: ${id}
    import {
      to = descope_ses_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 SesConnectorState
    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 SesConnectorState
    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 SesConnectorState
    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 SesConnectorState
    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. Required when the authentication type is 'credentials'.
    AuthType string
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    Description string
    A description of what your connector is used for.
    Endpoint string
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    ExternalId string
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    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 region the SES service is configured in.
    RoleArn string
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    SecretAccessKey string
    The AWS secret access key. Required when the authentication type is 'credentials'.
    SenderEmail string
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    SenderName string
    The name shown as the sender of the emails.
    Tags Dictionary<string, string>
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    AccessKeyId string
    The AWS access key ID. Required when the authentication type is 'credentials'.
    AuthType string
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    Description string
    A description of what your connector is used for.
    Endpoint string
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    ExternalId string
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    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 region the SES service is configured in.
    RoleArn string
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    SecretAccessKey string
    The AWS secret access key. Required when the authentication type is 'credentials'.
    SenderEmail string
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    SenderName string
    The name shown as the sender of the emails.
    Tags map[string]string
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    access_key_id string
    The AWS access key ID. Required when the authentication type is 'credentials'.
    auth_type string
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    description string
    A description of what your connector is used for.
    endpoint string
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    external_id string
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    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 region the SES service is configured in.
    role_arn string
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    secret_access_key string
    The AWS secret access key. Required when the authentication type is 'credentials'.
    sender_email string
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    sender_name string
    The name shown as the sender of the emails.
    tags map(string)
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    accessKeyId String
    The AWS access key ID. Required when the authentication type is 'credentials'.
    authType String
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    description String
    A description of what your connector is used for.
    endpoint String
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    externalId String
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    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 region the SES service is configured in.
    roleArn String
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    secretAccessKey String
    The AWS secret access key. Required when the authentication type is 'credentials'.
    senderEmail String
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    senderName String
    The name shown as the sender of the emails.
    tags Map<String,String>
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    accessKeyId string
    The AWS access key ID. Required when the authentication type is 'credentials'.
    authType string
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    description string
    A description of what your connector is used for.
    endpoint string
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    externalId string
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    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 region the SES service is configured in.
    roleArn string
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    secretAccessKey string
    The AWS secret access key. Required when the authentication type is 'credentials'.
    senderEmail string
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    senderName string
    The name shown as the sender of the emails.
    tags {[key: string]: string}
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    access_key_id str
    The AWS access key ID. Required when the authentication type is 'credentials'.
    auth_type str
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    description str
    A description of what your connector is used for.
    endpoint str
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    external_id str
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    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 region the SES service is configured in.
    role_arn str
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    secret_access_key str
    The AWS secret access key. Required when the authentication type is 'credentials'.
    sender_email str
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    sender_name str
    The name shown as the sender of the emails.
    tags Mapping[str, str]
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.
    accessKeyId String
    The AWS access key ID. Required when the authentication type is 'credentials'.
    authType String
    How to authenticate with AWS: using static credentials or by assuming an IAM role.
    description String
    A description of what your connector is used for.
    endpoint String
    A custom endpoint for the SES API. Leave empty to use the default AWS endpoint.
    externalId String
    The external ID used when assuming the IAM role. Required when the authentication type is 'assumeRole'.
    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 region the SES service is configured in.
    roleArn String
    The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
    secretAccessKey String
    The AWS secret access key. Required when the authentication type is 'credentials'.
    senderEmail String
    The email address that emails are sent from. Make sure it is a verified identity in SES.
    senderName String
    The name shown as the sender of the emails.
    tags Map<String>
    Custom AWS SES message tags added to every email sent through this connector, as key/value pairs.

    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