Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

...

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper

The topic Arn, attributes, protocol and endpoint details of the topic.

Output

Document

  • Min: 0

  • Max: 1

  • Copy

The endpoint details that is subscribed to the topic.

Snap Settings

Noteinfo

Field names marked with an asterisk ( * ) are mandatory.

Field Name

Field Type

Field Dependency

Description

Label*

String

N/A

The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

Default Value: N/A
Example: Subscribe Topic

Region

String

N/A

Specify the AWS region where the application is implemented. This is a suggestible field and suggestions will be populated based on the Account settings. If the region field is empty, then the Snap evaluates the region in the following sequence:
Topic Arn or Subscription ARN and the region of the EC2 instance.

It is a best practice to provide the value for Region field.

Default value: None
Example: us-east-1, us-west-1

Topic Arn*

String

N/A

Specify the Amazon Resource Name of the topic. This is a suggestible field and suggestions will be populated based on the Account settings.

Default Value: N/A
ExampleTopic 1

Protocol

N/A

The internet protocol to connect to Amazon server. Options available include:

  • http

  • https

  • email

  • email-json

  • SQS

  • sms

Endpoint

String

N/A

Enter the endpoint value, such as an email address or the ARN of an Amazon SQS queue.

Attributes

Select to update the topic attributes. This field set consists of the following fields:

  • Attribute Name

  • Attribute Value

Attribute Name

String

N/A

Enter the name of the attribute in the topic. This is a suggestible field and suggestions will be populated based on the Account settings.

Default Value: N/A
ExampleTopic 1234

Attribute Value

Integer

N/A

Enter the value of the attribute in the topic.

Default Value: N/A
Example3456

Always Return Subscription ARN

Checkbox

N/A

Select this checkbox if you want to return the subscription ARN even if it is not yet confirmed. Otherwise, the pending subscription would be returned for unconfirmed subscription.

Snap Execution

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default valueExecute only
ExampleValidate & Execute

...