Skip to main content

Config for aws-s3

Jobs that use the aws-s3 adaptor may require authentication. A "credential" for the aws-s3 adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration​

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "accessKeyId": "AKIA...",
  "region": "us-east-1"
}

Full Schema​

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "accessKeyId": {
          "title": "AWS Access Key ID",
          "type": "string",
          "description": "AWS access key id",
          "examples": [
              "AKIA..."
          ]
      },
      "secretAccessKey": {
          "title": "AWS Secret Access Key",
          "type": "string",
          "description": "AWS secret key",
          "writeOnly": true
      },
      "sessionToken": {
          "title": "AWS Session Token",
          "type": "string",
          "description": "Optional temporary session token (for STS).",
          "writeOnly": true
      },
      "region": {
          "title": "AWS Region",
          "type": "string",
          "description": "AWS region to use (e.g. us-east-1).",
          "examples": [
              "us-east-1"
          ]
      },
      "endpoint": {
          "title": "Override endpoint",
          "type": "string",
          "description": "Optional S3 endpoint (useful for LocalStack or S3-compatible services).",
          "format": "uri"
      },
      "bucket": {
          "title": "Bucket",
          "type": "string",
          "description": "Optional bucket name to use"
      }
  },
  "type": "object",
  "additionalProperties": false
}