← All posts
2 min read

EventBridge: Create archive from the CLI

#aws#cli#eventbridge#serverless#events
📑 On this page

Part 330 of AWS from Zero. This is lesson 9 in the EventBridge track.

What we are learning

Use create-archive to create or register one EventBridge resource through the CLI. This lesson identifies the required input shape, saves the raw response, and keeps inspection separate from execution.

The AWS CLI operation is aws events create-archive. Required operation inputs: --archive-name (string), --event-source-arn (string). The modeled top-level response contains ArchiveArn, State, StateReason, CreationTime.

Before you run it

aws sts get-caller-identity
REGION="${AWS_REGION:-ap-south-1}"
ARCHIVE_NAME="replace-with-archive-name"
EVENT_SOURCE_ARN="replace-with-event-source-arn"
aws events create-archive help

Use a sandbox account or an approved learning environment. Read the operation help before supplying identifiers, ARNs, network ranges, policy documents, or customer data.

Cost note: Custom events, schema discovery, pipes, and targets can incur usage charges.

The command

aws events create-archive \
  --archive-name "$ARCHIVE_NAME" \
  --event-source-arn "$EVENT_SOURCE_ARN" \
  --region "$REGION" \
  --output json > part-330-response.json

The response is saved to part-330-response.json so inspection is separate from execution. The explicit variables above keep required identifiers visible before the API call.

Inspect the result

node -e "const r=require('./part-330-response.json'); console.log(Object.keys(r))"
node -e "const r=require('./part-330-response.json'); console.log(JSON.stringify(r, null, 2))"

Compare the returned identifiers and status fields with the account, Region, and resource you intended to target. For asynchronous operations, continue with the service's matching get, list, or describe command until it reaches a terminal state.

One tiny variation

node -e "const r=require('./part-330-response.json'); console.log(JSON.stringify(r["ArchiveArn"], null, 2))"

This variation changes output inspection rather than adding another infrastructure concept. Keep the raw JSON while developing a query so a narrow projection does not hide an error or unexpected field.

Common mistake

Do not run a generated request unchanged. Replace every placeholder, add ownership tags where supported, estimate cost, and verify that the selected Region and account are disposable.

Cleanup

# Review the inverse operation before removing the demo resource.
aws events delete-archive help
rm -f part-330-request.json part-330-response.json part-330-payload.bin part-330-debug.log

Local request and response files may contain account IDs, ARNs, names, or service configuration. Remove them when the lab is complete and follow dependency-aware cleanup for any AWS resource you created.

Next, we will learn EventBridge: Create connection from the CLI.

Official AWS CLI reference