Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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

connect-directory

Description

Creates an AD Connector to connect to an on-premises 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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  connect-directory
--name <value>
[--short-name <value>]
--password <value>
[--description <value>]
--size <value>
--connect-settings <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The fully qualified name of the on-premises directory, such as corp.example.com .

--short-name (string)

The NetBIOS name of the on-premises directory, such as CORP .

--password (string)

The password for the on-premises user account.

--description (string)

A description for the directory.

--size (string)

The size of the directory.

Possible values:

  • Small
  • Large

--connect-settings (structure)

A DirectoryConnectSettings object that contains additional information for the operation.

Shorthand Syntax:

VpcId=string,SubnetIds=string,string,CustomerDnsIps=string,string,CustomerUserName=string

JSON Syntax:

{
  "VpcId": "string",
  "SubnetIds": ["string", ...],
  "CustomerDnsIps": ["string", ...],
  "CustomerUserName": "string"
}

--tags (list)

The tags to be assigned to AD Connector.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "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.

See 'aws help' for descriptions of global parameters.

Output

DirectoryId -> (string)

The identifier of the new directory.