AWS Classic v6.13.2, Dec 7 23

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.2 published on Thursday, Dec 7, 2023 by Pulumi

pulumi/pulumi-aws

aws.transfer.getServer

Explore with Pulumi AI

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.2 published on Thursday, Dec 7, 2023 by Pulumi

pulumi/pulumi-aws

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Transfer.GetServer.Invoke(new()
    {
        ServerId = "s-1234567",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/transfer"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.transfer.TransferFunctions;
import com.pulumi.aws.transfer.inputs.GetServerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = TransferFunctions.getServer(GetServerArgs.builder()
            .serverId("s-1234567")
            .build());

    }
}

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 = aws.transfer.getServer({
    serverId: "s-1234567",
});

variables:
  example:
    fn::invoke:
      Function: aws:transfer:getServer
      Arguments:
        serverId: s-1234567

Using getServer

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOptions): Output<GetServerResult>

def get_server(server_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetServerResult
def get_server_output(server_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetServerResult]

func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput

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

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

public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:transfer/getServer:getServer
  arguments:
    # arguments dictionary

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.

serverId string: ID for an SFTP server.

server_id str: ID for an SFTP server.

serverId String: ID for an SFTP server.

getServer Result

The following output properties are available:

Arn string: ARN of Transfer Server.
Certificate string: ARN of any certificate.
Domain string: The domain of the storage system that is used for file transfers.
Endpoint string: Endpoint of the Transfer Server (e.g., s-12345678.server.transfer.REGION.amazonaws.com).
EndpointType string: Type of endpoint that the server is connected to.
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: ARN of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.
LoggingRole 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.
Protocols List<string>: File transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
SecurityPolicyName string: The name of the security policy that is attached to the server.
ServerId string
StructuredLogDestinations List<string>: A set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs.
Url string: URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.

Arn string: ARN of Transfer Server.
Certificate string: ARN of any certificate.
Domain string: The domain of the storage system that is used for file transfers.
Endpoint string: Endpoint of the Transfer Server (e.g., s-12345678.server.transfer.REGION.amazonaws.com).
EndpointType string: Type of endpoint that the server is connected to.
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: ARN of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.
LoggingRole 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.
Protocols []string: File transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
SecurityPolicyName string: The name of the security policy that is attached to the server.
ServerId string
StructuredLogDestinations []string: A set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs.
Url string: URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.

arn String: ARN of Transfer Server.
certificate String: ARN of any certificate.
domain String: The domain of the storage system that is used for file transfers.
endpoint String: Endpoint of the Transfer Server (e.g., s-12345678.server.transfer.REGION.amazonaws.com).
endpointType String: Type of endpoint that the server is connected to.
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: ARN of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.
loggingRole 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.
protocols List<String>: File transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
securityPolicyName String: The name of the security policy that is attached to the server.
serverId String
structuredLogDestinations List<String>: A set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs.
url String: URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.

arn string: ARN of Transfer Server.
certificate string: ARN of any certificate.
domain string: The domain of the storage system that is used for file transfers.
endpoint string: Endpoint of the Transfer Server (e.g., s-12345678.server.transfer.REGION.amazonaws.com).
endpointType string: Type of endpoint that the server is connected to.
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: ARN of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.
loggingRole 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.
protocols string[]: File transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
securityPolicyName string: The name of the security policy that is attached to the server.
serverId string
structuredLogDestinations string[]: A set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs.
url string: URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.

arn str: ARN of Transfer Server.
certificate str: ARN of any certificate.
domain str: The domain of the storage system that is used for file transfers.
endpoint str: Endpoint of the Transfer Server (e.g., s-12345678.server.transfer.REGION.amazonaws.com).
endpoint_type str: Type of endpoint that the server is connected to.
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: ARN of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.
logging_role str: 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.
protocols Sequence[str]: File transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
security_policy_name str: The name of the security policy that is attached to the server.
server_id str
structured_log_destinations Sequence[str]: A set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs.
url str: URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.

arn String: ARN of Transfer Server.
certificate String: ARN of any certificate.
domain String: The domain of the storage system that is used for file transfers.
endpoint String: Endpoint of the Transfer Server (e.g., s-12345678.server.transfer.REGION.amazonaws.com).
endpointType String: Type of endpoint that the server is connected to.
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: ARN of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.
loggingRole 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.
protocols List<String>: File transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
securityPolicyName String: The name of the security policy that is attached to the server.
serverId String
structuredLogDestinations List<String>: A set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs.
url String: URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.

Package Details

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

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.2 published on Thursday, Dec 7, 2023 by Pulumi

pulumi/pulumi-aws

aws.transfer.getServer

On this page

On this page

Example Usage

Using getServer

getServer Result

Package Details

On this page

On this page