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

Class CreateMicrosoftAdRequest

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.CreateMicrosoftAdRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateMicrosoftAdRequest.Builder,CreateMicrosoftAdRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateMicrosoftAdRequest extends DirectoryRequest implements ToCopyableBuilder<CreateMicrosoftAdRequest.Builder,CreateMicrosoftAdRequest>

Creates an Managed Microsoft AD directory.

  • Method Details

    • name

      public final String name()

      The fully qualified domain name for the 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.

      Returns:
      The fully qualified domain name for the 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

      public final String 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.

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

      public final String password()

      The password for the default administrative user named Admin.

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

      Returns:
      The password for the default administrative user named Admin.

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

    • description

      public final String description()

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

      Returns:
      A description for the directory. This label will appear on the Amazon Web Services console Directory Details page after the directory is created.

    • vpcSettings

      public final DirectoryVpcSettings vpcSettings()

      Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

      Returns:
      Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

    • edition

      public final DirectoryEdition edition()

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

      If the service returns an enum value that is not available in the current SDK version, edition will return DirectoryEdition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from editionAsString().

      Returns:
      Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.
      See Also:

    • editionAsString

      public final String editionAsString()

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

      If the service returns an enum value that is not available in the current SDK version, edition will return DirectoryEdition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from editionAsString().

      Returns:
      Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.
      See Also:

    • 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 Managed Microsoft 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 Managed Microsoft AD directory.

    • toBuilder

      public CreateMicrosoftAdRequest.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<CreateMicrosoftAdRequest.Builder,CreateMicrosoftAdRequest>
      Specified by:
      toBuilder in class DirectoryRequest
      Returns:
      a builder for type T

    • builder

      public static CreateMicrosoftAdRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateMicrosoftAdRequest.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.