Versions Compared

Key

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

...

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper

  • File Reader

The region, name, attributes, tag attributes, and other details of the topic.

Output

Document

  • Min: 0

  • Max: 1

  • Copy

  • Head

  • Filter

  • Confirm Topic

  • Delete Topic

The created topic meets the required criteria.

Error

Error handling is to have a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that might arise while running the Pipeline by choosing one of the options from the When errors occur section under the Views tab.

The options available are:

  • Stop Pipeline Execution: Stops the current pipeline execution when an error arises.

  • Discard Error Data and Continue: Ignores an error completely, discard that record, and continue with the rest of the records.

  • Route Error Data to Error View: Routes the data to an error view of the Snap and then decides what to do with the error.

See Error View in Pipeline in examples to understand the Snap error view settings and error output. For more information on the error view and handling error output in a Pipeline, see Error handling in Pipelines.

Snap Settings

Info

Icons used in the interface

  • Asterisk (*) - Mandatory fields: Indicates a mandatory field.

  • Suggestion icon (blue star) - Suggestible fields and suggestions will be ((blue star)): Indicates a list that is dynamically populated based on the account settingsconfiguration.

  • Expression icon ((blue star)): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon (blue star) - Enable when you want to use expressions as field values((blue star)): Indicates that you can add fields in the field set.

  • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

Field Name

Field Type

Field Dependency

Description

Label*

Default Value:Create topic
ExampleCreate topic

String

None

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

Region

Default Value:N/A
Exampleus-east-1, us-west-1

String/Suggestion

None

Specify the AWS region where an application is implemented. If the region field is empty, then the Snap evaluates the region in the following sequence:

  • The Topic Arn or Subscription ARN

  • The region of the EC2 instance.

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

Topic Name*

Default Value:N/A
ExampleTopic 1

String

None

Specify the name of the target topic.

Attributes

Use this field set to define attributes for the new entry.

Attribute Name

Default Value: N/A
ExampledisplayName

String/Suggestion

None

Choose the attribute name:

  • DeliveryPolicy: The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • Displayname: The display name to use for a topic with SMS subscriptions.

  • FifoTopic: When you select FifoTopic, the topic name should be with the extension .fifo and the Attribute value should be true.

  • Policy: The policy that defines the users who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

  • KmsMasterkeyId: The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

  • ContentBasedDeduplication: Enables content-based deduplication for FIFO topics.

Attribute Value

Default Value: N/A
Example$displayName

String

None

Specify a value for the attribute name.

Tag Attributes

Use this field set to define tag attributes for the new entry.

Tag Name

Default Value: N/A
Exampletag1

String

None

Specify a name for the tag attribute.

Value


Default Value: N/A
Exampletag_Name1

String

None

Specify a name for the tag value.

Snap Execution

Default ValueExecute only
ExampleValidate & Execute

Dropdown list

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.

...