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 . iot-managed-integrations ]
create-connector-destination¶
Description¶
Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer’s Amazon Web Services account.
See also: AWS API Documentation
Synopsis¶
create-connector-destination
[--name <value>]
[--description <value>]
--cloud-connector-id <value>
--auth-type <value>
--auth-config <value>
--secrets-manager <value>
[--client-token <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 display name of the connector destination.
--description (string)
A description of the connector destination.
--cloud-connector-id (string)
The identifier of the C2C connector.
--auth-type (string)
The authentication type used for the connector destination, which determines how credentials and access are managed.
Possible values:
OAUTH
--auth-config (structure)
The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters.
oAuth -> (structure)
The OAuth configuration settings used for authentication with the third-party service.
authUrl -> (string)
The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.tokenUrl -> (string)
The token URL for the OAuth service, where authorization codes are exchanged for access tokens.scope -> (string)
The OAuth scopes requested during authorization, which define the permissions granted to the application.tokenEndpointAuthenticationScheme -> (string)
The authentication scheme used when requesting tokens from the token endpoint.oAuthCompleteRedirectUrl -> (string)
The URL where users are redirected after completing the OAuth authorization process.proactiveRefreshTokenRenewal -> (structure)
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.
Shorthand Syntax:
oAuth={authUrl=string,tokenUrl=string,scope=string,tokenEndpointAuthenticationScheme=string,oAuthCompleteRedirectUrl=string,proactiveRefreshTokenRenewal={enabled=boolean,DaysBeforeRenewal=integer}}
JSON Syntax:
{
"oAuth": {
"authUrl": "string",
"tokenUrl": "string",
"scope": "string",
"tokenEndpointAuthenticationScheme": "HTTP_BASIC"|"REQUEST_BODY_CREDENTIALS",
"oAuthCompleteRedirectUrl": "string",
"proactiveRefreshTokenRenewal": {
"enabled": true|false,
"DaysBeforeRenewal": integer
}
}
}
--secrets-manager (structure)
The AWS Secrets Manager configuration used to securely store and manage sensitive information 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"
}
--client-token (string)
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
--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.