Load data into a Redshift database with a Singer target.

Full documentation can be found on the GitHub Repo.

yaml
type: "io.kestra.plugin.singer.targets.pipelinewiseredshift"

Dynamic YES

Min length 1

Name of the schema where the tables will be created.

If schema_mapping is not defined then every stream sent by the tap is loaded into this schema.

Dynamic YES

The raw data from a tap.

Dynamic YES

Min length 1

The database hostname.

Dynamic NO

The database port.

Dynamic YES

Min length 1

The S3 bucket name.

Dynamic YES

Min length 1

The database user.

Dynamic YES

S3 Access Key ID.

Used for S3 and Redshift copy operations.

Dynamic NO

Default false

Add metadata columns.

Metadata columns add extra row level information about data ingestions, (i.e. when was the row read in source, when was inserted or deleted in redshift etc.) Metadata columns are creating automatically by adding extra columns to the tables with a column prefix SDC. The metadata columns are documented at here. Enabling metadata columns will flag the deleted rows by setting the _SDC_DELETED_AT metadata column. Without the addMetadataColumns option the deleted rows from singer taps will not be recongisable in Redshift.

Dynamic NO

Default 100000

Maximum number of rows in each batch.

At the end of each batch, the rows in the batch are loaded into Redshift.

Dynamic YES

Override default singer command.

Dynamic YES

Default bzip2

Possible Values

gzipbzip2

The compression method to use when writing files to S3 and running Redshift COPY.

Dynamic YES

Default python:3.10.12

The task runner container image, only used if the task runner is container-based.

Dynamic YES

COPY options.

Parameters to use in the COPY command when loading data to Redshift. Some basic file formatting parameters are fixed values and not recommended overriding them by custom values. They are like: CSV GZIP DELIMITER ',' REMOVEQUOTES ESCAPE.

Dynamic NO

Default 0

Object type RECORD items from taps can be transformed to flattened columns by creating columns automatically.

When hardDelete option is true then DELETE SQL commands will be performed in Redshift to delete rows in tables. It's achieved by continuously checking the _SDC_DELETED_AT metadata column sent by the singer tap. Due to deleting rows requires metadata columns, hardDelete option automatically enables the addMetadataColumns option as well..

Dynamic YES

The database name.

Dynamic YES

Grant USAGE privilege on newly created schemas and grant SELECT privilege on newly created tables to a specific list of users or groups.

If schemaMapping is not defined then every stream sent by the tap is granted accordingly.

Dynamic NO

Default false

Disable table cache.

By default the connector caches the available table structures in Redshift at startup. In this way it doesn't need to run additional queries when ingesting data to check if altering the target tables is required. With disable_table_cache option you can turn off this caching. You will always see the most recent table structures but will cause an extra query runtime.

Dynamic NO

Deprecated, use 'taskRunner' instead

Dynamic NO

Default false

Flush and load every stream into Redshift when one batch is full.

Warning: This may trigger the COPY command to use files with low number of records..

Dynamic NO

Default false

Delete rows on Redshift.

Dynamic NO

Default 16

Max number of parallel threads to use when flushing tables.

Dynamic NO

Default 0

The number of threads used to flush tables.

0 will create a thread for each stream, up to parallelism_max. -1 will create a thread for each CPU core. Any other positive number will create that number of threads, up to parallelism_max.

Dynamic YES

The database user's password.

SubType string

Dynamic YES

Override default pip packages to use a specific version.

Dynamic NO

Default true

Log based and Incremental replications on tables with no Primary Key cause duplicates when merging UPDATE events.

When set to true, stop loading data if no Primary Key is defined..

Dynamic YES

AWS Redshift COPY role ARN.

AWS Role ARN to be used for the Redshift COPY operation. Used instead of the given AWS keys for the COPY operation if provided - the keys are still used for other S3 operations.

Dynamic YES

AWS S3 ACL.

S3 Object ACL.

Dynamic YES

S3 Key Prefix.

