aws-cdk-lib.aws_sam.CfnFunction.AuthProperty

interface AuthProperty

LanguageType name
.NETAmazon.CDK.AWS.SAM.CfnFunction.AuthProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnFunction_AuthProperty
Javasoftware.amazon.awscdk.services.sam.CfnFunction.AuthProperty
Pythonaws_cdk.aws_sam.CfnFunction.AuthProperty
TypeScript aws-cdk-lib » 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 { aws_sam as sam } from 'aws-cdk-lib';

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

NameTypeDescription
apiKeyRequired?boolean | IResolvableCfnFunction.AuthProperty.ApiKeyRequired.
authorizationScopes?string[]CfnFunction.AuthProperty.AuthorizationScopes.
authorizer?stringCfnFunction.AuthProperty.Authorizer.
resourcePolicy?IResolvable | AuthResourcePolicyPropertyCfnFunction.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.