AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot-managed-integrations ]

update-connector-destination

Description

Updates the properties of an existing connector destination.

See also: AWS API Documentation

Synopsis

  update-connector-destination
--identifier <value>
[--description <value>]
[--name <value>]
[--auth-type <value>]
[--auth-config <value>]
[--secrets-manager <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>]
[--v2-debug]

Options

--identifier (string)

The unique identifier of the connector destination to update.

--description (string)

The new description to assign to the connector destination.

--name (string)

The new display name to assign to the connector destination.

--auth-type (string)

The new authentication type to use for the connector destination.

Possible values:

  • OAUTH

--auth-config (structure)

The updated authentication configuration details for the connector destination.

oAuthUpdate -> (structure)

The updated OAuth configuration settings for the authentication configuration.

oAuthCompleteRedirectUrl -> (string)

The updated URL where users are redirected after completing the OAuth authorization process.

proactiveRefreshTokenRenewal -> (structure)

Updated configuration for proactively refreshing OAuth tokens before they expire.

enabled -> (boolean)

Indicates whether proactive refresh token renewal is enabled.

DaysBeforeRenewal -> (integer)

The days before token expiration when the system should attempt to renew the token, specified in days.

GeneralAuthorizationUpdate -> (structure)

The General Authorization update information containing authorization materials to add or update in Kinesis Data Streams.

AuthMaterialsToAdd -> (list)

The authorization materials to add.

(structure)

The authorization material containing the Secrets Manager arn and version.

SecretsManager -> (structure)

Configuration for AWS Secrets Manager, used to securely store and manage sensitive information for connector destinations.

arn -> (string)

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret.

versionId -> (string)

The version ID of the AWS Secrets Manager secret.

AuthMaterialName -> (string)

The name of the authorization material.

AuthMaterialsToUpdate -> (list)

The authorization materials to update.

(structure)

The authorization material containing the Secrets Manager arn and version.

SecretsManager -> (structure)

Configuration for AWS Secrets Manager, used to securely store and manage sensitive information for connector destinations.

arn -> (string)

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret.

versionId -> (string)

The version ID of the AWS Secrets Manager secret.

AuthMaterialName -> (string)

The name of the authorization material.

JSON Syntax:

{
  "oAuthUpdate": {
    "oAuthCompleteRedirectUrl": "string",
    "proactiveRefreshTokenRenewal": {
      "enabled": true|false,
      "DaysBeforeRenewal": integer
    }
  },
  "GeneralAuthorizationUpdate": {
    "AuthMaterialsToAdd": [
      {
        "SecretsManager": {
          "arn": "string",
          "versionId": "string"
        },
        "AuthMaterialName": "string"
      }
      ...
    ],
    "AuthMaterialsToUpdate": [
      {
        "SecretsManager": {
          "arn": "string",
          "versionId": "string"
        },
        "AuthMaterialName": "string"
      }
      ...
    ]
  }
}

--secrets-manager (structure)

The updated AWS Secrets Manager configuration for the connector destination.

arn -> (string)

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret.

versionId -> (string)

The version ID of the AWS Secrets Manager secret.

Shorthand Syntax:

arn=string,versionId=string

JSON Syntax:

{
  "arn": "string",
  "versionId": "string"
}

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

None