connect-directory¶
Description¶
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 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--name (string)
The fully qualified name of your self-managed directory, such as
corp.example.com.
--short-name (string)
The NetBIOS name of your self-managed directory, such as
CORP.
--password (string)
The password for your self-managed 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.
VpcId -> (string)
The identifier of the VPC in which the AD Connector is created.
SubnetIds -> (list)
A list of subnet identifiers in the VPC in which the AD Connector is created.
(string)
CustomerDnsIps -> (list)
A list of one or more IP addresses of DNS servers or domain controllers in your self-managed directory.
(string)
CustomerUserName -> (string)
The user name of an account in your self-managed directory that is used to connect to the directory. This account must have the following permissions:
Read users and groups
Create computer objects
Join computers to the domain
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.
(structure)
Metadata assigned to a directory consisting of a key-value pair.
Key -> (string)
Required name of the tag. The string value can be Unicode characters and cannot be prefixed with “aws:”. The string can contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).
Value -> (string)
The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.