Class Server

Provides a AWS Transfer Server resource.

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var fooRole = new Aws.Iam.Role("fooRole", new Aws.Iam.RoleArgs
    {
        AssumeRolePolicy = @"{
""Version"": ""2012-10-17"",
""Statement"": [
{
""Effect"": ""Allow"",
""Principal"": {
""Service"": ""transfer.amazonaws.com""
},
""Action"": ""sts:AssumeRole""
}
]
}

",
    });
    var fooRolePolicy = new Aws.Iam.RolePolicy("fooRolePolicy", new Aws.Iam.RolePolicyArgs
    {
        Policy = @"{
""Version"": ""2012-10-17"",
""Statement"": [
{
""Sid"": ""AllowFullAccesstoCloudWatchLogs"",
""Effect"": ""Allow"",
""Action"": [
""logs:*""
],
""Resource"": ""*""
}
]
}

",
        Role = fooRole.Id,
    });
    var fooServer = new Aws.Transfer.Server("fooServer", new Aws.Transfer.ServerArgs
    {
        IdentityProviderType = "SERVICE_MANAGED",
        LoggingRole = fooRole.Arn,
        Tags = 
        {
            { "ENV", "test" },
            { "NAME", "tf-acc-test-transfer-server" },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Server

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Transfer

Assembly: Pulumi.Aws.dll

Syntax

public class Server : CustomResource

Constructors

Server(String, ServerArgs, CustomResourceOptions)

Create a Server resource with the given unique name, arguments, and options.

Declaration

public Server(string name, ServerArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ServerArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

Amazon Resource Name (ARN) of Transfer Server

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

Endpoint

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

Declaration

public Output<string> Endpoint { get; }

Property Value

Type	Description
Output<System.String>

EndpointDetails

The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. Fields documented below.

Declaration

public Output<ServerEndpointDetails> EndpointDetails { get; }

Property Value

Type	Description
Output<ServerEndpointDetails>

EndpointType

The type of endpoint that you want your SFTP server connect to. If you connect to a VPC_ENDPOINT, your SFTP server isn't accessible over the public internet. If you want to connect your SFTP server via public internet, set PUBLIC. Defaults to PUBLIC.

Declaration

public Output<string> EndpointType { get; }

Property Value

Type	Description
Output<System.String>

ForceDestroy

A boolean that indicates all users associated with the server should be deleted so that the Server can be destroyed without error. The default value is false.

Declaration

public Output<bool?> ForceDestroy { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

HostKey

RSA private key (e.g. as generated by the ssh-keygen -N "" -f my-new-server-key command).

Declaration

public Output<string> HostKey { get; }

Property Value

Type	Description
Output<System.String>

HostKeyFingerprint

This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.

Declaration

public Output<string> HostKeyFingerprint { get; }

Property Value

Type	Description
Output<System.String>

IdentityProviderType

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.

Declaration

public Output<string> IdentityProviderType { get; }

Property Value

Type	Description
Output<System.String>

InvocationRole

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

Declaration

public Output<string> InvocationRole { get; }

Property Value

Type	Description
Output<System.String>

LoggingRole

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.

Declaration

public Output<string> LoggingRole { get; }

Property Value

Type	Description
Output<System.String>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Url

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

Declaration

public Output<string> Url { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ServerState, CustomResourceOptions)

Get an existing Server resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Server Get(string name, Input<string> id, ServerState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ServerState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Server