|
| 1 | +// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. *** |
| 2 | +// *** Do not edit by hand unless you're certain you know what you are doing! *** |
| 3 | + |
| 4 | +import * as pulumi from "@pulumi/pulumi"; |
| 5 | +import * as utilities from "../utilities"; |
| 6 | + |
| 7 | +/** |
| 8 | + * Use this data source to get the ARN of an AWS Transfer Server for use in other |
| 9 | + * resources. |
| 10 | + * |
| 11 | + * ## Example Usage |
| 12 | + * |
| 13 | + * ```typescript |
| 14 | + * import * as pulumi from "@pulumi/pulumi"; |
| 15 | + * import * as aws from "@pulumi/aws"; |
| 16 | + * |
| 17 | + * const example = aws.transfer.getServer({ |
| 18 | + * serverId: "s-1234567", |
| 19 | + * }); |
| 20 | + * ``` |
| 21 | + */ |
| 22 | +export function getServer(args: GetServerArgs, opts?: pulumi.InvokeOptions): Promise<GetServerResult> { |
| 23 | + |
| 24 | + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); |
| 25 | + return pulumi.runtime.invoke("aws:transfer/getServer:getServer", { |
| 26 | + "serverId": args.serverId, |
| 27 | + }, opts); |
| 28 | +} |
| 29 | + |
| 30 | +/** |
| 31 | + * A collection of arguments for invoking getServer. |
| 32 | + */ |
| 33 | +export interface GetServerArgs { |
| 34 | + /** |
| 35 | + * ID for an SFTP server. |
| 36 | + */ |
| 37 | + serverId: string; |
| 38 | +} |
| 39 | + |
| 40 | +/** |
| 41 | + * A collection of values returned by getServer. |
| 42 | + */ |
| 43 | +export interface GetServerResult { |
| 44 | + /** |
| 45 | + * ARN of Transfer Server. |
| 46 | + */ |
| 47 | + readonly arn: string; |
| 48 | + /** |
| 49 | + * ARN of any certificate. |
| 50 | + */ |
| 51 | + readonly certificate: string; |
| 52 | + /** |
| 53 | + * The domain of the storage system that is used for file transfers. |
| 54 | + */ |
| 55 | + readonly domain: string; |
| 56 | + /** |
| 57 | + * Endpoint of the Transfer Server (e.g., `s-12345678.server.transfer.REGION.amazonaws.com`). |
| 58 | + */ |
| 59 | + readonly endpoint: string; |
| 60 | + /** |
| 61 | + * Type of endpoint that the server is connected to. |
| 62 | + */ |
| 63 | + readonly endpointType: string; |
| 64 | + /** |
| 65 | + * The provider-assigned unique ID for this managed resource. |
| 66 | + */ |
| 67 | + readonly id: string; |
| 68 | + /** |
| 69 | + * 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. |
| 70 | + */ |
| 71 | + readonly identityProviderType: string; |
| 72 | + /** |
| 73 | + * ARN of the IAM role used to authenticate the user account with an `identityProviderType` of `API_GATEWAY`. |
| 74 | + */ |
| 75 | + readonly invocationRole: string; |
| 76 | + /** |
| 77 | + * 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. |
| 78 | + */ |
| 79 | + readonly loggingRole: string; |
| 80 | + /** |
| 81 | + * File transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. |
| 82 | + */ |
| 83 | + readonly protocols: string[]; |
| 84 | + /** |
| 85 | + * The name of the security policy that is attached to the server. |
| 86 | + */ |
| 87 | + readonly securityPolicyName: string; |
| 88 | + readonly serverId: string; |
| 89 | + /** |
| 90 | + * URL of the service endpoint used to authenticate users with an `identityProviderType` of `API_GATEWAY`. |
| 91 | + */ |
| 92 | + readonly url: string; |
| 93 | +} |
| 94 | +/** |
| 95 | + * Use this data source to get the ARN of an AWS Transfer Server for use in other |
| 96 | + * resources. |
| 97 | + * |
| 98 | + * ## Example Usage |
| 99 | + * |
| 100 | + * ```typescript |
| 101 | + * import * as pulumi from "@pulumi/pulumi"; |
| 102 | + * import * as aws from "@pulumi/aws"; |
| 103 | + * |
| 104 | + * const example = aws.transfer.getServer({ |
| 105 | + * serverId: "s-1234567", |
| 106 | + * }); |
| 107 | + * ``` |
| 108 | + */ |
| 109 | +export function getServerOutput(args: GetServerOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetServerResult> { |
| 110 | + return pulumi.output(args).apply((a: any) => getServer(a, opts)) |
| 111 | +} |
| 112 | + |
| 113 | +/** |
| 114 | + * A collection of arguments for invoking getServer. |
| 115 | + */ |
| 116 | +export interface GetServerOutputArgs { |
| 117 | + /** |
| 118 | + * ID for an SFTP server. |
| 119 | + */ |
| 120 | + serverId: pulumi.Input<string>; |
| 121 | +} |
0 commit comments