ServerState class
Input properties used for looking up and filtering Server resources.
Constructors
-
ServerState({Input<
String?> ? arn, Input<String?> ? certificate, Input<String?> ? directoryId, Input<String?> ? domain, Input<String?> ? endpoint, Input<ServerEndpointDetails?> ? endpointDetails, Input<String?> ? endpointType, Input<bool?> ? forceDestroy, Input<String?> ? function, Input<String?> ? hostKey, Input<String?> ? hostKeyFingerprint, Input<String?> ? identityProviderType, Input<String?> ? invocationRole, Input<String?> ? ipAddressType, Input<String?> ? loggingRole, Input<String?> ? postAuthenticationLoginBanner, Input<String?> ? preAuthenticationLoginBanner, Input<ServerProtocolDetails?> ? protocolDetails, Input<List< ? protocols, Input<String> ?>String?> ? region, Input<ServerS3StorageOptions?> ? s3StorageOptions, Input<String?> ? securityPolicyName, Input<String?> ? sftpAuthenticationMethods, Input<List< ? structuredLogDestinations, Input<String> ?>Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? url, Input<ServerWorkflowDetails?> ? workflowDetails}) -
Creates a new ServerState.
arnARN of Transfer ServercertificateARN of the AWS Certificate Manager (ACM) certificate. Required whenprotocolsis set toFTPS.directoryIdDirectory service ID of the directory service you want to connect to with anidentityProviderTypeofAWS_DIRECTORY_SERVICE.domainDomain of the storage system that is used for file transfers. Valid values are:S3andEFS. The default value isS3.endpointEndpoint of the Transfer Server (e.g.,s-12345678.server.transfer.REGION.amazonaws.com)endpointDetailsVPC endpoint settings that you want to configure for your SFTP server. SeeendpointDetailsBlock below for details.endpointTypeType of endpoint that you want your SFTP server connect to. If you connect to aVPC(orVPC_ENDPOINT), your SFTP server isn't accessible over the public internet. If you want to connect your SFTP server via public internet, setPUBLIC. Defaults toPUBLIC.forceDestroyBoolean that indicates all users associated with the server should be deleted so that the Server can be destroyed without error. The default value isfalse. This option only applies to servers configured with aSERVICE_MANAGEDidentityProviderType.functionARN for a lambda function to use for the Identity provider with anidentityProviderTypeofAWS_LAMBDA.hostKeyRSA, ECDSA, or ED25519 private key (e.g., as generated by thessh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key,ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-keyorssh-keygen -t ed25519 -N "" -f my-new-server-keycommands).hostKeyFingerprintMessage-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of thessh-keygen -l -E md5 -f my-new-server-keycommand.identityProviderTypeMode of authentication enabled for this service. The default value isSERVICE_MANAGED, which allows you to store and access SFTP user credentials within the service.API_GATEWAYindicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice. UsingAWS_DIRECTORY_SERVICEwill allow for authentication against AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment, or in AWS using AD Connectors. Use theAWS_LAMBDAvalue to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in thefunctionargument.invocationRoleARN of the IAM role used to authenticate the user account with anidentityProviderTypeofAPI_GATEWAY.ipAddressTypeType of IP addresses for the AWS Transfer Family endpoint. Valid values areIPV4andDUALSTACK. The default value isIPV4. WhenipAddressTypeis set toDUALSTACK,addressAllocationIdscannot be specified in theendpointDetailsblock. UpdatingipAddressTypestops the server and then restarts it with the newipAddressTypevalue.loggingRoleARN of an IAM role that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.postAuthenticationLoginBannerSpecify a string to display when users connect to a server. This string is displayed after the user authenticates. The SFTP protocol does not support post-authentication display banners.preAuthenticationLoginBannerSpecify a string to display when users connect to a server. This string is displayed before the user authenticates.protocolDetailsProtocol settings that are configured for your server. SeeprotocolDetailsBlock below for details.protocolsFile transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. This defaults toSFTP. The available protocols areAS2(file transfer over Applicability Statement 2),SFTP(file transfer over SSH),FTPS(file transfer with TLS encryption), andFTP(unencrypted file transfer).regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.s3StorageOptionsWhether performance for your Amazon S3 directories is optimized. This is disabled by default. Sees3StorageOptionsBlock below for details.securityPolicyNameName of the security policy that is attached to the server. Default value is:TransferSecurityPolicy-2018-11. The available values areTransferSecurityPolicy-2018-11,TransferSecurityPolicy-2020-06,TransferSecurityPolicy-2022-03,TransferSecurityPolicy-2023-05,TransferSecurityPolicy-2024-01,TransferSecurityPolicy-2025-03,TransferSecurityPolicy-FIPS-2020-06,TransferSecurityPolicy-FIPS-2023-05,TransferSecurityPolicy-FIPS-2024-01,TransferSecurityPolicy-FIPS-2024-05,TransferSecurityPolicy-FIPS-2025-03,TransferSecurityPolicy-PQ-SSH-Experimental-2023-04,TransferSecurityPolicy-PQ-SSH-FIPS-Experimental-2023-04,TransferSecurityPolicy-Restricted-2018-11,TransferSecurityPolicy-Restricted-2020-06,TransferSecurityPolicy-Restricted-2024-06,TransferSecurityPolicy-SshAuditCompliant-2025-02, andTransferSecurityPolicy-AS2Restricted-2025-07. See Security policies for AWS Transfer Family servers for details.sftpAuthenticationMethodsFor SFTP-enabled servers with anidentityProviderTypeofAPI_GATEWAYorAWS_LAMBDA. Valid values arePASSWORD,PUBLIC_KEY,PUBLIC_KEY_OR_PASSWORDandPUBLIC_KEY_AND_PASSWORD. Default value is:PUBLIC_KEY_OR_PASSWORD.structuredLogDestinationsSet of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs. If provided this enables the transfer server to emit structured logs to the specified locations.tagsMap of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.urlURL of the service endpoint used to authenticate users with anidentityProviderTypeofAPI_GATEWAY.workflowDetailsWorkflow details. SeeworkflowDetailsBlock below for details.const -
ServerState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN of Transfer Server
final
-
certificate
→ Input<
String?> ? -
ARN of the AWS Certificate Manager (ACM) certificate. Required when
protocolsis set toFTPS.final -
directoryId
→ Input<
String?> ? -
Directory service ID of the directory service you want to connect to with an
identityProviderTypeofAWS_DIRECTORY_SERVICE.final -
domain
→ Input<
String?> ? -
Domain of the storage system that is used for file transfers. Valid values are:
S3andEFS. The default value isS3.final -
endpoint
→ Input<
String?> ? -
Endpoint of the Transfer Server (e.g.,
s-12345678.server.transfer.REGION.amazonaws.com)final -
endpointDetails
→ Input<
ServerEndpointDetails?> ? -
VPC endpoint settings that you want to configure for your SFTP server. See
endpointDetailsBlock below for details.final -
endpointType
→ Input<
String?> ? -
Type of endpoint that you want your SFTP server connect to. If you connect to a
VPC(orVPC_ENDPOINT), your SFTP server isn't accessible over the public internet. If you want to connect your SFTP server via public internet, setPUBLIC. Defaults toPUBLIC.final -
forceDestroy
→ Input<
bool?> ? -
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. This option only applies to servers configured with aSERVICE_MANAGEDidentityProviderType.final -
function
→ Input<
String?> ? -
ARN for a lambda function to use for the Identity provider with an
identityProviderTypeofAWS_LAMBDA.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
hostKey
→ Input<
String?> ? -
RSA, ECDSA, or ED25519 private key (e.g., as generated by the
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key,ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-keyorssh-keygen -t ed25519 -N "" -f my-new-server-keycommands).final -
hostKeyFingerprint
→ Input<
String?> ? -
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-keycommand.final -
identityProviderType
→ Input<
String?> ? -
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_GATEWAYindicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice. UsingAWS_DIRECTORY_SERVICEwill allow for authentication against AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment, or in AWS using AD Connectors. Use theAWS_LAMBDAvalue to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in thefunctionargument.final -
invocationRole
→ Input<
String?> ? -
ARN of the IAM role used to authenticate the user account with an
identityProviderTypeofAPI_GATEWAY.final -
ipAddressType
→ Input<
String?> ? -
Type of IP addresses for the AWS Transfer Family endpoint. Valid values are
IPV4andDUALSTACK. The default value isIPV4. WhenipAddressTypeis set toDUALSTACK,addressAllocationIdscannot be specified in theendpointDetailsblock. UpdatingipAddressTypestops the server and then restarts it with the newipAddressTypevalue.final -
loggingRole
→ Input<
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.
final
-
postAuthenticationLoginBanner
→ Input<
String?> ? -
Specify a string to display when users connect to a server. This string is displayed after the user authenticates. The SFTP protocol does not support post-authentication display banners.
final
-
preAuthenticationLoginBanner
→ Input<
String?> ? -
Specify a string to display when users connect to a server. This string is displayed before the user authenticates.
final
-
protocolDetails
→ Input<
ServerProtocolDetails?> ? -
Protocol settings that are configured for your server. See
protocolDetailsBlock below for details.final -
protocols
→ Input<
List< ?String> ?> -
File transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. This defaults to
SFTP. The available protocols areAS2(file transfer over Applicability Statement 2),SFTP(file transfer over SSH),FTPS(file transfer with TLS encryption), andFTP(unencrypted file transfer).final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
s3StorageOptions
→ Input<
ServerS3StorageOptions?> ? -
Whether performance for your Amazon S3 directories is optimized. This is disabled by default. See
s3StorageOptionsBlock below for details.final -
securityPolicyName
→ Input<
String?> ? -
Name of the security policy that is attached to the server. Default value is:
TransferSecurityPolicy-2018-11. The available values areTransferSecurityPolicy-2018-11,TransferSecurityPolicy-2020-06,TransferSecurityPolicy-2022-03,TransferSecurityPolicy-2023-05,TransferSecurityPolicy-2024-01,TransferSecurityPolicy-2025-03,TransferSecurityPolicy-FIPS-2020-06,TransferSecurityPolicy-FIPS-2023-05,TransferSecurityPolicy-FIPS-2024-01,TransferSecurityPolicy-FIPS-2024-05,TransferSecurityPolicy-FIPS-2025-03,TransferSecurityPolicy-PQ-SSH-Experimental-2023-04,TransferSecurityPolicy-PQ-SSH-FIPS-Experimental-2023-04,TransferSecurityPolicy-Restricted-2018-11,TransferSecurityPolicy-Restricted-2020-06,TransferSecurityPolicy-Restricted-2024-06,TransferSecurityPolicy-SshAuditCompliant-2025-02, andTransferSecurityPolicy-AS2Restricted-2025-07. See Security policies for AWS Transfer Family servers for details.final -
sftpAuthenticationMethods
→ Input<
String?> ? -
For SFTP-enabled servers with an
identityProviderTypeofAPI_GATEWAYorAWS_LAMBDA. Valid values arePASSWORD,PUBLIC_KEY,PUBLIC_KEY_OR_PASSWORDandPUBLIC_KEY_AND_PASSWORD. Default value is:PUBLIC_KEY_OR_PASSWORD.final -
structuredLogDestinations
→ Input<
List< ?String> ?> -
Set of ARNs of destinations that will receive structured logs from the transfer server such as CloudWatch Log Group ARNs. If provided this enables the transfer server to emit structured logs to the specified locations.
final
-
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
url
→ Input<
String?> ? -
URL of the service endpoint used to authenticate users with an
identityProviderTypeofAPI_GATEWAY.final -
workflowDetails
→ Input<
ServerWorkflowDetails?> ? -
Workflow details. See
workflowDetailsBlock below for details.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited