[ aws . appintegrations ]

create-event-integration

Description

The Amazon AppIntegrations APIs are in preview release and are subject to change.

Creates an EventIntegration, given a specified name, description, and a reference to an Amazon Eventbridge bus in your account and a partner event source that will push events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-event-integration
--name <value>
[--description <value>]
--event-filter <value>
--event-bridge-bus <value>
[--client-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the event integration.

--description (string)

The description of the event integration.

--event-filter (structure)

The event filter.

Source -> (string)

The source of the events.

Shorthand Syntax:

Source=string

JSON Syntax:

{
  "Source": "string"
}

--event-bridge-bus (string)

The Eventbridge bus.

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--tags (map)

One or more tags.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--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.

See ‘aws help’ for descriptions of global parameters.

Output

EventIntegrationArn -> (string)

The Amazon Resource Name (ARN) of the event integration.