S3 Object

S3 object artifacts are references to objects stored in S3 buckets.

These artifacts are generally consumed by stages that read configuration from text files, such as a Deploy Manifest or AWS Deploy stage.

S3 object artifact in the UI

The pipeline UI exposes the following fields for the S3 object artifact:

FieldExplanation
AccountAn S3 artifact account.
Object pathThe full path to the artifact file, beginning with s3://.

In a trigger

When configuring a trigger, you can use an S3 object as an expected artifact.

Configuring S3 object fields in a pipeline trigger’s expected artifact settings.

Configuring S3 object fields in a pipeline trigger’s expected artifact settings.

In a pipeline stage

When configuring a “Deploy (Manifest)” or “Deploy” stage, you can use an S3 object as a manifest or application artifact. You can either use a previously-defined artifact (for example, an artifact defined in a trigger) or define an artifact inline.

Configuring a Deploy (Manifest) stage to use an S3 object as a manifest source.

Configuring a Deploy (Manifest) stage to use an S3 object as a manifest source.

S3 object artifact in a pipeline definition

The following are the fields that make up an S3 object artifact:

FieldExplanation
typeAlways s3/object.
nameThe full path to the artifact file, beginning with s3://.
referenceThe full path to the artifact file, beginning with s3://.
locationThe region of the bucket containing the object.

The following is an example JSON representation of an S3 object artifact, as it would appear in a pipeline definition:

  1. {
  2. "type": "s3/object",
  3. "name": "s3://bucket/file.json",
  4. "reference": "s3://bucket/file.json",
  5. "location": "us-east-1"
  6. }

Last modified July 1, 2021: docs(fix): fix internal links (#98) (d74c3a4)