ListedServer - AWS Transfer Family

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

ListedServer

指定されたファイル転送プロトコル対応サーバーのプロパティを返します。

内容

Arn

一覧表示するサーバーについて一意の Amazon リソースネーム (ARN) を指定します。

型: 文字列

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

Pattern: arn:\S+

必須:はい

Domain

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

型: 文字列

有効な値:S3 | EFS

必須:いいえ

EndpointType

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

型: 文字列

有効な値:PUBLIC | VPC | VPC_ENDPOINT

必須:いいえ

IdentityProviderType

サーバーの認証のモード。デフォルト値は SERVICE_MANAGED で、この値により、AWS Transfer Family サービス内でユーザー認証情報の保存とアクセスが可能です。

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

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

AWS_LAMBDA 値を使用すると、AWS Lambda 関数をアイデンティティプロバイダーとして直接使用できます。この値を選択した場合、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 ログにユーザーアクティビティを表示できます。

型: 文字列

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

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

必須: いいえ

ServerId

一覧表示されたサーバーについて一意のシステム割り当て識別子を指定します。

型: 文字列

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

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

必須: いいえ

State

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

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

型: 文字列

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

必須:いいえ

UserCount

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

型: 整数

必須:いいえ

その他の参照資料

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