2.233.0

interface CfnUrlMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.Lambda.Mixins.CfnUrlMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awslambda/mixins#CfnUrlMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.lambda.mixins.CfnUrlMixinProps
Pythonaws_cdk.mixins_preview.aws_lambda.mixins.CfnUrlMixinProps
TypeScript @aws-cdk/mixins-preview » aws_lambda » mixins » CfnUrlMixinProps

Properties for CfnUrlPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as lambda_mixins } from '@aws-cdk/mixins-preview/aws-lambda';
const cfnUrlMixinProps: lambda_mixins.CfnUrlMixinProps = {
  authType: 'authType',
  cors: {
    allowCredentials: false,
    allowHeaders: ['allowHeaders'],
    allowMethods: ['allowMethods'],
    allowOrigins: ['allowOrigins'],
    exposeHeaders: ['exposeHeaders'],
    maxAge: 123,
  },
  invokeMode: 'invokeMode',
  qualifier: 'qualifier',
  targetFunctionArn: 'targetFunctionArn',
};

Properties

NameTypeDescription
authType?stringThe type of authentication that your function URL uses.
cors?IResolvable | CorsPropertyThe Cross-Origin Resource Sharing (CORS) settings for your function URL.
invokeMode?stringUse one of the following options:.
qualifier?stringThe alias name.
targetFunctionArn?stringThe name of the Lambda function.

authType?

Type: string (optional)

The type of authentication that your function URL uses.

Set to AWS_IAM if you want to restrict access to authenticated 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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype

cors?

Type: IResolvable | CorsProperty (optional)

The Cross-Origin Resource Sharing (CORS) settings for your function URL.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-cors

invokeMode?

Type: string (optional)

Use one of the following options:.

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode

qualifier?

Type: string (optional)

The alias name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-qualifier

targetFunctionArn?

Type: string (optional)

The name of the Lambda function.

Name formats - Function name - my-function .

  • Function ARN - lambda: : :function:my-function .
  • Partial ARN - :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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-targetfunctionarn

← PreviousNext →