interface AuthProperty

Language	Type name
.NET	Amazon.CDK.AWS.SAM.CfnApi.AuthProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnApi_AuthProperty
Java	software.amazon.awscdk.services.sam.CfnApi.AuthProperty
Python	aws_cdk.aws_sam.CfnApi.AuthProperty
TypeScript	aws-cdk-lib » aws_sam » CfnApi » AuthProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-auth.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sam as sam } from 'aws-cdk-lib';

declare const authorizers: any;
const authProperty: sam.CfnApi.AuthProperty = {
  addDefaultAuthorizerToCorsPreflight: false,
  authorizers: authorizers,
  defaultAuthorizer: 'defaultAuthorizer',
};

Properties

Name	Type	Description
addDefaultAuthorizerToCorsPreflight?	boolean | IResolvable
authorizers?	any
defaultAuthorizer?	string

---

addDefaultAuthorizerToCorsPreflight?

Type: boolean | IResolvable (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-auth.html#cfn-serverless-api-auth-adddefaultauthorizertocorspreflight

---

authorizers?

Type: any (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-auth.html#cfn-serverless-api-auth-authorizers

---

defaultAuthorizer?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-auth.html#cfn-serverless-api-auth-defaultauthorizer