設計図パラメータを指定する
設定ファイルには、parameterSpec JSON オブジェクトの設計図パラメータの仕様が含まれます。parameterSpec には、1 つ以上のパラメータオブジェクトが含まれます。
"parameterSpec": { "<parameter_name>": { "type": "<parameter-type>", "collection": true|false, "description": "<parameter-description>", "defaultValue": "<default value for the parameter if value not specified>" "allowedValues": "<list of allowed values>" }, "<parameter_name>": { ... } }
以下は、各パラメータオブジェクトでのコーディング規則です。
-
パラメータ名と
typeは必須です。その他のプロパティはすべてオプションです。 -
defaultValueプロパティを指定する場合のパラメータはオプションです。それ以外の場合、パラメータは必須であり、この設計図からワークフローを作成するデータアナリストは、その値を提供する必要があります。 -
collectionプロパティにtrueを設定した場合、このパラメータは値のコレクションを参照できます。コレクションは、任意のデータ型にすることができます。 -
allowedValuesを指定すると、ブループリントからワークフローを作成する際にデータアナリストが選択する、値のドロップダウンリストが AWS Glue コンソールに表示されます。
type で使用可能な値を以下に示します。
| パラメータのデータ型 | メモ |
|---|---|
String |
- |
Integer |
- |
Double |
- |
Boolean |
指定できる値は true および false です。AWS Glue コンソールの [Create a workflow from <blueprint>] (<blueprint> からのワークフローの作成) ページで、チェックボックスを生成します。 |
S3Uri |
s3:// で開始する Amazon S3 パスを完成させます。[Create a workflow from <blueprint>] (<blueprint> からのワークフローの作成) ページで、テキストフィールドおよび [Browse] (参照) ボタンを生成します。 |
S3Bucket |
Amazon S3 バケット名のみ。[Create a workflow from <blueprint>] (<blueprint> からのワークフローの作成) ページで、バケットピッカーを生成します。 |
IAMRoleArn |
AWS Identity and Access Management (IAM ロール) の Amazon リソースネーム (ARN)。[Create a workflow from <blueprint>] (<blueprint> からのワークフローの作成) ページで、ロールピッカーを生成します。 |
IAMRoleName |
IAM ロールの名前。[Create a workflow from <blueprint>] (<blueprint> からのワークフローの作成) ページで、ロールピッカーを生成します。 |