directoryservice_create_microsoft_ad: Creates a Microsoft AD directory in the AWS Cloud

Description Usage Arguments Value Request syntax

View source: R/directoryservice_operations.R

Description

Creates a Microsoft AD directory in the AWS Cloud. For more information, see AWS Managed Microsoft AD in the AWS Directory Service Admin Guide.

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

Usage

1
2
directoryservice_create_microsoft_ad(Name, ShortName, Password,
  Description, VpcSettings, Edition, Tags)

Arguments

Name

[required] The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.

ShortName

The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

Password

[required] The password for the default administrative user named Admin.

If you need to change the password for the administrator account, you can use the reset_user_password API call.

Description

A description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.

VpcSettings

[required] Contains VPC information for the create_directory or create_microsoft_ad operation.

Edition

AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

Tags

The tags to be assigned to the AWS Managed Microsoft AD directory.

Value

A list with the following syntax:

1
2
3
list(
  DirectoryId = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
svc$create_microsoft_ad(
  Name = "string",
  ShortName = "string",
  Password = "string",
  Description = "string",
  VpcSettings = list(
    VpcId = "string",
    SubnetIds = list(
      "string"
    )
  ),
  Edition = "Enterprise"|"Standard",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

paws.security.identity documentation built on Aug. 23, 2021, 9:16 a.m.