interface AuthProperty

Language	Type name
.NET	`Amazon.CDK.AWS.SAM.CfnFunction.AuthProperty`
Java	`software.amazon.awscdk.services.sam.CfnFunction.AuthProperty`
Python	`aws_cdk.aws_sam.CfnFunction.AuthProperty`
TypeScript	`@aws-cdk/aws-sam` » `CfnFunction` » `AuthProperty`

Example

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

declare const customStatements: any;
const authProperty: sam.CfnFunction.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`	`CfnFunction.AuthProperty.ApiKeyRequired`.
authorizationScopes?	`string[]`	`CfnFunction.AuthProperty.AuthorizationScopes`.
authorizer?	`string`	`CfnFunction.AuthProperty.Authorizer`.
resourcePolicy?	`IResolvable` `\|` `AuthResourcePolicyProperty`	`CfnFunction.AuthProperty.ResourcePolicy`.

apiKeyRequired?

Type: boolean | IResolvable (optional)

CfnFunction.AuthProperty.ApiKeyRequired.

authorizationScopes?

Type: string[] (optional)

CfnFunction.AuthProperty.AuthorizationScopes.

authorizer?

Type: string (optional)

CfnFunction.AuthProperty.Authorizer.

resourcePolicy?

Type: IResolvable | AuthResourcePolicyProperty (optional)

CfnFunction.AuthProperty.ResourcePolicy.