Package software.amazon.awssdk.services.directory.model

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.

  • Method Details

    • 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 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.

      Returns:
      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.

    • 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, size will return DirectorySize.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sizeAsString().

      Returns:
      The size of the directory.
      See Also:

    • 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, size will return DirectorySize.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sizeAsString().

      Returns:
      The size of the directory.
      See Also:

    • 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 the isEmpty() 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDirectoryRequest.Builder,CreateDirectoryRequest>
      Specified by:
      toBuilder in class DirectoryRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDirectoryRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDirectoryRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.