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(value="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 and Description
static interface	CreateDirectoryRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDirectoryRequest.Builder	builder()
String	description() A textual description for the directory.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The fully qualified name for the directory, such as corp.example.com.
String	password() The password for the directory administrator.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDirectoryRequest.Builder>	serializableBuilderClass()
String	shortName() The short name of the directory, such as CORP.
DirectorySize	size() The size of the directory.
String	sizeAsString() The size of the directory.
List<Tag>	tags() The tags to be assigned to the Simple AD directory.
CreateDirectoryRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
DirectoryVpcSettings	vpcSettings() 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 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 String shortName()

The short name of the directory, such as CORP.

Returns:

The short name of the directory, such as CORP.

password

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

Returns:

The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.

description

public String description()

A textual description for the directory.

Returns:

A textual description for the directory.

size

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

DirectorySize

sizeAsString

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

DirectorySize

vpcSettings

public DirectoryVpcSettings vpcSettings()

A DirectoryVpcSettings object that contains additional information for the operation.

Returns:

A DirectoryVpcSettings object that contains additional information for the operation.

tags

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

Returns:

The tags to be assigned to the Simple AD directory.

toBuilder

public CreateDirectoryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDirectoryRequest.Builder,CreateDirectoryRequest>

Specified by:

toBuilder in class DirectoryRequest

builder

public static CreateDirectoryRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo