@Generated(value="software.amazon.awssdk:codegen") public interface DirectoryAsyncClient extends SdkClient, SdkAutoCloseable
builder() method.
AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AddIpRoutesResponse> |
addIpRoutes(AddIpRoutesRequest addIpRoutesRequest)
If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address
block to correctly route traffic to and from your Microsoft AD on Amazon Web Services.
|
default CompletableFuture<AddIpRoutesResponse> |
addIpRoutes(Consumer<AddIpRoutesRequest.Builder> addIpRoutesRequest)
If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address
block to correctly route traffic to and from your Microsoft AD on Amazon Web Services.
|
default CompletableFuture<AddTagsToResourceResponse> |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified directory.
|
default CompletableFuture<AddTagsToResourceResponse> |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified directory.
|
static DirectoryAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
DirectoryAsyncClient. |
default CompletableFuture<CancelSchemaExtensionResponse> |
cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest)
Cancels an in-progress schema extension to a Microsoft AD directory.
|
default CompletableFuture<CancelSchemaExtensionResponse> |
cancelSchemaExtension(Consumer<CancelSchemaExtensionRequest.Builder> cancelSchemaExtensionRequest)
Cancels an in-progress schema extension to a Microsoft AD directory.
|
default CompletableFuture<ConnectDirectoryResponse> |
connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)
Creates an AD Connector to connect to an on-premises directory.
|
default CompletableFuture<ConnectDirectoryResponse> |
connectDirectory(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest)
Creates an AD Connector to connect to an on-premises directory.
|
static DirectoryAsyncClient |
create()
Create a
DirectoryAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateAliasResponse> |
createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Creates an alias for a directory and assigns the alias to the directory.
|
default CompletableFuture<CreateAliasResponse> |
createAlias(CreateAliasRequest createAliasRequest)
Creates an alias for a directory and assigns the alias to the directory.
|
default CompletableFuture<CreateComputerResponse> |
createComputer(Consumer<CreateComputerRequest.Builder> createComputerRequest)
Creates a computer account in the specified directory, and joins the computer to the directory.
|
default CompletableFuture<CreateComputerResponse> |
createComputer(CreateComputerRequest createComputerRequest)
Creates a computer account in the specified directory, and joins the computer to the directory.
|
default CompletableFuture<CreateConditionalForwarderResponse> |
createConditionalForwarder(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest)
Creates a conditional forwarder associated with your AWS directory.
|
default CompletableFuture<CreateConditionalForwarderResponse> |
createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)
Creates a conditional forwarder associated with your AWS directory.
|
default CompletableFuture<CreateDirectoryResponse> |
createDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest)
Creates a Simple AD directory.
|
default CompletableFuture<CreateDirectoryResponse> |
createDirectory(CreateDirectoryRequest createDirectoryRequest)
Creates a Simple AD directory.
|
default CompletableFuture<CreateMicrosoftADResponse> |
createMicrosoftAD(Consumer<CreateMicrosoftADRequest.Builder> createMicrosoftADRequest)
Creates a Microsoft AD in the AWS cloud.
|
default CompletableFuture<CreateMicrosoftADResponse> |
createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest)
Creates a Microsoft AD in the AWS cloud.
|
default CompletableFuture<CreateSnapshotResponse> |
createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
|
default CompletableFuture<CreateSnapshotResponse> |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
|
default CompletableFuture<CreateTrustResponse> |
createTrust(Consumer<CreateTrustRequest.Builder> createTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships.
|
default CompletableFuture<CreateTrustResponse> |
createTrust(CreateTrustRequest createTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships.
|
default CompletableFuture<DeleteConditionalForwarderResponse> |
deleteConditionalForwarder(Consumer<DeleteConditionalForwarderRequest.Builder> deleteConditionalForwarderRequest)
Deletes a conditional forwarder that has been set up for your AWS directory.
|
default CompletableFuture<DeleteConditionalForwarderResponse> |
deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)
Deletes a conditional forwarder that has been set up for your AWS directory.
|
default CompletableFuture<DeleteDirectoryResponse> |
deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest)
Deletes an AWS Directory Service directory.
|
default CompletableFuture<DeleteDirectoryResponse> |
deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes an AWS Directory Service directory.
|
default CompletableFuture<DeleteSnapshotResponse> |
deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)
Deletes a directory snapshot.
|
default CompletableFuture<DeleteSnapshotResponse> |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes a directory snapshot.
|
default CompletableFuture<DeleteTrustResponse> |
deleteTrust(Consumer<DeleteTrustRequest.Builder> deleteTrustRequest)
Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
|
default CompletableFuture<DeleteTrustResponse> |
deleteTrust(DeleteTrustRequest deleteTrustRequest)
Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
|
default CompletableFuture<DeregisterEventTopicResponse> |
deregisterEventTopic(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified SNS topic.
|
default CompletableFuture<DeregisterEventTopicResponse> |
deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified SNS topic.
|
default CompletableFuture<DescribeConditionalForwardersResponse> |
describeConditionalForwarders(Consumer<DescribeConditionalForwardersRequest.Builder> describeConditionalForwardersRequest)
Obtains information about the conditional forwarders for this account.
|
default CompletableFuture<DescribeConditionalForwardersResponse> |
describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest)
Obtains information about the conditional forwarders for this account.
|
default CompletableFuture<DescribeDirectoriesResponse> |
describeDirectories()
Obtains information about the directories that belong to this account.
|
default CompletableFuture<DescribeDirectoriesResponse> |
describeDirectories(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest)
Obtains information about the directories that belong to this account.
|
default CompletableFuture<DescribeDirectoriesResponse> |
describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)
Obtains information about the directories that belong to this account.
|
default CompletableFuture<DescribeDomainControllersResponse> |
describeDomainControllers(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest)
Provides information about any domain controllers in your directory.
|
default CompletableFuture<DescribeDomainControllersResponse> |
describeDomainControllers(DescribeDomainControllersRequest describeDomainControllersRequest)
Provides information about any domain controllers in your directory.
|
default CompletableFuture<DescribeEventTopicsResponse> |
describeEventTopics()
Obtains information about which SNS topics receive status messages from the specified directory.
|
default CompletableFuture<DescribeEventTopicsResponse> |
describeEventTopics(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest)
Obtains information about which SNS topics receive status messages from the specified directory.
|
default CompletableFuture<DescribeEventTopicsResponse> |
describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)
Obtains information about which SNS topics receive status messages from the specified directory.
|
default CompletableFuture<DescribeSnapshotsResponse> |
describeSnapshots()
Obtains information about the directory snapshots that belong to this account.
|
default CompletableFuture<DescribeSnapshotsResponse> |
describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)
Obtains information about the directory snapshots that belong to this account.
|
default CompletableFuture<DescribeSnapshotsResponse> |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
Obtains information about the directory snapshots that belong to this account.
|
default CompletableFuture<DescribeTrustsResponse> |
describeTrusts()
Obtains information about the trust relationships for this account.
|
default CompletableFuture<DescribeTrustsResponse> |
describeTrusts(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest)
Obtains information about the trust relationships for this account.
|
default CompletableFuture<DescribeTrustsResponse> |
describeTrusts(DescribeTrustsRequest describeTrustsRequest)
Obtains information about the trust relationships for this account.
|
default CompletableFuture<DisableRadiusResponse> |
disableRadius(Consumer<DisableRadiusRequest.Builder> disableRadiusRequest)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server
for an AD Connector directory.
|
default CompletableFuture<DisableRadiusResponse> |
disableRadius(DisableRadiusRequest disableRadiusRequest)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server
for an AD Connector directory.
|
default CompletableFuture<DisableSsoResponse> |
disableSso(Consumer<DisableSsoRequest.Builder> disableSsoRequest)
Disables single-sign on for a directory.
|
default CompletableFuture<DisableSsoResponse> |
disableSso(DisableSsoRequest disableSsoRequest)
Disables single-sign on for a directory.
|
default CompletableFuture<EnableRadiusResponse> |
enableRadius(Consumer<EnableRadiusRequest.Builder> enableRadiusRequest)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for
an AD Connector directory.
|
default CompletableFuture<EnableRadiusResponse> |
enableRadius(EnableRadiusRequest enableRadiusRequest)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for
an AD Connector directory.
|
default CompletableFuture<EnableSsoResponse> |
enableSso(Consumer<EnableSsoRequest.Builder> enableSsoRequest)
Enables single sign-on for a directory.
|
default CompletableFuture<EnableSsoResponse> |
enableSso(EnableSsoRequest enableSsoRequest)
Enables single sign-on for a directory.
|
default CompletableFuture<GetDirectoryLimitsResponse> |
getDirectoryLimits()
Obtains directory limit information for the current region.
|
default CompletableFuture<GetDirectoryLimitsResponse> |
getDirectoryLimits(Consumer<GetDirectoryLimitsRequest.Builder> getDirectoryLimitsRequest)
Obtains directory limit information for the current region.
|
default CompletableFuture<GetDirectoryLimitsResponse> |
getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)
Obtains directory limit information for the current region.
|
default CompletableFuture<GetSnapshotLimitsResponse> |
getSnapshotLimits(Consumer<GetSnapshotLimitsRequest.Builder> getSnapshotLimitsRequest)
Obtains the manual snapshot limits for a directory.
|
default CompletableFuture<GetSnapshotLimitsResponse> |
getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)
Obtains the manual snapshot limits for a directory.
|
default CompletableFuture<ListIpRoutesResponse> |
listIpRoutes(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest)
Lists the address blocks that you have added to a directory.
|
default CompletableFuture<ListIpRoutesResponse> |
listIpRoutes(ListIpRoutesRequest listIpRoutesRequest)
Lists the address blocks that you have added to a directory.
|
default CompletableFuture<ListSchemaExtensionsResponse> |
listSchemaExtensions(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest)
Lists all schema extensions applied to a Microsoft AD Directory.
|
default CompletableFuture<ListSchemaExtensionsResponse> |
listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest)
Lists all schema extensions applied to a Microsoft AD Directory.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on a directory.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a directory.
|
default CompletableFuture<RegisterEventTopicResponse> |
registerEventTopic(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest)
Associates a directory with an SNS topic.
|
default CompletableFuture<RegisterEventTopicResponse> |
registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)
Associates a directory with an SNS topic.
|
default CompletableFuture<RemoveIpRoutesResponse> |
removeIpRoutes(Consumer<RemoveIpRoutesRequest.Builder> removeIpRoutesRequest)
Removes IP address blocks from a directory.
|
default CompletableFuture<RemoveIpRoutesResponse> |
removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest)
Removes IP address blocks from a directory.
|
default CompletableFuture<RemoveTagsFromResourceResponse> |
removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes tags from a directory.
|
default CompletableFuture<RemoveTagsFromResourceResponse> |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tags from a directory.
|
default CompletableFuture<RestoreFromSnapshotResponse> |
restoreFromSnapshot(Consumer<RestoreFromSnapshotRequest.Builder> restoreFromSnapshotRequest)
Restores a directory using an existing directory snapshot.
|
default CompletableFuture<RestoreFromSnapshotResponse> |
restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)
Restores a directory using an existing directory snapshot.
|
default CompletableFuture<StartSchemaExtensionResponse> |
startSchemaExtension(Consumer<StartSchemaExtensionRequest.Builder> startSchemaExtensionRequest)
Applies a schema extension to a Microsoft AD directory.
|
default CompletableFuture<StartSchemaExtensionResponse> |
startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest)
Applies a schema extension to a Microsoft AD directory.
|
default CompletableFuture<UpdateConditionalForwarderResponse> |
updateConditionalForwarder(Consumer<UpdateConditionalForwarderRequest.Builder> updateConditionalForwarderRequest)
Updates a conditional forwarder that has been set up for your AWS directory.
|
default CompletableFuture<UpdateConditionalForwarderResponse> |
updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)
Updates a conditional forwarder that has been set up for your AWS directory.
|
default CompletableFuture<UpdateNumberOfDomainControllersResponse> |
updateNumberOfDomainControllers(Consumer<UpdateNumberOfDomainControllersRequest.Builder> updateNumberOfDomainControllersRequest)
Adds or removes domain controllers to or from the directory.
|
default CompletableFuture<UpdateNumberOfDomainControllersResponse> |
updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest)
Adds or removes domain controllers to or from the directory.
|
default CompletableFuture<UpdateRadiusResponse> |
updateRadius(Consumer<UpdateRadiusRequest.Builder> updateRadiusRequest)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
|
default CompletableFuture<UpdateRadiusResponse> |
updateRadius(UpdateRadiusRequest updateRadiusRequest)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
|
default CompletableFuture<VerifyTrustResponse> |
verifyTrust(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
|
default CompletableFuture<VerifyTrustResponse> |
verifyTrust(VerifyTrustRequest verifyTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
|
serviceNameclosestatic final String SERVICE_NAME
static DirectoryAsyncClient create()
DirectoryAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DirectoryAsyncClientBuilder builder()
DirectoryAsyncClient.default CompletableFuture<AddIpRoutesResponse> addIpRoutes(AddIpRoutesRequest addIpRoutesRequest)
If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.
Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
addIpRoutesRequest - default CompletableFuture<AddIpRoutesResponse> addIpRoutes(Consumer<AddIpRoutesRequest.Builder> addIpRoutesRequest)
If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.
Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the AddIpRoutesRequest.Builder avoiding the need to
create one manually via AddIpRoutesRequest.builder()
addIpRoutesRequest - A Consumer that will call methods on AddIpRoutesRequest.Builder to create a request.default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
addTagsToResourceRequest - default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceRequest.Builder to create a request.default CompletableFuture<CancelSchemaExtensionResponse> cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest)
Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started
replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled
during any of the following states; Initializing, CreatingSnapshot, and
UpdatingSchema.
cancelSchemaExtensionRequest - default CompletableFuture<CancelSchemaExtensionResponse> cancelSchemaExtension(Consumer<CancelSchemaExtensionRequest.Builder> cancelSchemaExtensionRequest)
Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started
replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled
during any of the following states; Initializing, CreatingSnapshot, and
UpdatingSchema.
This is a convenience which creates an instance of the CancelSchemaExtensionRequest.Builder avoiding the
need to create one manually via CancelSchemaExtensionRequest.builder()
cancelSchemaExtensionRequest - A Consumer that will call methods on CancelSchemaExtensionRequest.Builder to create a
request.default CompletableFuture<ConnectDirectoryResponse> connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)
Creates an AD Connector to connect to an on-premises directory.
Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
connectDirectoryRequest - Contains the inputs for the ConnectDirectory operation.default CompletableFuture<ConnectDirectoryResponse> connectDirectory(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest)
Creates an AD Connector to connect to an on-premises directory.
Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the ConnectDirectoryRequest.Builder avoiding the need
to create one manually via ConnectDirectoryRequest.builder()
connectDirectoryRequest - A Consumer that will call methods on ConnectDirectoryRequest.Builder to create a request.
Contains the inputs for the ConnectDirectory operation.default CompletableFuture<CreateAliasResponse> createAlias(CreateAliasRequest createAliasRequest)
Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the
access URL for the directory, such as http://<alias>.awsapps.com.
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
createAliasRequest - Contains the inputs for the CreateAlias operation.default CompletableFuture<CreateAliasResponse> createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the
access URL for the directory, such as http://<alias>.awsapps.com.
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
This is a convenience which creates an instance of the CreateAliasRequest.Builder avoiding the need to
create one manually via CreateAliasRequest.builder()
createAliasRequest - A Consumer that will call methods on CreateAliasRequest.Builder to create a request.
Contains the inputs for the CreateAlias operation.default CompletableFuture<CreateComputerResponse> createComputer(CreateComputerRequest createComputerRequest)
Creates a computer account in the specified directory, and joins the computer to the directory.
createComputerRequest - Contains the inputs for the CreateComputer operation.default CompletableFuture<CreateComputerResponse> createComputer(Consumer<CreateComputerRequest.Builder> createComputerRequest)
Creates a computer account in the specified directory, and joins the computer to the directory.
This is a convenience which creates an instance of the CreateComputerRequest.Builder avoiding the need to
create one manually via CreateComputerRequest.builder()
createComputerRequest - A Consumer that will call methods on CreateComputerRequest.Builder to create a request.
Contains the inputs for the CreateComputer operation.default CompletableFuture<CreateConditionalForwarderResponse> createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)
Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
createConditionalForwarderRequest - Initiates the creation of a conditional forwarder for your AWS Directory Service for Microsoft Active
Directory. Conditional forwarders are required in order to set up a trust relationship with another
domain.default CompletableFuture<CreateConditionalForwarderResponse> createConditionalForwarder(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest)
Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
This is a convenience which creates an instance of the CreateConditionalForwarderRequest.Builder avoiding
the need to create one manually via CreateConditionalForwarderRequest.builder()
createConditionalForwarderRequest - A Consumer that will call methods on CreateConditionalForwarderRequest.Builder to create a
request. Initiates the creation of a conditional forwarder for your AWS Directory Service for Microsoft
Active Directory. Conditional forwarders are required in order to set up a trust relationship with another
domain.default CompletableFuture<CreateDirectoryResponse> createDirectory(CreateDirectoryRequest createDirectoryRequest)
Creates a Simple AD directory.
Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
createDirectoryRequest - Contains the inputs for the CreateDirectory operation.default CompletableFuture<CreateDirectoryResponse> createDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest)
Creates a Simple AD directory.
Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the CreateDirectoryRequest.Builder avoiding the need
to create one manually via CreateDirectoryRequest.builder()
createDirectoryRequest - A Consumer that will call methods on CreateDirectoryRequest.Builder to create a request.
Contains the inputs for the CreateDirectory operation.default CompletableFuture<CreateMicrosoftADResponse> createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest)
Creates a Microsoft AD in the AWS cloud.
Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
createMicrosoftADRequest - Creates a Microsoft AD in the AWS cloud.default CompletableFuture<CreateMicrosoftADResponse> createMicrosoftAD(Consumer<CreateMicrosoftADRequest.Builder> createMicrosoftADRequest)
Creates a Microsoft AD in the AWS cloud.
Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the CreateMicrosoftADRequest.Builder avoiding the need
to create one manually via CreateMicrosoftADRequest.builder()
createMicrosoftADRequest - A Consumer that will call methods on CreateMicrosoftADRequest.Builder to create a request.
Creates a Microsoft AD in the AWS cloud.default CompletableFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
You cannot take snapshots of AD Connector directories.
createSnapshotRequest - Contains the inputs for the CreateSnapshot operation.default CompletableFuture<CreateSnapshotResponse> createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
You cannot take snapshots of AD Connector directories.
This is a convenience which creates an instance of the CreateSnapshotRequest.Builder avoiding the need to
create one manually via CreateSnapshotRequest.builder()
createSnapshotRequest - A Consumer that will call methods on CreateSnapshotRequest.Builder to create a request.
Contains the inputs for the CreateSnapshot operation.default CompletableFuture<CreateTrustResponse> createTrust(CreateTrustRequest createTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.
createTrustRequest - AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For
example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing
on-premises Microsoft Active Directory. This would allow you to provide users and groups access to
resources in either domain, with a single set of credentials.
This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.
default CompletableFuture<CreateTrustResponse> createTrust(Consumer<CreateTrustRequest.Builder> createTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.
This is a convenience which creates an instance of the CreateTrustRequest.Builder avoiding the need to
create one manually via CreateTrustRequest.builder()
createTrustRequest - A Consumer that will call methods on CreateTrustRequest.Builder to create a request. AWS
Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example,
you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises
Microsoft Active Directory. This would allow you to provide users and groups access to resources in either
domain, with a single set of credentials.
This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.
default CompletableFuture<DeleteConditionalForwarderResponse> deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)
Deletes a conditional forwarder that has been set up for your AWS directory.
deleteConditionalForwarderRequest - Deletes a conditional forwarder.default CompletableFuture<DeleteConditionalForwarderResponse> deleteConditionalForwarder(Consumer<DeleteConditionalForwarderRequest.Builder> deleteConditionalForwarderRequest)
Deletes a conditional forwarder that has been set up for your AWS directory.
This is a convenience which creates an instance of the DeleteConditionalForwarderRequest.Builder avoiding
the need to create one manually via DeleteConditionalForwarderRequest.builder()
deleteConditionalForwarderRequest - A Consumer that will call methods on DeleteConditionalForwarderRequest.Builder to create a
request. Deletes a conditional forwarder.default CompletableFuture<DeleteDirectoryResponse> deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes an AWS Directory Service directory.
Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
deleteDirectoryRequest - Contains the inputs for the DeleteDirectory operation.default CompletableFuture<DeleteDirectoryResponse> deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest)
Deletes an AWS Directory Service directory.
Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the DeleteDirectoryRequest.Builder avoiding the need
to create one manually via DeleteDirectoryRequest.builder()
deleteDirectoryRequest - A Consumer that will call methods on DeleteDirectoryRequest.Builder to create a request.
Contains the inputs for the DeleteDirectory operation.default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes a directory snapshot.
deleteSnapshotRequest - Contains the inputs for the DeleteSnapshot operation.default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)
Deletes a directory snapshot.
This is a convenience which creates an instance of the DeleteSnapshotRequest.Builder avoiding the need to
create one manually via DeleteSnapshotRequest.builder()
deleteSnapshotRequest - A Consumer that will call methods on DeleteSnapshotRequest.Builder to create a request.
Contains the inputs for the DeleteSnapshot operation.default CompletableFuture<DeleteTrustResponse> deleteTrust(DeleteTrustRequest deleteTrustRequest)
Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
deleteTrustRequest - Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud and the
external domain.default CompletableFuture<DeleteTrustResponse> deleteTrust(Consumer<DeleteTrustRequest.Builder> deleteTrustRequest)
Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
This is a convenience which creates an instance of the DeleteTrustRequest.Builder avoiding the need to
create one manually via DeleteTrustRequest.builder()
deleteTrustRequest - A Consumer that will call methods on DeleteTrustRequest.Builder to create a request.
Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud and the
external domain.default CompletableFuture<DeregisterEventTopicResponse> deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified SNS topic.
deregisterEventTopicRequest - Removes the specified directory as a publisher to the specified SNS topic.default CompletableFuture<DeregisterEventTopicResponse> deregisterEventTopic(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified SNS topic.
This is a convenience which creates an instance of the DeregisterEventTopicRequest.Builder avoiding the
need to create one manually via DeregisterEventTopicRequest.builder()
deregisterEventTopicRequest - A Consumer that will call methods on DeregisterEventTopicRequest.Builder to create a
request. Removes the specified directory as a publisher to the specified SNS topic.default CompletableFuture<DescribeConditionalForwardersResponse> describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest)
Obtains information about the conditional forwarders for this account.
If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
describeConditionalForwardersRequest - Describes a conditional forwarder.default CompletableFuture<DescribeConditionalForwardersResponse> describeConditionalForwarders(Consumer<DescribeConditionalForwardersRequest.Builder> describeConditionalForwardersRequest)
Obtains information about the conditional forwarders for this account.
If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
This is a convenience which creates an instance of the DescribeConditionalForwardersRequest.Builder
avoiding the need to create one manually via DescribeConditionalForwardersRequest.builder()
describeConditionalForwardersRequest - A Consumer that will call methods on DescribeConditionalForwardersRequest.Builder to
create a request. Describes a conditional forwarder.default CompletableFuture<DescribeDirectoriesResponse> describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)
Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
describeDirectoriesRequest - Contains the inputs for the DescribeDirectories operation.default CompletableFuture<DescribeDirectoriesResponse> describeDirectories(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest)
Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
This is a convenience which creates an instance of the DescribeDirectoriesRequest.Builder avoiding the
need to create one manually via DescribeDirectoriesRequest.builder()
describeDirectoriesRequest - A Consumer that will call methods on DescribeDirectoriesRequest.Builder to create a
request. Contains the inputs for the DescribeDirectories operation.default CompletableFuture<DescribeDirectoriesResponse> describeDirectories()
Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
default CompletableFuture<DescribeDomainControllersResponse> describeDomainControllers(DescribeDomainControllersRequest describeDomainControllersRequest)
Provides information about any domain controllers in your directory.
describeDomainControllersRequest - default CompletableFuture<DescribeDomainControllersResponse> describeDomainControllers(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest)
Provides information about any domain controllers in your directory.
This is a convenience which creates an instance of the DescribeDomainControllersRequest.Builder avoiding
the need to create one manually via DescribeDomainControllersRequest.builder()
describeDomainControllersRequest - A Consumer that will call methods on DescribeDomainControllersRequest.Builder to create a
request.default CompletableFuture<DescribeEventTopicsResponse> describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)
Obtains information about which SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
describeEventTopicsRequest - Describes event topics.default CompletableFuture<DescribeEventTopicsResponse> describeEventTopics(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest)
Obtains information about which SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
This is a convenience which creates an instance of the DescribeEventTopicsRequest.Builder avoiding the
need to create one manually via DescribeEventTopicsRequest.builder()
describeEventTopicsRequest - A Consumer that will call methods on DescribeEventTopicsRequest.Builder to create a
request. Describes event topics.default CompletableFuture<DescribeEventTopicsResponse> describeEventTopics()
Obtains information about which SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
describeSnapshotsRequest - Contains the inputs for the DescribeSnapshots operation.default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)
Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder avoiding the need
to create one manually via DescribeSnapshotsRequest.builder()
describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsRequest.Builder to create a request.
Contains the inputs for the DescribeSnapshots operation.default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots()
Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
default CompletableFuture<DescribeTrustsResponse> describeTrusts(DescribeTrustsRequest describeTrustsRequest)
Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
describeTrustsRequest - Describes the trust relationships for a particular Microsoft AD in the AWS cloud. If no input parameters
are are provided, such as directory ID or trust ID, this request describes all the trust relationships.default CompletableFuture<DescribeTrustsResponse> describeTrusts(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest)
Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
This is a convenience which creates an instance of the DescribeTrustsRequest.Builder avoiding the need to
create one manually via DescribeTrustsRequest.builder()
describeTrustsRequest - A Consumer that will call methods on DescribeTrustsRequest.Builder to create a request.
Describes the trust relationships for a particular Microsoft AD in the AWS cloud. If no input parameters
are are provided, such as directory ID or trust ID, this request describes all the trust relationships.default CompletableFuture<DescribeTrustsResponse> describeTrusts()
Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
default CompletableFuture<DisableRadiusResponse> disableRadius(DisableRadiusRequest disableRadiusRequest)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
disableRadiusRequest - Contains the inputs for the DisableRadius operation.default CompletableFuture<DisableRadiusResponse> disableRadius(Consumer<DisableRadiusRequest.Builder> disableRadiusRequest)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
This is a convenience which creates an instance of the DisableRadiusRequest.Builder avoiding the need to
create one manually via DisableRadiusRequest.builder()
disableRadiusRequest - A Consumer that will call methods on DisableRadiusRequest.Builder to create a request.
Contains the inputs for the DisableRadius operation.default CompletableFuture<DisableSsoResponse> disableSso(DisableSsoRequest disableSsoRequest)
Disables single-sign on for a directory.
disableSsoRequest - Contains the inputs for the DisableSso operation.default CompletableFuture<DisableSsoResponse> disableSso(Consumer<DisableSsoRequest.Builder> disableSsoRequest)
Disables single-sign on for a directory.
This is a convenience which creates an instance of the DisableSsoRequest.Builder avoiding the need to
create one manually via DisableSsoRequest.builder()
disableSsoRequest - A Consumer that will call methods on DisableSsoRequest.Builder to create a request.
Contains the inputs for the DisableSso operation.default CompletableFuture<EnableRadiusResponse> enableRadius(EnableRadiusRequest enableRadiusRequest)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
enableRadiusRequest - Contains the inputs for the EnableRadius operation.default CompletableFuture<EnableRadiusResponse> enableRadius(Consumer<EnableRadiusRequest.Builder> enableRadiusRequest)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
This is a convenience which creates an instance of the EnableRadiusRequest.Builder avoiding the need to
create one manually via EnableRadiusRequest.builder()
enableRadiusRequest - A Consumer that will call methods on EnableRadiusRequest.Builder to create a request.
Contains the inputs for the EnableRadius operation.default CompletableFuture<EnableSsoResponse> enableSso(EnableSsoRequest enableSsoRequest)
Enables single sign-on for a directory.
enableSsoRequest - Contains the inputs for the EnableSso operation.default CompletableFuture<EnableSsoResponse> enableSso(Consumer<EnableSsoRequest.Builder> enableSsoRequest)
Enables single sign-on for a directory.
This is a convenience which creates an instance of the EnableSsoRequest.Builder avoiding the need to
create one manually via EnableSsoRequest.builder()
enableSsoRequest - A Consumer that will call methods on EnableSsoRequest.Builder to create a request.
Contains the inputs for the EnableSso operation.default CompletableFuture<GetDirectoryLimitsResponse> getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)
Obtains directory limit information for the current region.
getDirectoryLimitsRequest - Contains the inputs for the GetDirectoryLimits operation.default CompletableFuture<GetDirectoryLimitsResponse> getDirectoryLimits(Consumer<GetDirectoryLimitsRequest.Builder> getDirectoryLimitsRequest)
Obtains directory limit information for the current region.
This is a convenience which creates an instance of the GetDirectoryLimitsRequest.Builder avoiding the
need to create one manually via GetDirectoryLimitsRequest.builder()
getDirectoryLimitsRequest - A Consumer that will call methods on GetDirectoryLimitsRequest.Builder to create a
request. Contains the inputs for the GetDirectoryLimits operation.default CompletableFuture<GetDirectoryLimitsResponse> getDirectoryLimits()
Obtains directory limit information for the current region.
default CompletableFuture<GetSnapshotLimitsResponse> getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)
Obtains the manual snapshot limits for a directory.
getSnapshotLimitsRequest - Contains the inputs for the GetSnapshotLimits operation.default CompletableFuture<GetSnapshotLimitsResponse> getSnapshotLimits(Consumer<GetSnapshotLimitsRequest.Builder> getSnapshotLimitsRequest)
Obtains the manual snapshot limits for a directory.
This is a convenience which creates an instance of the GetSnapshotLimitsRequest.Builder avoiding the need
to create one manually via GetSnapshotLimitsRequest.builder()
getSnapshotLimitsRequest - A Consumer that will call methods on GetSnapshotLimitsRequest.Builder to create a request.
Contains the inputs for the GetSnapshotLimits operation.default CompletableFuture<ListIpRoutesResponse> listIpRoutes(ListIpRoutesRequest listIpRoutesRequest)
Lists the address blocks that you have added to a directory.
listIpRoutesRequest - default CompletableFuture<ListIpRoutesResponse> listIpRoutes(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest)
Lists the address blocks that you have added to a directory.
This is a convenience which creates an instance of the ListIpRoutesRequest.Builder avoiding the need to
create one manually via ListIpRoutesRequest.builder()
listIpRoutesRequest - A Consumer that will call methods on ListIpRoutesRequest.Builder to create a request.default CompletableFuture<ListSchemaExtensionsResponse> listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest)
Lists all schema extensions applied to a Microsoft AD Directory.
listSchemaExtensionsRequest - default CompletableFuture<ListSchemaExtensionsResponse> listSchemaExtensions(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest)
Lists all schema extensions applied to a Microsoft AD Directory.
This is a convenience which creates an instance of the ListSchemaExtensionsRequest.Builder avoiding the
need to create one manually via ListSchemaExtensionsRequest.builder()
listSchemaExtensionsRequest - A Consumer that will call methods on ListSchemaExtensionsRequest.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a directory.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on a directory.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<RegisterEventTopicResponse> registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)
Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
registerEventTopicRequest - Registers a new event topic.default CompletableFuture<RegisterEventTopicResponse> registerEventTopic(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest)
Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
This is a convenience which creates an instance of the RegisterEventTopicRequest.Builder avoiding the
need to create one manually via RegisterEventTopicRequest.builder()
registerEventTopicRequest - A Consumer that will call methods on RegisterEventTopicRequest.Builder to create a
request. Registers a new event topic.default CompletableFuture<RemoveIpRoutesResponse> removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest)
Removes IP address blocks from a directory.
removeIpRoutesRequest - default CompletableFuture<RemoveIpRoutesResponse> removeIpRoutes(Consumer<RemoveIpRoutesRequest.Builder> removeIpRoutesRequest)
Removes IP address blocks from a directory.
This is a convenience which creates an instance of the RemoveIpRoutesRequest.Builder avoiding the need to
create one manually via RemoveIpRoutesRequest.builder()
removeIpRoutesRequest - A Consumer that will call methods on RemoveIpRoutesRequest.Builder to create a request.default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tags from a directory.
removeTagsFromResourceRequest - default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes tags from a directory.
This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceRequest.Builder to create a
request.default CompletableFuture<RestoreFromSnapshotResponse> restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)
Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore
operation by calling the DescribeDirectories operation with the directory identifier. When the
DirectoryDescription.Stage value changes to Active, the restore operation is complete.
restoreFromSnapshotRequest - An object representing the inputs for the RestoreFromSnapshot operation.default CompletableFuture<RestoreFromSnapshotResponse> restoreFromSnapshot(Consumer<RestoreFromSnapshotRequest.Builder> restoreFromSnapshotRequest)
Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore
operation by calling the DescribeDirectories operation with the directory identifier. When the
DirectoryDescription.Stage value changes to Active, the restore operation is complete.
This is a convenience which creates an instance of the RestoreFromSnapshotRequest.Builder avoiding the
need to create one manually via RestoreFromSnapshotRequest.builder()
restoreFromSnapshotRequest - A Consumer that will call methods on RestoreFromSnapshotRequest.Builder to create a
request. An object representing the inputs for the RestoreFromSnapshot operation.default CompletableFuture<StartSchemaExtensionResponse> startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest)
Applies a schema extension to a Microsoft AD directory.
startSchemaExtensionRequest - default CompletableFuture<StartSchemaExtensionResponse> startSchemaExtension(Consumer<StartSchemaExtensionRequest.Builder> startSchemaExtensionRequest)
Applies a schema extension to a Microsoft AD directory.
This is a convenience which creates an instance of the StartSchemaExtensionRequest.Builder avoiding the
need to create one manually via StartSchemaExtensionRequest.builder()
startSchemaExtensionRequest - A Consumer that will call methods on StartSchemaExtensionRequest.Builder to create a
request.default CompletableFuture<UpdateConditionalForwarderResponse> updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)
Updates a conditional forwarder that has been set up for your AWS directory.
updateConditionalForwarderRequest - Updates a conditional forwarder.default CompletableFuture<UpdateConditionalForwarderResponse> updateConditionalForwarder(Consumer<UpdateConditionalForwarderRequest.Builder> updateConditionalForwarderRequest)
Updates a conditional forwarder that has been set up for your AWS directory.
This is a convenience which creates an instance of the UpdateConditionalForwarderRequest.Builder avoiding
the need to create one manually via UpdateConditionalForwarderRequest.builder()
updateConditionalForwarderRequest - A Consumer that will call methods on UpdateConditionalForwarderRequest.Builder to create a
request. Updates a conditional forwarder.default CompletableFuture<UpdateNumberOfDomainControllersResponse> updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest)
Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
updateNumberOfDomainControllersRequest - default CompletableFuture<UpdateNumberOfDomainControllersResponse> updateNumberOfDomainControllers(Consumer<UpdateNumberOfDomainControllersRequest.Builder> updateNumberOfDomainControllersRequest)
Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
This is a convenience which creates an instance of the UpdateNumberOfDomainControllersRequest.Builder
avoiding the need to create one manually via UpdateNumberOfDomainControllersRequest.builder()
updateNumberOfDomainControllersRequest - A Consumer that will call methods on UpdateNumberOfDomainControllersRequest.Builder to
create a request.default CompletableFuture<UpdateRadiusResponse> updateRadius(UpdateRadiusRequest updateRadiusRequest)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
updateRadiusRequest - Contains the inputs for the UpdateRadius operation.default CompletableFuture<UpdateRadiusResponse> updateRadius(Consumer<UpdateRadiusRequest.Builder> updateRadiusRequest)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
This is a convenience which creates an instance of the UpdateRadiusRequest.Builder avoiding the need to
create one manually via UpdateRadiusRequest.builder()
updateRadiusRequest - A Consumer that will call methods on UpdateRadiusRequest.Builder to create a request.
Contains the inputs for the UpdateRadius operation.default CompletableFuture<VerifyTrustResponse> verifyTrust(VerifyTrustRequest verifyTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.
verifyTrustRequest - Initiates the verification of an existing trust relationship between a Microsoft AD in the AWS cloud and
an external domain.default CompletableFuture<VerifyTrustResponse> verifyTrust(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.
This is a convenience which creates an instance of the VerifyTrustRequest.Builder avoiding the need to
create one manually via VerifyTrustRequest.builder()
verifyTrustRequest - A Consumer that will call methods on VerifyTrustRequest.Builder to create a request.
Initiates the verification of an existing trust relationship between a Microsoft AD in the AWS cloud and
an external domain.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.