FunctionUrlConfig

指定された設定パラメータを使用して AWS Lambda 関数 URL を作成します。Lambda 関数 URL は、関数を呼び出すために使用する HTTPS エンドポイントです。

デフォルトでは、作成する関数 URL は Lambda 関数のバージョン $LATEST を使用します。Lambda 関数に AutoPublishAlias を指定した場合、エンドポイントは指定された関数エイリアスに接続します。

詳細については、「AWS Lambda デベロッパーガイド」の「Lambda 関数 URL」を参照してください。

構文

AWS Serverless Application Model （AWS SAM) テンプレートでこのエンティティを宣言するには、次の構文を使用します。

YAML

AuthType: String
Cors: Cors
InvokeMode: String

プロパティ

AuthType

関数 URL が使用する認証のタイプ。 AWS Identity and Access Management (IAM) を使用してリクエストを承認するには、 を に設定しますAWS_IAM。オープンアクセスの場合は、[NONE] に設定します。

タイプ: 文字列

必須: はい

AWS CloudFormation 互換性: このプロパティは、 AWS::Lambda::Urlリソースの AuthTypeプロパティに直接渡されます。

Cors

関数 URL のための、Cross-Origin Resource Sharing (CORS) 設定。

型: Cors

必須: いいえ

AWS CloudFormation 互換性: このプロパティは、 AWS::Lambda::Urlリソースの Corsプロパティに直接渡されます。

InvokeMode

関数 URL が呼び出されるモード。呼び出しの完了後に関数がレスポンスを返すようにするには、BUFFERED に設定します。関数がレスポンスをストリーミングするようにするには、RESPONSE_STREAM に設定します。デフォルト値は、BUFFEREDです。

有効な値: BUFFERED または RESPONSE_STREAM

タイプ: 文字列

必須: いいえ

AWS CloudFormation 互換性: このプロパティは、 AWS::Lambda::Urlリソースの InvokeModeプロパティに直接渡されます。

例

関数 URL

次の例では、関数 URL を使用して Lambda 関数を作成します。関数 URL は IAM 認証を使用します。

YAML

HelloWorldFunction:
  Type: AWS::Serverless::Function
  Properties:
    CodeUri: hello_world/
    Handler: index.handler
    Runtime: nodejs20.x
    FunctionUrlConfig:
      AuthType: AWS_IAM
      InvokeMode: RESPONSE_STREAM

Outputs:
  MyFunctionUrlEndpoint:
      Description: "My Lambda Function URL Endpoint"
      Value:
        Fn::GetAtt: HelloWorldFunctionUrl.FunctionUrl