Class CreateDirectoryRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.directory.model.DirectoryRequest
-
- software.amazon.awssdk.services.directory.model.CreateDirectoryRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateDirectoryRequest.Builder,CreateDirectoryRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDirectoryRequest extends DirectoryRequest implements ToCopyableBuilder<CreateDirectoryRequest.Builder,CreateDirectoryRequest>
Contains the inputs for the CreateDirectory operation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateDirectoryRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateDirectoryRequest.Builderbuilder()Stringdescription()A description for the directory.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringname()The fully qualified name for the directory, such ascorp.example.com.Stringpassword()The password for the directory administrator.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateDirectoryRequest.Builder>serializableBuilderClass()StringshortName()The NetBIOS name of the directory, such asCORP.DirectorySizesize()The size of the directory.StringsizeAsString()The size of the directory.List<Tag>tags()The tags to be assigned to the Simple AD directory.CreateDirectoryRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.DirectoryVpcSettingsvpcSettings()A DirectoryVpcSettings object that contains additional information for the operation.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The fully qualified name for the directory, such as
corp.example.com.- Returns:
- The fully qualified name for the directory, such as
corp.example.com.
-
shortName
public final String shortName()
The NetBIOS name of the directory, such as
CORP.- Returns:
- The NetBIOS name of the directory, such as
CORP.
-
password
public final String password()
The password for the directory administrator. The directory creation process creates a directory administrator account with the user name
Administratorand 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.
- Returns:
- The password for the directory administrator. The directory creation process creates a directory
administrator account with the user name
Administratorand 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.
-
-
-
description
public final String description()
A description for the directory.
- Returns:
- A description for the directory.
-
size
public final DirectorySize size()
The size of the directory.
If the service returns an enum value that is not available in the current SDK version,
sizewill returnDirectorySize.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsizeAsString().- Returns:
- The size of the directory.
- See Also:
DirectorySize
-
sizeAsString
public final String sizeAsString()
The size of the directory.
If the service returns an enum value that is not available in the current SDK version,
sizewill returnDirectorySize.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsizeAsString().- Returns:
- The size of the directory.
- See Also:
DirectorySize
-
vpcSettings
public final DirectoryVpcSettings vpcSettings()
A DirectoryVpcSettings object that contains additional information for the operation.
- Returns:
- A DirectoryVpcSettings object that contains additional information for the operation.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<Tag> tags()
The tags to be assigned to the Simple AD directory.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- The tags to be assigned to the Simple AD directory.
-
toBuilder
public CreateDirectoryRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateDirectoryRequest.Builder,CreateDirectoryRequest>- Specified by:
toBuilderin classDirectoryRequest
-
builder
public static CreateDirectoryRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateDirectoryRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-