AWS CLI Command Reference

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

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>]
[--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>]

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.

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

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

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.