aws.transfer.getServer
Use this data source to get the ARN of an AWS Transfer Server for use in other resources.
Example Usage
using System.Collections.Generic;
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/v5/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:
- Server
Id string ID for an SFTP server.
- Server
Id string ID for an SFTP server.
- server
Id String ID for an SFTP server.
- server
Id string ID for an SFTP server.
- server_
id str ID for an SFTP server.
- server
Id 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
).- Endpoint
Type string Type of endpoint that the server is connected to.
- Id string
The provider-assigned unique ID for this managed resource.
- Identity
Provider stringType 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 string ARN of the IAM role used to authenticate the user account with an
identity_provider_type
ofAPI_GATEWAY
.- Logging
Role 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.
- Security
Policy stringName The name of the security policy that is attached to the server.
- Server
Id string - Url string
URL of the service endpoint used to authenticate users with an
identity_provider_type
ofAPI_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
).- Endpoint
Type string Type of endpoint that the server is connected to.
- Id string
The provider-assigned unique ID for this managed resource.
- Identity
Provider stringType 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 string ARN of the IAM role used to authenticate the user account with an
identity_provider_type
ofAPI_GATEWAY
.- Logging
Role 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.
- Security
Policy stringName The name of the security policy that is attached to the server.
- Server
Id string - Url string
URL of the service endpoint used to authenticate users with an
identity_provider_type
ofAPI_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
).- endpoint
Type String Type of endpoint that the server is connected to.
- id String
The provider-assigned unique ID for this managed resource.
- identity
Provider StringType 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 String ARN of the IAM role used to authenticate the user account with an
identity_provider_type
ofAPI_GATEWAY
.- logging
Role 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.
- security
Policy StringName The name of the security policy that is attached to the server.
- server
Id String - url String
URL of the service endpoint used to authenticate users with an
identity_provider_type
ofAPI_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
).- endpoint
Type string Type of endpoint that the server is connected to.
- id string
The provider-assigned unique ID for this managed resource.
- identity
Provider stringType 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 string ARN of the IAM role used to authenticate the user account with an
identity_provider_type
ofAPI_GATEWAY
.- logging
Role 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.
- security
Policy stringName The name of the security policy that is attached to the server.
- server
Id string - url string
URL of the service endpoint used to authenticate users with an
identity_provider_type
ofAPI_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_ strtype 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
ofAPI_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_ strname The name of the security policy that is attached to the server.
- server_
id str - url str
URL of the service endpoint used to authenticate users with an
identity_provider_type
ofAPI_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
).- endpoint
Type String Type of endpoint that the server is connected to.
- id String
The provider-assigned unique ID for this managed resource.
- identity
Provider StringType 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 String ARN of the IAM role used to authenticate the user account with an
identity_provider_type
ofAPI_GATEWAY
.- logging
Role 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.
- security
Policy StringName The name of the security policy that is attached to the server.
- server
Id String - url String
URL of the service endpoint used to authenticate users with an
identity_provider_type
ofAPI_GATEWAY
.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.