Skip to content
v2.275.0

AuthProperty Struct ​

Example ​

ts
// 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 ​

apiKeyRequiredoptionalboolean | IResolvableapi_key_requiredoptionaltyping.Union[bool, IResolvable]apiKeyRequiredoptionalBooleanApiKeyRequiredoptionalboolApiKeyRequiredoptionalinterface{}#
authorizationScopesoptionalstring[]authorization_scopesoptionaltyping.List[str]authorizationScopesoptionalList<String>AuthorizationScopesoptionalstring[]AuthorizationScopesoptional*[]*string#
authorizeroptionalstringauthorizeroptionalstrauthorizeroptionalStringAuthorizeroptionalstringAuthorizeroptional*string#
resourcePolicyoptionalIResolvable | CfnFunction.AuthResourcePolicyPropertyresource_policyoptionaltyping.Union[IResolvable, AuthResourcePolicyProperty]resourcePolicyoptionalIResolvableResourcePolicyoptionalIResolvableResourcePolicyoptionalinterface{}#