@pulumi/aws/transfer/getServer.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * Use this data source to get the ARN of an AWS Transfer Server for use in other
 * resources.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.transfer.getServer({
 *     serverId: "s-1234567",
 * });
 * ```
 */
export declare function getServer(args: GetServerArgs, opts?: pulumi.InvokeOptions): Promise<GetServerResult>;
/**
 * A collection of arguments for invoking getServer.
 */
export interface GetServerArgs {
    /**
     * 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;
    /**
     * ID for an SFTP server.
     */
    serverId: string;
    /**
     * Map of tags assigned to the resource.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getServer.
 */
export interface GetServerResult {
    /**
     * ARN of Transfer Server.
     */
    readonly arn: string;
    /**
     * ARN of any certificate.
     */
    readonly certificate: string;
    /**
     * The domain of the storage system that is used for file transfers.
     */
    readonly domain: string;
    /**
     * Endpoint of the Transfer Server (e.g., `s-12345678.server.transfer.REGION.amazonaws.com`).
     */
    readonly endpoint: string;
    /**
     * Type of endpoint that the server is connected to.
     */
    readonly endpointType: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The mode of authentication enabled for this service. The default value is `SERVICE_MANAGED`, which allows you to store and access SFTP user credentials within the service. `API_GATEWAY` indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.
     */
    readonly identityProviderType: string;
    /**
     * ARN of the IAM role used to authenticate the user account with an `identityProviderType` of `API_GATEWAY`.
     */
    readonly invocationRole: string;
    /**
     * ARN of an IAM role that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
     */
    readonly loggingRole: string;
    /**
     * File transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
     */
    readonly protocols: string[];
    readonly region: string;
    /**
     * The name of the security policy that is attached to the server.
     */
    readonly securityPolicyName: string;
    readonly serverId: string;
    /**
     * A set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs.
     */
    readonly structuredLogDestinations: string[];
    /**
     * Map of tags assigned to the resource.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * URL of the service endpoint used to authenticate users with an `identityProviderType` of `API_GATEWAY`.
     */
    readonly url: string;
}
/**
 * Use this data source to get the ARN of an AWS Transfer Server for use in other
 * resources.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.transfer.getServer({
 *     serverId: "s-1234567",
 * });
 * ```
 */
export declare function getServerOutput(args: GetServerOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetServerResult>;
/**
 * A collection of arguments for invoking getServer.
 */
export interface GetServerOutputArgs {
    /**
     * 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>;
    /**
     * ID for an SFTP server.
     */
    serverId: pulumi.Input<string>;
    /**
     * Map of tags assigned to the resource.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}