A static prefix before the generated S3 key names. Using prefixes you can upload files into specific directories in the S3 bucket. Default(None).

Dynamic YES

Schema mapping.

Useful if you want to load multiple streams from one tap to multiple Redshift schemas. If the tap sends the stream_id in <schema_name>-<table_name> format then this option overwrites the default_target_schema value. Note, that using schema_mapping you can overwrite the default_target_schema_select_permissions value to grant SELECT permissions to different groups per schemas or optionally you can create indices automatically for the replicated tables.

Dynamic YES

S3 Secret Access Key.

Used for S3 and Redshift copy operations.

Dynamic YES

AWS S3 Session Token.

S3 AWS STS token for temporary credentials.

Dynamic NO

Default false

Do not update existing records when Primary Key is defined.

Useful to improve performance when records are immutable, e.g. events.

Dynamic NO

Default 1

number of slices to split files into prior to running COPY on Redshift.

This should be set to the number of Redshift slices. The number of slices per node depends on the node size of the cluster - run SELECT COUNT(DISTINCT slice) slices FROM stv_slices to calculate this.

Dynamic YES

Default singer-state

The name of Singer state file stored in KV Store.

Dynamic NO

The task runner to use.

Task runners are provided by plugins, each have their own properties.

Dynamic NO

Default false

Validate every single record message to the corresponding JSON schema.

This option is disabled by default and invalid RECORD messages will fail only at load time by Redshift. Enabling this option will detect invalid records earlier but could cause performance degradation..

Key of the state in KV Store

Dynamic YES

Default busybox

The image used for the file sidecar container.

Dynamic NO

The maximum amount of CPU resources a container can use.

Make sure to set that to a numeric value e.g. cpus: "1.5" or cpus: "4" or For instance, if the host machine has two CPUs and you set cpus: "1.5", the container is guaranteed at most one and a half of the CPUs.

Dynamic NO

Dynamic YES

The registry authentication.

The auth field is a base64-encoded authentication string of username: password or a token.

Dynamic YES

The identity token.

Dynamic YES

The registry password.

Dynamic YES

The registry URL.

If not defined, the registry will be extracted from the image name.

Dynamic YES

The registry token.

Dynamic YES

The registry username.

Dynamic YES

The ARM resource ID of the user assigned identity.

Dynamic YES

Extra boot disk size for each task.

Dynamic YES

The milliCPU count.

Defines the amount of CPU resources per task in milliCPU units. For example, 1000 corresponds to 1 vCPU per task. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType property in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time.

For example, if you specify the n2-standard-2 machine type, which has 2 vCPUs, you can set the cpu to no more than 2000. Alternatively, you can run two tasks on the same VM if you set the cpu to 1000 or less.

Dynamic YES

Memory in MiB.

Defines the amount of memory per task in MiB units. If undefined, the default value is 2048. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time.

For example, if you specify the n2-standard-2 machine type, which has 8 GiB of memory, you can set the memory to no more than 8192.

Dynamic NO

The configuration of the target Kubernetes cluster.

Dynamic YES

Additional YAML spec for the container.

Dynamic NO

Default true

Whether the pod should be deleted upon completion.

Dynamic YES

Additional YAML spec for the sidecar container.

Dynamic NO

Default

{
  "image": "busybox"
}

The configuration of the file sidecar container that handle download and upload of files.

Dynamic YES

The pod custom labels

Kestra will add default labels to the pod with execution and flow identifiers.

Dynamic YES

Default default

The namespace where the pod will be created.

Dynamic YES

Node selector for pod scheduling

Kestra will assign the pod to the nodes you want (see Assign Pod Nodes)

Dynamic YES

Additional YAML spec for the pod.

Dynamic YES

Default ALWAYS

Possible Values

IF_NOT_PRESENTALWAYSNEVER

The image pull policy for a container image and the tag of the image, which affect when Docker attempts to pull (download) the specified image.

Dynamic NO

The pod custom resources

Dynamic NO

Default true

Whether to reconnect to the current pod if it already exists.

