2019/02/19 - AWS Directory Service - 3 updated api methods
Changes This release adds support for tags during directory creation (CreateDirectory, CreateMicrosoftAd, ConnectDirectory).
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
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
Request Syntax
client.connect_directory(
Name='string',
ShortName='string',
Password='string',
Description='string',
Size='Small'|'Large',
ConnectSettings={
'VpcId': 'string',
'SubnetIds': [
'string',
],
'CustomerDnsIps': [
'string',
],
'CustomerUserName': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The fully qualified name of the on-premises directory, such as corp.example.com .
string
The NetBIOS name of the on-premises directory, such as CORP .
string
[REQUIRED]
The password for the on-premises user account.
string
A textual description for the directory.
string
[REQUIRED]
The size of the directory.
dict
[REQUIRED]
A DirectoryConnectSettings object that contains additional information for the operation.
VpcId (string) -- [REQUIRED]
The identifier of the VPC in which the AD Connector is created.
SubnetIds (list) -- [REQUIRED]
A list of subnet identifiers in the VPC in which the AD Connector is created.
(string) --
CustomerDnsIps (list) -- [REQUIRED]
A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.
(string) --
CustomerUserName (string) -- [REQUIRED]
The user name of an account in the on-premises 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
list
The tags to be assigned to AD Connector.
(dict) --
Metadata assigned to a directory consisting of a key-value pair.
Key (string) -- [REQUIRED]
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) -- [REQUIRED]
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}_.:/=+\-]*)$").
dict
Response Syntax
{
'DirectoryId': 'string'
}
Response Structure
(dict) --
Contains the results of the ConnectDirectory operation.
DirectoryId (string) --
The identifier of the new directory.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates a Simple AD directory.
Before you call CreateDirectory , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .
See also: AWS API Documentation
Request Syntax
client.create_directory(
Name='string',
ShortName='string',
Password='string',
Description='string',
Size='Small'|'Large',
VpcSettings={
'VpcId': 'string',
'SubnetIds': [
'string',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The fully qualified name for the directory, such as corp.example.com .
string
The short name of the directory, such as CORP .
string
[REQUIRED]
The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.
string
A textual description for the directory.
string
[REQUIRED]
The size of the directory.
dict
A DirectoryVpcSettings object that contains additional information for the operation.
VpcId (string) -- [REQUIRED]
The identifier of the VPC in which to create the directory.
SubnetIds (list) -- [REQUIRED]
The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.
(string) --
list
The tags to be assigned to the Simple AD directory.
(dict) --
Metadata assigned to a directory consisting of a key-value pair.
Key (string) -- [REQUIRED]
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) -- [REQUIRED]
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}_.:/=+\-]*)$").
dict
Response Syntax
{
'DirectoryId': 'string'
}
Response Structure
(dict) --
Contains the results of the CreateDirectory operation.
DirectoryId (string) --
The identifier of the directory that was created.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates an AWS Managed Microsoft AD directory.
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 .
See also: AWS API Documentation
Request Syntax
client.create_microsoft_ad(
Name='string',
ShortName='string',
Password='string',
Description='string',
VpcSettings={
'VpcId': 'string',
'SubnetIds': [
'string',
]
},
Edition='Enterprise'|'Standard',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The fully qualified domain name for the directory, such as corp.example.com . This name will resolve inside your VPC only. It does not need to be publicly resolvable.
string
The NetBIOS name for your domain. A short identifier 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 .
string
[REQUIRED]
The password for the default administrative user named Admin .
string
A textual description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.
dict
[REQUIRED]
Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
VpcId (string) -- [REQUIRED]
The identifier of the VPC in which to create the directory.
SubnetIds (list) -- [REQUIRED]
The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.
(string) --
string
AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.
list
The tags to be assigned to the AWS Managed Microsoft AD directory.
(dict) --
Metadata assigned to a directory consisting of a key-value pair.
Key (string) -- [REQUIRED]
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) -- [REQUIRED]
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}_.:/=+\-]*)$").
dict
Response Syntax
{
'DirectoryId': 'string'
}
Response Structure
(dict) --
Result of a CreateMicrosoftAD request.
DirectoryId (string) --
The identifier of the directory that was created.