Class CreateMicrosoftAdRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateMicrosoftAdRequest.Builder,
CreateMicrosoftAdRequest>
Creates an Managed Microsoft AD directory.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A description for the directory.final DirectoryEdition
edition()
Managed Microsoft AD is available in two editions:Standard
andEnterprise
.final String
Managed Microsoft AD is available in two editions:Standard
andEnterprise
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
The fully qualified domain name for the Managed Microsoft AD directory, such ascorp.example.com
.final String
password()
The password for the default administrative user namedAdmin
.static Class
<? extends CreateMicrosoftAdRequest.Builder> final String
The NetBIOS name for your domain, such asCORP
.tags()
The tags to be assigned to the Managed Microsoft AD directory.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final DirectoryVpcSettings
Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 DNScorp.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 DNScorp.example.com
.
-
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
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
Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
- Returns:
- Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
-
edition
Managed Microsoft AD is available in two editions:
Standard
andEnterprise
.Enterprise
is the default.If the service returns an enum value that is not available in the current SDK version,
edition
will returnDirectoryEdition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeditionAsString()
.- Returns:
- Managed Microsoft AD is available in two editions:
Standard
andEnterprise
.Enterprise
is the default. - See Also:
-
editionAsString
Managed Microsoft AD is available in two editions:
Standard
andEnterprise
.Enterprise
is the default.If the service returns an enum value that is not available in the current SDK version,
edition
will returnDirectoryEdition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeditionAsString()
.- Returns:
- Managed Microsoft AD is available in two editions:
Standard
andEnterprise
.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 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
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
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 interfaceToCopyableBuilder<CreateMicrosoftAdRequest.Builder,
CreateMicrosoftAdRequest> - Specified by:
toBuilder
in classDirectoryRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-