Dynamic YES

The name of the service account.

Dynamic NO

Default false

Dynamic NO

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

The version of the plugin to use.

Dynamic YES

Default PT5S

Format duration

The additional duration to wait for logs to arrive after pod completion.

As logs are not retrieved in real time, we cannot guarantee that we have fetched all logs when the pod complete, therefore we wait for a fixed amount of time to fetch late logs.

Dynamic YES

Default PT1H

Format duration

The maximum duration to wait for the pod completion unless the task timeout property is set which will take precedence over this property.

Dynamic YES

Default PT10M

Format duration

The maximum duration to wait until the pod is created.

This timeout is the maximum time that Kubernetes scheduler can take to

schedule the pod
pull the pod image
and start the pod.

Dynamic YES

The Batch account name.

Dynamic YES

The blob service endpoint.

Dynamic YES

Id of the pool on which to run the job.

Dynamic NO

Dynamic YES

The Batch access key.

Dynamic NO

Dynamic YES

Default PT5S

Format duration

Determines how often Kestra should poll the container for completion. By default, the task runner checks every 5 seconds whether the job is completed. You can set this to a lower value (e.g. PT0.1S = every 100 milliseconds) for quick jobs and to a lower threshold (e.g. PT1M = every minute) for long-running jobs. Setting this property to a lower value will reduce the number of API calls Kestra makes to the remote service — keep that in mind in case you see API rate limit errors.

Dynamic NO

Default true

Whether the job should be deleted upon completion.

Warning, if the job is not deleted, a retry of the task could resume an old failed attempt of the job.

Dynamic NO

The private registry which contains the container image.

Dynamic NO

Default true

Whether to reconnect to the current job if it already exists.

Dynamic NO

Default false

Enable log streaming during task execution.

This property is useful for capturing logs from tasks that have a timeout. If a task with a timeout is terminated, this property makes sure all logs up to that point are retrieved.

Dynamic NO

Default false

Dynamic NO

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

The version of the plugin to use.

Dynamic YES

Default PT1H

Format duration

The maximum duration to wait for the job completion unless the task timeout property is set, which will take precedence over this property.

Azure Batch will automatically timeout the job upon reaching such duration and the task will fail.

SubType integer

Dynamic YES

Exit codes of a task execution.

If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.

Dynamic YES

The GCP region.

Dynamic NO

Dynamic YES

Google Cloud Storage Bucket to use to upload (inputFiles and namespaceFiles) and download (outputFiles) files.

It's mandatory to provide a bucket if you want to use such properties.

Dynamic YES

Default PT5S

Format duration

Dynamic NO

Default true

Whether the job should be deleted upon completion.

Dynamic YES

The GCP service account to impersonate.

Dynamic NO

Default 3

The maximum number of retries for the Cloud Run job. By default, the task runner retries the job up to 3 times.

Dynamic YES

The GCP project ID.

Dynamic NO

Default true

Whether to reconnect to the current job if it already exists.

SubType string

Dynamic YES

Default ["https://www.googleapis.com/auth/cloud-platform"]

The GCP scopes to be used.

Dynamic YES

The GCP service account key.

Dynamic NO

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

The version of the plugin to use.

Dynamic YES

The full resource name of the VPC Access Connector to route egress traffic through.

Example: projects/my-project/locations/europe-west1/connectors/my-connector

Dynamic YES

Possible Values

VPC_EGRESS_UNSPECIFIEDALL_TRAFFICPRIVATE_RANGES_ONLYUNRECOGNIZED

The VPC egress setting for the Cloud Run job.

Must be PRIVATE_RANGES_ONLY or ALL_TRAFFIC (case-insensitive). Requires vpcAccessConnector to be set.

Dynamic YES

Default PT5S

Format duration

Additional time after the job ends to wait for late logs.

Dynamic YES

Default PT1H

Format duration

The maximum duration to wait for the job completion unless the task timeout property is set which will take precedence over this property.

Google Cloud Run will automatically timeout the Job upon reaching such duration and the task will be failed.

