Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ConnectDirectory

Creates an AD Connector to connect to a self-managed directory.

Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Request Syntax


{
   "ConnectSettings": { 
      "CustomerDnsIps": [ "string" ],
      "CustomerUserName": "string",
      "SubnetIds": [ "string" ],
      "VpcId": "string"
   },
   "Description": "string",
   "Name": "string",
   "Password": "string",
   "ShortName": "string",
   "Size": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

The request accepts the following data in JSON format.

ConnectSettings

A DirectoryConnectSettings object that contains additional information for the operation.

Type: DirectoryConnectSettings object

Required: Yes

Description

A description for the directory.

Type: String

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

Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$

Required: No

Name

The fully qualified name of your self-managed directory, such as corp.example.com.

Type: String

Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$

Required: Yes

Password

The password for your self-managed user account.

Type: String

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

Required: Yes

ShortName

The NetBIOS name of your self-managed directory, such as CORP.

Type: String

Pattern: ^[^\\/:*?"<>|.]+[^\\/:*?"<>|]*$

Required: No

Size

The size of the directory.

Type: String

Valid Values: Small | Large

Required: Yes

Tags

The tags to be assigned to AD Connector.

Type: Array of Tag objects

Required: No

Response Syntax


{
   "DirectoryId": "string"
}

Response Elements

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

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

DirectoryId

The identifier of the new directory.

Type: String

Pattern: ^d-[0-9a-f]{10}$

Errors

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

ClientException

A client exception has occurred.

HTTP Status Code: 400

DirectoryLimitExceededException

The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

Examples

The following examples are formatted for legibility.

Example Request

This example illustrates one usage of ConnectDirectory.


POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 295
X-Amz-Target: DirectoryService_20150416.ConnectDirectory
X-Amz-Date: 20161212T233740Z
User-Agent: aws-cli/1.11.24 Python/2.7.9 Windows/7 botocore/1.4.81
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 
 Credential=AKIAI7E3BYXS3example/20161212/us-west-2/ds/aws4_request, 
 SignedHeaders=content-type;host;x-amz-date;x-amz-target, 
 Signature=60ddfa4a90d91327ef8cb510563d6f031eab1b092d5b1034fab7b157733bf86b

 {
   "Name":"corp.example.com",
   "ConnectSettings":{
      "CustomerUserName":"Administrator",
      "VpcId":"vpc-45025421",
      "SubnetIds":[
         "subnet-ba0146de",
         "subnet-bef46bc8"
      ],
      "CustomerDnsIps":[
         "172.30.21.228"
      ]
   },
   "Description":"Connector to corp",
   "ShortName":"corp",
   "Password":"Str0ngP@ssw0rd",
   "Size":"Small"
 }

Example Response

This example illustrates one usage of ConnectDirectory.


HTTP/1.1 200 OK
x-amzn-RequestId: fa22d0f1-c0c3-11e6-9ed0-172b3469d361
Content-Type: application/x-amz-json-1.1
Content-Length: 30
Date: Mon, 12 Dec 2016 23:37:43 GMT

{  
   "DirectoryId":"d-926example"
}