DescribedServer - AWS Transfer Family
内容その他の参照資料

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

DescribedServer

指定されたファイル転送プロトコル対応サーバーのプロパティについて記述します。

内容

Arn

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

型: 文字列

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

Pattern: arn:\S+

必須：はい

As2ServiceManagedEgressIpAddresses

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

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

タイプ：文字列の配列

Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

必須: いいえ

Certificate

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

型: 文字列

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

必須: いいえ

Domain

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

型: 文字列

有効な値：S3 | EFS

必須：いいえ

EndpointDetails

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

型: EndpointDetails オブジェクト

必須: いいえ

EndpointType

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

型: 文字列

有効な値：PUBLIC | VPC | VPC_ENDPOINT

必須：いいえ

HostKeyFingerprint

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

タイプ: 文字列

必須: いいえ

IdentityProviderDetails

カスタマー提供の認証 API を呼び出すための情報を指定します。サーバーの IdentityProviderType が AWS_DIRECTORY_SERVICE または SERVICE_MANAGED の場合、このフィールドには自動機な値が入力されます。

型: IdentityProviderDetails オブジェクト

必須: いいえ

IdentityProviderType

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

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

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

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

型: 文字列

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

必須：いいえ

LoggingRole

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

型: 文字列

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

パターン: (|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 パラメータを使用します。ファイアウォール、ルーター、ロードバランサーの外部 IP アドレスなど、クアッドドット形式の単一 IPv4 アドレスを入力します。

  • S3 バケットにアップロードしているファイルに対して、クライアントが SETSTAT コマンドの使用を試みた時に発生するエラーを無視するには、SetStatOption パラメータを使用します。SFTP クライアントを変更せずに AWS Transfer Family サーバーでSETSTATコマンドを無視してファイルをアップロードするには、値を に設定しますENABLE_NO_OP。SetStatOption パラメータを に設定するとENABLE_NO_OP、Transfer Family は Amazon CloudWatch Logs にログエントリを生成し、クライアントがいつSETSTAT呼び出しを行っているかを特定できるようにします。

  • AWS Transfer Family サーバーが一意のセッション ID を介して最近ネゴシエートされたセッションを再開するかどうかを確認するには、 TlsSessionResumptionModeパラメータを使用します。

  • As2Transports は、AS2 メッセージの転送方法を示します。現在は、HTTP のみがサポートされます。

タイプ：ProtocolDetails オブジェクト

必須: いいえ

Protocols

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

  • SFTP(Secure Shell (SSH) File Transfer Protocol): SSH 経由のファイル転送

  • FTPS (File Transfer Protocol Secure): TLS 暗号化によるファイル転送

  • FTP (File Transfer Protocol): 暗号化されていないファイル転送

  • 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 はサポートされている ID タイプ (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 です。

Pattern: Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+

必須: いいえ

ServerId

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

型: 文字列

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

Pattern: s-([0-9a-f]{17})

必須: いいえ

State

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

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 です。

Pattern: arn:\S+

必須: いいえ

Tags

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

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

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

必須: いいえ

UserCount

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

型: 整数

必須: いいえ

WorkflowDetails

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

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

タイプ：WorkflowDetails オブジェクト

必須: いいえ

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。