aws-cdk-lib.aws_sam.CfnApi.AuthProperty

interface AuthProperty

LanguageType name
.NETAmazon.CDK.AWS.SAM.CfnApi.AuthProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnApi_AuthProperty
Javasoftware.amazon.awscdk.services.sam.CfnApi.AuthProperty
Pythonaws_cdk.aws_sam.CfnApi.AuthProperty
TypeScript aws-cdk-lib » aws_sam » CfnApi » AuthProperty

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

NameTypeDescription
addDefaultAuthorizerToCorsPreflight?boolean | IResolvableCfnApi.AuthProperty.AddDefaultAuthorizerToCorsPreflight.
authorizers?anyCfnApi.AuthProperty.Authorizers.
defaultAuthorizer?stringCfnApi.AuthProperty.DefaultAuthorizer.

addDefaultAuthorizerToCorsPreflight?

Type: boolean | IResolvable (optional)

CfnApi.AuthProperty.AddDefaultAuthorizerToCorsPreflight.


authorizers?

Type: any (optional)

CfnApi.AuthProperty.Authorizers.


defaultAuthorizer?

Type: string (optional)

CfnApi.AuthProperty.DefaultAuthorizer.