Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <[email protected]> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.AWS.DirectoryService
Contents
- Service Configuration
- Errors
- DirectoryUnavailableException
- AuthenticationFailedException
- InvalidParameterException
- UnsupportedOperationException
- EntityAlreadyExistsException
- DirectoryLimitExceededException
- EntityDoesNotExistException
- InsufficientPermissionsException
- InvalidNextTokenException
- ServiceException
- SnapshotLimitExceededException
- ClientException
- Waiters
- Operations
- DescribeConditionalForwarders
- GetSnapshotLimits
- RegisterEventTopic
- ConnectDirectory
- CreateAlias
- DescribeDirectories
- DescribeTrusts
- DeleteTrust
- CreateMicrosoftAD
- DeregisterEventTopic
- CreateDirectory
- DescribeEventTopics
- UpdateConditionalForwarder
- DeleteConditionalForwarder
- EnableSSO
- EnableRadius
- DisableRadius
- RestoreFromSnapshot
- DescribeSnapshots
- DeleteSnapshot
- CreateTrust
- DeleteDirectory
- CreateSnapshot
- CreateComputer
- DisableSSO
- VerifyTrust
- CreateConditionalForwarder
- GetDirectoryLimits
- UpdateRadius
- Types
- DirectorySize
- DirectoryStage
- DirectoryType
- RadiusAuthenticationProtocol
- RadiusStatus
- ReplicationScope
- SnapshotStatus
- SnapshotType
- TopicStatus
- TrustDirection
- TrustState
- TrustType
- Attribute
- Computer
- ConditionalForwarder
- DirectoryConnectSettings
- DirectoryConnectSettingsDescription
- DirectoryDescription
- DirectoryLimits
- DirectoryVPCSettings
- DirectoryVPCSettingsDescription
- EventTopic
- RadiusSettings
- Snapshot
- SnapshotLimits
- Trust
Description
AWS Directory Service
This is the AWS Directory Service API Reference. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors.
- directoryService :: Service
- _DirectoryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _AuthenticationFailedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _EntityAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _DirectoryLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _EntityDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientPermissionsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _SnapshotLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClientException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.DirectoryService.DescribeConditionalForwarders
- module Network.AWS.DirectoryService.GetSnapshotLimits
- module Network.AWS.DirectoryService.RegisterEventTopic
- module Network.AWS.DirectoryService.ConnectDirectory
- module Network.AWS.DirectoryService.CreateAlias
- module Network.AWS.DirectoryService.DescribeDirectories
- module Network.AWS.DirectoryService.DescribeTrusts
- module Network.AWS.DirectoryService.DeleteTrust
- module Network.AWS.DirectoryService.CreateMicrosoftAD
- module Network.AWS.DirectoryService.DeregisterEventTopic
- module Network.AWS.DirectoryService.CreateDirectory
- module Network.AWS.DirectoryService.DescribeEventTopics
- module Network.AWS.DirectoryService.UpdateConditionalForwarder
- module Network.AWS.DirectoryService.DeleteConditionalForwarder
- module Network.AWS.DirectoryService.EnableSSO
- module Network.AWS.DirectoryService.EnableRadius
- module Network.AWS.DirectoryService.DisableRadius
- module Network.AWS.DirectoryService.RestoreFromSnapshot
- module Network.AWS.DirectoryService.DescribeSnapshots
- module Network.AWS.DirectoryService.DeleteSnapshot
- module Network.AWS.DirectoryService.CreateTrust
- module Network.AWS.DirectoryService.DeleteDirectory
- module Network.AWS.DirectoryService.CreateSnapshot
- module Network.AWS.DirectoryService.CreateComputer
- module Network.AWS.DirectoryService.DisableSSO
- module Network.AWS.DirectoryService.VerifyTrust
- module Network.AWS.DirectoryService.CreateConditionalForwarder
- module Network.AWS.DirectoryService.GetDirectoryLimits
- module Network.AWS.DirectoryService.UpdateRadius
- data DirectorySize
- data DirectoryStage
- data DirectoryType
- data RadiusAuthenticationProtocol
- data RadiusStatus
- data ReplicationScope = Domain
- data SnapshotStatus
- data SnapshotType
- data TopicStatus
- data TrustDirection
- data TrustState
- data TrustType = Forest
- data Attribute
- attribute :: Attribute
- aValue :: Lens' Attribute (Maybe Text)
- aName :: Lens' Attribute (Maybe Text)
- data Computer
- computer :: Computer
- cComputerId :: Lens' Computer (Maybe Text)
- cComputerAttributes :: Lens' Computer [Attribute]
- cComputerName :: Lens' Computer (Maybe Text)
- data ConditionalForwarder
- conditionalForwarder :: ConditionalForwarder
- cfDNSIPAddrs :: Lens' ConditionalForwarder [Text]
- cfRemoteDomainName :: Lens' ConditionalForwarder (Maybe Text)
- cfReplicationScope :: Lens' ConditionalForwarder (Maybe ReplicationScope)
- data DirectoryConnectSettings
- directoryConnectSettings :: Text -> Text -> DirectoryConnectSettings
- dcsVPCId :: Lens' DirectoryConnectSettings Text
- dcsSubnetIds :: Lens' DirectoryConnectSettings [Text]
- dcsCustomerDNSIPs :: Lens' DirectoryConnectSettings [Text]
- dcsCustomerUserName :: Lens' DirectoryConnectSettings Text
- data DirectoryConnectSettingsDescription
- directoryConnectSettingsDescription :: DirectoryConnectSettingsDescription
- dcsdCustomerUserName :: Lens' DirectoryConnectSettingsDescription (Maybe Text)
- dcsdSubnetIds :: Lens' DirectoryConnectSettingsDescription [Text]
- dcsdVPCId :: Lens' DirectoryConnectSettingsDescription (Maybe Text)
- dcsdSecurityGroupId :: Lens' DirectoryConnectSettingsDescription (Maybe Text)
- dcsdConnectIPs :: Lens' DirectoryConnectSettingsDescription [Text]
- dcsdAvailabilityZones :: Lens' DirectoryConnectSettingsDescription [Text]
- data DirectoryDescription
- directoryDescription :: DirectoryDescription
- ddRadiusStatus :: Lens' DirectoryDescription (Maybe RadiusStatus)
- ddStage :: Lens' DirectoryDescription (Maybe DirectoryStage)
- ddDirectoryId :: Lens' DirectoryDescription (Maybe Text)
- ddAccessURL :: Lens' DirectoryDescription (Maybe Text)
- ddShortName :: Lens' DirectoryDescription (Maybe Text)
- ddSize :: Lens' DirectoryDescription (Maybe DirectorySize)
- ddRadiusSettings :: Lens' DirectoryDescription (Maybe RadiusSettings)
- ddLaunchTime :: Lens' DirectoryDescription (Maybe UTCTime)
- ddAlias :: Lens' DirectoryDescription (Maybe Text)
- ddName :: Lens' DirectoryDescription (Maybe Text)
- ddStageLastUpdatedDateTime :: Lens' DirectoryDescription (Maybe UTCTime)
- ddSSOEnabled :: Lens' DirectoryDescription (Maybe Bool)
- ddDNSIPAddrs :: Lens' DirectoryDescription [Text]
- ddVPCSettings :: Lens' DirectoryDescription (Maybe DirectoryVPCSettingsDescription)
- ddType :: Lens' DirectoryDescription (Maybe DirectoryType)
- ddStageReason :: Lens' DirectoryDescription (Maybe Text)
- ddConnectSettings :: Lens' DirectoryDescription (Maybe DirectoryConnectSettingsDescription)
- ddDescription :: Lens' DirectoryDescription (Maybe Text)
- data DirectoryLimits
- directoryLimits :: DirectoryLimits
- dlConnectedDirectoriesCurrentCount :: Lens' DirectoryLimits (Maybe Natural)
- dlCloudOnlyMicrosoftADLimitReached :: Lens' DirectoryLimits (Maybe Bool)
- dlConnectedDirectoriesLimit :: Lens' DirectoryLimits (Maybe Natural)
- dlConnectedDirectoriesLimitReached :: Lens' DirectoryLimits (Maybe Bool)
- dlCloudOnlyMicrosoftADLimit :: Lens' DirectoryLimits (Maybe Natural)
- dlCloudOnlyDirectoriesLimit :: Lens' DirectoryLimits (Maybe Natural)
- dlCloudOnlyDirectoriesCurrentCount :: Lens' DirectoryLimits (Maybe Natural)
- dlCloudOnlyDirectoriesLimitReached :: Lens' DirectoryLimits (Maybe Bool)
- dlCloudOnlyMicrosoftADCurrentCount :: Lens' DirectoryLimits (Maybe Natural)
- data DirectoryVPCSettings
- directoryVPCSettings :: Text -> DirectoryVPCSettings
- dvsVPCId :: Lens' DirectoryVPCSettings Text
- dvsSubnetIds :: Lens' DirectoryVPCSettings [Text]
- data DirectoryVPCSettingsDescription
- directoryVPCSettingsDescription :: DirectoryVPCSettingsDescription
- dvsdSubnetIds :: Lens' DirectoryVPCSettingsDescription [Text]
- dvsdVPCId :: Lens' DirectoryVPCSettingsDescription (Maybe Text)
- dvsdSecurityGroupId :: Lens' DirectoryVPCSettingsDescription (Maybe Text)
- dvsdAvailabilityZones :: Lens' DirectoryVPCSettingsDescription [Text]
- data EventTopic
- eventTopic :: EventTopic
- etStatus :: Lens' EventTopic (Maybe TopicStatus)
- etDirectoryId :: Lens' EventTopic (Maybe Text)
- etTopicName :: Lens' EventTopic (Maybe Text)
- etTopicARN :: Lens' EventTopic (Maybe Text)
- etCreatedDateTime :: Lens' EventTopic (Maybe UTCTime)
- data RadiusSettings
- radiusSettings :: RadiusSettings
- rsDisplayLabel :: Lens' RadiusSettings (Maybe Text)
- rsRadiusRetries :: Lens' RadiusSettings (Maybe Natural)
- rsAuthenticationProtocol :: Lens' RadiusSettings (Maybe RadiusAuthenticationProtocol)
- rsRadiusServers :: Lens' RadiusSettings [Text]
- rsUseSameUsername :: Lens' RadiusSettings (Maybe Bool)
- rsSharedSecret :: Lens' RadiusSettings (Maybe Text)
- rsRadiusTimeout :: Lens' RadiusSettings (Maybe Natural)
- rsRadiusPort :: Lens' RadiusSettings (Maybe Natural)
- data Snapshot
- snapshot :: Snapshot
- sStatus :: Lens' Snapshot (Maybe SnapshotStatus)
- sDirectoryId :: Lens' Snapshot (Maybe Text)
- sStartTime :: Lens' Snapshot (Maybe UTCTime)
- sName :: Lens' Snapshot (Maybe Text)
- sType :: Lens' Snapshot (Maybe SnapshotType)
- sSnapshotId :: Lens' Snapshot (Maybe Text)
- data SnapshotLimits
- snapshotLimits :: SnapshotLimits
- slManualSnapshotsLimitReached :: Lens' SnapshotLimits (Maybe Bool)
- slManualSnapshotsCurrentCount :: Lens' SnapshotLimits (Maybe Natural)
- slManualSnapshotsLimit :: Lens' SnapshotLimits (Maybe Natural)
- data Trust
- trust :: Trust
- tDirectoryId :: Lens' Trust (Maybe Text)
- tTrustState :: Lens' Trust (Maybe TrustState)
- tLastUpdatedDateTime :: Lens' Trust (Maybe UTCTime)
- tTrustDirection :: Lens' Trust (Maybe TrustDirection)
- tStateLastUpdatedDateTime :: Lens' Trust (Maybe UTCTime)
- tTrustType :: Lens' Trust (Maybe TrustType)
- tTrustStateReason :: Lens' Trust (Maybe Text)
- tRemoteDomainName :: Lens' Trust (Maybe Text)
- tTrustId :: Lens' Trust (Maybe Text)
- tCreatedDateTime :: Lens' Trust (Maybe UTCTime)
Service Configuration
directoryService :: Service Source #
API version '2015-04-16' of the Amazon Directory Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by DirectoryService
.
DirectoryUnavailableException
_DirectoryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified directory is unavailable or could not be found.
AuthenticationFailedException
_AuthenticationFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An authentication error occurred.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more parameters are not valid.
UnsupportedOperationException
_UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation is not supported.
EntityAlreadyExistsException
_EntityAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified entity already exists.
DirectoryLimitExceededException
_DirectoryLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.
EntityDoesNotExistException
_EntityDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified entity could not be found.
InsufficientPermissionsException
_InsufficientPermissionsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The account does not have sufficient permission to perform the operation.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The NextToken value is not valid.
ServiceException
_ServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception has occurred in AWS Directory Service.
SnapshotLimitExceededException
_SnapshotLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.
ClientException
_ClientException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A client exception has occurred.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribeConditionalForwarders
GetSnapshotLimits
RegisterEventTopic
ConnectDirectory
CreateAlias
DescribeDirectories
DescribeTrusts
DeleteTrust
CreateMicrosoftAD
DeregisterEventTopic
CreateDirectory
DescribeEventTopics
UpdateConditionalForwarder
DeleteConditionalForwarder
EnableSSO
EnableRadius
DisableRadius
RestoreFromSnapshot
DescribeSnapshots
DeleteSnapshot
CreateTrust
DeleteDirectory
CreateSnapshot
CreateComputer
DisableSSO
VerifyTrust
CreateConditionalForwarder
GetDirectoryLimits
UpdateRadius
Types
DirectorySize
data DirectorySize Source #
Instances
DirectoryStage
data DirectoryStage Source #
Constructors
DSActive | |
DSCreated | |
DSCreating | |
DSDeleted | |
DSDeleting | |
DSFailed | |
DSImpaired | |
DSInoperable | |
DSRequested | |
DSRestoreFailed | |
DSRestoring |
Instances
DirectoryType
data DirectoryType Source #
Constructors
ADConnector | |
MicrosoftAD | |
SimpleAD |
Instances
RadiusAuthenticationProtocol
data RadiusAuthenticationProtocol Source #
Instances
RadiusStatus
data RadiusStatus Source #
Instances
ReplicationScope
data ReplicationScope Source #
Constructors
Domain |
Instances
SnapshotStatus
data SnapshotStatus Source #
Constructors
SSCompleted | |
SSCreating | |
SSFailed |
Instances
SnapshotType
data SnapshotType Source #
Instances
TopicStatus
data TopicStatus Source #
Constructors
TDeleted | |
TFailed | |
TRegistered | |
TTopicNotFound |
Instances
TrustDirection
data TrustDirection Source #
Constructors
OneWayIncoming | |
OneWayOutgoing | |
TwoWay |
Instances
TrustState
data TrustState Source #
Constructors
TSCreated | |
TSCreating | |
TSDeleted | |
TSDeleting | |
TSFailed | |
TSVerified | |
TSVerifyFailed | |
TSVerifying |
Instances
TrustType
Constructors
Forest |
Instances
Attribute
Represents a named directory attribute.
See: attribute
smart constructor.
Computer
Contains information about a computer account in a directory.
See: computer
smart constructor.
Creates a value of Computer
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cComputerAttributes :: Lens' Computer [Attribute] Source #
An array of Attribute objects containing the LDAP attributes that belong to the computer account.
ConditionalForwarder
data ConditionalForwarder Source #
Points to a remote domain with which you are setting up a trust relationship. Conditional forwarders are required in order to set up a trust relationship with another domain.
See: conditionalForwarder
smart constructor.
Instances
conditionalForwarder :: ConditionalForwarder Source #
Creates a value of ConditionalForwarder
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfDNSIPAddrs :: Lens' ConditionalForwarder [Text] Source #
The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to.
cfRemoteDomainName :: Lens' ConditionalForwarder (Maybe Text) Source #
The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.
cfReplicationScope :: Lens' ConditionalForwarder (Maybe ReplicationScope) Source #
The replication scope of the conditional forwarder. The only allowed
value is Domain
, which will replicate the conditional forwarder to all
of the domain controllers for your AWS directory.
DirectoryConnectSettings
data DirectoryConnectSettings Source #
Contains information for the ConnectDirectory operation when an AD Connector directory is being created.
See: directoryConnectSettings
smart constructor.
Instances
directoryConnectSettings Source #
Arguments
:: Text | |
-> Text | |
-> DirectoryConnectSettings |
Creates a value of DirectoryConnectSettings
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dcsVPCId :: Lens' DirectoryConnectSettings Text Source #
The identifier of the VPC in which the AD Connector is created.
dcsSubnetIds :: Lens' DirectoryConnectSettings [Text] Source #
A list of subnet identifiers in the VPC in which the AD Connector is created.
dcsCustomerDNSIPs :: Lens' DirectoryConnectSettings [Text] Source #
A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.
dcsCustomerUserName :: Lens' DirectoryConnectSettings Text Source #
The username of an account in the on-premises directory that is used to connect to the directory. This account must have the following privileges:
- Read users and groups
- Create computer objects
- Join computers to the domain
DirectoryConnectSettingsDescription
data DirectoryConnectSettingsDescription Source #
Contains information about an AD Connector directory.
See: directoryConnectSettingsDescription
smart constructor.
Instances
directoryConnectSettingsDescription :: DirectoryConnectSettingsDescription Source #
Creates a value of DirectoryConnectSettingsDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dcsdCustomerUserName :: Lens' DirectoryConnectSettingsDescription (Maybe Text) Source #
The username of the service account in the on-premises directory.
dcsdSubnetIds :: Lens' DirectoryConnectSettingsDescription [Text] Source #
A list of subnet identifiers in the VPC that the AD connector is in.
dcsdVPCId :: Lens' DirectoryConnectSettingsDescription (Maybe Text) Source #
The identifier of the VPC that the AD Connector is in.
dcsdSecurityGroupId :: Lens' DirectoryConnectSettingsDescription (Maybe Text) Source #
The security group identifier for the AD Connector directory.
dcsdConnectIPs :: Lens' DirectoryConnectSettingsDescription [Text] Source #
The IP addresses of the AD Connector servers.
dcsdAvailabilityZones :: Lens' DirectoryConnectSettingsDescription [Text] Source #
A list of the Availability Zones that the directory is in.
DirectoryDescription
data DirectoryDescription Source #
Contains information about an AWS Directory Service directory.
See: directoryDescription
smart constructor.
Instances
directoryDescription :: DirectoryDescription Source #
Creates a value of DirectoryDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddRadiusStatus :: Lens' DirectoryDescription (Maybe RadiusStatus) Source #
The status of the RADIUS MFA server connection.
ddStage :: Lens' DirectoryDescription (Maybe DirectoryStage) Source #
The current stage of the directory.
ddDirectoryId :: Lens' DirectoryDescription (Maybe Text) Source #
The directory identifier.
ddAccessURL :: Lens' DirectoryDescription (Maybe Text) Source #
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'.
ddShortName :: Lens' DirectoryDescription (Maybe Text) Source #
The short name of the directory.
ddSize :: Lens' DirectoryDescription (Maybe DirectorySize) Source #
The directory size.
ddRadiusSettings :: Lens' DirectoryDescription (Maybe RadiusSettings) Source #
A RadiusSettings object that contains information about the RADIUS server configured for this directory.
ddLaunchTime :: Lens' DirectoryDescription (Maybe UTCTime) Source #
Specifies when the directory was created.
ddAlias :: Lens' DirectoryDescription (Maybe Text) Source #
The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as 'd-XXXXXXXXXX'.
ddName :: Lens' DirectoryDescription (Maybe Text) Source #
The fully-qualified name of the directory.
ddStageLastUpdatedDateTime :: Lens' DirectoryDescription (Maybe UTCTime) Source #
The date and time that the stage was last updated.
ddSSOEnabled :: Lens' DirectoryDescription (Maybe Bool) Source #
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
ddDNSIPAddrs :: Lens' DirectoryDescription [Text] Source #
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.
ddVPCSettings :: Lens' DirectoryDescription (Maybe DirectoryVPCSettingsDescription) Source #
A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory.
ddType :: Lens' DirectoryDescription (Maybe DirectoryType) Source #
The directory size.
ddStageReason :: Lens' DirectoryDescription (Maybe Text) Source #
Additional information about the directory stage.
ddConnectSettings :: Lens' DirectoryDescription (Maybe DirectoryConnectSettingsDescription) Source #
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.
ddDescription :: Lens' DirectoryDescription (Maybe Text) Source #
The textual description for the directory.
DirectoryLimits
data DirectoryLimits Source #
Contains directory limit information for a region.
See: directoryLimits
smart constructor.
directoryLimits :: DirectoryLimits Source #
Creates a value of DirectoryLimits
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dlConnectedDirectoriesCurrentCount :: Lens' DirectoryLimits (Maybe Natural) Source #
The current number of connected directories in the region.
dlCloudOnlyMicrosoftADLimitReached :: Lens' DirectoryLimits (Maybe Bool) Source #
Indicates if the Microsoft AD directory limit has been reached.
dlConnectedDirectoriesLimit :: Lens' DirectoryLimits (Maybe Natural) Source #
The maximum number of connected directories allowed in the region.
dlConnectedDirectoriesLimitReached :: Lens' DirectoryLimits (Maybe Bool) Source #
Indicates if the connected directory limit has been reached.
dlCloudOnlyMicrosoftADLimit :: Lens' DirectoryLimits (Maybe Natural) Source #
The maximum number of Microsoft AD directories allowed in the region.
dlCloudOnlyDirectoriesLimit :: Lens' DirectoryLimits (Maybe Natural) Source #
The maximum number of cloud directories allowed in the region.
dlCloudOnlyDirectoriesCurrentCount :: Lens' DirectoryLimits (Maybe Natural) Source #
The current number of cloud directories in the region.
dlCloudOnlyDirectoriesLimitReached :: Lens' DirectoryLimits (Maybe Bool) Source #
Indicates if the cloud directory limit has been reached.
dlCloudOnlyMicrosoftADCurrentCount :: Lens' DirectoryLimits (Maybe Natural) Source #
The current number of Microsoft AD directories in the region.
DirectoryVPCSettings
data DirectoryVPCSettings Source #
Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
See: directoryVPCSettings
smart constructor.
Instances
Arguments
:: Text | |
-> DirectoryVPCSettings |
Creates a value of DirectoryVPCSettings
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvsVPCId :: Lens' DirectoryVPCSettings Text Source #
The identifier of the VPC in which to create the directory.
dvsSubnetIds :: Lens' DirectoryVPCSettings [Text] Source #
The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.
DirectoryVPCSettingsDescription
data DirectoryVPCSettingsDescription Source #
Contains information about the directory.
See: directoryVPCSettingsDescription
smart constructor.
Instances
directoryVPCSettingsDescription :: DirectoryVPCSettingsDescription Source #
Creates a value of DirectoryVPCSettingsDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvsdSubnetIds :: Lens' DirectoryVPCSettingsDescription [Text] Source #
The identifiers of the subnets for the directory servers.
dvsdVPCId :: Lens' DirectoryVPCSettingsDescription (Maybe Text) Source #
The identifier of the VPC that the directory is in.
dvsdSecurityGroupId :: Lens' DirectoryVPCSettingsDescription (Maybe Text) Source #
The security group identifier for the directory. If the directory was created before 8/1/2014, this is the identifier of the directory members security group that was created when the directory was created. If the directory was created after this date, this value is null.
dvsdAvailabilityZones :: Lens' DirectoryVPCSettingsDescription [Text] Source #
The list of Availability Zones that the directory is in.
EventTopic
data EventTopic Source #
Information about SNS topic and AWS Directory Service directory associations.
See: eventTopic
smart constructor.
Instances
eventTopic :: EventTopic Source #
Creates a value of EventTopic
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
etStatus :: Lens' EventTopic (Maybe TopicStatus) Source #
The topic registration status.
etDirectoryId :: Lens' EventTopic (Maybe Text) Source #
The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.
etTopicName :: Lens' EventTopic (Maybe Text) Source #
The name of an AWS SNS topic the receives status messages from the directory.
etTopicARN :: Lens' EventTopic (Maybe Text) Source #
The SNS topic ARN (Amazon Resource Name).
etCreatedDateTime :: Lens' EventTopic (Maybe UTCTime) Source #
The date and time of when you associated your directory with the SNS topic.
RadiusSettings
data RadiusSettings Source #
Contains information about a Remote Authentication Dial In User Service (RADIUS) server.
See: radiusSettings
smart constructor.
Instances
radiusSettings :: RadiusSettings Source #
Creates a value of RadiusSettings
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsDisplayLabel :: Lens' RadiusSettings (Maybe Text) Source #
Not currently used.
rsRadiusRetries :: Lens' RadiusSettings (Maybe Natural) Source #
The maximum number of times that communication with the RADIUS server is attempted.
rsAuthenticationProtocol :: Lens' RadiusSettings (Maybe RadiusAuthenticationProtocol) Source #
The protocol specified for your RADIUS endpoints.
rsRadiusServers :: Lens' RadiusSettings [Text] Source #
An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.
rsUseSameUsername :: Lens' RadiusSettings (Maybe Bool) Source #
Not currently used.
rsSharedSecret :: Lens' RadiusSettings (Maybe Text) Source #
The shared secret code that was specified when your RADIUS endpoints were created.
rsRadiusTimeout :: Lens' RadiusSettings (Maybe Natural) Source #
The amount of time, in seconds, to wait for the RADIUS server to respond.
rsRadiusPort :: Lens' RadiusSettings (Maybe Natural) Source #
The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.
Snapshot
Describes a directory snapshot.
See: snapshot
smart constructor.
Creates a value of Snapshot
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SnapshotLimits
data SnapshotLimits Source #
Contains manual snapshot limit information for a directory.
See: snapshotLimits
smart constructor.
snapshotLimits :: SnapshotLimits Source #
Creates a value of SnapshotLimits
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
slManualSnapshotsLimitReached :: Lens' SnapshotLimits (Maybe Bool) Source #
Indicates if the manual snapshot limit has been reached.
slManualSnapshotsCurrentCount :: Lens' SnapshotLimits (Maybe Natural) Source #
The current number of manual snapshots of the directory.
slManualSnapshotsLimit :: Lens' SnapshotLimits (Maybe Natural) Source #
The maximum number of manual snapshots allowed.
Trust
Describes a trust relationship between an Microsoft AD in the AWS cloud and an external domain.
See: trust
smart constructor.
Creates a value of Trust
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tDirectoryId :: Lens' Trust (Maybe Text) Source #
The Directory ID of the AWS directory involved in the trust relationship.
tTrustState :: Lens' Trust (Maybe TrustState) Source #
The trust relationship state.
tLastUpdatedDateTime :: Lens' Trust (Maybe UTCTime) Source #
The date and time that the trust relationship was last updated.
tTrustDirection :: Lens' Trust (Maybe TrustDirection) Source #
The trust relationship direction.
tStateLastUpdatedDateTime :: Lens' Trust (Maybe UTCTime) Source #
The date and time that the TrustState was last updated.