/AWS1/CL_DSRDIRECTORYDESC¶
Contains information about an Directory Service directory.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_directoryid TYPE /AWS1/DSRDIRECTORYID /AWS1/DSRDIRECTORYID¶
The directory identifier.
iv_name TYPE /AWS1/DSRDIRECTORYNAME /AWS1/DSRDIRECTORYNAME¶
The fully qualified name of the directory.
iv_shortname TYPE /AWS1/DSRDIRECTORYSHORTNAME /AWS1/DSRDIRECTORYSHORTNAME¶
The short name of the directory.
iv_size TYPE /AWS1/DSRDIRECTORYSIZE /AWS1/DSRDIRECTORYSIZE¶
The directory size.
iv_edition TYPE /AWS1/DSRDIRECTORYEDITION /AWS1/DSRDIRECTORYEDITION¶
The edition associated with this directory.
iv_alias TYPE /AWS1/DSRALIASNAME /AWS1/DSRALIASNAME¶
The alias for the directory. If no alias exists, the alias is the directory identifier, such as
d-XXXXXXXXXX.
iv_accessurl TYPE /AWS1/DSRACCESSURL /AWS1/DSRACCESSURL¶
The access URL for the directory, such as
http://. If no alias exists,.awsapps.com is the directory identifier, such asd-XXXXXXXXXX.
iv_description TYPE /AWS1/DSRDESCRIPTION /AWS1/DSRDESCRIPTION¶
The description for the directory.
it_dnsipaddrs TYPE /AWS1/CL_DSRDNSIPADDRS_W=>TT_DNSIPADDRS TT_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 self-managed directory to which the AD Connector is connected.
it_dnsipv6addrs TYPE /AWS1/CL_DSRDNSIPV6ADDRS_W=>TT_DNSIPV6ADDRS TT_DNSIPV6ADDRS¶
The IPv6 addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IPv6 addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IPv6 addresses of the DNS servers or domain controllers in your self-managed directory to which the AD Connector is connected.
iv_stage TYPE /AWS1/DSRDIRECTORYSTAGE /AWS1/DSRDIRECTORYSTAGE¶
The current stage of the directory.
iv_sharestatus TYPE /AWS1/DSRSHARESTATUS /AWS1/DSRSHARESTATUS¶
Current directory status of the shared Managed Microsoft AD directory.
iv_sharemethod TYPE /AWS1/DSRSHAREMETHOD /AWS1/DSRSHAREMETHOD¶
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).
iv_sharenotes TYPE /AWS1/DSRNOTES /AWS1/DSRNOTES¶
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.
iv_launchtime TYPE /AWS1/DSRLAUNCHTIME /AWS1/DSRLAUNCHTIME¶
The date and time when the directory was created.
iv_stagelastupdateddatetime TYPE /AWS1/DSRLASTUPDATEDDATETIME /AWS1/DSRLASTUPDATEDDATETIME¶
The date and time when the stage was last updated.
iv_type TYPE /AWS1/DSRDIRECTORYTYPE /AWS1/DSRDIRECTORYTYPE¶
The directory type.
io_vpcsettings TYPE REF TO /AWS1/CL_DSRDIRECTORYVPCSTGS00 /AWS1/CL_DSRDIRECTORYVPCSTGS00¶
A DirectoryVpcSettingsDescription object that contains additional information about a directory. Present only for Simple AD and Managed Microsoft AD directories.
io_connectsettings TYPE REF TO /AWS1/CL_DSRDIRECTORYCNCTSTG00 /AWS1/CL_DSRDIRECTORYCNCTSTG00¶
DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. Present only for AD Connector directories.
io_radiussettings TYPE REF TO /AWS1/CL_DSRRADIUSSETTINGS /AWS1/CL_DSRRADIUSSETTINGS¶
Information about the RadiusSettings object configured for this directory.
iv_radiusstatus TYPE /AWS1/DSRRADIUSSTATUS /AWS1/DSRRADIUSSTATUS¶
The status of the RADIUS MFA server connection.
iv_stagereason TYPE /AWS1/DSRSTAGEREASON /AWS1/DSRSTAGEREASON¶
Additional information about the directory stage.
iv_ssoenabled TYPE /AWS1/DSRSSOENABLED /AWS1/DSRSSOENABLED¶
Indicates whether single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.
iv_desirednumberofdomctllers TYPE /AWS1/DSRDESIREDNOOFDOMCTLLERS /AWS1/DSRDESIREDNOOFDOMCTLLERS¶
The desired number of domain controllers in the directory if the directory is Microsoft AD.
io_ownerdirectorydescription TYPE REF TO /AWS1/CL_DSROWNERDIRECTORYDESC /AWS1/CL_DSROWNERDIRECTORYDESC¶
Describes the Managed Microsoft AD directory in the directory owner account.
io_regionsinfo TYPE REF TO /AWS1/CL_DSRREGIONSINFO /AWS1/CL_DSRREGIONSINFO¶
Lists the Regions where the directory has replicated.
iv_osversion TYPE /AWS1/DSROSVERSION /AWS1/DSROSVERSION¶
The operating system (OS) version of the directory.
io_hybridsettings TYPE REF TO /AWS1/CL_DSRHYBRIDSETTINGSDESC /AWS1/CL_DSRHYBRIDSETTINGSDESC¶
Contains information about the hybrid directory configuration for the directory, including Amazon Web Services System Manager managed node identifiers and DNS IPs.
iv_networktype TYPE /AWS1/DSRNETWORKTYPE /AWS1/DSRNETWORKTYPE¶
The network type of the directory.
Queryable Attributes¶
DirectoryId¶
The directory identifier.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DIRECTORYID() |
Getter for DIRECTORYID, with configurable default |
ASK_DIRECTORYID() |
Getter for DIRECTORYID w/ exceptions if field has no value |
HAS_DIRECTORYID() |
Determine if DIRECTORYID has a value |
Name¶
The fully qualified name of the directory.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
ShortName¶
The short name of the directory.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHORTNAME() |
Getter for SHORTNAME, with configurable default |
ASK_SHORTNAME() |
Getter for SHORTNAME w/ exceptions if field has no value |
HAS_SHORTNAME() |
Determine if SHORTNAME has a value |
Size¶
The directory size.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SIZE() |
Getter for SIZE, with configurable default |
ASK_SIZE() |
Getter for SIZE w/ exceptions if field has no value |
HAS_SIZE() |
Determine if SIZE has a value |
Edition¶
The edition associated with this directory.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EDITION() |
Getter for EDITION, with configurable default |
ASK_EDITION() |
Getter for EDITION w/ exceptions if field has no value |
HAS_EDITION() |
Determine if EDITION has a value |
Alias¶
The alias for the directory. If no alias exists, the alias is the directory identifier, such as
d-XXXXXXXXXX.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ALIAS() |
Getter for ALIAS, with configurable default |
ASK_ALIAS() |
Getter for ALIAS w/ exceptions if field has no value |
HAS_ALIAS() |
Determine if ALIAS has a value |
AccessUrl¶
The access URL for the directory, such as
http://. If no alias exists,.awsapps.com is the directory identifier, such asd-XXXXXXXXXX.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCESSURL() |
Getter for ACCESSURL, with configurable default |
ASK_ACCESSURL() |
Getter for ACCESSURL w/ exceptions if field has no value |
HAS_ACCESSURL() |
Determine if ACCESSURL has a value |
Description¶
The description for the directory.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
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 self-managed directory to which the AD Connector is connected.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DNSIPADDRS() |
Getter for DNSIPADDRS, with configurable default |
ASK_DNSIPADDRS() |
Getter for DNSIPADDRS w/ exceptions if field has no value |
HAS_DNSIPADDRS() |
Determine if DNSIPADDRS has a value |
DnsIpv6Addrs¶
The IPv6 addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IPv6 addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IPv6 addresses of the DNS servers or domain controllers in your self-managed directory to which the AD Connector is connected.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DNSIPV6ADDRS() |
Getter for DNSIPV6ADDRS, with configurable default |
ASK_DNSIPV6ADDRS() |
Getter for DNSIPV6ADDRS w/ exceptions if field has no value |
HAS_DNSIPV6ADDRS() |
Determine if DNSIPV6ADDRS has a value |
Stage¶
The current stage of the directory.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STAGE() |
Getter for STAGE, with configurable default |
ASK_STAGE() |
Getter for STAGE w/ exceptions if field has no value |
HAS_STAGE() |
Determine if STAGE has a value |
ShareStatus¶
Current directory status of the shared Managed Microsoft AD directory.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHARESTATUS() |
Getter for SHARESTATUS, with configurable default |
ASK_SHARESTATUS() |
Getter for SHARESTATUS w/ exceptions if field has no value |
HAS_SHARESTATUS() |
Determine if SHARESTATUS has a value |
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).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHAREMETHOD() |
Getter for SHAREMETHOD, with configurable default |
ASK_SHAREMETHOD() |
Getter for SHAREMETHOD w/ exceptions if field has no value |
HAS_SHAREMETHOD() |
Determine if SHAREMETHOD has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHARENOTES() |
Getter for SHARENOTES, with configurable default |
ASK_SHARENOTES() |
Getter for SHARENOTES w/ exceptions if field has no value |
HAS_SHARENOTES() |
Determine if SHARENOTES has a value |
LaunchTime¶
The date and time when the directory was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LAUNCHTIME() |
Getter for LAUNCHTIME, with configurable default |
ASK_LAUNCHTIME() |
Getter for LAUNCHTIME w/ exceptions if field has no value |
HAS_LAUNCHTIME() |
Determine if LAUNCHTIME has a value |
StageLastUpdatedDateTime¶
The date and time when the stage was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STAGELASTUPDATEDDATETIME() |
Getter for STAGELASTUPDATEDDATETIME, with configurable defau |
ASK_STAGELASTUPDATEDDATETIME() |
Getter for STAGELASTUPDATEDDATETIME w/ exceptions if field h |
HAS_STAGELASTUPDATEDDATETIME() |
Determine if STAGELASTUPDATEDDATETIME has a value |
Type¶
The directory type.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
VpcSettings¶
A DirectoryVpcSettingsDescription object that contains additional information about a directory. Present only for Simple AD and Managed Microsoft AD directories.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCSETTINGS() |
Getter for VPCSETTINGS |
ConnectSettings¶
DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. Present only for AD Connector directories.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONNECTSETTINGS() |
Getter for CONNECTSETTINGS |
RadiusSettings¶
Information about the RadiusSettings object configured for this directory.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RADIUSSETTINGS() |
Getter for RADIUSSETTINGS |
RadiusStatus¶
The status of the RADIUS MFA server connection.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RADIUSSTATUS() |
Getter for RADIUSSTATUS, with configurable default |
ASK_RADIUSSTATUS() |
Getter for RADIUSSTATUS w/ exceptions if field has no value |
HAS_RADIUSSTATUS() |
Determine if RADIUSSTATUS has a value |
StageReason¶
Additional information about the directory stage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STAGEREASON() |
Getter for STAGEREASON, with configurable default |
ASK_STAGEREASON() |
Getter for STAGEREASON w/ exceptions if field has no value |
HAS_STAGEREASON() |
Determine if STAGEREASON has a value |
SsoEnabled¶
Indicates whether single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SSOENABLED() |
Getter for SSOENABLED |
DesiredNumberOfDomainControllers¶
The desired number of domain controllers in the directory if the directory is Microsoft AD.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESIREDNUMOFDOMCTLLERS() |
Getter for DESIREDNUMBEROFDOMAINCTLLERS, with configurable d |
ASK_DESIREDNUMOFDOMCTLLERS() |
Getter for DESIREDNUMBEROFDOMAINCTLLERS w/ exceptions if fie |
HAS_DESIREDNUMOFDOMCTLLERS() |
Determine if DESIREDNUMBEROFDOMAINCTLLERS has a value |
OwnerDirectoryDescription¶
Describes the Managed Microsoft AD directory in the directory owner account.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OWNERDIRECTORYDESC() |
Getter for OWNERDIRECTORYDESCRIPTION |
RegionsInfo¶
Lists the Regions where the directory has replicated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REGIONSINFO() |
Getter for REGIONSINFO |
OsVersion¶
The operating system (OS) version of the directory.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OSVERSION() |
Getter for OSVERSION, with configurable default |
ASK_OSVERSION() |
Getter for OSVERSION w/ exceptions if field has no value |
HAS_OSVERSION() |
Determine if OSVERSION has a value |
HybridSettings¶
Contains information about the hybrid directory configuration for the directory, including Amazon Web Services System Manager managed node identifiers and DNS IPs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HYBRIDSETTINGS() |
Getter for HYBRIDSETTINGS |
NetworkType¶
The network type of the directory.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NETWORKTYPE() |
Getter for NETWORKTYPE, with configurable default |
ASK_NETWORKTYPE() |
Getter for NETWORKTYPE w/ exceptions if field has no value |
HAS_NETWORKTYPE() |
Determine if NETWORKTYPE has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_DIRECTORYDESCRIPTIONS¶
TYPES TT_DIRECTORYDESCRIPTIONS TYPE STANDARD TABLE OF REF TO /AWS1/CL_DSRDIRECTORYDESC WITH DEFAULT KEY
.