Connect Directory

directoryservice_connect_directory

R Documentation

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

Description

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

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

Usage

directoryservice_connect_directory(Name, ShortName, Password,
  Description, Size, ConnectSettings, Tags, NetworkType)

Arguments

Name	[required] The fully qualified name of your self-managed directory, such as corp.example.com.
ShortName	The NetBIOS name of your self-managed directory, such as CORP.
Password	[required] The password for your self-managed user account.
Description	A description for the directory.
Size	[required] The size of the directory.
ConnectSettings	[required] A DirectoryConnectSettings object that contains additional information for the operation.
Tags	The tags to be assigned to AD Connector.
NetworkType	The network type for your directory. The default value is IPv4 or IPv6 based on the provided subnet capabilities.

Value

A list with the following syntax:

list(
  DirectoryId = "string"
)

Request syntax

svc$connect_directory(
  Name = "string",
  ShortName = "string",
  Password = "string",
  Description = "string",
  Size = "Small"|"Large",
  ConnectSettings = list(
    VpcId = "string",
    SubnetIds = list(
      "string"
    ),
    CustomerDnsIps = list(
      "string"
    ),
    CustomerDnsIpsV6 = list(
      "string"
    ),
    CustomerUserName = "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  NetworkType = "Dual-stack"|"IPv4"|"IPv6"
)