DescribedServer class

Describes the properties of a file transfer protocol-enabled server that was specified.

Constructors

DescribedServer.new({required String arn, String? certificate, EndpointDetails? endpointDetails, EndpointType? endpointType, String? hostKeyFingerprint, IdentityProviderDetails? identityProviderDetails, IdentityProviderType? identityProviderType, String? loggingRole, List<Protocol>? protocols, String? securityPolicyName, String? serverId, State? state, List<Tag>? tags, int? userCount})

DescribedServer.fromJson(Map<String, dynamic> json)

factory

Properties

arn → String

Specifies the unique Amazon Resource Name (ARN) of the server.

final

certificate → String?

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

final

endpointDetails → EndpointDetails?

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.

final

endpointType → EndpointType?

Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

final

hashCode → int

The hash code for this object.

no setter, inherited

hostKeyFingerprint → String?

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

final

identityProviderDetails → IdentityProviderDetails?

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is SERVICE_MANAGED.

final

identityProviderType → IdentityProviderType?

Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

final

loggingRole → String?

Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

final

protocols → List<Protocol>?

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

securityPolicyName → String?

Specifies the name of the security policy that is attached to the server.

final

serverId → String?

Specifies the unique system-assigned identifier for a server that you instantiate.

final

state → State?

Specifies the condition of a server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

final

tags → List<Tag>?

Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

final

userCount → int?

Specifies the number of users that are assigned to a server you specified with the ServerId.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited