AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DirectoryDescription

import "github.com/aws/aws-sdk-go/service/directoryservice"

type DirectoryDescription struct { AccessUrl *string `min:"1" type:"string"` Alias *string `min:"1" type:"string"` ConnectSettings *DirectoryConnectSettingsDescription `type:"structure"` Description *string `type:"string"` DesiredNumberOfDomainControllers *int64 `min:"2" type:"integer"` DirectoryId *string `type:"string"` DnsIpAddrs []*string `type:"list"` Edition *string `type:"string" enum:"DirectoryEdition"` LaunchTime *time.Time `type:"timestamp"` Name *string `type:"string"` OwnerDirectoryDescription *OwnerDirectoryDescription `type:"structure"` RadiusSettings *RadiusSettings `type:"structure"` RadiusStatus *string `type:"string" enum:"RadiusStatus"` ShareMethod *string `type:"string" enum:"ShareMethod"` ShareNotes *string `type:"string" sensitive:"true"` ShareStatus *string `type:"string" enum:"ShareStatus"` ShortName *string `type:"string"` Size *string `type:"string" enum:"DirectorySize"` SsoEnabled *bool `type:"boolean"` Stage *string `type:"string" enum:"DirectoryStage"` StageLastUpdatedDateTime *time.Time `type:"timestamp"` StageReason *string `type:"string"` Type *string `type:"string" enum:"DirectoryType"` VpcSettings *DirectoryVpcSettingsDescription `type:"structure"` }

Contains information about an AWS Directory Service directory.

AccessUrl

Type: *string

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

Type: *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

Contains information about an AD Connector directory.

Description

Type: *string

The textual description for the directory.

DesiredNumberOfDomainControllers

Type: *int64

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

DirectoryId

Type: *string

The directory identifier.

DnsIpAddrs

Type: []*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 the on-premises directory to which the AD Connector is connected.

Edition

Type: *string

The edition associated with this directory.

LaunchTime

Type: *time.Time

Specifies when the directory was created.

Name

Type: *string

The fully qualified name of the directory.

OwnerDirectoryDescription

Describes the directory owner account details that have been shared to the directory consumer account.

RadiusSettings

Contains information about a Remote Authentication Dial In User Service (RADIUS) server.

RadiusStatus

Type: *string

The status of the RADIUS MFA server connection.

ShareMethod

Type: *string

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

ShareNotes

Type: *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

Type: *string

Current directory status of the shared AWS Managed Microsoft AD directory.

ShortName

Type: *string

The short name of the directory.

Size

Type: *string

The directory size.

SsoEnabled

Type: *bool

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

Stage

Type: *string

The current stage of the directory.

StageLastUpdatedDateTime

Type: *time.Time

The date and time that the stage was last updated.

StageReason

Type: *string

Additional information about the directory stage.

Type

Type: *string

The directory size.

VpcSettings

Contains information about the directory.

Method

GoString

func (s DirectoryDescription) GoString() string

GoString returns the string representation

SetAccessUrl

func (s *DirectoryDescription) SetAccessUrl(v string) *DirectoryDescription

SetAccessUrl sets the AccessUrl field's value.

SetAlias

func (s *DirectoryDescription) SetAlias(v string) *DirectoryDescription

SetAlias sets the Alias field's value.

SetConnectSettings

func (s *DirectoryDescription) SetConnectSettings(v *DirectoryConnectSettingsDescription) *DirectoryDescription

SetConnectSettings sets the ConnectSettings field's value.

SetDescription

func (s *DirectoryDescription) SetDescription(v string) *DirectoryDescription

SetDescription sets the Description field's value.

SetDesiredNumberOfDomainControllers

func (s *DirectoryDescription) SetDesiredNumberOfDomainControllers(v int64) *DirectoryDescription

SetDesiredNumberOfDomainControllers sets the DesiredNumberOfDomainControllers field's value.

SetDirectoryId

func (s *DirectoryDescription) SetDirectoryId(v string) *DirectoryDescription

SetDirectoryId sets the DirectoryId field's value.

SetDnsIpAddrs

func (s *DirectoryDescription) SetDnsIpAddrs(v []*string) *DirectoryDescription

SetDnsIpAddrs sets the DnsIpAddrs field's value.

SetEdition

func (s *DirectoryDescription) SetEdition(v string) *DirectoryDescription

SetEdition sets the Edition field's value.

SetLaunchTime

func (s *DirectoryDescription) SetLaunchTime(v time.Time) *DirectoryDescription

SetLaunchTime sets the LaunchTime field's value.

SetName

func (s *DirectoryDescription) SetName(v string) *DirectoryDescription

SetName sets the Name field's value.

SetOwnerDirectoryDescription

func (s *DirectoryDescription) SetOwnerDirectoryDescription(v *OwnerDirectoryDescription) *DirectoryDescription

SetOwnerDirectoryDescription sets the OwnerDirectoryDescription field's value.

SetRadiusSettings

func (s *DirectoryDescription) SetRadiusSettings(v *RadiusSettings) *DirectoryDescription

SetRadiusSettings sets the RadiusSettings field's value.

SetRadiusStatus

func (s *DirectoryDescription) SetRadiusStatus(v string) *DirectoryDescription

SetRadiusStatus sets the RadiusStatus field's value.

SetShareMethod

func (s *DirectoryDescription) SetShareMethod(v string) *DirectoryDescription

SetShareMethod sets the ShareMethod field's value.

SetShareNotes

func (s *DirectoryDescription) SetShareNotes(v string) *DirectoryDescription

SetShareNotes sets the ShareNotes field's value.

SetShareStatus

func (s *DirectoryDescription) SetShareStatus(v string) *DirectoryDescription

SetShareStatus sets the ShareStatus field's value.

SetShortName

func (s *DirectoryDescription) SetShortName(v string) *DirectoryDescription

SetShortName sets the ShortName field's value.

SetSize

func (s *DirectoryDescription) SetSize(v string) *DirectoryDescription

SetSize sets the Size field's value.

SetSsoEnabled

func (s *DirectoryDescription) SetSsoEnabled(v bool) *DirectoryDescription

SetSsoEnabled sets the SsoEnabled field's value.

SetStage

func (s *DirectoryDescription) SetStage(v string) *DirectoryDescription

SetStage sets the Stage field's value.

SetStageLastUpdatedDateTime

func (s *DirectoryDescription) SetStageLastUpdatedDateTime(v time.Time) *DirectoryDescription

SetStageLastUpdatedDateTime sets the StageLastUpdatedDateTime field's value.

SetStageReason

func (s *DirectoryDescription) SetStageReason(v string) *DirectoryDescription

SetStageReason sets the StageReason field's value.

SetType

func (s *DirectoryDescription) SetType(v string) *DirectoryDescription

SetType sets the Type field's value.

SetVpcSettings

func (s *DirectoryDescription) SetVpcSettings(v *DirectoryVpcSettingsDescription) *DirectoryDescription

SetVpcSettings sets the VpcSettings field's value.

String

func (s DirectoryDescription) String() string

String returns the string representation

On this page: