1. Docs
  2. Reference
  3. API
  4. AWS
  5. transfer
  6. GetServer

GetServer

Use this data source to get the ARN of an AWS Transfer Server for use in other resources.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.Transfer.GetServer.InvokeAsync(new Aws.Transfer.GetServerArgs
        {
            ServerId = "s-1234567",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/transfer"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := transfer.LookupServer(ctx, &transfer.LookupServerArgs{
            ServerId: "s-1234567",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

example = aws.transfer.get_server(server_id="s-1234567")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.transfer.getServer({
    serverId: "s-1234567",
}, { async: true }));

Using GetServer

function getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
function  get_server(server_id=None, opts=None)
func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)

Note: This function is named LookupServer in the Go SDK.

public static class GetServer {
    public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ServerId string

ID for an SFTP server.

ServerId string

ID for an SFTP server.

serverId string

ID for an SFTP server.

server_id str

ID for an SFTP server.

GetServer Result

The following output properties are available:

Arn string

Amazon Resource Name (ARN) of Transfer Server

Endpoint string

The endpoint of the Transfer Server (e.g. s-12345678.server.transfer.REGION.amazonaws.com)

Id string

The provider-assigned unique ID for this managed resource.

IdentityProviderType 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.

InvocationRole string

Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.

LoggingRole string

Amazon Resource Name (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.

ServerId string
Url string

URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.

Arn string

Amazon Resource Name (ARN) of Transfer Server

Endpoint string

The endpoint of the Transfer Server (e.g. s-12345678.server.transfer.REGION.amazonaws.com)

Id string

The provider-assigned unique ID for this managed resource.

IdentityProviderType 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.

InvocationRole string

Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.

LoggingRole string

Amazon Resource Name (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.

ServerId string
Url string

URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.

arn string

Amazon Resource Name (ARN) of Transfer Server

endpoint string

The endpoint of the Transfer Server (e.g. s-12345678.server.transfer.REGION.amazonaws.com)

id string

The provider-assigned unique ID for this managed resource.

identityProviderType 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.

invocationRole string

Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.

loggingRole string

Amazon Resource Name (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.

serverId string
url string

URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.

arn str

Amazon Resource Name (ARN) of Transfer Server

endpoint str

The endpoint of the Transfer Server (e.g. s-12345678.server.transfer.REGION.amazonaws.com)

id str

The provider-assigned unique ID for this managed resource.

identity_provider_type str

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.

invocation_role str

Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.

logging_role str

Amazon Resource Name (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.

server_id str
url str

URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.