You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DirectoryService::Types::CreateDirectoryRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::DirectoryService::Types::CreateDirectoryRequest
- Defined in:
- (unknown)
Overview
When passing CreateDirectoryRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
name: "DirectoryName", # required
short_name: "DirectoryShortName",
password: "Password", # required
description: "Description",
size: "Small", # required, accepts Small, Large
vpc_settings: {
vpc_id: "VpcId", # required
subnet_ids: ["SubnetId"], # required
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
}
Contains the inputs for the CreateDirectory operation.
Instance Attribute Summary collapse
-
#description ⇒ String
A description for the directory.
-
#name ⇒ String
The fully qualified name for the directory, such as
corp.example.com
. -
#password ⇒ String
The password for the directory administrator.
-
#short_name ⇒ String
The NetBIOS name of the directory, such as
CORP
. -
#size ⇒ String
The size of the directory.
-
#tags ⇒ Array<Types::Tag>
The tags to be assigned to the Simple AD directory.
-
#vpc_settings ⇒ Types::DirectoryVpcSettings
A DirectoryVpcSettings object that contains additional information for the operation.
Instance Attribute Details
#description ⇒ String
A description for the directory.
#name ⇒ String
The fully qualified name for the directory, such as corp.example.com
.
#password ⇒ String
The password for the directory administrator. The directory creation
process creates a directory administrator account with the user name
Administrator
and this password.
If you need to change the password for the administrator account, you can use the ResetUserPassword API call.
The regex pattern for this string is made up of the following conditions:
- Length (?=^.`8,64`$) – Must be between 8 and 64 characters
^
AND any 3 of the following password complexity rules required by Active Directory:
Numbers and upper case and lowercase (?=.*\d)(?=.*[A-Z])(?=.*[a-z])
Numbers and special characters and lower case (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])
Special characters and upper case and lower case (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])
Numbers and upper case and special characters (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s])
For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.
#short_name ⇒ String
The NetBIOS name of the directory, such as CORP
.
#size ⇒ String
The size of the directory.
Possible values:
- Small
- Large
#tags ⇒ Array<Types::Tag>
The tags to be assigned to the Simple AD directory.
#vpc_settings ⇒ Types::DirectoryVpcSettings
A DirectoryVpcSettings object that contains additional information for the operation.