CreateServer

（ARN) 証明書の Amazon リソースネーム AWS Certificate Manager （ACM）。Protocols が FTPS に設定されている場合は必須です。

新しいパブリック証明書をリクエストするには、 AWS Certificate Manager 「 ユーザーガイド」の「パブリック証明書をリクエストする」を参照してください。

既存の証明書を にインポートするにはACM、 AWS Certificate Manager 「 ユーザーガイド」の「 に証明書をインポートACMする」を参照してください。

プライベート IP アドレスFTPSを介してプライベート証明書を使用するようにリクエストするには、 AWS Certificate Manager ユーザーガイドの「プライベート証明書のリクエスト」を参照してください。

以下の暗号化アルゴリズムとキーサイズの証明書がサポートされています。

型: 文字列

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

必須：いいえ

ファイル転送に使用されるストレージシステムのドメイン。Amazon Simple Storage Service (Amazon S3) と Amazon Elastic File System (Amazon ) の 2 つのドメインを使用できますEFS。デフォルト値は S3 です。

型: 文字列

有効な値: S3 | EFS

必須：いいえ

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

型: EndpointDetails オブジェクト

必須：いいえ

サーバーで使用したいエンドポイントのタイプ。サーバーのエンドポイントをパブリックにアクセス可能 (PUBLIC) にするか、 内でホストするかを選択できますVPC。でホストされているエンドポイントではVPC、 内でのみサーバーとリソースへのアクセスを制限したり、Elastic IP アドレスを直接アタッチしてVPCインターネットに接続したりできます。

型: 文字列

有効な値: PUBLIC | VPC | VPC_ENDPOINT

必須：いいえ

SFTPが有効なサーバーに使用する RSA、ECDSA、またはED25519プライベートキー。キーをローテーションしたい場合や、異なるアルゴリズムを使用するアクティブキーのセットが必要な場合に備えて、複数のホストキーを追加できます。

次のコマンドを使用して、パスフレーズのない 2048 RSA ビットキーを生成します。

ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key.

-b オプションには最小値 2048 を使用してください。3072 または 4096 を使用すると、より強力なキーを作成できます。

次のコマンドを使用して、パスフレーズのない 256 ECDSA ビットキーを生成します。

ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key.

-b のオプションに有効な値は、256、384、および 521 ECDSAです。

次のコマンドを使用して、パスフレーズのないED25519キーを生成します。

ssh-keygen -t ed25519 -N "" -f my-new-server-key.

これらのコマンドのすべてについて、 を任意の文字列my-new-server-keyに置き換えることができます。

詳細については、 AWS Transfer Family 「 ユーザーガイド」のSFTP「 対応サーバーのホストキーの更新」を参照してください。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 4,096 です。

必須：いいえ

IdentityProviderType が AWS_DIRECTORY_SERVICE、 AWS_LAMBDA または API_GATEWAY に設定されている場合に必要です。API ゲートウェイ を含む、 でディレクトリを使用するAWS_DIRECTORY_SERVICEかAPI、カスタマー提供の認証 を呼び出すために必要なすべての情報を含む配列を受け入れますURL。IdentityProviderType が 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-.+

必須: いいえ

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

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

必須：いいえ

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

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

型: WorkflowDetails オブジェクト

必須: いいえ

作成されるサーバーのサービス割り当て識別子。

型: 文字列

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

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

このアクションを実行する十分なアクセス権限がありません。

HTTP ステータスコード: 400

この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。

HTTP ステータスコード: 500

この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。

HTTP ステータスコード: 400

要求されたリソースは存在しないか、コマンドに指定されたリージョン以外のリージョンに存在します。

HTTP ステータスコード: 400

この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。

HTTP ステータスコード: 400

AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。

HTTP ステータスコード: 500

リクエストのスロットリングにより、リクエストが拒否されました。

HTTP ステータスコード: 400