@pulumi/aws/directoryservice/getDirectory.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Get attributes of AWS Directory Service directory (SimpleAD, Managed AD, AD Connector). It's especially useful to refer AWS Managed AD or on-premise AD in AD Connector configuration.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.directoryservice.getDirectory({
 *     directoryId: main.id,
 * });
 * ```
 */
export declare function getDirectory(args: GetDirectoryArgs, opts?: pulumi.InvokeOptions): Promise<GetDirectoryResult>;
/**
 * A collection of arguments for invoking getDirectory.
 */
export interface GetDirectoryArgs {
    /**
     * ID of the directory.
     */
    directoryId: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * A map of tags assigned to the directory/connector.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getDirectory.
 */
export interface GetDirectoryResult {
    /**
     * Access URL for the directory/connector, such as http://alias.awsapps.com.
     */
    readonly accessUrl: string;
    /**
     * Alias for the directory/connector, such as `d-991708b282.awsapps.com`.
     */
    readonly alias: string;
    readonly connectSettings: outputs.directoryservice.GetDirectoryConnectSetting[];
    /**
     * Textual description for the directory/connector.
     */
    readonly description: string;
    readonly directoryId: string;
    /**
     * List of IP addresses of the DNS servers for the directory/connector.
     */
    readonly dnsIpAddresses: string[];
    /**
     * (for `MicrosoftAD`) Microsoft AD edition (`Standard` or `Enterprise`).
     */
    readonly edition: string;
    /**
     * Directory/connector single-sign on status.
     */
    readonly enableSso: boolean;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Fully qualified name for the directory/connector.
     */
    readonly name: string;
    readonly radiusSettings: outputs.directoryservice.GetDirectoryRadiusSetting[];
    readonly region: string;
    /**
     * ID of the security group created by the directory/connector.
     */
    readonly securityGroupId: string;
    /**
     * Short name of the directory/connector, such as `CORP`.
     */
    readonly shortName: string;
    /**
     * (for `SimpleAD` and `ADConnector`) Size of the directory/connector (`Small` or `Large`).
     */
    readonly size: string;
    /**
     * A map of tags assigned to the directory/connector.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * Directory type (`SimpleAD`, `ADConnector` or `MicrosoftAD`).
     */
    readonly type: string;
    readonly vpcSettings: outputs.directoryservice.GetDirectoryVpcSetting[];
}
/**
 * Get attributes of AWS Directory Service directory (SimpleAD, Managed AD, AD Connector). It's especially useful to refer AWS Managed AD or on-premise AD in AD Connector configuration.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.directoryservice.getDirectory({
 *     directoryId: main.id,
 * });
 * ```
 */
export declare function getDirectoryOutput(args: GetDirectoryOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDirectoryResult>;
/**
 * A collection of arguments for invoking getDirectory.
 */
export interface GetDirectoryOutputArgs {
    /**
     * ID of the directory.
     */
    directoryId: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * A map of tags assigned to the directory/connector.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}