ラムダ関数に適用可能な環境変数
ラムダ関数に適用できる環境変数を理解する。
以下は、 HeartBeat, API および Metrics Lambda Functions に適用されるプロパティです。
Amazon API Gateway コンフィギュレーションでは、Amazon API Gateway の AWS 接続に必要なコンフィギュレーションを指定できます。
| プロパティ－ | 説明 |
|---|---|
| AWS_STAGE | 必須。 Amazon API Gateway のステージ（ランタイム）名。 |
エージェント設定により、 AWS エージェントのハートビート間隔、アセット同期間隔、メトリクス同期間隔などの設定を指定できます。
| プロパティ－ | 説明 | 可能な値 |
|---|---|---|
| apicp_heartbeat_send_interval_seconds | オプション。 エージェントがヘルスチェックステータスをAPI Control Planeに送信しなければならない時間(秒)。 | 最小：15秒 最大：900秒（5分）。 デフォルト: 60秒。 このプロパティに値を指定しない場合、デフォルト値が考慮される。 |
Runtime configurationsでは、 連携API管理から管理したいAmazon API Gateway のメタデータ（Runtime名、Description、Tagsなど）を指定することができます。
| プロパティ－ | 説明 |
|---|---|
| apicp_runtime_name | 必須。 実行時の名前。 このプロパティは、フェデレーテッド API 管理においてランタイムを識別する方法を定義します。名前は 50 文字を超えてはなりません。 ランタイムがフェデレーテッドAPI管理に初めて登録される際、現在の実装ではランタイムIDが<AWS_アカウントID><AWS_リージョン><AWS_ステージ>の形式で生成されます。その結果、ランタイム名を変更してもランタイムIDは変更されません。 エージェントの再起動間でランタイム名が変更されても、 フェデレーテッドAPI管理では新しいランタイムは作成されません。 代わりに、ランタイム名は既存のランタイム用に更新される。 |
| apicp_runtime_description | オプション。 ランタイムの説明。 説明は300文字を超えてはなりません。 デフォルト値: AWS ランタイム。 このプロパティに値を指定しない場合、デフォルト値が考慮される。 |
| apicp_runtime_region | オプション。 ランタイムがホストされているリージョン名。 例：米国東部 地域名は50文字を超えてはなりません。 |
| apicp_runtime_location | オプション。 ランタイムがデプロイされる場所。 国|州|都市の形式で場所を指定してください。 注： と個々のフィールド（
APICP_RUNTIME_COUNTRY, APICP_RUNTIME_STATE, および APICP_RUNTIME_CITY）の APICP_RUNTIME_LOCATION 両方が指定されている場合、の値が優先されます APICP_RUNTIME_LOCATION 。 |
| APICP_RUNTIME_COUNTRY | オプション。 ランタイムがデプロイされる国。 |
| APICP_RUNTIME_STATE | オプション。 ランタイムがデプロイされている状態。 |
| APICP_RUNTIME_CITY | オプション。 ランタイムがデプロイされる都市。 都市名が一意であり、国および州のフィールドが指定されていない場合、 フェデレーテッドAPI管理は自動的に国および州の値を設定します。 |
| apicp_runtime_tags | オプション。 ランタイムのタグ名。 デフォルト: AWS このプロパティの値を指定しない場合、デフォルト値が適用されます。 タグはランタイムを整理し分類するために使用されます。 複数のタグはコンマを追加することで指定できます。 例: test, local, devTags は50文字を超えてはならない。 空白を含んではならず、タグの数は100を超えてはならない。 |
| apicp_runtime_capacity_value | オプション。 ランタイムが指定された期間内に処理できるトランザクション呼び出しの数。 容量値は任意の非負の整数で設定できますデフォルト値: 500000 |
| apicp_runtime_capacity_unit（アピクパ・ランタイム・キャパシティ・ユニット | オプション。 容量値は、負でない任意の整数で、以下の単位で任意の期間を設定できる：
|
連携API管理コンフィギュレーションでは、Amazon API Gateway が接続を確立しなければならない連携API管理の詳細を指定できる。
| プロパティ－ | 説明 |
|---|---|
| APICP_URL | 必須。 連携API管理へのアクセスに使用される有効な URL。 |
| APICP_ユーザー名 | 必須。 連携API管理へのログインに使用するユーザー名。 |
| APICP_パスワード | 必須。 ベーシック認証による連携 API 管理へのログインに使用される、対応するユーザー名のパスワード。 |
| apicp_ssl_enabled | オプション。 連携API 管理のSSL認証。取り得る値： true または false |
| apicp_truststore_path | オプション。 トラストストアの場所 file.If APICP_SSL_ENABLEDが trueに設定されている場合、このプロパティに値を指定する必要があります。 |
| apicp_truststore_password | オプション。 トラストストアにアクセスするためのパスワード file.If APICP_SSL_ENABLEDが trueに設定されている場合、このプロパティに値を指定する必要があります。 |
| apicp_truststore_type | オプション。 truststore.If APICP_SSL_ENABLED が true に設定されている場合、このプロパティに値を指定する必要があります。 |
| apicp_keystore_path | オプション。 鍵ストアの場所 file.If APICP_SSL_ENABLEDが trueに設定されている場合、このプロパティに値を指定する必要があります。 |
| apicp_keystore_password | オプション。 鍵ストアにアクセスするためのパスワード file.If APICP_SSL_ENABLEDが trueに設定されている場合、このプロパティに値を指定する必要があります。 |
| apicp_keystore_type | オプション。 keystore.If APICP_SSL_ENABLED が true に設定されている場合、このプロパティに値を指定する必要があります。 |
| apicp_key_alias | オプション。 keystore.If APICP_SSL_ENABLED が true に設定されている場合、このプロパティに値を指定する必要があります。 |
| apicp_key_password | オプション。 keystore.If APICP_SSL_ENABLEDのキーのパスワードが trueに設定されている場合、このプロパティに値を指定する必要があります。 |
| APICP_HTTP_接続タイムアウト | オプション。 エージェントがフェデレーテッドAPI管理との初期接続を確立しなければならない秒単位の時間。 デフォルト: 10 秒。 |
| APICP_HTTP_READ_タイムアウト | オプション。 エージェントが確立された HTTP 接続を介してデータを受信できない状態が継続する秒数。 デフォルト: 10 秒。 |
| APICP_HTTP_MAX_CONNECTION | オプション。 エージェントがフェデレーションAPI 管理と確立できる同時接続の最大数を定義します。 デフォルト: 5. |
| APICP_HTTP_最大再試行回数 | オプション。 初期接続失敗後、操作が自動的に再試行される最大回数を定義します。 デフォルト: 0. |
| APICP_HTTP_再試行間隔 | オプション。 エージェントが接続に失敗した後、 フェデレーションAPI管理への再接続を試行するまでの待機時間を秒単位で指定します。 デフォルト: 5秒 |
以下はMetrics Lambda Function固有のプロパティです。
| プロパティ－ | 説明 |
|---|---|
| AWS_メトリクス_データ別または統計別 | オプション。 CloudWatch.Valuesからメトリクスを取得する方法：
|
| aws_metrics_sync_buffer_interval_seconds | オプション。 デフォルトでは、Amazon API Gateway のメトリック・データは1分間隔で自動的にAmazon CloudWatch に送信される。 つまり、ほとんどのAmazon API Gateway メトリクスは、元のデータ point.But から1分以内にAmazon CloudWatch で利用できるようになります。適切なメトリクスの同期を確保するには、 CloudWatch バッファ時間間隔を600秒（10分）以上に設定します。デフォルト値は600秒です。 このプロパティに値を指定しない場合、デフォルト値が考慮される。 |
| apicp_metrics_send_interval_seconds | オプション。 エージェントが Amazon CloudWatch からメトリクスを取得し、 連携 API 管理にメトリクスを送信するまでの秒数。 サポートされるメトリック同期値：
|
以下は、アセット・ラムダ関数に固有のプロパティです。
| プロパティ－ | 説明 |
|---|---|
| apicp_assets_sync_interval_seconds | オプション。 エージェントがアセットに加えられた変更を、Amazon CloudTrail から連携 API 管理に同期させなければならない時間（秒）。 Min:60 おかわり 最大：21600秒（6時間） デフォルト：300秒 このプロパティに値を指定しない場合、デフォルト値が考慮される。 |
| aws_assets_sync_buffer_interval_seconds | 必須。 CloudTrail 通常、APIコールが行われてから約5分以内にAmazon API Gateway の管理イベントが配信される。 これは、 CloudTrail イベントの標準的な納期です。 したがって、 CloudTrail イベント時間間隔を300秒（5分）以上に設定してください。デフォルト値は300秒です。 このプロパティに値を指定しない場合、デフォルト値が考慮される。 |