Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . events ]

update-endpoint

Description

Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-endpoint
--name <value>
[--description <value>]
[--routing-config <value>]
[--replication-config <value>]
[--event-buses <value>]
[--role-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the endpoint you want to update.

--description (string)

A description for the endpoint.

--routing-config (structure)

Configure the routing policy, including the health check and secondary Region..

FailoverConfig -> (structure)

The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

Primary -> (structure)

The main Region of the endpoint.

HealthCheck -> (string)

The ARN of the health check used by the endpoint to determine whether failover is triggered.

Secondary -> (structure)

The Region that events are routed to when failover is triggered or event replication is enabled.

Route -> (string)

Defines the secondary Region.

Shorthand Syntax:

FailoverConfig={Primary={HealthCheck=string},Secondary={Route=string}}

JSON Syntax:

{
  "FailoverConfig": {
    "Primary": {
      "HealthCheck": "string"
    },
    "Secondary": {
      "Route": "string"
    }
  }
}

--replication-config (structure)

Whether event replication was enabled or disabled by this request.

State -> (string)

The state of event replication.

Shorthand Syntax:

State=string

JSON Syntax:

{
  "State": "ENABLED"|"DISABLED"
}

--event-buses (list)

Define event buses used for replication.

(structure)

The event buses the endpoint is associated with.

EventBusArn -> (string)

The ARN of the event bus the endpoint is associated with.

Shorthand Syntax:

EventBusArn=string ...

JSON Syntax:

[
  {
    "EventBusArn": "string"
  }
  ...
]

--role-arn (string)

The ARN of the role used by event replication for this request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

Name -> (string)

The name of the endpoint you updated in this request.

Arn -> (string)

The ARN of the endpoint you updated in this request.

RoutingConfig -> (structure)

The routing configuration you updated in this request.

FailoverConfig -> (structure)

The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

Primary -> (structure)

The main Region of the endpoint.

HealthCheck -> (string)

The ARN of the health check used by the endpoint to determine whether failover is triggered.

Secondary -> (structure)

The Region that events are routed to when failover is triggered or event replication is enabled.

Route -> (string)

Defines the secondary Region.

ReplicationConfig -> (structure)

Whether event replication was enabled or disabled for the endpoint you updated in this request.

State -> (string)

The state of event replication.

EventBuses -> (list)

The event buses used for replication for the endpoint you updated in this request.

(structure)

The event buses the endpoint is associated with.

EventBusArn -> (string)

The ARN of the event bus the endpoint is associated with.

RoleArn -> (string)

The ARN of the role used by event replication for the endpoint you updated in this request.

EndpointId -> (string)

The ID of the endpoint you updated in this request.

EndpointUrl -> (string)

The URL of the endpoint you updated in this request.

State -> (string)

The state of the endpoint you updated in this request.