interface AuthProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SAM.Mixins.CfnFunctionPropsMixin.AuthProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssam/mixins#CfnFunctionPropsMixin_AuthProperty
Java	software.amazon.awscdk.mixins.preview.services.sam.mixins.CfnFunctionPropsMixin.AuthProperty
Python	aws_cdk.mixins_preview.aws_sam.mixins.CfnFunctionPropsMixin.AuthProperty
TypeScript	@aws-cdk/mixins-preview » aws_sam » mixins » CfnFunctionPropsMixin » AuthProperty

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

Example

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

declare const customStatements: any;
const authProperty: sam_mixins.CfnFunctionPropsMixin.AuthProperty = {
  apiKeyRequired: false,
  authorizationScopes: ['authorizationScopes'],
  authorizer: 'authorizer',
  resourcePolicy: {
    awsAccountBlacklist: ['awsAccountBlacklist'],
    awsAccountWhitelist: ['awsAccountWhitelist'],
    customStatements: [customStatements],
    intrinsicVpcBlacklist: ['intrinsicVpcBlacklist'],
    intrinsicVpceBlacklist: ['intrinsicVpceBlacklist'],
    intrinsicVpceWhitelist: ['intrinsicVpceWhitelist'],
    intrinsicVpcWhitelist: ['intrinsicVpcWhitelist'],
    ipRangeBlacklist: ['ipRangeBlacklist'],
    ipRangeWhitelist: ['ipRangeWhitelist'],
    sourceVpcBlacklist: ['sourceVpcBlacklist'],
    sourceVpcWhitelist: ['sourceVpcWhitelist'],
  },
};

Properties

Name	Type	Description
apiKeyRequired?	boolean | IResolvable
authorizationScopes?	string[]
authorizer?	string
resourcePolicy?	IResolvable | AuthResourcePolicyProperty

---

apiKeyRequired?

Type: boolean | IResolvable (optional)

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

---

authorizationScopes?

Type: string[] (optional)

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

---

authorizer?

Type: string (optional)

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

---

resourcePolicy?

Type: IResolvable | AuthResourcePolicyProperty (optional)

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