published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a AWS SNS connector and its configuration in a Descope project. Send text messages through Amazon Simple Notification Service (SNS).
Create SnsConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SnsConnector(name: string, args: SnsConnectorArgs, opts?: CustomResourceOptions);@overload
def SnsConnector(resource_name: str,
args: SnsConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SnsConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
region: Optional[str] = None,
endpoint: Optional[str] = None,
access_key_id: Optional[str] = None,
entity_id: Optional[str] = None,
external_id: Optional[str] = None,
name: Optional[str] = None,
origination_number: Optional[str] = None,
description: Optional[str] = None,
auth_type: Optional[str] = None,
role_arn: Optional[str] = None,
secret_access_key: Optional[str] = None,
sender_id: Optional[str] = None,
template_id: Optional[str] = None)func NewSnsConnector(ctx *Context, name string, args SnsConnectorArgs, opts ...ResourceOption) (*SnsConnector, error)public SnsConnector(string name, SnsConnectorArgs args, CustomResourceOptions? opts = null)
public SnsConnector(String name, SnsConnectorArgs args)
public SnsConnector(String name, SnsConnectorArgs args, CustomResourceOptions options)
type: descope:SnsConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_sns_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SnsConnectorArgs
- 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 SnsConnectorArgs
- 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 SnsConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SnsConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SnsConnectorArgs
- 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 snsConnectorResource = new Descope.SnsConnector("snsConnectorResource", new()
{
ProjectId = "string",
Region = "string",
Endpoint = "string",
AccessKeyId = "string",
EntityId = "string",
ExternalId = "string",
Name = "string",
OriginationNumber = "string",
Description = "string",
AuthType = "string",
RoleArn = "string",
SecretAccessKey = "string",
SenderId = "string",
TemplateId = "string",
});
example, err := descope.NewSnsConnector(ctx, "snsConnectorResource", &descope.SnsConnectorArgs{
ProjectId: pulumi.String("string"),
Region: pulumi.String("string"),
Endpoint: pulumi.String("string"),
AccessKeyId: pulumi.String("string"),
EntityId: pulumi.String("string"),
ExternalId: pulumi.String("string"),
Name: pulumi.String("string"),
OriginationNumber: pulumi.String("string"),
Description: pulumi.String("string"),
AuthType: pulumi.String("string"),
RoleArn: pulumi.String("string"),
SecretAccessKey: pulumi.String("string"),
SenderId: pulumi.String("string"),
TemplateId: pulumi.String("string"),
})
resource "descope_sns_connector" "snsConnectorResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
region = "string"
endpoint = "string"
access_key_id = "string"
entity_id = "string"
external_id = "string"
name = "string"
origination_number = "string"
description = "string"
auth_type = "string"
role_arn = "string"
secret_access_key = "string"
sender_id = "string"
template_id = "string"
}
var snsConnectorResource = new SnsConnector("snsConnectorResource", SnsConnectorArgs.builder()
.projectId("string")
.region("string")
.endpoint("string")
.accessKeyId("string")
.entityId("string")
.externalId("string")
.name("string")
.originationNumber("string")
.description("string")
.authType("string")
.roleArn("string")
.secretAccessKey("string")
.senderId("string")
.templateId("string")
.build());
sns_connector_resource = descope.SnsConnector("snsConnectorResource",
project_id="string",
region="string",
endpoint="string",
access_key_id="string",
entity_id="string",
external_id="string",
name="string",
origination_number="string",
description="string",
auth_type="string",
role_arn="string",
secret_access_key="string",
sender_id="string",
template_id="string")
const snsConnectorResource = new descope.SnsConnector("snsConnectorResource", {
projectId: "string",
region: "string",
endpoint: "string",
accessKeyId: "string",
entityId: "string",
externalId: "string",
name: "string",
originationNumber: "string",
description: "string",
authType: "string",
roleArn: "string",
secretAccessKey: "string",
senderId: "string",
templateId: "string",
});
type: descope:SnsConnector
properties:
accessKeyId: string
authType: string
description: string
endpoint: string
entityId: string
externalId: string
name: string
originationNumber: string
projectId: string
region: string
roleArn: string
secretAccessKey: string
senderId: string
templateId: string
SnsConnector 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 SnsConnector resource accepts the following input properties:
- 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 SNS service is configured in.
- Access
Key stringId - 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 SNS API. Leave empty to use the default AWS endpoint.
- Entity
Id string - The entity ID used for regulatory registration, where required.
- 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.
- Origination
Number string - The phone number that text messages are sent from.
- Role
Arn string - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- Secret
Access stringKey - The AWS secret access key. Required when the authentication type is 'credentials'.
- Sender
Id string - The sender ID shown as the origin of the text messages, where supported.
- Template
Id string - The template ID used for regulatory registration, where required.
- 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 SNS service is configured in.
- Access
Key stringId - 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 SNS API. Leave empty to use the default AWS endpoint.
- Entity
Id string - The entity ID used for regulatory registration, where required.
- 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.
- Origination
Number string - The phone number that text messages are sent from.
- Role
Arn string - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- Secret
Access stringKey - The AWS secret access key. Required when the authentication type is 'credentials'.
- Sender
Id string - The sender ID shown as the origin of the text messages, where supported.
- Template
Id string - The template ID used for regulatory registration, where required.
- 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 SNS service is configured in.
- access_
key_ stringid - 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 SNS API. Leave empty to use the default AWS endpoint.
- entity_
id string - The entity ID used for regulatory registration, where required.
- 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.
- origination_
number string - The phone number that text messages are sent from.
- role_
arn string - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- secret_
access_ stringkey - The AWS secret access key. Required when the authentication type is 'credentials'.
- sender_
id string - The sender ID shown as the origin of the text messages, where supported.
- template_
id string - The template ID used for regulatory registration, where required.
- 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 SNS service is configured in.
- access
Key StringId - 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 SNS API. Leave empty to use the default AWS endpoint.
- entity
Id String - The entity ID used for regulatory registration, where required.
- 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.
- origination
Number String - The phone number that text messages are sent from.
- role
Arn String - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- secret
Access StringKey - The AWS secret access key. Required when the authentication type is 'credentials'.
- sender
Id String - The sender ID shown as the origin of the text messages, where supported.
- template
Id String - The template ID used for regulatory registration, where required.
- 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 SNS service is configured in.
- access
Key stringId - 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 SNS API. Leave empty to use the default AWS endpoint.
- entity
Id string - The entity ID used for regulatory registration, where required.
- 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.
- origination
Number string - The phone number that text messages are sent from.
- role
Arn string - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- secret
Access stringKey - The AWS secret access key. Required when the authentication type is 'credentials'.
- sender
Id string - The sender ID shown as the origin of the text messages, where supported.
- template
Id string - The template ID used for regulatory registration, where required.
- 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 SNS service is configured in.
- access_
key_ strid - 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 SNS API. Leave empty to use the default AWS endpoint.
- entity_
id str - The entity ID used for regulatory registration, where required.
- 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.
- origination_
number str - The phone number that text messages are sent from.
- role_
arn str - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- secret_
access_ strkey - The AWS secret access key. Required when the authentication type is 'credentials'.
- sender_
id str - The sender ID shown as the origin of the text messages, where supported.
- template_
id str - The template ID used for regulatory registration, where required.
- 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 SNS service is configured in.
- access
Key StringId - 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 SNS API. Leave empty to use the default AWS endpoint.
- entity
Id String - The entity ID used for regulatory registration, where required.
- 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.
- origination
Number String - The phone number that text messages are sent from.
- role
Arn String - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- secret
Access StringKey - The AWS secret access key. Required when the authentication type is 'credentials'.
- sender
Id String - The sender ID shown as the origin of the text messages, where supported.
- template
Id String - The template ID used for regulatory registration, where required.
Outputs
All input properties are implicitly available as output properties. Additionally, the SnsConnector 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 SnsConnector Resource
Get an existing SnsConnector 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?: SnsConnectorState, opts?: CustomResourceOptions): SnsConnector@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,
entity_id: Optional[str] = None,
external_id: Optional[str] = None,
name: Optional[str] = None,
origination_number: Optional[str] = None,
project_id: Optional[str] = None,
region: Optional[str] = None,
role_arn: Optional[str] = None,
secret_access_key: Optional[str] = None,
sender_id: Optional[str] = None,
template_id: Optional[str] = None) -> SnsConnectorfunc GetSnsConnector(ctx *Context, name string, id IDInput, state *SnsConnectorState, opts ...ResourceOption) (*SnsConnector, error)public static SnsConnector Get(string name, Input<string> id, SnsConnectorState? state, CustomResourceOptions? opts = null)public static SnsConnector get(String name, Output<String> id, SnsConnectorState state, CustomResourceOptions options)resources: _: type: descope:SnsConnector get: id: ${id}import {
to = descope_sns_connector.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Access
Key stringId - 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 SNS API. Leave empty to use the default AWS endpoint.
- Entity
Id string - The entity ID used for regulatory registration, where required.
- 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.
- Origination
Number string - The phone number that text messages are sent from.
- 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 SNS service is configured in.
- Role
Arn string - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- Secret
Access stringKey - The AWS secret access key. Required when the authentication type is 'credentials'.
- Sender
Id string - The sender ID shown as the origin of the text messages, where supported.
- Template
Id string - The template ID used for regulatory registration, where required.
- Access
Key stringId - 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 SNS API. Leave empty to use the default AWS endpoint.
- Entity
Id string - The entity ID used for regulatory registration, where required.
- 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.
- Origination
Number string - The phone number that text messages are sent from.
- 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 SNS service is configured in.
- Role
Arn string - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- Secret
Access stringKey - The AWS secret access key. Required when the authentication type is 'credentials'.
- Sender
Id string - The sender ID shown as the origin of the text messages, where supported.
- Template
Id string - The template ID used for regulatory registration, where required.
- access_
key_ stringid - 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 SNS API. Leave empty to use the default AWS endpoint.
- entity_
id string - The entity ID used for regulatory registration, where required.
- 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.
- origination_
number string - The phone number that text messages are sent from.
- 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 SNS service is configured in.
- role_
arn string - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- secret_
access_ stringkey - The AWS secret access key. Required when the authentication type is 'credentials'.
- sender_
id string - The sender ID shown as the origin of the text messages, where supported.
- template_
id string - The template ID used for regulatory registration, where required.
- access
Key StringId - 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 SNS API. Leave empty to use the default AWS endpoint.
- entity
Id String - The entity ID used for regulatory registration, where required.
- 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.
- origination
Number String - The phone number that text messages are sent from.
- 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 SNS service is configured in.
- role
Arn String - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- secret
Access StringKey - The AWS secret access key. Required when the authentication type is 'credentials'.
- sender
Id String - The sender ID shown as the origin of the text messages, where supported.
- template
Id String - The template ID used for regulatory registration, where required.
- access
Key stringId - 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 SNS API. Leave empty to use the default AWS endpoint.
- entity
Id string - The entity ID used for regulatory registration, where required.
- 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.
- origination
Number string - The phone number that text messages are sent from.
- 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 SNS service is configured in.
- role
Arn string - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- secret
Access stringKey - The AWS secret access key. Required when the authentication type is 'credentials'.
- sender
Id string - The sender ID shown as the origin of the text messages, where supported.
- template
Id string - The template ID used for regulatory registration, where required.
- access_
key_ strid - 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 SNS API. Leave empty to use the default AWS endpoint.
- entity_
id str - The entity ID used for regulatory registration, where required.
- 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.
- origination_
number str - The phone number that text messages are sent from.
- 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 SNS service is configured in.
- role_
arn str - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- secret_
access_ strkey - The AWS secret access key. Required when the authentication type is 'credentials'.
- sender_
id str - The sender ID shown as the origin of the text messages, where supported.
- template_
id str - The template ID used for regulatory registration, where required.
- access
Key StringId - 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 SNS API. Leave empty to use the default AWS endpoint.
- entity
Id String - The entity ID used for regulatory registration, where required.
- 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.
- origination
Number String - The phone number that text messages are sent from.
- 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 SNS service is configured in.
- role
Arn String - The ARN of the IAM role to assume. Required when the authentication type is 'assumeRole'.
- secret
Access StringKey - The AWS secret access key. Required when the authentication type is 'credentials'.
- sender
Id String - The sender ID shown as the origin of the text messages, where supported.
- template
Id String - The template ID used for regulatory registration, where required.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope