本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
DescribedServer
描述指定的檔案傳輸通訊協定啟用伺服器屬性。
目錄
- Arn
-
指定伺服器的唯一 Amazon Resource Name （ARN）。
類型：字串
長度限制︰長度下限為 20。長度上限為 1600。
模式：
arn:\S+必要：是
- As2ServiceManagedEgressIpAddresses
-
此伺服器的輸出 IP 地址清單。這些 IP 地址僅適用於使用AS2通訊協定的伺服器。它們用於傳送非同步 MDNs。
這些 IP 地址會在您建立AS2伺服器時自動指派。此外，如果您更新現有的伺服器並新增AS2通訊協定，也會指派靜態 IP 地址。
類型：字串陣列
模式：
\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}必要：否
- Certificate
-
指定 AWS Certificate Manager （ACM） 憑證ARN的 。當
Protocols設定為FTPS時，此為必要項目。類型：字串
長度限制：長度下限為 0。長度上限為 1600。
必要：否
- Domain
-
指定用於檔案傳輸的儲存系統網域。
類型：字串
有效值:
S3 | EFS必要：否
- EndpointDetails
-
為您的伺服器設定的虛擬私有雲端 （VPC） 端點設定。當您在 中託管端點時VPC，您只能讓 中的資源存取端點VPC，也可以連接彈性 IP 地址，讓用戶端透過網際網路存取端點。您 VPC的預設安全群組會自動指派給端點。
類型：EndpointDetails 物件
必要：否
- EndpointType
-
定義伺服器連線的端點類型。如果您的伺服器已連線至VPC端點，則無法透過公有網際網路存取您的伺服器。
類型：字串
有效值:
PUBLIC | VPC | VPC_ENDPOINT必要：否
- HostKeyFingerprint
-
指定伺服器主機金鑰的 Base64-encodedSHA256指紋。此值等同於
ssh-keygen -l -f my-new-server-key命令的輸出。類型：字串
必要：否
- IdentityProviderDetails
-
指定呼叫客戶提供身分驗證 的資訊API。當伺服器的 為
AWS_DIRECTORY_SERVICE或 時IdentityProviderType，不會填入此欄位SERVICE_MANAGED。類型：IdentityProviderDetails 物件
必要：否
- IdentityProviderType
-
伺服器的身分驗證模式。預設值為
SERVICE_MANAGED，可讓您在 AWS Transfer Family 服務中存放和存取使用者憑證。使用
AWS_DIRECTORY_SERVICE可讓您存取內部部署環境 AWS Directory Service for Microsoft Active Directory 或使用 AWS AD Connector 的 或 Microsoft Active Directory 中的 Active Directory 群組。此選項也要求您使用IdentityProviderDetails參數提供 Directory ID。使用
API_GATEWAY值來和您選擇的身分提供者整合。此API_GATEWAY設定要求您提供 Amazon API Gateway 端點URL，以使用IdentityProviderDetails參數呼叫以進行身分驗證。使用
AWS_LAMBDA值直接使用 AWS Lambda 函數作為您的身分提供者。如果您選擇此值，您必須在IdentityProviderDetails資料類型ARN的Function參數中指定 Lambda 函數的 。類型：字串
有效值:
SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA必要：否
- LoggingRole
-
（ARN） 角色的 Amazon Resource Name AWS Identity and Access Management （IAM），允許伺服器開啟 Amazon S3 或 Amazon 的 Amazon CloudWatch 記錄EFSevents。設定時，您可以在 CloudWatch 日誌中檢視使用者活動。
類型：字串
長度限制：長度下限為 0。長度上限為 2048。
模式：
(|arn:.*role/\S+)必要：否
- PostAuthenticationLoginBanner
-
指定使用者連線到伺服器時要顯示的字串。此字串會在使用者驗證後顯示。
注意
SFTP 通訊協定不支援驗證後顯示橫幅。
類型：字串
長度限制：長度下限為 0。長度上限為 4096。
模式：
[\x09-\x0D\x20-\x7E]*必要：否
- PreAuthenticationLoginBanner
-
指定使用者連線到伺服器時要顯示的字串。此字串會在使用者驗證之前顯示。例如，下列橫幅會顯示有關使用系統的詳細資訊：
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.類型：字串
長度限制：長度下限為 0。長度上限為 4096。
模式：
[\x09-\x0D\x20-\x7E]*必要：否
- ProtocolDetails
-
為伺服器設定的通訊協定設定。
-
若要指示被動模式 （適用於 FTP和 FTPS 通訊協定），請使用
PassiveIp參數。輸入單一點四IPv4位址，例如防火牆、路由器或負載平衡器的外部 IP 地址。 -
若要忽略在用戶端嘗試對您上傳至 Amazon S3 儲存貯體的檔案使用
SETSTAT命令時所產生的錯誤，請使用SetStatOption參數。若要讓 AWS Transfer Family 伺服器忽略SETSTAT命令並上傳檔案，而不需要對SFTP用戶端進行任何變更，請將 值設定為ENABLE_NO_OP。如果您將SetStatOption參數設定為ENABLE_NO_OP，Transfer Family 會產生 Amazon CloudWatch Logs 的日誌項目，以便您可以判斷用戶端何時SETSTAT撥打電話。 -
若要判斷 AWS Transfer Family 伺服器是否透過唯一的工作階段 ID 來恢復最近的交涉工作階段，請使用
TlsSessionResumptionMode參數。 -
As2Transports表示AS2訊息的傳輸方法。目前僅支援 HTTP。
類型：ProtocolDetails 物件
必要：否
-
- Protocols
-
在您的檔案傳輸通訊協定用戶端可以連線到伺服器的端點上，指定檔案傳輸通訊協定或通訊協定。可用的通訊協定包括：
-
SFTP（Secure Shell （SSH） 檔案傳輸通訊協定）：檔案傳輸 SSH -
FTPS（檔案傳輸通訊協定安全）：使用TLS加密進行檔案傳輸 -
FTP(檔案傳輸通訊協定)：未加密的檔案傳輸 -
AS2（適用性陳述式 2）：用於傳輸結構化 business-to-business資料
注意
-
如果您選擇
FTPS，您必須選擇儲存在 AWS Certificate Manager （ACM） 中的憑證，當用戶端透過 連線到伺服器時，該憑證可用來識別您的伺服器FTPS。 -
如果
Protocol包含FTP或FTPS，則EndpointType必須是VPC且IdentityProviderType必須是AWS_DIRECTORY_SERVICE、AWS_LAMBDA或API_GATEWAY。 -
如果
Protocol包含FTP，則無法與AddressAllocationIds建立關聯。 -
如果
Protocol僅設定為SFTP，則EndpointType可以設定為PUBLIC，且IdentityProviderType可以設定任何支援的識別類型：SERVICE_MANAGED、AWS_DIRECTORY_SERVICE、AWS_LAMBDA或API_GATEWAY。 -
如果
Protocol包括AS2，則EndpointType必須為VPC，且網域必須為 Amazon S3。
類型：字串陣列
陣列成員：項目數下限為 1。最多 4 個項目。
有效值:
SFTP | FTP | FTPS | AS2必要：否
-
- S3StorageOptions
-
指定是否最佳化 Amazon S3 目錄的效能。此選項根據預設為停用。
根據預設，主目錄映射具有
TYPE的DIRECTORY。如果您啟用此選項，則HomeDirectoryMapEntryTypeFILE如果您想要映射具有檔案目標，則需要將 明確設定為 。類型：S3StorageOptions 物件
必要：否
- SecurityPolicyName
-
指定連接至伺服器的安全政策名稱。
類型：字串
長度限制：長度下限為 0。長度上限為 100。
模式：
TransferSecurityPolicy-.+必要：否
- ServerId
-
指定您實例化之伺服器的唯一系統指派識別碼。
類型：字串
長度限制條件：固定長度為 19。
模式：
s-([0-9a-f]{17})必要：否
- State
-
描述的伺服器條件。的值
ONLINE表示伺服器可接受任務和傳輸檔案。State的值OFFLINE表示伺服器無法執行檔案傳輸操作。STARTING和 的狀態STOPPING表示伺服器處於中繼狀態，可能是無法完全回應，或並非完全離線。START_FAILED或 的值STOP_FAILED可以指示錯誤條件。類型：字串
有效值:
OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED必要：否
- StructuredLogDestinations
-
指定伺服器日誌的傳送目的地日誌群組。
若要指定日誌群組，您必須ARN為現有日誌群組提供 。在此情況下，日誌群組的格式如下：
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*例如
arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*如果您先前已為伺服器指定日誌群組，您可以清除該群組，並在
update-server通話中提供此參數的空值，並實際上關閉結構化日誌。例如：update-server --server-id s-1234567890abcdef0 --structured-log-destinations類型：字串陣列
陣列成員：項目數下限為 0。項目數上限為 1。
長度限制︰長度下限為 20。長度上限為 1600。
模式：
arn:\S+必要：否
- Tags
-
指定您可以用來搜尋並分組指派給所述伺服器的金鑰值對。
類型：Tag 物件陣列
陣列成員：項目數下限為 1。項目數上限為 50。
必要：否
- UserCount
-
指定指派給您使用 指定的伺服器的使用者數量
ServerId。類型：整數
必要：否
- WorkflowDetails
-
指定要指派之工作流程的工作流程 ID，以及用於執行工作流程的執行角色。
除了完全上傳檔案時要執行的工作流程外，
WorkflowDetails亦可包含要在部分上傳時執行之工作流程的工作流程 ID (和執行角色)。當伺服器工作階段在檔案仍在上傳時中斷連線時，會發生部分上傳。類型：WorkflowDetails 物件
必要：否
另請參閱
如需在其中一種語言特定 API中使用此功能的詳細資訊 AWS SDKs，請參閱下列內容：
