DescribedServer

サーバーの一意の Amazon リソースネーム (ARN) を指定します。

型: 文字列

長さの制限: 最小長は 20 です。最大長は 1600 です。

Pattern: arn:\S+

必須：はい

このサーバーの出力 IP アドレスのリスト。これらの IP アドレスは、AS2プロトコルを使用するサーバーにのみ関連します。非同期 の送信に使用されますMDNs。

これらの IP アドレスは、AS2サーバーの作成時に自動的に割り当てられます。さらに、既存のサーバーを更新してAS2プロトコルを追加すると、静的 IP アドレスも割り当てられます。

型: 文字列の配列

パターン: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

必須: いいえ

AWS Certificate Manager (ACM) 証明書ARNの を指定します。Protocols が FTPS に設定されている場合は必須です。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 1600 です。

必須：いいえ

ファイル転送に使用されるストレージシステムのドメインを指定します。

型: 文字列

有効な値: S3 | EFS

必須：いいえ

サーバー用に設定された仮想プライベートクラウド (VPC) エンドポイント設定。内でエンドポイントをホストする場合VPC、エンドポイントを 内のリソースにのみアクセスできるようにするかVPC、Elastic IP アドレスをアタッチして、インターネット経由でクライアントにアクセスできるようにします。VPCのデフォルトのセキュリティグループは、エンドポイントに自動的に割り当てられます。

型: EndpointDetails オブジェクト

必須：いいえ

サーバーの接続先になるエンドポイントのタイプ。サーバーがVPCエンドポイントに接続されている場合、サーバーはパブリックインターネット経由でアクセスできません。

型: 文字列

有効な値: PUBLIC | VPC | VPC_ENDPOINT

必須：いいえ

サーバーのホストキーの Base64-encodedされたSHA256フィンガープリントを指定します。この値は、ssh-keygen -l -f my-new-server-key コマンドの出力と等価です。

型: 文字列

必須: いいえ

お客様が用意した認証 を呼び出す情報を指定しますAPI。サーバーの IdentityProviderType が AWS_DIRECTORY_SERVICE または SERVICE_MANAGED の場合、このフィールドには自動機な値が入力されます。

型: IdentityProviderDetails オブジェクト

必須：いいえ

サーバーの認証のモード。デフォルト値は です。これによりSERVICE_MANAGED、 AWS Transfer Family サービス内にユーザー認証情報を保存してアクセスできます。

を使用してAWS_DIRECTORY_SERVICE、オンプレミス環境の AWS Directory Service for Microsoft Active Directory または Microsoft Active Directory の Active Directory グループ、または AD Connector AWS を使用した へのアクセスを提供します。このオプションでは、IdentityProviderDetails パラメータを使用してディレクトリ ID を指定する必要もあります。

この API_GATEWAY 値を使用して、選択した ID プロバイダーと統合します。API_GATEWAY この設定では、 IdentityProviderDetailsパラメータを使用して認証を呼びURL出す Amazon API Gateway エンドポイントを指定する必要があります。

AWS_LAMBDA 値を使用して、 AWS Lambda 関数を ID プロバイダーとして直接使用します。この値を選択する場合は、IdentityProviderDetailsデータ型の Functionパラメータで ARN Lambda 関数の を指定する必要があります。

型: 文字列

有効な値: SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA

必須：いいえ

サーバーが Amazon S3 または Amazon の Amazon CloudWatch ログ記録を有効にすることを許可する () ロールARNの Amazon リソースネーム AWS Identity and Access Management （IAM）EFSevents。 Amazon S3 設定すると、 CloudWatch ログにユーザーアクティビティを表示できます。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 2,048 です。

パターン: (|arn:.*role/\S+)

必須: いいえ

ユーザーがサーバーに接続するときに表示する文字列を指定します。この文字列はユーザーが認証した後で表示されます。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 4096 です。

パターン: [\x09-\x0D\x20-\x7E]*

必須: いいえ

ユーザーがサーバーに接続するときに表示する文字列を指定します。この文字列はユーザーが認証される前に表示されます。例えば、次のバナーはシステムの使用に関する詳細を表示します。

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 オブジェクト

必須：いいえ

ファイル転送プロトコルクライアントがサーバーのエンドポイントに接続できる 1 つまたは複数のファイル転送プロトコルを指定します。使用可能なプロトコルは次のとおりです。

型: 文字列の配列

配列メンバー：最小数は 1 項目です。最大数は 4 項目です。

有効な値: SFTP | FTP | FTPS | AS2

必須：いいえ

Amazon S3 ディレクトリのパフォーマンスを最適化するかどうかを指定します。これはデフォルトでは無効になっています。

デフォルトでは、ホームディレクトリマッピングには TYPEの がありますDIRECTORY。このオプションを有効にすると、マッピングHomeDirectoryMapEntryTypeにファイルターゲットを設定するFILE場合は、 を明示的に に設定する必要があります。

型: S3StorageOptions オブジェクト

必須：いいえ

サーバーにアタッチするセキュリティポリシーの名前を指定します。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 100 です。

パターン: TransferSecurityPolicy-.+

必須: いいえ

インスタンス化するサーバーの一意のシステム割り当て識別子を指定します。

型: 文字列

長さの制限: 固定長は 19 です。

パターン: s-([0-9a-f]{17})

必須: いいえ

記述されたサーバーの状態です。ONLINE の値は、サーバーがジョブを受け入れてファイルを転送できることを示します。OFFLINE の State 値は、サーバーがファイルオペレーションを実行できないことを意味します。

STARTING と STOPPING のステータスは、サーバーが中間状態である (完全に応答できないか完全にオフラインでない) ことを示します。START_FAILED または STOP_FAILED の値は、エラー条件を示すことができます。

型: 文字列

有効な値: OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED

必須：いいえ

サーバーログの送信先となるロググループを指定します。

ロググループを指定するには、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+

必須: いいえ

記述したサーバーに割り当てられているサーバーを検索およびグループ化するために使用できるキーバリューペアを指定します。

型: Tag オブジェクトの配列

配列メンバー：最小数は 1 項目です。最大数は 50 項目です。

必須：いいえ

ServerId で指定したサーバーに割り当てられるユーザーの数を指定します。

型: 整数

必須：いいえ

割り当てるワークフローのワークフロー ID とワークフローの実行に使用する実行ロールを指定します。

ファイルのアップロード完了時に実行するワークフローに加えて、部分的なアップロードで実行するワークフローのワークフロー ID (および実行ロール) も WorkflowDetails に含めることができます。部分的なアップロードは、ファイルのアップロード中にサーバーセッションが切断されたときに発生します。

型: WorkflowDetails オブジェクト

必須: いいえ