directoryservice/aws.sdk.kotlin.services.directoryservice.model/DirectoryDescription/Builder

Builder

Properties

The access URL for the directory, such as http://<alias>.awsapps.com. If no alias has been created for the directory, <alias> is the directory identifier, such as d-XXXXXXXXXX.

alias

var alias: String?

The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.

connectSettings

var connectSettings: DirectoryConnectSettingsDescription?

A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.

description

var description: String?

The description for the directory.

desiredNumberOfDomainControllers

var desiredNumberOfDomainControllers: Int?

The desired number of domain controllers in the directory if the directory is Microsoft AD.

directoryId

var directoryId: String?

The directory identifier.

dnsIpAddrs

var dnsIpAddrs: List<String>?

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in your self-managed directory to which the AD Connector is connected.

edition

var edition: DirectoryEdition?

The edition associated with this directory.

launchTime

var launchTime: Instant?

Specifies when the directory was created.

name

var name: String?

The fully qualified name of the directory.

osVersion

var osVersion: OsVersion?

The operating system (OS) version of the directory.

ownerDirectoryDescription

var ownerDirectoryDescription: OwnerDirectoryDescription?

Describes the Managed Microsoft AD directory in the directory owner account.

radiusSettings

var radiusSettings: RadiusSettings?

A RadiusSettings object that contains information about the RADIUS server configured for this directory.

radiusStatus

var radiusStatus: RadiusStatus?

The status of the RADIUS MFA server connection.

regionsInfo

var regionsInfo: RegionsInfo?

Lists the Regions where the directory has replicated.

shareMethod

var shareMethod: ShareMethod?

The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request (HANDSHAKE).

shareNotes

var shareNotes: String?

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

shareStatus

var shareStatus: ShareStatus?

Current directory status of the shared Managed Microsoft AD directory.

shortName

var shortName: String?

The short name of the directory.

size

var size: DirectorySize?

The directory size.

ssoEnabled

var ssoEnabled: Boolean

Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.

stage

var stage: DirectoryStage?

The current stage of the directory.

stageLastUpdatedDateTime

var stageLastUpdatedDateTime: Instant?

The date and time that the stage was last updated.

stageReason

var stageReason: String?

Additional information about the directory stage.

type

var type: DirectoryType?

The directory size.

vpcSettings

var vpcSettings: DirectoryVpcSettingsDescription?

A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed Microsoft AD directory.

Functions

connectSettings

fun connectSettings(block: DirectoryConnectSettingsDescription.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.directoryservice.model.DirectoryConnectSettingsDescription inside the given block

ownerDirectoryDescription

fun ownerDirectoryDescription(block: OwnerDirectoryDescription.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.directoryservice.model.OwnerDirectoryDescription inside the given block

radiusSettings

fun radiusSettings(block: RadiusSettings.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.directoryservice.model.RadiusSettings inside the given block

regionsInfo

fun regionsInfo(block: RegionsInfo.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.directoryservice.model.RegionsInfo inside the given block

vpcSettings

fun vpcSettings(block: DirectoryVpcSettingsDescription.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.directoryservice.model.DirectoryVpcSettingsDescription inside the given block