Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

Amazon SNS Connector Reference

Configurations


Configuration

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Globally Defined Default Topic ARN

String

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

Connection Types

Basic
Parameters
Name Type Description Default Value Required

Test Topic

String

Connection Timeout

Number

50000

Socket Timeout

Number

50000

Access Key

String

x

Secret Key

String

x

Try Default AWSCredentials Provider Chain

Boolean

false

Max Connections

Number

Region Endpoint

Enumeration, one of:

  • US_EAST_1

  • US_EAST_2

  • US_WEST_1

  • US_WEST_2

  • EU_WEST_1

  • EU_WEST_2

  • EU_CENTRAL_1

  • AP_NORTHEAST_1

  • AP_NORTHEAST_2

  • AP_SOUTH_1

  • AP_SOUTHEAST_1

  • AP_SOUTHEAST_2

  • SA_EAST_1

  • CA_CENTRAL_1

  • CN_NORTH_1

  • US_GOV_WEST_1

US_EAST_1

Topic Arn (Only to test connectivity)

String

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Host

String

Port

Number

Username

String

Password

String

Domain

String

Workstation

String

Role
Name Type Description Default Value Required

Role ARN

String

x

Test Topic ARN

String

Connection Timeout

Number

50000

Socket Timeout

Number

50000

Access Key

String

x

Secret Key

String

x

Try Default AWSCredentials Provider Chain

Boolean

false

Max Connections

Number

Region Endpoint

Enumeration, one of:

  • US_EAST_1

  • US_EAST_2

  • US_WEST_1

  • US_WEST_2

  • EU_WEST_1

  • EU_WEST_2

  • EU_CENTRAL_1

  • AP_NORTHEAST_1

  • AP_NORTHEAST_2

  • AP_SOUTH_1

  • AP_SOUTHEAST_1

  • AP_SOUTHEAST_2

  • SA_EAST_1

  • CA_CENTRAL_1

  • CN_NORTH_1

  • US_GOV_WEST_1

US_EAST_1

Topic Arn (Only to test connectivity)

String

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Host

String

Port

Number

Username

String

Password

String

Domain

String

Workstation

String

Operations

Add Permission

<sns:add-permission>

Adds a statement to a topic’s access control policy, granting access for the specified AWS accounts to the specified actions. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Arn

String

The ARN of the topic whose access control policy you wish to modify.

x

Label

String

A unique identifier for the new policy statement.

x

Account Ids

Array of String

The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.

x

Action Names

Array of String

The action you want to allow for the specified principal(s)

x

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Confirm Subscription

<sns:confirm-subscription>

The confirmSubscription action verifies an endpoint owner’s intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true". View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Arn

String

The ARN of the topic for which you wish to confirm a subscription.

x

Token

String

Short-lived token sent to an endpoint during the <code>Subscribe</code> action.

x

Authenticate On Unsubscribe

String

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Create Platform Application

<sns:create-platform-application>

Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Name

String

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

x

Platform

String

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).

x

Attributes

Object

The list of attributes.

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Create Platform Endpoint

<sns:create-platform-endpoint>

Creates an endpoint for a device and mobile app on one of the supported push notification services. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Platform Application Arn

String

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

x

Token

String

Unique identifier created by the notification service for an app on a device. The specific name for Token varies, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

x

Custom User Data

String

x

Attributes

Object

The list of attributes.

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Create Topic

<sns:create-topic>

The CreateTopic action creates a topic to which notifications can be published. Users can create at most 100 topics. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Name

String

The name of the topic you want to create.

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Delete Endpoint

<sns:delete-endpoint>

Deletes the endpoint for a device and mobile app from Amazon SNS. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Endpoint Arn

String

EndpointArn of endpoint to delete.

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Delete Platform Application

<sns:delete-platform-application>

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Platform Application Arn

String

PlatformApplicationArn of platform application object to delete.

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Delete Topic

<sns:delete-topic>

The DeleteTopic action deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Arn

String

The ARN of the topic you want to delete.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Get Endpoint Attributes

<sns:get-endpoint-attributes>

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Endpoint Arn

String

EndpointArn for GetEndpointAttributes input.

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Attributes Type

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Get Platform Application Attributes

<sns:get-platform-application-attributes>

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Platform Application Arn

String

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Attributes Type

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Get Subscription Attributes

<sns:get-subscription-attributes>

The GetSubscriptionAttributes action returns all of the properties of a subscription. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription Arn

String

The ARN of the subscription whose properties you want to get

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Attributes Type

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Get Topic Attributes

<sns:get-topic-attributes>

The GetTopicAttributes action returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Arn

String

The ARN of the topic whose properties you want to get.

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Attributes Type

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

List Endpoints By Platform Application

<sns:list-endpoints-by-platform-application>

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Arn

String

The ARN of the platform application.

x

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [Endpoint] payload and [Request ID Attribute] attributes

For Configurations

List Platform Applications

<sns:list-platform-applications>

Lists the platform application objects for the supported push notification services, such as APNS and GCM. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [Platform Application] payload and [Request ID Attribute] attributes

For Configurations

List Subscriptions

<sns:list-subscriptions>

The ListSubscriptions action returns a list of the requester’s subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [Subscription] payload and [Request ID Attribute] attributes

For Configurations

List Subscriptions By Topic

<sns:list-subscriptions-by-topic>

The SubscriptionsByTopic action returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new SubscriptionsByTopic call to get further results. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Arn

String

The ARN of the topic.

x

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [Subscription] payload and [Request ID Attribute] attributes

For Configurations

List Topics

<sns:list-topics>

The ListTopics action returns a list of the requester’s topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [String] payload and [Request ID Attribute] attributes

For Configurations

Publish

<sns:publish>

The Publish action sends a message to all of a topic’s subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS attempts to deliver it to the topic’s subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Arn

String

The topic you want to publish to.

x

Message

String

The message you want to send to the topic.

#[payload]

Subject

String

Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field is also included, if present, in the standard JSON messages delivered to other endpoints.

Message Structure

String

Set <code>MessageStructure</code> to <code>json</code> if you want to send a different message for each protocol.

x

Target Arn

String

Either TopicArn or EndpointArn, but not both.

Message Attributes

Object

The message attributes.

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Remove Permission

<sns:remove-permission>

The RemovePermission action removes a statement from a topic’s access control policy. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Arn

String

The ARN of the topic whose access control policy you wish to modify.

x

Label

String

The unique label of the statement you want to remove.

x

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Set Endpoint Attributes

<sns:set-endpoint-attributes>

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Endpoint

Container for the parameters to the SetEndpointAttributes operation.

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Set Platform Application Attributes

<sns:set-platform-application-attributes>

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Platform Application Attributes

Container for the parameters to the SetPlatformApplicationAttributes operation.

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Set Subscription Attributes

<sns:set-subscription-attributes>

The SubscriptionAttributes action allows a subscription owner to set an attribute of the topic to a new value. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription Arn

String

The ARN of the subscription.

x

Attribute Name

String

The name of the attribute.

x

Attribute Value

String

The value of the attribute.

x

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Set Topic Attributes

<sns:set-topic-attributes>

The TopicAttributes action allows a topic owner to set an attribute of the topic to a new value. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Arn

String

The ARN of the topic.

x

Attribute Name

String

The name of the attribute.

x

Attribute Value

String

The value of the attribute.

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Subscribe

<sns:subscribe>

The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the confirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Arn

String

The ARN of the topic you want to subscribe to.

x

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

  • EMAIL

  • EMAIL_JSON

  • SMS

  • SQS

  • APPLICATION

  • LAMBDA

The protocol you want to use.

x

Endpoint

String

The endpoint that you want to receive notifications. Endpoints vary by protocol:</p> <ul> <li> <p> For the <code>http</code> protocol, the endpoint is an URL beginning with "http://" </p> </li> <li> <p> For the <code>https</code> protocol, the endpoint is a URL beginning with "https://" </p> </li> <li> <p> For the <code>email</code> protocol, the endpoint is an email address </p> </li> <li> <p> For the <code>email-json</code> protocol, the endpoint is an email address </p> </li> <li> <p> For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device </p> </li> <li> <p> For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue </p> </li> <li> <p> For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device. </p> </li> <li> <p> For the <code>lambda</code> protocol, the endpoint is the ARN of an AWS Lambda function. </p> </li>

x

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Unsubscribe

<sns:unsubscribe>

The Unsubscribe action deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the its topic’s owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended. View this operation in the Amazon API reference.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription Arn

String

The ARN of the subscription to be deleted.

#[payload]

Target Variable

String

The name of a variable that stores the output of this operation.

Target Value

String

An expression to evaluate against the operation’s output, and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • SNS:RETRY_EXHAUSTED

  • SNS:CONNECTIVITY

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Request ID Attribute

Field Type Description Default Value Required

Request Id

String

Endpoint

Field Type Description Default Value Required

Attributes

Object

Endpoint Arn

String

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much will the buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Platform Application

Field Type Description Default Value Required

Attributes

Object

Platform Application Arn

String

Subscription

Field Type Description Default Value Required

Endpoint

String

Owner

String

Protocol

String

Subscription Arn

String

Topic Arn

String