Dynamic YES

Possible Values

ACTION_UNSPECIFIEDRETRY_TASKFAIL_TASKUNRECOGNIZED

Action on task failures based on different conditions.

Dynamic NO

Conditions for actions to deal with task failures.

Dynamic YES

Network identifier with the format projects/HOST_PROJECT_ID/global/networks/NETWORK.

Dynamic YES

Subnetwork identifier in the format projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNET

Dynamic YES

Default v1

The API version

Dynamic YES

CA certificate as data

Dynamic YES

CA certificate as file path

Dynamic YES

Client certificate as data

Dynamic YES

Client certificate as a file path

Dynamic YES

Default RSA

Client key encryption algorithm

default is RSA

Dynamic YES

Client key as data

Dynamic YES

Client key as a file path

Dynamic YES

Client key passphrase

Dynamic NO

Disable hostname verification

Dynamic YES

Key store file

Dynamic YES

Key store passphrase

Dynamic YES

Default https://kubernetes.default.svc

The url to the Kubernetes API

Dynamic YES

The namespace used

Dynamic YES

Oauth token

Dynamic NO

Oauth token provider

Dynamic YES

Password

Dynamic NO

Trust all certificates

Dynamic YES

Truststore file

Dynamic YES

Truststore passphrase

Dynamic YES

Username

Dynamic YES

The URL of the blob container the compute node should use.

Mandatory if you want to use namespaceFiles, inputFiles or outputFiles properties.

Dynamic YES

Connection string of the Storage Account.

Dynamic YES

The blob service endpoint.

Dynamic YES

Shared Key access key for authenticating requests.

Dynamic YES

Shared Key account name for authenticating requests.

Dynamic NO

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

The version of the plugin to use.

Dynamic YES

The GCP region.

Dynamic NO

Dynamic YES

Google Cloud Storage Bucket to use to upload (inputFiles and namespaceFiles) and download (outputFiles) files.

It's mandatory to provide a bucket if you want to use such properties.

Dynamic YES

Default PT5S

Format duration

Dynamic NO

Compute resource requirements.

ComputeResource defines the amount of resources required for each task. Make sure your tasks have enough compute resources to successfully run. If you also define the types of resources for a job to use with the InstancePolicyOrTemplate field, make sure both fields are compatible with each other.

Dynamic NO

Default true

Whether the job should be deleted upon completion.

Warning, if the job is not deleted, a retry of the task could resume an old failed attempt of the job.

SubType string

Dynamic YES

Container entrypoint to use.

Dynamic YES

The GCP service account to impersonate.

SubType

Dynamic NO

Lifecycle management schema when any task in a task group is failed.

Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.

Dynamic YES

Default e2-medium

The GCP machine type.

See https://cloud.google.com/compute/docs/machine-types

Dynamic NO

Default 2

Dynamic NO

Minimum >= 0

Maximum <= 10

Maximum number of retries on failures.

The default, 0, which means never retry.

SubType

Dynamic NO

Network interfaces.

Dynamic YES

The GCP project ID.

Dynamic YES

Compute reservation.

Dynamic NO

Default true

Whether to reconnect to the current job if it already exists.

SubType string

Dynamic YES

Default ["https://www.googleapis.com/auth/cloud-platform"]

The GCP scopes to be used.

Dynamic YES

The GCP service account key.

Dynamic NO

Default false

Dynamic NO

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

The version of the plugin to use.

Dynamic YES

Default PT5S

Format duration

Additional time after the job ends to wait for late logs.

Dynamic YES

Default PT1H

Format duration

The maximum duration to wait for the job completion unless the task timeout property is set which will take precedence over this property.

Google Cloud Batch will automatically timeout the job upon reaching such duration and the task will be failed.

Dynamic YES

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4MB. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See the kernel-memory docs for more details.

Dynamic YES

The maximum amount of memory resources the container can use.

Make sure to use the format number + unit (regardless of the case) without any spaces. The unit can be KB (kilobytes), MB (megabytes), GB (gigabytes), etc.

Given that it's case-insensitive, the following values are equivalent:

"512MB"
"512Mb"
"512mb"
"512000KB"
"0.5GB"

It is recommended that you allocate at least 6MB.

Dynamic YES

Allows you to specify a soft limit smaller than memory which is activated when Docker detects contention or low memory on the host machine.

If you use memoryReservation, it must be set lower than memory for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.

Dynamic YES

The total amount of memory and swap that can be used by a container.

If memory and memorySwap are set to the same value, this prevents containers from using any swap. This is because memorySwap includes both the physical memory and swap space, while memory is only the amount of physical memory that can be used.

Dynamic YES

A setting which controls the likelihood of the kernel to swap memory pages.

By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set memorySwappiness to a value between 0 and 100 to tune this percentage.

Dynamic NO

By default, if an out-of-memory (OOM) error occurs, the kernel kills processes in a container.

To change this behavior, use the oomKillDisable option. Only disable the OOM killer on containers where you have also set the memory option. If the memory flag is not set, the host can run out of memory, and the kernel may need to kill the host system’s processes to free the memory.

Dynamic YES

The reference to the user assigned identity to use to access the Azure Container Registry instead of username and password.

Dynamic YES

The password to log into the registry server.

Dynamic YES

The registry server URL.

If omitted, the default is "docker.io".

Dynamic YES

The user name to log into the registry server.

Dynamic YES

Min length 1

Docker image to use.

Dynamic YES

Docker configuration file.

Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json.

Dynamic NO

Limits the CPU usage to a given maximum threshold value.

By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.

Dynamic YES

SubType

Dynamic NO

A list of device requests to be sent to device drivers.

SubType string

Dynamic YES

Docker entrypoint to use.

SubType string

Dynamic YES

Extra hostname mappings to the container network interface configuration.

Dynamic YES

Docker API URI.

Dynamic NO

Limits memory usage to a given maximum threshold value.

Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.

Dynamic YES

Docker network mode to use e.g. host, none, etc.

Dynamic NO

Give extended privileges to this container.

Dynamic YES

Default IF_NOT_PRESENT

Possible Values

IF_NOT_PRESENTALWAYSNEVER

The image pull policy for a container image and the tag of the image, which affect when Docker attempts to pull (download) the specified image.

Dynamic YES

Size of /dev/shm in bytes.

The size must be greater than 0. If omitted, the system uses 64MB.

Dynamic YES

User in the Docker container.

SubType string

Dynamic YES

List of volumes to mount.

Must be a valid mount expression as string, example : /home/user:/app.

Volumes mount are disabled by default for security reasons; you must enable them on server configuration by setting kestra.tasks.scripts.docker.volume-enabled to true.

Dynamic NO

Dynamic YES

Docker configuration file.

Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json.

Dynamic NO

Limits the CPU usage to a given maximum threshold value.

By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.

Dynamic YES

Dynamic NO

Default true

Whether the container should be deleted upon completion.

SubType

Dynamic NO

A list of device requests to be sent to device drivers.

SubType string

Dynamic YES

Default

[
  ""
]

Docker entrypoint to use.

SubType string

Dynamic YES

Extra hostname mappings to the container network interface configuration.

Dynamic YES

Default VOLUME

Possible Values

MOUNTVOLUME

File handling strategy.

How to handle local files (input files, output files, namespace files, ...). By default, we create a volume and copy the file into the volume bind path. Configuring it to MOUNT will mount the working directory instead.

Dynamic YES

Docker API URI.

Dynamic NO

Default PT0S

Format duration

When a task is killed, this property sets the grace period before killing the container.

By default, we kill the container immediately when a task is killed. Optionally, you can configure a grace period so the container is stopped with a grace period instead.

Dynamic NO

Limits memory usage to a given maximum threshold value.

Dynamic YES

Docker network mode to use e.g. host, none, etc.

SubType string

Dynamic YES

List of port bindings.

Corresponds to the --publish (-p) option of the docker run CLI command using the format ip: dockerHostPort: containerPort/protocol. Possible example :

8080: 80/udp- 127.0.0.1: 8080: 80- 127.0.0.1: 8080: 80/udp

Dynamic NO

Give extended privileges to this container.

Dynamic YES

Default IF_NOT_PRESENT

Possible Values

IF_NOT_PRESENTALWAYSNEVER

The pull policy for a container image.

Use the IF_NOT_PRESENT pull policy to avoid pulling already existing images. Use the ALWAYS pull policy to pull the latest version of an image even if an image with the same tag already exists.

Dynamic YES

Size of /dev/shm in bytes.

The size must be greater than 0. If omitted, the system uses 64MB.

Dynamic YES

User in the Docker container.

Dynamic NO

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

The version of the plugin to use.

SubType string

Dynamic YES

List of volumes to mount.

Make sure to provide a map of a local path to a container path in the format: /home/local/path:/app/container/path. Volume mounts are disabled by default for security reasons — if you are sure you want to use them, enable that feature in the plugin configuration by setting volume-enabled to true.

Here is how you can add that setting to your kestra configuration:

text

kestra: 
  plugins: 
    configurations: 
      - type: io.kestra.plugin.scripts.runner.docker.Docker
        values: 
          volume-enabled: true

Dynamic NO

Default true

Whether to wait for the container to exit.

SubType array

Dynamic YES

A list of capabilities; an OR list of AND lists of capabilities.

Dynamic NO

SubType string

Dynamic YES

SubType string

Dynamic YES

Driver-specific options, specified as key/value pairs.

These options are passed directly to the driver.

Dynamic YES

Compute environment in which to run the job.

Dynamic YES

AWS region with which the SDK should communicate.

Dynamic NO

Dynamic YES

Access Key Id in order to connect to AWS.

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

Dynamic YES

S3 Bucket to upload (inputFiles and namespaceFiles) and download (outputFiles) files.

It's mandatory to provide a bucket if you want to use such properties.

Dynamic YES

Default PT5S

Format duration

Dynamic NO

Default true

Whether the job should be deleted upon completion.

Warning, if the job is not deleted, a retry of the task could resume an old failed attempt of the job.

Dynamic YES

The endpoint with which the SDK should communicate.

This property allows you to use a different S3 compatible storage backend.

Dynamic YES

Execution role for the AWS Batch job.

Mandatory if the compute environment is ECS Fargate. See the AWS documentation for more details.

Dynamic YES

Job queue to use to submit jobs (ARN). If not specified, the task runner will create a job queue — keep in mind that this can lead to a longer execution.

Dynamic NO

Default

{
  "request": {
    "memory": "2048",
    "cpu": "1"
  }
}

Custom resources for the ECS Fargate container.

See the AWS documentation for more details.

Dynamic NO

Default true

Whether to reconnect to the current job if it already exists.

Dynamic YES

Secret Key Id in order to connect to AWS.

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

Dynamic YES

AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource.

If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

Dynamic YES

The AWS STS endpoint with which the SDKClient should communicate.

Dynamic YES

AWS STS Role.

The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

Dynamic YES

AWS STS External Id.

A unique identifier that might be required when you assume a role in another account. This property is only used when an stsRoleArn is defined.

Dynamic YES

Default PT15M

Format duration

AWS STS Session duration.

The duration of the role session (default: 15 minutes, i.e., PT15M). This property is only used when an stsRoleArn is defined.

Dynamic YES

AWS STS Session name.

This property is only used when an stsRoleArn is defined.

Dynamic NO

Default false

Dynamic YES

Task role to use within the container.

Needed if you want to authenticate with AWS CLI within your container.

Dynamic NO

Validation RegExp \d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)

The version of the plugin to use.

Dynamic YES

Default PT1H

Format duration

The maximum duration to wait for the job completion unless the task timeout property is set which will take precedence over this property.

AWS Batch will automatically timeout the job upon reaching that duration and the task will be marked as failed.