software.amazon.awscdk.services.lambda

Class CfnUrl

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lambda.CfnUrl

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.416Z")
 @Stability(value=Stable)
public class CfnUrl
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lambda::Url`.

The AWS::Lambda::Url resource creates a function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 CfnUrl cfnUrl = CfnUrl.Builder.create(this, "MyCfnUrl")
         .authType("authType")
         .targetFunctionArn("targetFunctionArn")
         // the properties below are optional
         .cors(CorsProperty.builder()
                 .allowCredentials(false)
                 .allowHeaders(List.of("allowHeaders"))
                 .allowMethods(List.of("allowMethods"))
                 .allowOrigins(List.of("allowOrigins"))
                 .exposeHeaders(List.of("exposeHeaders"))
                 .maxAge(123)
                 .build())
         .invokeMode("invokeMode")
         .qualifier("qualifier")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnUrl.Builder A fluent builder for CfnUrl.
static interface	CfnUrl.CorsProperty 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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUrl(software.constructs.Construct scope, String id, CfnUrlProps props) Create a new `AWS::Lambda::Url`.
protected	CfnUrl(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUrl(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrFunctionArn() The Amazon Resource Name (ARN) of the function.
String	getAttrFunctionUrl() The HTTP URL endpoint for your function.
String	getAuthType() The type of authentication that your function URL uses.
protected Map<String,Object>	getCfnProperties()
Object	getCors() 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.
String	getInvokeMode() `AWS::Lambda::Url.InvokeMode`.
String	getQualifier() The alias name.
String	getTargetFunctionArn() The name of the Lambda function.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthType(String value) The type of authentication that your function URL uses.
void	setCors(CfnUrl.CorsProperty value) 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.
void	setCors(IResolvable value) 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.
void	setInvokeMode(String value) `AWS::Lambda::Url.InvokeMode`.
void	setQualifier(String value) The alias name.
void	setTargetFunctionArn(String value) The name of the Lambda function.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUrl

protected CfnUrl(software.amazon.jsii.JsiiObjectRef objRef)

CfnUrl

protected CfnUrl(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUrl

@Stability(value=Stable)
public CfnUrl(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id,
                                       @NotNull
                                       CfnUrlProps props)

Create a new `AWS::Lambda::Url`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrFunctionArn

@Stability(value=Stable)
 @NotNull
public String getAttrFunctionArn()

The Amazon Resource Name (ARN) of the function.

getAttrFunctionUrl

@Stability(value=Stable)
 @NotNull
public String getAttrFunctionUrl()

The HTTP URL endpoint for your function.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAuthType

@Stability(value=Stable)
 @NotNull
public String getAuthType()

The type of authentication that your function URL uses.

Set to AWS_IAM if you want to restrict access to authenticated IAM users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs .

setAuthType

@Stability(value=Stable)
public void setAuthType(@NotNull
                                                 String value)

The type of authentication that your function URL uses.

Set to AWS_IAM if you want to restrict access to authenticated IAM users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs .

getTargetFunctionArn

@Stability(value=Stable)
 @NotNull
public String getTargetFunctionArn()

The name of the Lambda function.

Name formats - Function name - my-function .

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function .
• Partial ARN - 123456789012:function:my-function .

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

setTargetFunctionArn

@Stability(value=Stable)
public void setTargetFunctionArn(@NotNull
                                                          String value)

The name of the Lambda function.

Name formats - Function name - my-function .

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function .
• Partial ARN - 123456789012:function:my-function .

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

getCors

@Stability(value=Stable)
 @Nullable
public Object getCors()

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.

setCors

@Stability(value=Stable)
public void setCors(@Nullable
                                             CfnUrl.CorsProperty value)

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.

setCors

@Stability(value=Stable)
public void setCors(@Nullable
                                             IResolvable value)

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.

getInvokeMode

@Stability(value=Stable)
 @Nullable
public String getInvokeMode()

`AWS::Lambda::Url.InvokeMode`.

setInvokeMode

@Stability(value=Stable)
public void setInvokeMode(@Nullable
                                                   String value)

`AWS::Lambda::Url.InvokeMode`.

getQualifier

@Stability(value=Stable)
 @Nullable
public String getQualifier()

The alias name.

setQualifier

@Stability(value=Stable)
public void setQualifier(@Nullable
                                                  String value)

The alias name.