Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lambda
  5. getUrl

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.lambda.getUrl

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::Lambda::Url

Using getUrl

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUrl(args: GetUrlArgs, opts?: InvokeOptions): Promise<GetUrlResult>
function getUrlOutput(args: GetUrlOutputArgs, opts?: InvokeOptions): Output<GetUrlResult>
Copy
def get_url(function_arn: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetUrlResult
def get_url_output(function_arn: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetUrlResult]
Copy
func LookupUrl(ctx *Context, args *LookupUrlArgs, opts ...InvokeOption) (*LookupUrlResult, error)
func LookupUrlOutput(ctx *Context, args *LookupUrlOutputArgs, opts ...InvokeOption) LookupUrlResultOutput
Copy

> Note: This function is named LookupUrl in the Go SDK.

public static class GetUrl 
{
    public static Task<GetUrlResult> InvokeAsync(GetUrlArgs args, InvokeOptions? opts = null)
    public static Output<GetUrlResult> Invoke(GetUrlInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUrlResult> getUrl(GetUrlArgs args, InvokeOptions options)
public static Output<GetUrlResult> getUrl(GetUrlArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:lambda:getUrl
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FunctionArn This property is required. string
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
FunctionArn This property is required. string
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
functionArn This property is required. String
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
functionArn This property is required. string
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
function_arn This property is required. str
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
functionArn This property is required. String
The full Amazon Resource Name (ARN) of the function associated with the Function URL.

getUrl Result

The following output properties are available:

AuthType Pulumi.AwsNative.Lambda.UrlAuthType
Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
Cors Pulumi.AwsNative.Lambda.Outputs.UrlCors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
FunctionArn string
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
FunctionUrl string
The generated url for this resource.
InvokeMode Pulumi.AwsNative.Lambda.UrlInvokeMode
The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.
AuthType UrlAuthType
Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
Cors UrlCors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
FunctionArn string
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
FunctionUrl string
The generated url for this resource.
InvokeMode UrlInvokeMode
The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.
authType UrlAuthType
Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
cors UrlCors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
functionArn String
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
functionUrl String
The generated url for this resource.
invokeMode UrlInvokeMode
The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.
authType UrlAuthType
Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
cors UrlCors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
functionArn string
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
functionUrl string
The generated url for this resource.
invokeMode UrlInvokeMode
The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.
auth_type lambda_.UrlAuthType
Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
cors lambda_.UrlCors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
function_arn str
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
function_url str
The generated url for this resource.
invoke_mode lambda_.UrlInvokeMode
The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.
authType "AWS_IAM" | "NONE"
Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
cors Property Map
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
functionArn String
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
functionUrl String
The generated url for this resource.
invokeMode "BUFFERED" | "RESPONSE_STREAM"
The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.

Supporting Types

UrlAllowMethodsItem

UrlAuthType

UrlCors

AllowCredentials bool
Specifies whether credentials are included in the CORS request.
AllowHeaders List<string>
Represents a collection of allowed headers.
AllowMethods List<Pulumi.AwsNative.Lambda.UrlAllowMethodsItem>
Represents a collection of allowed HTTP methods.
AllowOrigins List<string>
Represents a collection of allowed origins.
ExposeHeaders List<string>
Represents a collection of exposed headers.
MaxAge int
The maximum amount of time, in seconds, that browsers can cache results of a preflight request. By default, this is set to 0 , which means the browser will not cache results.
AllowCredentials bool
Specifies whether credentials are included in the CORS request.
AllowHeaders []string
Represents a collection of allowed headers.
AllowMethods []UrlAllowMethodsItem
Represents a collection of allowed HTTP methods.
AllowOrigins []string
Represents a collection of allowed origins.
ExposeHeaders []string
Represents a collection of exposed headers.
MaxAge int
The maximum amount of time, in seconds, that browsers can cache results of a preflight request. By default, this is set to 0 , which means the browser will not cache results.
allowCredentials Boolean
Specifies whether credentials are included in the CORS request.
allowHeaders List<String>
Represents a collection of allowed headers.
allowMethods List<UrlAllowMethodsItem>
Represents a collection of allowed HTTP methods.
allowOrigins List<String>
Represents a collection of allowed origins.
exposeHeaders List<String>
Represents a collection of exposed headers.
maxAge Integer
The maximum amount of time, in seconds, that browsers can cache results of a preflight request. By default, this is set to 0 , which means the browser will not cache results.
allowCredentials boolean
Specifies whether credentials are included in the CORS request.
allowHeaders string[]
Represents a collection of allowed headers.
allowMethods UrlAllowMethodsItem[]
Represents a collection of allowed HTTP methods.
allowOrigins string[]
Represents a collection of allowed origins.
exposeHeaders string[]
Represents a collection of exposed headers.
maxAge number
The maximum amount of time, in seconds, that browsers can cache results of a preflight request. By default, this is set to 0 , which means the browser will not cache results.
allow_credentials bool
Specifies whether credentials are included in the CORS request.
allow_headers Sequence[str]
Represents a collection of allowed headers.
allow_methods Sequence[lambda_.UrlAllowMethodsItem]
Represents a collection of allowed HTTP methods.
allow_origins Sequence[str]
Represents a collection of allowed origins.
expose_headers Sequence[str]
Represents a collection of exposed headers.
max_age int
The maximum amount of time, in seconds, that browsers can cache results of a preflight request. By default, this is set to 0 , which means the browser will not cache results.
allowCredentials Boolean
Specifies whether credentials are included in the CORS request.
allowHeaders List<String>
Represents a collection of allowed headers.
allowMethods List<"GET" | "PUT" | "HEAD" | "POST" | "PATCH" | "DELETE" | "*">
Represents a collection of allowed HTTP methods.
allowOrigins List<String>
Represents a collection of allowed origins.
exposeHeaders List<String>
Represents a collection of exposed headers.
maxAge Number
The maximum amount of time, in seconds, that browsers can cache results of a preflight request. By default, this is set to 0 , which means the browser will not cache results.

UrlInvokeMode

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native