aws-native.lambda.Url
Explore with Pulumi AI
Resource Type definition for AWS::Lambda::Url
Create Url Resource
new Url(name: string, args: UrlArgs, opts?: CustomResourceOptions);
@overload
def Url(resource_name: str,
opts: Optional[ResourceOptions] = None,
auth_type: Optional[_lambda_.UrlAuthType] = None,
cors: Optional[_lambda_.UrlCorsArgs] = None,
invoke_mode: Optional[_lambda_.UrlInvokeMode] = None,
qualifier: Optional[str] = None,
target_function_arn: Optional[str] = None)
@overload
def Url(resource_name: str,
args: UrlArgs,
opts: Optional[ResourceOptions] = None)
func NewUrl(ctx *Context, name string, args UrlArgs, opts ...ResourceOption) (*Url, error)
public Url(string name, UrlArgs args, CustomResourceOptions? opts = null)
type: aws-native:lambda:Url
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UrlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args UrlArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UrlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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
The Url resource accepts the following input properties:
- Auth
Type Pulumi.Aws Native. Lambda. Url Auth Type 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 stringArn The Amazon Resource Name (ARN) of the function associated with the Function URL.
- Cors
Pulumi.
Aws Native. Lambda. Inputs. Url Cors Args - Invoke
Mode Pulumi.Aws Native. Lambda. Url Invoke Mode 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 UrlAuth Type 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 stringArn The Amazon Resource Name (ARN) of the function associated with the Function URL.
- Cors
Url
Cors Args - Invoke
Mode UrlInvoke Mode 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 UrlAuth Type 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 StringArn The Amazon Resource Name (ARN) of the function associated with the Function URL.
- cors
Url
Cors Args - invoke
Mode UrlInvoke Mode 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 UrlAuth Type 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 stringArn The Amazon Resource Name (ARN) of the function associated with the Function URL.
- cors
Url
Cors Args - invoke
Mode UrlInvoke Mode 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 UrlAuth Type 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_ strarn The Amazon Resource Name (ARN) of the function associated with the Function URL.
- cors
Url
Cors Args - invoke_
mode UrlInvoke Mode 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.
- auth
Type "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.
- target
Function StringArn The Amazon Resource Name (ARN) of the function associated with the Function URL.
- cors Property Map
- invoke
Mode "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:
- Function
Arn string The full Amazon Resource Name (ARN) of the function associated with the Function URL.
- Function
Url string The generated url for this resource.
- Id string
The provider-assigned unique ID for this managed resource.
- Function
Arn string The full Amazon Resource Name (ARN) of the function associated with the Function URL.
- Function
Url string The generated url for this resource.
- Id string
The provider-assigned unique ID for this managed resource.
- function
Arn String The full Amazon Resource Name (ARN) of the function associated with the Function URL.
- function
Url String The generated url for this resource.
- id String
The provider-assigned unique ID for this managed resource.
- function
Arn string The full Amazon Resource Name (ARN) of the function associated with the Function URL.
- function
Url 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.
- function
Arn String The full Amazon Resource Name (ARN) of the function associated with the Function URL.
- function
Url String The generated url for this resource.
- id String
The provider-assigned unique ID for this managed resource.
Supporting Types
UrlAllowMethodsItem
- Get
- GET
- Put
- PUT
- Head
- HEAD
- Post
- POST
- Patch
- PATCH
- Delete
- DELETE
- Asterisk
- *
- Url
Allow Methods Item Get - GET
- Url
Allow Methods Item Put - PUT
- Url
Allow Methods Item Head - HEAD
- Url
Allow Methods Item Post - POST
- Url
Allow Methods Item Patch - PATCH
- Url
Allow Methods Item Delete - DELETE
- Url
Allow Methods Item 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
- ASTERISK
- *
- "GET"
- GET
- "PUT"
- PUT
- "HEAD"
- HEAD
- "POST"
- POST
- "PATCH"
- PATCH
- "DELETE"
- DELETE
- "*"
- *
UrlAuthType
- Aws
Iam - AWS_IAM
- None
- NONE
- Url
Auth Type Aws Iam - AWS_IAM
- Url
Auth Type None - NONE
- Aws
Iam - AWS_IAM
- None
- NONE
- Aws
Iam - AWS_IAM
- None
- NONE
- AWS_IAM
- AWS_IAM
- NONE
- NONE
- "AWS_IAM"
- AWS_IAM
- "NONE"
- NONE
UrlCors
- Allow
Credentials bool Specifies whether credentials are included in the CORS request.
- Allow
Headers List<string> Represents a collection of allowed headers.
- Allow
Methods List<Pulumi.Aws Native. Lambda. Url Allow Methods Item> Represents a collection of allowed HTTP methods.
- Allow
Origins List<string> Represents a collection of allowed origins.
- Expose
Headers List<string> Represents a collection of exposed headers.
- Max
Age int
- Allow
Credentials bool Specifies whether credentials are included in the CORS request.
- Allow
Headers []string Represents a collection of allowed headers.
- Allow
Methods []UrlAllow Methods Item Represents a collection of allowed HTTP methods.
- Allow
Origins []string Represents a collection of allowed origins.
- Expose
Headers []string Represents a collection of exposed headers.
- Max
Age int
- allow
Credentials Boolean Specifies whether credentials are included in the CORS request.
- allow
Headers List<String> Represents a collection of allowed headers.
- allow
Methods List<UrlAllow Methods Item> Represents a collection of allowed HTTP methods.
- allow
Origins List<String> Represents a collection of allowed origins.
- expose
Headers List<String> Represents a collection of exposed headers.
- max
Age Integer
- allow
Credentials boolean Specifies whether credentials are included in the CORS request.
- allow
Headers string[] Represents a collection of allowed headers.
- allow
Methods UrlAllow Methods Item[] Represents a collection of allowed HTTP methods.
- allow
Origins string[] Represents a collection of allowed origins.
- expose
Headers string[] Represents a collection of exposed headers.
- max
Age number
- allow_
credentials bool Specifies whether credentials are included in the CORS request.
- allow_
headers Sequence[str] Represents a collection of allowed headers.
- allow_
methods UrlAllow Methods Item] 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
- allow
Credentials Boolean Specifies whether credentials are included in the CORS request.
- allow
Headers List<String> Represents a collection of allowed headers.
- allow
Methods List<"GET" | "PUT" | "HEAD" | "POST" | "PATCH" | "DELETE" | "*"> Represents a collection of allowed HTTP methods.
- allow
Origins List<String> Represents a collection of allowed origins.
- expose
Headers List<String> Represents a collection of exposed headers.
- max
Age Number
UrlInvokeMode
- Buffered
- BUFFERED
- Response
Stream - RESPONSE_STREAM
- Url
Invoke Mode Buffered - BUFFERED
- Url
Invoke Mode Response Stream - RESPONSE_STREAM
- Buffered
- BUFFERED
- Response
Stream - RESPONSE_STREAM
- Buffered
- BUFFERED
- Response
Stream - 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