Amazonka.DirectoryService.Types.DirectoryDescription

Documentation

data DirectoryDescription

Contains information about an Directory Service directory.

See: newDirectoryDescription smart constructor.

Constructors

DirectoryDescription'

Fields

• accessUrl :: Maybe Text

  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 :: Maybe Text

  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 :: Maybe 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 :: Maybe Text

  The description for the directory.

• desiredNumberOfDomainControllers :: Maybe Natural

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

• directoryId :: Maybe Text

  The directory identifier.

• dnsIpAddrs :: Maybe [Text]

  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 :: Maybe DirectoryEdition

  The edition associated with this directory.

• launchTime :: Maybe POSIX

  Specifies when the directory was created.

• name :: Maybe Text

  The fully qualified name of the directory.

• osVersion :: Maybe OSVersion

  The operating system (OS) version of the directory.

• ownerDirectoryDescription :: Maybe OwnerDirectoryDescription

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

• radiusSettings :: Maybe RadiusSettings

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

• radiusStatus :: Maybe RadiusStatus

  The status of the RADIUS MFA server connection.

• regionsInfo :: Maybe RegionsInfo

  Lists the Regions where the directory has replicated.

• shareMethod :: Maybe 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 :: Maybe (Sensitive Text)

  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 :: Maybe ShareStatus

  Current directory status of the shared Managed Microsoft AD directory.

• shortName :: Maybe Text

  The short name of the directory.

• size :: Maybe DirectorySize

  The directory size.

• ssoEnabled :: Maybe Bool

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

• stage :: Maybe DirectoryStage

  The current stage of the directory.

• stageLastUpdatedDateTime :: Maybe POSIX

  The date and time that the stage was last updated.

• stageReason :: Maybe Text

  Additional information about the directory stage.

• type' :: Maybe DirectoryType

  The directory size.

• vpcSettings :: Maybe 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.

Instances

FromJSON DirectoryDescription

Defined in Amazonka.DirectoryService.Types.DirectoryDescription

Methods

parseJSON :: Value -> Parser DirectoryDescription

parseJSONList :: Value -> Parser [DirectoryDescription]

Generic DirectoryDescription

Defined in Amazonka.DirectoryService.Types.DirectoryDescription

Associated Types

type Rep DirectoryDescription :: Type -> Type

Methods

from :: DirectoryDescription -> Rep DirectoryDescription x

to :: Rep DirectoryDescription x -> DirectoryDescription

Show DirectoryDescription

Defined in Amazonka.DirectoryService.Types.DirectoryDescription

Methods

showsPrec :: Int -> DirectoryDescription -> ShowS

show :: DirectoryDescription -> String

showList :: [DirectoryDescription] -> ShowS

NFData DirectoryDescription

Defined in Amazonka.DirectoryService.Types.DirectoryDescription

Methods

rnf :: DirectoryDescription -> ()

Eq DirectoryDescription

Defined in Amazonka.DirectoryService.Types.DirectoryDescription

Methods

(==) :: DirectoryDescription -> DirectoryDescription -> Bool

(/=) :: DirectoryDescription -> DirectoryDescription -> Bool

Hashable DirectoryDescription

Defined in Amazonka.DirectoryService.Types.DirectoryDescription

Methods

hashWithSalt :: Int -> DirectoryDescription -> Int

hash :: DirectoryDescription -> Int

type Rep DirectoryDescription

Defined in Amazonka.DirectoryService.Types.DirectoryDescription

