FunctionUrl — AWS Cloud Development Kit 1.204.0 documentation (original) (raw)

AWS Cloud Development Kit

class aws_cdk.aws_lambda.FunctionUrl(scope, id, *, function, auth_type=None, cors=None)

Bases: Resource

Defines a Lambda function url.

Resource:

AWS::Lambda::Url

ExampleMetadata:

infused

Example:

Can be a Function or an Alias

fn: lambda.Function

my_role: iam.Role

fn_url = fn.add_function_url() fn_url.grant_invoke_url(my_role)

CfnOutput(self, "TheUrl", # The .url attributes will return the unique Function URL value=fn_url.url )

Parameters:

scope (Construct)
id (str)
function (IFunction) – The function to which this url refers. It can also be an Alias but not a Version.
auth_type (Optional[FunctionUrlAuthType]) – The type of authentication that your function URL uses. Default: FunctionUrlAuthType.AWS_IAM
cors (Union[FunctionUrlCorsOptions, Dict[str, Any], None]) – The cross-origin resource sharing (CORS) settings for your function URL. Default: - No CORS configuration.

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy)

Return type:

None

grant_invoke_url(grantee)

Grant the given identity permissions to invoke this Lambda Function URL.

Parameters:

grantee (IGrantable)

Return type:

Grant

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

function_arn

The ARN of the function this URL refers to.

node

The construct tree node associated with this construct.

stack

The stack in which this resource is defined.

url

The url of the Lambda function.

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any)

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct)

Return type:

bool