Input Types

upsert - Boolean

When true use an upsert on the accountId index to upsert and avoid unique constraint violation.

If account already created, the existing account is unchanged.

upsert - Boolean

When true use an upsert on the accountSetId index to upsert and avoid unique constraint violation.

If account set already created, the existing account set is unchanged.

configId - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

processingStatus - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

created - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

transform - String

Optional jq transform to run on variables in file identified by key. The result of the transform must be a list of json variables.

@example("map(.accountId)")

calculationId - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

code - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

status - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

dimensions - [PartitionKeyInput]!

Group by these values to index the calculation.

The account, transaction and entry are available for use in the dimension computation on context.vars.

policy - String!

A set of policies to apply to this group, formatted as a JSON list that define the permissions granted to users within this group.

The structure of these policies matches the Policy type, but serialized as a JSON string.

Example:

Copypolicy: "[{\"actions\": [\"*\"],\"effect\": \"DENY\",\"resources\":[\"*\"],\"assertions\": {\"always false\": \"1 == 0\"}}]"

partitionShardCount - Int

Specifies the number of shards for partition write scaling.

This parameter defines how many shards the partition key is automatically split into, similarly to RAID-style disk striping. Increasing this value allows the index to distribute write throughput across multiple shards while sacrificing global sort order on the partition.

For instance, setting partitionShardCount to 4 splits each unique partition into four shards, effectively allowing 4000 writes per second for a single partition key.

constraints - ExpressionMap

Map of named CEL expressions specifying the conditions for including a record in this index.

Records are only included in the index if all expressions evaluate to true, i.e. they are combined with a logical AND. Each expression must return a boolean value.

For example, a custom index on a metadata.category field might use the constraints { hasCategory: "has(document.metadata.category)" } to ensure that only records whose metadata document has a defined value for the category field are included.

timezone - String!

The timezone to run this schedule on based on https://www.iana.org/time-zones

example: "America/Los_Angeles" or "UTC"

Supports ST rules defined in https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html

constraints - ExpressionMap

Map of named CEL expressions specifying the conditions for including a record in this index.

Records are only included in the index if all expressions evaluate to true, i.e. they are combined with a logical AND. Each expression must return a boolean value.

For example, a custom index on a metadata.category field might use the constraints { hasCategory: "has(document.metadata.category)" } to ensure that only records whose metadata document has a defined value for the category field are included.

accountId - String!

A globally unique identifier representing an environment within the organization.

This accountId, when combined with an AWS region, is used to calculate the database tenant.

document - [DocumentElementInput!]!

Cel Expressions and Type that define the aggregation.

context.source will have the triggering document.

partition - [PartitionKeyInput!]!

Partition for this aggregation.

Use context.source for defining the index.

sort - [IndexKeyInput!]!

Sort for this aggregation.

Use context.source for defining the index.

filters - ExpressionMap

Map of named CEL expressions that filter when the view should be updated. Only source changes that satisfy all filter conditions will trigger an update to the view. Each expression must return a boolean value.

Default: { enabled: "true" } (all changes trigger an update)

normalize - Expression

A CEL expression to normalize the source object by. If provided, must evaluate to a list. The trigger will be repeated for each item in the list and the value will be available on context.trigger.normalize.

If evaluates to an empty list, will behave as if the normalize expression not provided.

subscription - [String!]!

A list of subscriptions that are available, supporting wildcards *.

Format: <entity>.<inserted|updated|deleted> Supported entities:

• journal
• account
• accountcontext
• accountset
• accountsetmember
• trancode
• transaction
• entry
• balance
• customindex
• custombalance
• endpoint

filters - ExpressionMap

Map of named CEL expressions specifying conditions for sending an event to the endpoint.

Record is only sent if all expressions evaluate to true, i.e. they are combined with a logical AND. Each expression must return a boolean value.

subscription - [String]

A list of subscriptions that are available, supporting wildcards *.

Format: <entity>.<created|updated|deleted> Supported entities:

• journal
• account
• accountcontext
• accountset
• accountsetmember
• trancode
• transaction
• entry
• balance
• customindex
• custombalance
• endpoint

filters - ExpressionMap

Map of named CEL expressions specifying conditions for sending an event to the endpoint.

Record is only sent if all expressions evaluate to true, i.e. they are combined with a logical AND. Each expression must return a boolean value.

journalId - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

currency - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

layer - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

value - Expression!

CEL expression which resolves to the value that is to be sorted.

Within the expression, the document object represents the record. To sort by a field on the record, use document.<field_name>.

value - Expression!

CEL expression which resolves to the value that is to be used for the partition key.

Within the expression, the document object represents the record. To access a field on the document, use document.<field_name>.

resources - [String]!

The resources to allow or deny. In the format <namespace>.<resource>

The following namespaces exist:

• financial
• tenancy
• public
• system

As do the following resources in the financial namespace:

• Account
• AccountSet
• AccountSetMember
• Transaction
• Entry
• Balance
• TranCode
• Journal

You can use * to wildcard as well.

overrideVelocityEnforcement - VelocityEnforcementInput

Override velocity enforcement for this request. If a velocity control action will enforce at VOID or REJECT, will enforce with the action specified in this request.

This is useful for force posts, where you want to disable a velocity control with an action of WARN.

policy - String

A set of policies to apply to this group, formatted as a JSON list that define the permissions granted to users within this group.

Valid actions include db:Insert, db:Update, db:Delete, db:Select or wildcard *

Example:

Copypolicy: "[{\"actions\": [\"*\"],\"effect\": \"DENY\",\"resources\":[\"*\"],\"assertions\": {\"always false\": \"1 == 0\"}}]"

accountId - String!

A globally unique identifier representing an environment within the organization.

This accountId, when combined with an AWS region, is used to calculate the database tenant.

window - [PartitionKeyInput]!

Group by these values to index the calculation.

The account, transaction, tranCode and entry are available for use in the window computation on context.vars.

partitionShardCount - Int

Specifies the number of shards for partition write scaling.

This parameter defines how many shards the partition key is automatically split into, similarly to RAID-style disk striping. Increasing this value allows the index to distribute write throughput across multiple shards while sacrificing global sort order on the partition.

For instance, setting partitionShardCount to 4 splits each unique partition into four shards, effectively allowing 4000 writes per second for a single partition key.

constraints - ExpressionMap

Map of named CEL expressions specifying the conditions for including a record in this index.

Records are only included in the index if all expressions evaluate to true, i.e. they are combined with a logical AND. Each expression must return a boolean value.

For example, a custom index on a metadata.category field might use the constraints { hasCategory: "has(document.metadata.category)" } to ensure that only records whose metadata document has a defined value for the category field are included.

constraints - ExpressionMap

Map of named CEL expressions specifying the conditions for including a record in this index.

Records are only included in the index if all expressions evaluate to true, i.e. they are combined with a logical AND. Each expression must return a boolean value.

For example, a custom index on a metadata.category field might use the constraints { hasCategory: "has(document.metadata.category)" } to ensure that only records whose metadata document has a defined value for the category field are included.