@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
85 lines (84 loc) • 4.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource Type definition for AWS::Lambda::Url
*/
export declare class Url extends pulumi.CustomResource {
/**
* Get an existing Url resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Url;
/**
* Returns true if the given object is an instance of Url. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Url;
/**
* Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
*/
readonly authType: pulumi.Output<enums.lambda.UrlAuthType>;
/**
* The [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your function URL.
*/
readonly cors: pulumi.Output<outputs.lambda.UrlCors | undefined>;
/**
* The full Amazon Resource Name (ARN) of the function associated with the Function URL.
*/
readonly functionArn: pulumi.Output<string>;
/**
* The generated url for this resource.
*/
readonly functionUrl: pulumi.Output<string>;
/**
* 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.
*/
readonly invokeMode: pulumi.Output<enums.lambda.UrlInvokeMode | undefined>;
/**
* The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.
*/
readonly qualifier: pulumi.Output<string | undefined>;
/**
* The Amazon Resource Name (ARN) of the function associated with the Function URL.
*/
readonly targetFunctionArn: pulumi.Output<string>;
/**
* Create a Url resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: UrlArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Url resource.
*/
export interface UrlArgs {
/**
* Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.
*/
authType: pulumi.Input<enums.lambda.UrlAuthType>;
/**
* The [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your function URL.
*/
cors?: pulumi.Input<inputs.lambda.UrlCorsArgs>;
/**
* 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.
*/
invokeMode?: pulumi.Input<enums.lambda.UrlInvokeMode>;
/**
* The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed.
*/
qualifier?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) of the function associated with the Function URL.
*/
targetFunctionArn: pulumi.Input<string>;
}