type Rep DirectoryDescription = D1 ('MetaData "DirectoryDescription" "Amazonka.DirectoryService.Types.DirectoryDescription" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DirectoryDescription'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accessUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "connectSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DirectoryConnectSettingsDescription)))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "desiredNumberOfDomainControllers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "dnsIpAddrs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "edition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DirectoryEdition)) :*: S1 ('MetaSel ('Just "launchTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "osVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OSVersion))) :*: (S1 ('MetaSel ('Just "ownerDirectoryDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OwnerDirectoryDescription)) :*: S1 ('MetaSel ('Just "radiusSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RadiusSettings)))))) :*: (((S1 ('MetaSel ('Just "radiusStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RadiusStatus)) :*: (S1 ('MetaSel ('Just "regionsInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegionsInfo)) :*: S1 ('MetaSel ('Just "shareMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShareMethod)))) :*: (S1 ('MetaSel ('Just "shareNotes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "shareStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShareStatus)) :*: S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DirectorySize)) :*: (S1 ('MetaSel ('Just "ssoEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DirectoryStage)))) :*: ((S1 ('MetaSel ('Just "stageLastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "stageReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DirectoryType)) :*: S1 ('MetaSel ('Just "vpcSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DirectoryVpcSettingsDescription))))))))

newDirectoryDescription :: DirectoryDescription

Create a value of DirectoryDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessUrl:DirectoryDescription', directoryDescription_accessUrl - 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.

$sel:alias:DirectoryDescription', directoryDescription_alias - The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.

$sel:connectSettings:DirectoryDescription', directoryDescription_connectSettings - 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.

$sel:description:DirectoryDescription', directoryDescription_description - The description for the directory.

$sel:desiredNumberOfDomainControllers:DirectoryDescription', directoryDescription_desiredNumberOfDomainControllers - The desired number of domain controllers in the directory if the directory is Microsoft AD.

DirectoryDescription, directoryDescription_directoryId - The directory identifier.

DirectoryDescription, directoryDescription_dnsIpAddrs - 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.

$sel:edition:DirectoryDescription', directoryDescription_edition - The edition associated with this directory.

$sel:launchTime:DirectoryDescription', directoryDescription_launchTime - Specifies when the directory was created.

$sel:name:DirectoryDescription', directoryDescription_name - The fully qualified name of the directory.

$sel:osVersion:DirectoryDescription', directoryDescription_osVersion - The operating system (OS) version of the directory.

$sel:ownerDirectoryDescription:DirectoryDescription', directoryDescription_ownerDirectoryDescription - Describes the Managed Microsoft AD directory in the directory owner account.

DirectoryDescription, directoryDescription_radiusSettings - A RadiusSettings object that contains information about the RADIUS server configured for this directory.

DirectoryDescription, directoryDescription_radiusStatus - The status of the RADIUS MFA server connection.

$sel:regionsInfo:DirectoryDescription', directoryDescription_regionsInfo - Lists the Regions where the directory has replicated.

$sel:shareMethod:DirectoryDescription', directoryDescription_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).

$sel:shareNotes:DirectoryDescription', directoryDescription_shareNotes - 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.

$sel:shareStatus:DirectoryDescription', directoryDescription_shareStatus - Current directory status of the shared Managed Microsoft AD directory.

$sel:shortName:DirectoryDescription', directoryDescription_shortName - The short name of the directory.

$sel:size:DirectoryDescription', directoryDescription_size - The directory size.

$sel:ssoEnabled:DirectoryDescription', directoryDescription_ssoEnabled - Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.

$sel:stage:DirectoryDescription', directoryDescription_stage - The current stage of the directory.

$sel:stageLastUpdatedDateTime:DirectoryDescription', directoryDescription_stageLastUpdatedDateTime - The date and time that the stage was last updated.

$sel:stageReason:DirectoryDescription', directoryDescription_stageReason - Additional information about the directory stage.

$sel:type':DirectoryDescription', directoryDescription_type - The directory size.

DirectoryDescription, directoryDescription_vpcSettings - 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.

directoryDescription_accessUrl :: Lens' DirectoryDescription (Maybe Text)

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.

directoryDescription_alias :: Lens' DirectoryDescription (Maybe Text)

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

directoryDescription_connectSettings :: Lens' DirectoryDescription (Maybe 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.

directoryDescription_description :: Lens' DirectoryDescription (Maybe Text)

The description for the directory.

directoryDescription_desiredNumberOfDomainControllers :: Lens' DirectoryDescription (Maybe Natural)

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

directoryDescription_directoryId :: Lens' DirectoryDescription (Maybe Text)

The directory identifier.

directoryDescription_dnsIpAddrs :: Lens' DirectoryDescription (Maybe [Text])

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.

directoryDescription_edition :: Lens' DirectoryDescription (Maybe DirectoryEdition)

The edition associated with this directory.

directoryDescription_launchTime :: Lens' DirectoryDescription (Maybe UTCTime)

Specifies when the directory was created.

directoryDescription_name :: Lens' DirectoryDescription (Maybe Text)

The fully qualified name of the directory.

directoryDescription_osVersion :: Lens' DirectoryDescription (Maybe OSVersion)

The operating system (OS) version of the directory.

directoryDescription_ownerDirectoryDescription :: Lens' DirectoryDescription (Maybe OwnerDirectoryDescription)

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

directoryDescription_radiusSettings :: Lens' DirectoryDescription (Maybe RadiusSettings)

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

directoryDescription_radiusStatus :: Lens' DirectoryDescription (Maybe RadiusStatus)

The status of the RADIUS MFA server connection.

directoryDescription_regionsInfo :: Lens' DirectoryDescription (Maybe RegionsInfo)

Lists the Regions where the directory has replicated.

directoryDescription_shareMethod :: Lens' DirectoryDescription (Maybe 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).

directoryDescription_shareNotes :: Lens' DirectoryDescription (Maybe Text)

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.

directoryDescription_shareStatus :: Lens' DirectoryDescription (Maybe ShareStatus)

Current directory status of the shared Managed Microsoft AD directory.

directoryDescription_shortName :: Lens' DirectoryDescription (Maybe Text)

The short name of the directory.

directoryDescription_size :: Lens' DirectoryDescription (Maybe DirectorySize)

The directory size.

directoryDescription_ssoEnabled :: Lens' DirectoryDescription (Maybe Bool)

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

directoryDescription_stage :: Lens' DirectoryDescription (Maybe DirectoryStage)

The current stage of the directory.

directoryDescription_stageLastUpdatedDateTime :: Lens' DirectoryDescription (Maybe UTCTime)

The date and time that the stage was last updated.

directoryDescription_stageReason :: Lens' DirectoryDescription (Maybe Text)

Additional information about the directory stage.

directoryDescription_type :: Lens' DirectoryDescription (Maybe DirectoryType)

The directory size.

directoryDescription_vpcSettings :: Lens' DirectoryDescription (Maybe 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.