directoryservice

package module
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2020 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source
const ServiceAPIVersion = "2015-04-16"
View Source
const ServiceID = "Directory Service"

Variables

This section is empty.

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type AcceptSharedDirectoryInput

type AcceptSharedDirectoryInput struct {
	// Identifier of the shared directory in the directory consumer account. This
	// identifier is different for each directory owner account.
	SharedDirectoryId *string
}

type AcceptSharedDirectoryOutput

type AcceptSharedDirectoryOutput struct {
	// The shared directory in the directory consumer account.
	SharedDirectory *types.SharedDirectory

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AddIpRoutesInput

type AddIpRoutesInput struct {
	// Identifier (ID) of the directory to which to add the address block.
	DirectoryId *string
	// IP address blocks, using CIDR format, of the traffic to route. This is often the
	// IP address block of the DNS server used for your on-premises domain.
	IpRoutes []*types.IpRoute
	// If set to true, updates the inbound and outbound rules of the security group
	// that has the description: "AWS created security group for directory ID directory
	// controllers." Following are the new rules: Inbound:
	//
	//     * Type: Custom UDP
	// Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0
	//
	//     * Type: Custom UDP Rule,
	// Protocol: UDP, Range: 123, Source: 0.0.0.0/0
	//
	//     * Type: Custom UDP Rule,
	// Protocol: UDP, Range: 138, Source: 0.0.0.0/0
	//
	//     * Type: Custom UDP Rule,
	// Protocol: UDP, Range: 389, Source: 0.0.0.0/0
	//
	//     * Type: Custom UDP Rule,
	// Protocol: UDP, Range: 464, Source: 0.0.0.0/0
	//
	//     * Type: Custom UDP Rule,
	// Protocol: UDP, Range: 445, Source: 0.0.0.0/0
	//
	//     * Type: Custom TCP Rule,
	// Protocol: TCP, Range: 88, Source: 0.0.0.0/0
	//
	//     * Type: Custom TCP Rule,
	// Protocol: TCP, Range: 135, Source: 0.0.0.0/0
	//
	//     * Type: Custom TCP Rule,
	// Protocol: TCP, Range: 445, Source: 0.0.0.0/0
	//
	//     * Type: Custom TCP Rule,
	// Protocol: TCP, Range: 464, Source: 0.0.0.0/0
	//
	//     * Type: Custom TCP Rule,
	// Protocol: TCP, Range: 636, Source: 0.0.0.0/0
	//
	//     * Type: Custom TCP Rule,
	// Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0
	//
	//     * Type: Custom TCP
	// Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0
	//
	//     * Type: DNS
	// (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0
	//
	//     * Type: DNS (TCP),
	// Protocol: TCP, Range: 53, Source: 0.0.0.0/0
	//
	//     * Type: LDAP, Protocol: TCP,
	// Range: 389, Source: 0.0.0.0/0
	//
	//     * Type: All ICMP, Protocol: All, Range: N/A,
	// Source: 0.0.0.0/0
	//
	//     <p></p> <p>Outbound:</p> <ul> <li> <p>Type: All traffic,
	// Protocol: All, Range: All, Destination: 0.0.0.0/0</p> </li> </ul> <p>These
	// security rules impact an internal network interface that is not exposed
	// publicly.</p>
	UpdateSecurityGroupForDirectoryControllers *bool
}

type AddIpRoutesOutput

type AddIpRoutesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AddTagsToResourceInput

type AddTagsToResourceInput struct {
	// Identifier (ID) for the directory to which to add the tag.
	ResourceId *string
	// The tags to be assigned to the directory.
	Tags []*types.Tag
}

type AddTagsToResourceOutput

type AddTagsToResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CancelSchemaExtensionInput

type CancelSchemaExtensionInput struct {
	// The identifier of the directory whose schema extension will be canceled.
	DirectoryId *string
	// The identifier of the schema extension that will be canceled.
	SchemaExtensionId *string
}

type CancelSchemaExtensionOutput

type CancelSchemaExtensionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

AWS Directory Service 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 (https://aws.amazon.com/directoryservice/) and the AWS Directory Service Administration Guide (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html). 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 (http://aws.amazon.com/tools/).

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AcceptSharedDirectory

func (c *Client) AcceptSharedDirectory(ctx context.Context, params *AcceptSharedDirectoryInput, optFns ...func(*Options)) (*AcceptSharedDirectoryOutput, error)

Accepts a directory sharing request that was sent from the directory owner account.

func (*Client) AddIpRoutes

func (c *Client) AddIpRoutes(ctx context.Context, params *AddIpRoutesInput, optFns ...func(*Options)) (*AddIpRoutesOutput, error)

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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

func (*Client) AddTagsToResource

func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error)

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.

func (*Client) CancelSchemaExtension

func (c *Client) CancelSchemaExtension(ctx context.Context, params *CancelSchemaExtensionInput, optFns ...func(*Options)) (*CancelSchemaExtensionOutput, error)

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.

func (*Client) ConnectDirectory

func (c *Client) ConnectDirectory(ctx context.Context, params *ConnectDirectoryInput, optFns ...func(*Options)) (*ConnectDirectoryOutput, error)

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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

func (*Client) CreateAlias

func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optFns ...func(*Options)) (*CreateAliasOutput, error)

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://.awsapps.com. After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

func (*Client) CreateComputer

func (c *Client) CreateComputer(ctx context.Context, params *CreateComputerInput, optFns ...func(*Options)) (*CreateComputerOutput, error)

Creates a computer account in the specified directory, and joins the computer to the directory.

func (*Client) CreateConditionalForwarder

func (c *Client) CreateConditionalForwarder(ctx context.Context, params *CreateConditionalForwarderInput, optFns ...func(*Options)) (*CreateConditionalForwarderOutput, error)

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.

func (*Client) CreateDirectory

func (c *Client) CreateDirectory(ctx context.Context, params *CreateDirectoryInput, optFns ...func(*Options)) (*CreateDirectoryOutput, error)

Creates a Simple AD directory. For more information, see Simple Active Directory (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html) in the AWS Directory Service Admin Guide. 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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

