Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateConnectorDestination

Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's AWS account.

Request Syntax


POST /connector-destinations HTTP/1.1
Content-type: application/json

{
   "AuthConfig": { 
      "oAuth": { 
         "authUrl": "string",
         "oAuthCompleteRedirectUrl": "string",
         "proactiveRefreshTokenRenewal": { 
            "DaysBeforeRenewal": number,
            "enabled": boolean
         },
         "scope": "string",
         "tokenEndpointAuthenticationScheme": "string",
         "tokenUrl": "string"
      }
   },
   "AuthType": "string",
   "ClientToken": "string",
   "CloudConnectorId": "string",
   "Description": "string",
   "Name": "string",
   "SecretsManager": { 
      "arn": "string",
      "versionId": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AuthConfig

The authentication configuration details for the connector destination, including OAuth settings and other authentication parameters.

Type: AuthConfig object

Required: Yes

AuthType

The authentication type used for the connector destination, which determines how credentials and access are managed.

Type: String

Valid Values: OAUTH

Required: Yes

ClientToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9=_-]+

Required: No

CloudConnectorId

The identifier of the C2C connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9-_]+

Required: Yes

Description

A description of the connector destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [0-9A-Za-z_\- ]+

Required: No

Name

The display name of the connector destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [A-Za-z0-9-_ ]+

Required: No

SecretsManager

The AWS Secrets Manager configuration used to securely store and manage sensitive information for the connector destination.

Type: SecretsManager object

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "Id": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Id

The identifier of the C2C connector destination creation request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9-_]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User is not authorized.

HTTP Status Code: 403

ConflictException

There is a conflict with the request.

HTTP Status Code: 409

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

A validation error occurred when performing the API request.

HTTP Status Code: 400