AWS CLI Command Reference

[ aws . eventsv2 ]

create-event-bus

Description

Creates an event bus. Provisioning is asynchronous: the bus is returned in the CREATING state and transitions to ACTIVE when ready (see the EventBusActive waiter). Retries carrying the same ClientToken are idempotent.

See also: AWS API Documentation

Synopsis

  create-event-bus
--name <value>
[--description <value>]
[--encryption-configuration <value>]
[--storage-configuration <value>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--name (string) [required]

Name of an event bus. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’. The grammar matches the name segment of EventBusArn (event-busv2//), so every valid name can be represented in the bus’s ARN. The same type is used everywhere a bus name appears.

Constraints:

  • min: 1
  • max: 256
  • pattern: [A-Za-z0-9][\.\-_A-Za-z0-9]*

--description (string)

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

Constraints:

  • min: 0
  • max: 512
  • pattern: [^\u0000-\u001F\u007F-\u009F\u2028\u2029]*(?![\s\S]).*

--encryption-configuration (structure)

Encryption configuration for an event bus.

KmsKeyIdentifier -> (string)

Identifier of the AWS KMS customer managed key used to encrypt events: a key ID, key ARN, alias name, or alias ARN. When absent, events are encrypted with an AWS owned key.

Constraints:

  • min: 0
  • max: 2048
  • pattern: [a-zA-Z0-9_\-/:]*

Shorthand Syntax:

KmsKeyIdentifier=string

JSON Syntax:

{
  "KmsKeyIdentifier": "string"
}

--storage-configuration (structure)

Event storage configuration for an event bus.

RetentionPeriodInDays -> (integer)

Number of days events are retained on the event bus.

Constraints:

  • min: 1
  • max: 365

Shorthand Syntax:

RetentionPeriodInDays=integer

JSON Syntax:

{
  "RetentionPeriodInDays": integer
}

--tags (map)

Tags attached to a resource, as key-value pairs.

Constraints:

  • min: 0
  • max: 200

key -> (string)

Constraints:

  • min: 1
  • max: 128
  • pattern: \S([\s\S]*\S)?(?![\s\S]).*

value -> (string)

Constraints:

  • min: 0
  • max: 256
  • pattern: (\S([\s\S]*\S)?)?(?![\s\S]).*

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

Unique, case-sensitive identifier that ensures the idempotency of the request. The SDK generates one automatically when the field is omitted.

Constraints:

  • min: 1
  • max: 64
  • pattern: [\u0021-\u007E]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

EventBusArn -> (string)

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Constraints:

  • min: 1
  • max: 1011
  • pattern: arn:aws(-[a-z0-9]+)*:events:[a-z][a-z0-9]*(-[a-z0-9]+)*:([0-9]{12}):event-busv2\/[A-Za-z0-9][\.\-_A-Za-z0-9]{0,255}\/[a-z0-9]{25}

Name -> (string)

Name of an event bus. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’. The grammar matches the name segment of EventBusArn (event-busv2//), so every valid name can be represented in the bus’s ARN. The same type is used everywhere a bus name appears.

Constraints:

  • min: 1
  • max: 256
  • pattern: [A-Za-z0-9][\.\-_A-Za-z0-9]*

Description -> (string)

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

Constraints:

  • min: 0
  • max: 512
  • pattern: [^\u0000-\u001F\u007F-\u009F\u2028\u2029]*(?![\s\S]).*

EncryptionConfiguration -> (structure)

Encryption configuration for an event bus.

KmsKeyIdentifier -> (string)

Identifier of the AWS KMS customer managed key used to encrypt events: a key ID, key ARN, alias name, or alias ARN. When absent, events are encrypted with an AWS owned key.

Constraints:

  • min: 0
  • max: 2048
  • pattern: [a-zA-Z0-9_\-/:]*

StorageConfiguration -> (structure)

Event storage configuration of an event bus, as returned on reads.

RetentionPeriodInDays -> (integer)

Number of days events are retained on the event bus.

Constraints:

  • min: 1
  • max: 365

RetentionWindowStartTime -> (timestamp)

The earliest point in time from which stored events are available. Events older than this have expired from retention.

State -> (string)

Lifecycle state of an event bus.

  • CREATING: Bus creation is in progress.
  • CREATE_FAILED: Bus creation failed; see StateReason. The bus cannot be recovered or recreated in place: delete it with DeleteEventBus, then create a new bus.
  • ACTIVE: Bus is fully operational and can accept events.
  • UPDATING: Bus update is in progress.
  • UPDATE_FAILED: Bus update failed; the bus remains operational with its previous configuration.
  • DELETING: Bus deletion is actively in progress.
  • DELETE_FAILED: Bus deletion failed; see StateReason. Retry DeleteEventBus after removing subscribers and event sources.

Possible values:

  • CREATING
  • CREATE_FAILED
  • UPDATING
  • UPDATE_FAILED
  • DELETING
  • ACTIVE
  • DELETE_FAILED

StateReason -> (string)

Human-readable explanation of why an event bus is in its current State. Omitted when the bus is in a normal operational state (ACTIVE). It stands in for the error response an asynchronous failure cannot return, so it applies only to resources with an asynchronous lifecycle: event buses. EventSources and subscribers are provisioned synchronously and report failures directly on the request.

Constraints:

  • min: 0
  • max: 1000

CreationTime -> (timestamp)

The time the event bus was created.
© Copyright 2026, Amazon Web Services. Created using Sphinx.