func (*Client) CreateLogSubscription

func (c *Client) CreateLogSubscription(ctx context.Context, params *CreateLogSubscriptionInput, optFns ...func(*Options)) (*CreateLogSubscriptionOutput, error)

Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your AWS account.

func (*Client) CreateMicrosoftAD

func (c *Client) CreateMicrosoftAD(ctx context.Context, params *CreateMicrosoftADInput, optFns ...func(*Options)) (*CreateMicrosoftADOutput, error)

Creates a Microsoft AD directory in the AWS Cloud. For more information, see AWS Managed Microsoft AD (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) in the AWS Directory Service Admin Guide. 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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

func (*Client) CreateSnapshot

func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error)

Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. You cannot take snapshots of AD Connector directories.

func (*Client) CreateTrust

func (c *Client) CreateTrust(ctx context.Context, params *CreateTrustInput, optFns ...func(*Options)) (*CreateTrustOutput, error)

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, 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 an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.

func (*Client) DeleteConditionalForwarder

func (c *Client) DeleteConditionalForwarder(ctx context.Context, params *DeleteConditionalForwarderInput, optFns ...func(*Options)) (*DeleteConditionalForwarderOutput, error)

Deletes a conditional forwarder that has been set up for your AWS directory.

func (*Client) DeleteDirectory

func (c *Client) DeleteDirectory(ctx context.Context, params *DeleteDirectoryInput, optFns ...func(*Options)) (*DeleteDirectoryOutput, error)

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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

func (*Client) DeleteLogSubscription

func (c *Client) DeleteLogSubscription(ctx context.Context, params *DeleteLogSubscriptionInput, optFns ...func(*Options)) (*DeleteLogSubscriptionOutput, error)

Deletes the specified log subscription.

func (*Client) DeleteSnapshot

func (c *Client) DeleteSnapshot(ctx context.Context, params *DeleteSnapshotInput, optFns ...func(*Options)) (*DeleteSnapshotOutput, error)

Deletes a directory snapshot.

func (*Client) DeleteTrust

func (c *Client) DeleteTrust(ctx context.Context, params *DeleteTrustInput, optFns ...func(*Options)) (*DeleteTrustOutput, error)

Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.

func (*Client) DeregisterCertificate

func (c *Client) DeregisterCertificate(ctx context.Context, params *DeregisterCertificateInput, optFns ...func(*Options)) (*DeregisterCertificateOutput, error)

Deletes from the system the certificate that was registered for a secured LDAP connection.

func (*Client) DeregisterEventTopic

func (c *Client) DeregisterEventTopic(ctx context.Context, params *DeregisterEventTopicInput, optFns ...func(*Options)) (*DeregisterEventTopicOutput, error)

Removes the specified directory as a publisher to the specified SNS topic.

func (*Client) DescribeCertificate

func (c *Client) DescribeCertificate(ctx context.Context, params *DescribeCertificateInput, optFns ...func(*Options)) (*DescribeCertificateOutput, error)

Displays information about the certificate registered for a secured LDAP connection.

func (*Client) DescribeConditionalForwarders

func (c *Client) DescribeConditionalForwarders(ctx context.Context, params *DescribeConditionalForwardersInput, optFns ...func(*Options)) (*DescribeConditionalForwardersOutput, error)

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.

func (*Client) DescribeDirectories

func (c *Client) DescribeDirectories(ctx context.Context, params *DescribeDirectoriesInput, optFns ...func(*Options)) (*DescribeDirectoriesOutput, error)

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.

func (*Client) DescribeDomainControllers

func (c *Client) DescribeDomainControllers(ctx context.Context, params *DescribeDomainControllersInput, optFns ...func(*Options)) (*DescribeDomainControllersOutput, error)

Provides information about any domain controllers in your directory.

func (*Client) DescribeEventTopics

func (c *Client) DescribeEventTopics(ctx context.Context, params *DescribeEventTopicsInput, optFns ...func(*Options)) (*DescribeEventTopicsOutput, error)

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.

func (*Client) DescribeLDAPSSettings

func (c *Client) DescribeLDAPSSettings(ctx context.Context, params *DescribeLDAPSSettingsInput, optFns ...func(*Options)) (*DescribeLDAPSSettingsOutput, error)

Describes the status of LDAP security for the specified directory.

func (*Client) DescribeSharedDirectories

func (c *Client) DescribeSharedDirectories(ctx context.Context, params *DescribeSharedDirectoriesInput, optFns ...func(*Options)) (*DescribeSharedDirectoriesOutput, error)

Returns the shared directories in your account.

func (*Client) DescribeSnapshots

func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshotsInput, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error)

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.

func (*Client) DescribeTrusts

func (c *Client) DescribeTrusts(ctx context.Context, params *DescribeTrustsInput, optFns ...func(*Options)) (*DescribeTrustsOutput, error)

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.

func (*Client) DisableLDAPS

func (c *Client) DisableLDAPS(ctx context.Context, params *DisableLDAPSInput, optFns ...func(*Options)) (*DisableLDAPSOutput, error)

Deactivates LDAP secure calls for the specified directory.

func (*Client) DisableRadius

func (c *Client) DisableRadius(ctx context.Context, params *DisableRadiusInput, optFns ...func(*Options)) (*DisableRadiusOutput, error)

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

func (*Client) DisableSso

func (c *Client) DisableSso(ctx context.Context, params *DisableSsoInput, optFns ...func(*Options)) (*DisableSsoOutput, error)

Disables single-sign on for a directory.

func (*Client) EnableLDAPS

func (c *Client) EnableLDAPS(ctx context.Context, params *EnableLDAPSInput, optFns ...func(*Options)) (*EnableLDAPSOutput, error)

Activates the switch for the specific directory to always use LDAP secure calls.

func (*Client) EnableRadius

func (c *Client) EnableRadius(ctx context.Context, params *EnableRadiusInput, optFns ...func(*Options)) (*EnableRadiusOutput, error)

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

func (*Client) EnableSso

func (c *Client) EnableSso(ctx context.Context, params *EnableSsoInput, optFns ...func(*Options)) (*EnableSsoOutput, error)

Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately.

func (*Client) GetDirectoryLimits

func (c *Client) GetDirectoryLimits(ctx context.Context, params *GetDirectoryLimitsInput, optFns ...func(*Options)) (*GetDirectoryLimitsOutput, error)

Obtains directory limit information for the current Region.

func (*Client) GetSnapshotLimits

func (c *Client) GetSnapshotLimits(ctx context.Context, params *GetSnapshotLimitsInput, optFns ...func(*Options)) (*GetSnapshotLimitsOutput, error)

Obtains the manual snapshot limits for a directory.

func (*Client) ListCertificates

func (c *Client) ListCertificates(ctx context.Context, params *ListCertificatesInput, optFns ...func(*Options)) (*ListCertificatesOutput, error)

For the specified directory, lists all the certificates registered for a secured LDAP connection.

func (*Client) ListIpRoutes

func (c *Client) ListIpRoutes(ctx context.Context, params *ListIpRoutesInput, optFns ...func(*Options)) (*ListIpRoutesOutput, error)

Lists the address blocks that you have added to a directory.

func (*Client) ListLogSubscriptions

func (c *Client) ListLogSubscriptions(ctx context.Context, params *ListLogSubscriptionsInput, optFns ...func(*Options)) (*ListLogSubscriptionsOutput, error)

Lists the active log subscriptions for the AWS account.

func (*Client) ListSchemaExtensions

func (c *Client) ListSchemaExtensions(ctx context.Context, params *ListSchemaExtensionsInput, optFns ...func(*Options)) (*ListSchemaExtensionsOutput, error)

Lists all schema extensions applied to a Microsoft AD Directory.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists all tags on a directory.

func (*Client) RegisterCertificate

func (c *Client) RegisterCertificate(ctx context.Context, params *RegisterCertificateInput, optFns ...func(*Options)) (*RegisterCertificateOutput, error)

Registers a certificate for secured LDAP connection.

func (*Client) RegisterEventTopic

func (c *Client) RegisterEventTopic(ctx context.Context, params *RegisterEventTopicInput, optFns ...func(*Options)) (*RegisterEventTopicOutput, error)

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.

func (*Client) RejectSharedDirectory

func (c *Client) RejectSharedDirectory(ctx context.Context, params *RejectSharedDirectoryInput, optFns ...func(*Options)) (*RejectSharedDirectoryOutput, error)

Rejects a directory sharing request that was sent from the directory owner account.

func (*Client) RemoveIpRoutes

func (c *Client) RemoveIpRoutes(ctx context.Context, params *RemoveIpRoutesInput, optFns ...func(*Options)) (*RemoveIpRoutesOutput, error)

Removes IP address blocks from a directory.

func (*Client) RemoveTagsFromResource

func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error)

Removes tags from a directory.

func (*Client) ResetUserPassword

func (c *Client) ResetUserPassword(ctx context.Context, params *ResetUserPasswordInput, optFns ...func(*Options)) (*ResetUserPasswordOutput, error)

Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory. You can reset the password for any user in your directory with the following exceptions:

  • For Simple AD, you cannot reset the password for

any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.

  • For AWS Managed Microsoft AD, you can

only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the AWS Reserved OU. For more information about the OU structure for an AWS Managed Microsoft AD directory, see What Gets Created (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html) in the AWS Directory Service Administration Guide.

func (*Client) RestoreFromSnapshot

func (c *Client) RestoreFromSnapshot(ctx context.Context, params *RestoreFromSnapshotInput, optFns ...func(*Options)) (*RestoreFromSnapshotOutput, error)

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.

func (*Client) ShareDirectory

func (c *Client) ShareDirectory(ctx context.Context, params *ShareDirectoryInput, optFns ...func(*Options)) (*ShareDirectoryOutput, error)

Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer). With this operation you can use your directory from any AWS account and from any Amazon VPC within an AWS Region. When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account. The ShareMethod parameter determines whether the specified directory can be shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It also determines whether you can share the directory with any other AWS account either inside or outside of the organization (HANDSHAKE). The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.

func (*Client) StartSchemaExtension

func (c *Client) StartSchemaExtension(ctx context.Context, params *StartSchemaExtensionInput, optFns ...func(*Options)) (*StartSchemaExtensionOutput, error)

Applies a schema extension to a Microsoft AD directory.

func (*Client) UnshareDirectory

func (c *Client) UnshareDirectory(ctx context.Context, params *UnshareDirectoryInput, optFns ...func(*Options)) (*UnshareDirectoryOutput, error)

Stops the directory sharing between the directory owner and consumer accounts.

func (*Client) UpdateConditionalForwarder

func (c *Client) UpdateConditionalForwarder(ctx context.Context, params *UpdateConditionalForwarderInput, optFns ...func(*Options)) (*UpdateConditionalForwarderOutput, error)

Updates a conditional forwarder that has been set up for your AWS directory.

func (*Client) UpdateNumberOfDomainControllers

func (c *Client) UpdateNumberOfDomainControllers(ctx context.Context, params *UpdateNumberOfDomainControllersInput, optFns ...func(*Options)) (*UpdateNumberOfDomainControllersOutput, error)

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.

func (*Client) UpdateRadius

func (c *Client) UpdateRadius(ctx context.Context, params *UpdateRadiusInput, optFns ...func(*Options)) (*UpdateRadiusOutput, error)

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.

func (*Client) UpdateTrust

func (c *Client) UpdateTrust(ctx context.Context, params *UpdateTrustInput, optFns ...func(*Options)) (*UpdateTrustOutput, error)

Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.

func (*Client) VerifyTrust

func (c *Client) VerifyTrust(ctx context.Context, params *VerifyTrustInput, optFns ...func(*Options)) (*VerifyTrustOutput, error)

AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.

type ConnectDirectoryInput

type ConnectDirectoryInput struct {
	// The password for the on-premises user account.
	Password *string
	// The size of the directory.
	Size types.DirectorySize
	// The fully qualified name of the on-premises directory, such as corp.example.com.
	Name *string
	// A DirectoryConnectSettings () object that contains additional information for
	// the operation.
	ConnectSettings *types.DirectoryConnectSettings
	// The NetBIOS name of the on-premises directory, such as CORP.
	ShortName *string
	// The tags to be assigned to AD Connector.
	Tags []*types.Tag
	// A description for the directory.
	Description *string
}

Contains the inputs for the ConnectDirectory () operation.

type ConnectDirectoryOutput

type ConnectDirectoryOutput struct {
	// The identifier of the new directory.
	DirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the ConnectDirectory () operation.

type CreateAliasInput

type CreateAliasInput struct {
	// The identifier of the directory for which to create the alias.
	DirectoryId *string
	// The requested alias. The alias must be unique amongst all aliases in AWS. This
	// operation throws an EntityAlreadyExistsException error if the alias already
	// exists.
	Alias *string
}

Contains the inputs for the CreateAlias () operation.

type CreateAliasOutput

type CreateAliasOutput struct {
	// The alias for the directory.
	Alias *string
	// The identifier of the directory.
	DirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the CreateAlias () operation.

type CreateComputerInput

type CreateComputerInput struct {
	// The fully-qualified distinguished name of the organizational unit to place the
	// computer account in.
	OrganizationalUnitDistinguishedName *string
	// The identifier of the directory in which to create the computer account.
	DirectoryId *string
	// The name of the computer account.
	ComputerName *string
	// A one-time password that is used to join the computer to the directory. You
	// should generate a random, strong password to use for this parameter.
	Password *string
	// An array of Attribute () objects that contain any LDAP attributes to apply to
	// the computer account.
	ComputerAttributes []*types.Attribute
}

Contains the inputs for the CreateComputer () operation.

type CreateComputerOutput

type CreateComputerOutput struct {
	// A Computer () object that represents the computer account.
	Computer *types.Computer

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results for the CreateComputer () operation.

type CreateConditionalForwarderInput

type CreateConditionalForwarderInput struct {
	// The directory ID of the AWS directory for which you are creating the conditional
	// forwarder.
	DirectoryId *string
	// The IP addresses of the remote DNS server associated with RemoteDomainName.
	DnsIpAddrs []*string
	// The fully qualified domain name (FQDN) of the remote domain with which you will
	// set up a trust relationship.
	RemoteDomainName *string
}

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.

type CreateConditionalForwarderOutput

type CreateConditionalForwarderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a CreateConditinalForwarder request.

type CreateDirectoryInput

type CreateDirectoryInput struct {
	// A description for the directory.
	Description *string
	// The size of the directory.
	Size types.DirectorySize
	// The fully qualified name for the directory, such as corp.example.com.
	Name *string
	// The password for the directory administrator. The directory creation process
	// creates a directory administrator account with the user name Administrator and
	// this password. If you need to change the password for the administrator account,
	// you can use the ResetUserPassword () API call.
	Password *string
	// A DirectoryVpcSettings () object that contains additional information for the
	// operation.
	VpcSettings *types.DirectoryVpcSettings
	// The NetBIOS name of the directory, such as CORP.
	ShortName *string
	// The tags to be assigned to the Simple AD directory.
	Tags []*types.Tag
}

Contains the inputs for the CreateDirectory () operation.

type CreateDirectoryOutput

type CreateDirectoryOutput struct {
	// The identifier of the directory that was created.
	DirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the CreateDirectory () operation.

type CreateLogSubscriptionInput

type CreateLogSubscriptionInput struct {
	// Identifier of the directory to which you want to subscribe and receive real-time
	// logs to your specified CloudWatch log group.
	DirectoryId *string
	// The name of the CloudWatch log group where the real-time domain controller logs
	// are forwarded.
	LogGroupName *string
}

type CreateLogSubscriptionOutput

type CreateLogSubscriptionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateMicrosoftADInput

type CreateMicrosoftADInput struct {
	// The tags to be assigned to the AWS Managed Microsoft AD directory.
	Tags []*types.Tag
	// A description for the directory. This label will appear on the AWS console
	// Directory Details page after the directory is created.
	Description *string
	// The fully qualified domain name for the AWS Managed Microsoft AD directory, such
	// as corp.example.com. This name will resolve inside your VPC only. It does not
	// need to be publicly resolvable.
	Name *string
	// The password for the default administrative user named Admin. If you need to
	// change the password for the administrator account, you can use the
	// ResetUserPassword () API call.
	Password *string
	// AWS Managed Microsoft AD is available in two editions: Standard and Enterprise.
	// Enterprise is the default.
	Edition types.DirectoryEdition
	// The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS
	// name, it will default to the first part of your directory DNS. For example, CORP
	// for the directory DNS corp.example.com.
	ShortName *string
	// Contains VPC information for the CreateDirectory () or CreateMicrosoftAD ()
	// operation.
	VpcSettings *types.DirectoryVpcSettings
}

Creates an AWS Managed Microsoft AD directory.

type CreateMicrosoftADOutput

type CreateMicrosoftADOutput struct {
	// The identifier of the directory that was created.
	DirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Result of a CreateMicrosoftAD request.

type CreateSnapshotInput

type CreateSnapshotInput struct {
	// The descriptive name to apply to the snapshot.
	Name *string
	// The identifier of the directory of which to take a snapshot.
	DirectoryId *string
}

Contains the inputs for the CreateSnapshot () operation.

type CreateSnapshotOutput

type CreateSnapshotOutput struct {
	// The identifier of the snapshot that was created.
	SnapshotId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the CreateSnapshot () operation.

type CreateTrustInput

type CreateTrustInput struct {
	// The Directory ID of the AWS Managed Microsoft AD directory for which to
	// establish the trust relationship.
	DirectoryId *string
	// The Fully Qualified Domain Name (FQDN) of the external domain for which to
	// create the trust relationship.
	RemoteDomainName *string
	// Optional parameter to enable selective authentication for the trust.
	SelectiveAuth types.SelectiveAuth
	// The trust relationship type. Forest is the default.
	TrustType types.TrustType
	// The direction of the trust relationship.
	TrustDirection types.TrustDirection
	// The IP addresses of the remote DNS server associated with RemoteDomainName.
	ConditionalForwarderIpAddrs []*string
	// The trust password. The must be the same password that was used when creating
	// the trust relationship on the external domain.
	TrustPassword *string
}

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, 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 an AWS Managed Microsoft AD directory and an external domain.

type CreateTrustOutput

type CreateTrustOutput struct {
	// A unique identifier for the trust relationship that was created.
	TrustId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a CreateTrust request.

type DeleteConditionalForwarderInput

type DeleteConditionalForwarderInput struct {
	// The directory ID for which you are deleting the conditional forwarder.
	DirectoryId *string
	// The fully qualified domain name (FQDN) of the remote domain with which you are
	// deleting the conditional forwarder.
	RemoteDomainName *string
}

Deletes a conditional forwarder.

type DeleteConditionalForwarderOutput

type DeleteConditionalForwarderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DeleteConditionalForwarder request.

type DeleteDirectoryInput

type DeleteDirectoryInput struct {
	// The identifier of the directory to delete.
	DirectoryId *string
}

Contains the inputs for the DeleteDirectory () operation.

type DeleteDirectoryOutput

type DeleteDirectoryOutput struct {
	// The directory identifier.
	DirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the DeleteDirectory () operation.

type DeleteLogSubscriptionInput

type DeleteLogSubscriptionInput struct {
	// Identifier of the directory whose log subscription you want to delete.
	DirectoryId *string
}

type DeleteLogSubscriptionOutput

type DeleteLogSubscriptionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteSnapshotInput

type DeleteSnapshotInput struct {
	// The identifier of the directory snapshot to be deleted.
	SnapshotId *string
}

Contains the inputs for the DeleteSnapshot () operation.

type DeleteSnapshotOutput

type DeleteSnapshotOutput struct {
	// The identifier of the directory snapshot that was deleted.
	SnapshotId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the DeleteSnapshot () operation.

type DeleteTrustInput

type DeleteTrustInput struct {
	// Delete a conditional forwarder as part of a DeleteTrustRequest.
	DeleteAssociatedConditionalForwarder *bool
	// The Trust ID of the trust relationship to be deleted.
	TrustId *string
}

Deletes the local side of an existing trust relationship between the AWS Managed Microsoft AD directory and the external domain.

type DeleteTrustOutput

type DeleteTrustOutput struct {
	// The Trust ID of the trust relationship that was deleted.
	TrustId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DeleteTrust request.

type DeregisterCertificateInput

type DeregisterCertificateInput struct {
	// The identifier of the directory.
	DirectoryId *string
	// The identifier of the certificate.
	CertificateId *string
}

type DeregisterCertificateOutput

type DeregisterCertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeregisterEventTopicInput

type DeregisterEventTopicInput struct {
	// The name of the SNS topic from which to remove the directory as a publisher.
	TopicName *string
	// The Directory ID to remove as a publisher. This directory will no longer send
	// messages to the specified SNS topic.
	DirectoryId *string
}

Removes the specified directory as a publisher to the specified SNS topic.

type DeregisterEventTopicOutput

type DeregisterEventTopicOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DeregisterEventTopic request.

type DescribeCertificateInput

type DescribeCertificateInput struct {
	// The identifier of the certificate.
	CertificateId *string
	// The identifier of the directory.
	DirectoryId *string
}

type DescribeCertificateOutput

type DescribeCertificateOutput struct {
	// Information about the certificate, including registered date time, certificate
	// state, the reason for the state, expiration date time, and certificate common
	// name.
	Certificate *types.Certificate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeConditionalForwardersInput

type DescribeConditionalForwardersInput struct {
	// The fully qualified domain names (FQDN) of the remote domains for which to get
	// the list of associated conditional forwarders. If this member is null, all
	// conditional forwarders are returned.
	RemoteDomainNames []*string
	// The directory ID for which to get the list of associated conditional forwarders.
	DirectoryId *string
}

Describes a conditional forwarder.

type DescribeConditionalForwardersOutput

type DescribeConditionalForwardersOutput struct {
	// The list of conditional forwarders that have been created.
	ConditionalForwarders []*types.ConditionalForwarder

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DescribeConditionalForwarder request.

type DescribeDirectoriesInput

type DescribeDirectoriesInput struct {
	// The DescribeDirectoriesResult.NextToken value from a previous call to
	// DescribeDirectories (). Pass null if this is the first call.
	NextToken *string
	// The maximum number of items to return. If this value is zero, the maximum number
	// of items is specified by the limitations of the operation.
	Limit *int32
	// A list of identifiers of the directories for which to obtain the information. If
	// this member is null, all directories that belong to the current account are
	// returned. An empty list results in an InvalidParameterException being thrown.
	DirectoryIds []*string
}

Contains the inputs for the DescribeDirectories () operation.

type DescribeDirectoriesOutput

type DescribeDirectoriesOutput struct {
	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to DescribeDirectories () to retrieve the next
	// set of items.
	NextToken *string
	// The list of DirectoryDescription () objects that were retrieved. It is possible
	// that this list contains less than the number of items specified in the Limit
	// member of the request. This occurs if there are less than the requested number
	// of items left to retrieve, or if the limitations of the operation have been
	// exceeded.
	DirectoryDescriptions []*types.DirectoryDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the DescribeDirectories () operation.

type DescribeDomainControllersInput

type DescribeDomainControllersInput struct {
	// The DescribeDomainControllers.NextToken value from a previous call to
	// DescribeDomainControllers (). Pass null if this is the first call.
	NextToken *string
	// Identifier of the directory for which to retrieve the domain controller
	// information.
	DirectoryId *string
	// A list of identifiers for the domain controllers whose information will be
	// provided.
	DomainControllerIds []*string
	// The maximum number of items to return.
	Limit *int32
}

type DescribeDomainControllersOutput

type DescribeDomainControllersOutput struct {
	// List of the DomainController () objects that were retrieved.
	DomainControllers []*types.DomainController
	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to DescribeDomainControllers () retrieve the next
	// set of items.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeEventTopicsInput

type DescribeEventTopicsInput struct {
	// The Directory ID for which to get the list of associated SNS topics. If this
	// member is null, associations for all Directory IDs are returned.
	DirectoryId *string
	// A list of SNS topic names for which to obtain the information. If this member is
	// null, all associations for the specified Directory ID are returned. An empty
	// list results in an InvalidParameterException being thrown.
	TopicNames []*string
}

Describes event topics.

type DescribeEventTopicsOutput

type DescribeEventTopicsOutput struct {
	// A list of SNS topic names that receive status messages from the specified
	// Directory ID.
	EventTopics []*types.EventTopic

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DescribeEventTopic request.

type DescribeLDAPSSettingsInput

type DescribeLDAPSSettingsInput struct {
	// The type of LDAP security to enable. Currently only the value Client is
	// supported.
	Type types.LDAPSType
	// Specifies the number of items that should be displayed on one page.
	Limit *int32
	// The type of next token used for pagination.
	NextToken *string
	// The identifier of the directory.
	DirectoryId *string
}

type DescribeLDAPSSettingsOutput

type DescribeLDAPSSettingsOutput struct {
	// The next token used to retrieve the LDAPS settings if the number of setting
	// types exceeds page limit and there is another page.
	NextToken *string
	// Information about LDAP security for the specified directory, including status of
	// enablement, state last updated date time, and the reason for the state.
	LDAPSSettingsInfo []*types.LDAPSSettingInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSharedDirectoriesInput

type DescribeSharedDirectoriesInput struct {
	// A list of identifiers of all shared directories in your account.
	SharedDirectoryIds []*string
	// The DescribeSharedDirectoriesResult.NextToken value from a previous call to
	// DescribeSharedDirectories (). Pass null if this is the first call.
	NextToken *string
	// The number of shared directories to return in the response object.
	Limit *int32
	// Returns the identifier of the directory in the directory owner account.
	OwnerDirectoryId *string
}

type DescribeSharedDirectoriesOutput

type DescribeSharedDirectoriesOutput struct {
	// A list of all shared directories in your account.
	SharedDirectories []*types.SharedDirectory
	// If not null, token that indicates that more results are available. Pass this
	// value for the NextToken parameter in a subsequent call to
	// DescribeSharedDirectories () to retrieve the next set of items.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSnapshotsInput

type DescribeSnapshotsInput struct {
	// The identifier of the directory for which to retrieve snapshot information.
	DirectoryId *string
	// The maximum number of objects to return.
	Limit *int32
	// A list of identifiers of the snapshots to obtain the information for. If this
	// member is null or empty, all snapshots are returned using the Limit and
	// NextToken members.
	SnapshotIds []*string
	// The DescribeSnapshotsResult.NextToken value from a previous call to
	// DescribeSnapshots (). Pass null if this is the first call.
	NextToken *string
}

Contains the inputs for the DescribeSnapshots () operation.

type DescribeSnapshotsOutput

type DescribeSnapshotsOutput struct {
	// If not null, more results are available. Pass this value in the NextToken member
	// of a subsequent call to DescribeSnapshots ().
	NextToken *string
	// The list of Snapshot () objects that were retrieved. It is possible that this
	// list contains less than the number of items specified in the Limit member of the
	// request. This occurs if there are less than the requested number of items left
	// to retrieve, or if the limitations of the operation have been exceeded.
	Snapshots []*types.Snapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the DescribeSnapshots () operation.

type DescribeTrustsInput

type DescribeTrustsInput struct {
	// The Directory ID of the AWS directory that is a part of the requested trust
	// relationship.
	DirectoryId *string
	// The maximum number of objects to return.
	Limit *int32
	// The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts
	// (). Pass null if this is the first call.
	NextToken *string
	// A list of identifiers of the trust relationships for which to obtain the
	// information. If this member is null, all trust relationships that belong to the
	// current account are returned. An empty list results in an
	// InvalidParameterException being thrown.
	TrustIds []*string
}

Describes the trust relationships for a particular AWS Managed Microsoft AD directory. If no input parameters are are provided, such as directory ID or trust ID, this request describes all the trust relationships.

type DescribeTrustsOutput

type DescribeTrustsOutput struct {
	// The list of Trust objects that were retrieved. It is possible that this list
	// contains less than the number of items specified in the Limit member of the
	// request. This occurs if there are less than the requested number of items left
	// to retrieve, or if the limitations of the operation have been exceeded.
	Trusts []*types.Trust
	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to DescribeTrusts () to retrieve the next set of
	// items.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a DescribeTrust request.

type DisableLDAPSInput

type DisableLDAPSInput struct {
	// The identifier of the directory.
	DirectoryId *string
	// The type of LDAP security to enable. Currently only the value Client is
	// supported.
	Type types.LDAPSType
}

type DisableLDAPSOutput

type DisableLDAPSOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisableRadiusInput

type DisableRadiusInput struct {
	// The identifier of the directory for which to disable MFA.
	DirectoryId *string
}

Contains the inputs for the DisableRadius () operation.

type DisableRadiusOutput

type DisableRadiusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the DisableRadius () operation.

type DisableSsoInput

type DisableSsoInput struct {
	// The username of an alternate account to use to disable single-sign on. This is
	// only used for AD Connector directories. This account must have privileges to
	// remove a service principal name. If the AD Connector service account does not
	// have privileges to remove a service principal name, you can specify an alternate
	// account with the UserName and Password parameters. These credentials are only
	// used to disable single sign-on and are not stored by the service. The AD
	// Connector service account is not changed.
	UserName *string
	// The password of an alternate account to use to disable single-sign on. This is
	// only used for AD Connector directories. For more information, see the UserName
	// parameter.
	Password *string
	// The identifier of the directory for which to disable single-sign on.
	DirectoryId *string
}

Contains the inputs for the DisableSso () operation.

type DisableSsoOutput

type DisableSsoOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the DisableSso () operation.

type EnableLDAPSInput

type EnableLDAPSInput struct {
	// The type of LDAP security to enable. Currently only the value Client is
	// supported.
	Type types.LDAPSType
	// The identifier of the directory.
	DirectoryId *string
}

type EnableLDAPSOutput

type EnableLDAPSOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EnableRadiusInput

type EnableRadiusInput struct {
	// A RadiusSettings () object that contains information about the RADIUS server.
	RadiusSettings *types.RadiusSettings
	// The identifier of the directory for which to enable MFA.
	DirectoryId *string
}

Contains the inputs for the EnableRadius () operation.

type EnableRadiusOutput

type EnableRadiusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the EnableRadius () operation.

type EnableSsoInput

type EnableSsoInput struct {
	// The password of an alternate account to use to enable single-sign on. This is
	// only used for AD Connector directories. For more information, see the UserName
	// parameter.
	Password *string
	// The identifier of the directory for which to enable single-sign on.
	DirectoryId *string
	// The username of an alternate account to use to enable single-sign on. This is
	// only used for AD Connector directories. This account must have privileges to add
	// a service principal name. If the AD Connector service account does not have
	// privileges to add a service principal name, you can specify an alternate account
	// with the UserName and Password parameters. These credentials are only used to
	// enable single sign-on and are not stored by the service. The AD Connector
	// service account is not changed.
	UserName *string
}

Contains the inputs for the EnableSso () operation.

type EnableSsoOutput

type EnableSsoOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the EnableSso () operation.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type GetDirectoryLimitsInput

type GetDirectoryLimitsInput struct {
}

Contains the inputs for the GetDirectoryLimits () operation.

type GetDirectoryLimitsOutput

type GetDirectoryLimitsOutput struct {
	// A DirectoryLimits () object that contains the directory limits for the current
	// rRegion.
	DirectoryLimits *types.DirectoryLimits

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the GetDirectoryLimits () operation.

type GetSnapshotLimitsInput

type GetSnapshotLimitsInput struct {
	// Contains the identifier of the directory to obtain the limits for.
	DirectoryId *string
}

Contains the inputs for the GetSnapshotLimits () operation.

type GetSnapshotLimitsOutput

type GetSnapshotLimitsOutput struct {
	// A SnapshotLimits () object that contains the manual snapshot limits for the
	// specified directory.
	SnapshotLimits *types.SnapshotLimits

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the GetSnapshotLimits () operation.

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type ListCertificatesInput

type ListCertificatesInput struct {
	// The number of items that should show up on one page
	Limit *int32
	// A token for requesting another page of certificates if the NextToken response
	// element indicates that more certificates are available. Use the value of the
	// returned NextToken element in your request until the token comes back as null.
	// Pass null if this is the first call.
	NextToken *string
	// The identifier of the directory.
	DirectoryId *string
}

type ListCertificatesOutput

type ListCertificatesOutput struct {
	// Indicates whether another page of certificates is available when the number of
	// available certificates exceeds the page limit.
	NextToken *string
	// A list of certificates with basic details including certificate ID, certificate
	// common name, certificate state.
	CertificatesInfo []*types.CertificateInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListIpRoutesInput

type ListIpRoutesInput struct {
	// Identifier (ID) of the directory for which you want to retrieve the IP
	// addresses.
	DirectoryId *string
	// Maximum number of items to return. If this value is zero, the maximum number of
	// items is specified by the limitations of the operation.
	Limit *int32
	// The ListIpRoutes.NextToken value from a previous call to ListIpRoutes (). Pass
	// null if this is the first call.
	NextToken *string
}

type ListIpRoutesOutput

type ListIpRoutesOutput struct {
	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to ListIpRoutes () to retrieve the next set of
	// items.
	NextToken *string
	// A list of IpRoute ()s.
	IpRoutesInfo []*types.IpRouteInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListLogSubscriptionsInput

type ListLogSubscriptionsInput struct {
	// The token for the next set of items to return.
	NextToken *string
	// If a DirectoryID is provided, lists only the log subscription associated with
	// that directory. If no DirectoryId is provided, lists all log subscriptions
	// associated with your AWS account. If there are no log subscriptions for the AWS
	// account or the directory, an empty list will be returned.
	DirectoryId *string
	// The maximum number of items returned.
	Limit *int32
}

type ListLogSubscriptionsOutput

type ListLogSubscriptionsOutput struct {
	// The token for the next set of items to return.
	NextToken *string
	// A list of active LogSubscription () objects for calling the AWS account.
	LogSubscriptions []*types.LogSubscription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSchemaExtensionsInput

type ListSchemaExtensionsInput struct {
	// The ListSchemaExtensions.NextToken value from a previous call to
	// ListSchemaExtensions. Pass null if this is the first call.
	NextToken *string
	// The identifier of the directory from which to retrieve the schema extension
	// information.
	DirectoryId *string
	// The maximum number of items to return.
	Limit *int32
}

type ListSchemaExtensionsOutput

type ListSchemaExtensionsOutput struct {
	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to ListSchemaExtensions to retrieve the next set
	// of items.
	NextToken *string
	// Information about the schema extensions applied to the directory.
	SchemaExtensionsInfo []*types.SchemaExtensionInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTagsForResourceInput

type ListTagsForResourceInput struct {
	// Reserved for future use.
	NextToken *string
	// Identifier (ID) of the directory for which you want to retrieve tags.
	ResourceId *string
	// Reserved for future use.
	Limit *int32
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {
	// Reserved for future use.
	NextToken *string
	// List of tags returned by the ListTagsForResource operation.
	Tags []*types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type RegisterCertificateInput

type RegisterCertificateInput struct {
	// The identifier of the directory.
	DirectoryId *string
	// The certificate PEM string that needs to be registered.
	CertificateData *string
}

type RegisterCertificateOutput

type RegisterCertificateOutput struct {
	// The identifier of the certificate.
	CertificateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RegisterEventTopicInput

type RegisterEventTopicInput struct {
	// The SNS topic name to which the directory will publish status messages. This SNS
	// topic must be in the same region as the specified Directory ID.
	TopicName *string
	// The Directory ID that will publish status messages to the SNS topic.
	DirectoryId *string
}

Registers a new event topic.

type RegisterEventTopicOutput

type RegisterEventTopicOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a RegisterEventTopic request.

type RejectSharedDirectoryInput

type RejectSharedDirectoryInput struct {
	// Identifier of the shared directory in the directory consumer account. This
	// identifier is different for each directory owner account.
	SharedDirectoryId *string
}

type RejectSharedDirectoryOutput

type RejectSharedDirectoryOutput struct {
	// Identifier of the shared directory in the directory consumer account.
	SharedDirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RemoveIpRoutesInput

type RemoveIpRoutesInput struct {
	// Identifier (ID) of the directory from which you want to remove the IP addresses.
	DirectoryId *string
	// IP address blocks that you want to remove.
	CidrIps []*string
}

type RemoveIpRoutesOutput

type RemoveIpRoutesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RemoveTagsFromResourceInput

type RemoveTagsFromResourceInput struct {
	// Identifier (ID) of the directory from which to remove the tag.
	ResourceId *string
	// The tag key (name) of the tag to be removed.
	TagKeys []*string
}

type RemoveTagsFromResourceOutput

type RemoveTagsFromResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResetUserPasswordInput

type ResetUserPasswordInput struct {
	// The new password that will be reset.
	NewPassword *string
	// Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the
	// user resides.
	DirectoryId *string
	// The user name of the user whose password will be reset.
	UserName *string
}

type ResetUserPasswordOutput

type ResetUserPasswordOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type RestoreFromSnapshotInput

type RestoreFromSnapshotInput struct {
	// The identifier of the snapshot to restore from.
	SnapshotId *string
}

An object representing the inputs for the RestoreFromSnapshot () operation.

type RestoreFromSnapshotOutput

type RestoreFromSnapshotOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the RestoreFromSnapshot () operation.

type ShareDirectoryInput

type ShareDirectoryInput struct {
	// Identifier of the AWS Managed Microsoft AD directory that you want to share with
	// other AWS accounts.
	DirectoryId *string
	// Identifier for the directory consumer account with whom the directory is to be
	// shared.
	ShareTarget *types.ShareTarget
	// A directory share request that is sent by the directory owner to the directory
	// consumer. The request includes a typed message to help the directory consumer
	// administrator determine whether to approve or reject the share invitation.
	ShareNotes *string
	// The method used when sharing a directory to determine whether the directory
	// should be shared within your AWS organization (ORGANIZATIONS) or with any AWS
	// account by sending a directory sharing request (HANDSHAKE).
	ShareMethod types.ShareMethod
}

type ShareDirectoryOutput

type ShareDirectoryOutput struct {
	// Identifier of the directory that is stored in the directory consumer account
	// that is shared from the specified directory (DirectoryId).
	SharedDirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartSchemaExtensionInput

type StartSchemaExtensionInput struct {
	// The LDIF file represented as a string. To construct the LdifContent string,
	// precede each line as it would be formatted in an ldif file with \n. See the
	// example request below for more details. The file size can be no larger than 1MB.
	LdifContent *string
	// The identifier of the directory for which the schema extension will be applied
	// to.
	DirectoryId *string
	// A description of the schema extension.
	Description *string
	// If true, creates a snapshot of the directory before applying the schema
	// extension.
	CreateSnapshotBeforeSchemaExtension *bool
}

type StartSchemaExtensionOutput

type StartSchemaExtensionOutput struct {
	// The identifier of the schema extension that will be applied.
	SchemaExtensionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UnshareDirectoryInput

type UnshareDirectoryInput struct {
	// The identifier of the AWS Managed Microsoft AD directory that you want to stop
	// sharing.
	DirectoryId *string
	// Identifier for the directory consumer account with whom the directory has to be
	// unshared.
	UnshareTarget *types.UnshareTarget
}

type UnshareDirectoryOutput

type UnshareDirectoryOutput struct {
	// Identifier of the directory stored in the directory consumer account that is to
	// be unshared from the specified directory (DirectoryId).
	SharedDirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateConditionalForwarderInput

type UpdateConditionalForwarderInput struct {
	// The fully qualified domain name (FQDN) of the remote domain with which you will
	// set up a trust relationship.
	RemoteDomainName *string
	// The directory ID of the AWS directory for which to update the conditional
	// forwarder.
	DirectoryId *string
	// The updated IP addresses of the remote DNS server associated with the
	// conditional forwarder.
	DnsIpAddrs []*string
}

Updates a conditional forwarder.

type UpdateConditionalForwarderOutput

type UpdateConditionalForwarderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of an UpdateConditionalForwarder request.

type UpdateNumberOfDomainControllersInput

type UpdateNumberOfDomainControllersInput struct {
	// Identifier of the directory to which the domain controllers will be added or
	// removed.
	DirectoryId *string
	// The number of domain controllers desired in the directory.
	DesiredNumber *int32
}

type UpdateNumberOfDomainControllersOutput

type UpdateNumberOfDomainControllersOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateRadiusInput

type UpdateRadiusInput struct {
	// A RadiusSettings () object that contains information about the RADIUS server.
	RadiusSettings *types.RadiusSettings
	// The identifier of the directory for which to update the RADIUS server
	// information.
	DirectoryId *string
}

Contains the inputs for the UpdateRadius () operation.

type UpdateRadiusOutput

type UpdateRadiusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the results of the UpdateRadius () operation.

type UpdateTrustInput

type UpdateTrustInput struct {
	// Updates selective authentication for the trust.
	SelectiveAuth types.SelectiveAuth
	// Identifier of the trust relationship.
	TrustId *string
}

type UpdateTrustOutput

type UpdateTrustOutput struct {
	// The AWS request identifier.
	RequestId *string
	// Identifier of the trust relationship.
	TrustId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type VerifyTrustInput

type VerifyTrustInput struct {
	// The unique Trust ID of the trust relationship to verify.
	TrustId *string
}

Initiates the verification of an existing trust relationship between an AWS Managed Microsoft AD directory and an external domain.

type VerifyTrustOutput

type VerifyTrustOutput struct {
	// The unique Trust ID of the trust relationship that was verified.
	TrustId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Result of a VerifyTrust request.

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL