Class ServerState

Inheritance
System.Object
InputArgs
ResourceArgs
ServerState
Inherited Members
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 sealed class ServerState : ResourceArgs

Constructors

View Source

ServerState()

Declaration
public ServerState()

Properties

View Source

Arn

Amazon Resource Name (ARN) of Transfer Server

Declaration
public Input<string> Arn { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Endpoint

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

Declaration
public Input<string> Endpoint { get; set; }
Property Value
Type Description
Input<System.String>
View Source

EndpointDetails

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

Declaration
public Input<ServerEndpointDetailsGetArgs> EndpointDetails { get; set; }
Property Value
Type Description
Input<ServerEndpointDetailsGetArgs>
View Source

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 Input<string> EndpointType { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 Input<bool> ForceDestroy { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

HostKey

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

Declaration
public Input<string> HostKey { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 Input<string> HostKeyFingerprint { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 Input<string> IdentityProviderType { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 Input<string> InvocationRole { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 Input<string> LoggingRole { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Tags

A map of tags to assign to the resource.

Declaration
public InputMap<object> Tags { get; set; }
Property Value
Type Description
InputMap<System.Object>
View Source

Url

  • URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.
Declaration
public Input<string> Url { get; set; }
Property Value
Type Description
Input<System.String>