1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lambda
  5. Url

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.lambda.Url

Explore with Pulumi AI

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

Resource Type definition for AWS::Lambda::Url

Create Url Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Url(name: string, args: UrlArgs, opts?: CustomResourceOptions);
@overload
def Url(resource_name: str,
        args: UrlArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Url(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        auth_type: Optional[lambda_.UrlAuthType] = None,
        target_function_arn: Optional[str] = None,
        cors: Optional[_lambda_.UrlCorsArgs] = None,
        invoke_mode: Optional[lambda_.UrlInvokeMode] = None,
        qualifier: Optional[str] = None)
func NewUrl(ctx *Context, name string, args UrlArgs, opts ...ResourceOption) (*Url, error)
public Url(string name, UrlArgs args, CustomResourceOptions? opts = null)
public Url(String name, UrlArgs args)
public Url(String name, UrlArgs args, CustomResourceOptions options)
type: aws-native:lambda:Url
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UrlArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UrlArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UrlArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UrlArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UrlArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Url Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Url resource accepts the following input properties:

AuthType This property is required. 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.
TargetFunctionArn This property is required. string
The Amazon Resource Name (ARN) of the function associated with the Function URL.
Cors Pulumi.AwsNative.Lambda.Inputs.UrlCors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
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.
Qualifier string
The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.
AuthType This property is required. UrlAuthType
Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
TargetFunctionArn This property is required. string
The Amazon Resource Name (ARN) of the function associated with the Function URL.
Cors UrlCorsArgs
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
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.
Qualifier string
The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.
authType This property is required. UrlAuthType
Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
targetFunctionArn This property is required. String
The Amazon Resource Name (ARN) of the function associated with the Function URL.
cors UrlCors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
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.
qualifier String
The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.
authType This property is required. UrlAuthType
Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
targetFunctionArn This property is required. string
The Amazon Resource Name (ARN) of the function associated with the Function URL.
cors UrlCors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
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.
qualifier string
The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.
auth_type This property is required. 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.
target_function_arn This property is required. str
The Amazon Resource Name (ARN) of the function associated with the Function URL.
cors lambda_.UrlCorsArgs
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
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.
qualifier str
The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.
authType This property is required. "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.
targetFunctionArn This property is required. String
The Amazon Resource Name (ARN) of the function associated with the Function URL.
cors Property Map
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
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.
qualifier String
The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.

Outputs

All input properties are implicitly available as output properties. Additionally, the Url resource produces the following output properties:

FunctionArn string
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
FunctionUrl string
The generated url for this resource.
Id string
The provider-assigned unique ID for this managed resource.
FunctionArn string
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
FunctionUrl string
The generated url for this resource.
Id string
The provider-assigned unique ID for this managed resource.
functionArn String
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
functionUrl String
The generated url for this resource.
id String
The provider-assigned unique ID for this managed resource.
functionArn string
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
functionUrl string
The generated url for this resource.
id string
The provider-assigned unique ID for this managed resource.
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.
id str
The provider-assigned unique ID for this managed resource.
functionArn String
The full Amazon Resource Name (ARN) of the function associated with the Function URL.
functionUrl String
The generated url for this resource.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

UrlAllowMethodsItem
, UrlAllowMethodsItemArgs

Get
GET
Put
PUT
Head
HEAD
Post
POST
Patch
PATCH
Delete
DELETE
Asterisk
*
UrlAllowMethodsItemGet
GET
UrlAllowMethodsItemPut
PUT
UrlAllowMethodsItemHead
HEAD
UrlAllowMethodsItemPost
POST
UrlAllowMethodsItemPatch
PATCH
UrlAllowMethodsItemDelete
DELETE
UrlAllowMethodsItemAsterisk
*
Get
GET
Put
PUT
Head
HEAD
Post
POST
Patch
PATCH
Delete
DELETE
Asterisk
*
Get
GET
Put
PUT
Head
HEAD
Post
POST
Patch
PATCH
Delete
DELETE
Asterisk
*
GET
GET
PUT
PUT
HEAD
HEAD
POST
POST
PATCH
PATCH
DELETE
DELETE
ASTERISK
*
"GET"
GET
"PUT"
PUT
"HEAD"
HEAD
"POST"
POST
"PATCH"
PATCH
"DELETE"
DELETE
"*"
*

UrlAuthType
, UrlAuthTypeArgs

AwsIam
AWS_IAM
None
NONE
UrlAuthTypeAwsIam
AWS_IAM
UrlAuthTypeNone
NONE
AwsIam
AWS_IAM
None
NONE
AwsIam
AWS_IAM
None
NONE
AWS_IAM
AWS_IAM
NONE
NONE
"AWS_IAM"
AWS_IAM
"NONE"
NONE

UrlCors
, UrlCorsArgs

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
, UrlInvokeModeArgs

Buffered
BUFFERED
ResponseStream
RESPONSE_STREAM
UrlInvokeModeBuffered
BUFFERED
UrlInvokeModeResponseStream
RESPONSE_STREAM
Buffered
BUFFERED
ResponseStream
RESPONSE_STREAM
Buffered
BUFFERED
ResponseStream
RESPONSE_STREAM
BUFFERED
BUFFERED
RESPONSE_STREAM
RESPONSE_STREAM
"BUFFERED"
BUFFERED
"RESPONSE_STREAM"
RESPONSE_STREAM

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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi