aws-cdk-lib.aws_sam.CfnFunctionProps

interface CfnFunctionProps

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

Properties for defining a CfnFunction.

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 assumeRolePolicyDocument: any;
const cfnFunctionProps: sam.CfnFunctionProps = {
  architectures: ['architectures'],
  assumeRolePolicyDocument: assumeRolePolicyDocument,
  autoPublishAlias: 'autoPublishAlias',
  autoPublishCodeSha256: 'autoPublishCodeSha256',
  codeSigningConfigArn: 'codeSigningConfigArn',
  codeUri: 'codeUri',
  deadLetterQueue: {
    targetArn: 'targetArn',
    type: 'type',
  },
  deploymentPreference: {
    enabled: false,
    type: 'type',

    // the properties below are optional
    alarms: ['alarms'],
    hooks: {
      postTraffic: 'postTraffic',
      preTraffic: 'preTraffic',
    },
  },
  description: 'description',
  environment: {
    variables: {
      variablesKey: 'variables',
    },
  },
  eventInvokeConfig: {
    destinationConfig: {
      onFailure: {
        destination: 'destination',

        // the properties below are optional
        type: 'type',
      },
      onSuccess: {
        destination: 'destination',

        // the properties below are optional
        type: 'type',
      },
    },
    maximumEventAgeInSeconds: 123,
    maximumRetryAttempts: 123,
  },
  events: {
    eventsKey: {
      properties: {
        variables: {
          variablesKey: 'variables',
        },
      },
      type: 'type',
    },
  },
  fileSystemConfigs: [{
    arn: 'arn',
    localMountPath: 'localMountPath',
  }],
  functionName: 'functionName',
  handler: 'handler',
  imageConfig: {
    command: ['command'],
    entryPoint: ['entryPoint'],
    workingDirectory: 'workingDirectory',
  },
  imageUri: 'imageUri',
  inlineCode: 'inlineCode',
  kmsKeyArn: 'kmsKeyArn',
  layers: ['layers'],
  memorySize: 123,
  packageType: 'packageType',
  permissionsBoundary: 'permissionsBoundary',
  policies: 'policies',
  provisionedConcurrencyConfig: {
    provisionedConcurrentExecutions: 'provisionedConcurrentExecutions',
  },
  reservedConcurrentExecutions: 123,
  role: 'role',
  runtime: 'runtime',
  tags: {
    tagsKey: 'tags',
  },
  timeout: 123,
  tracing: 'tracing',
  versionDescription: 'versionDescription',
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
};

Properties

NameTypeDescription
architectures?string[]AWS::Serverless::Function.Architectures.
assumeRolePolicyDocument?anyAWS::Serverless::Function.AssumeRolePolicyDocument.
autoPublishAlias?stringAWS::Serverless::Function.AutoPublishAlias.
autoPublishCodeSha256?stringAWS::Serverless::Function.AutoPublishCodeSha256.
codeSigningConfigArn?stringAWS::Serverless::Function.CodeSigningConfigArn.
codeUri?string | IResolvable | S3LocationPropertyAWS::Serverless::Function.CodeUri.
deadLetterQueue?IResolvable | DeadLetterQueuePropertyAWS::Serverless::Function.DeadLetterQueue.
deploymentPreference?IResolvable | DeploymentPreferencePropertyAWS::Serverless::Function.DeploymentPreference.
description?stringAWS::Serverless::Function.Description.
environment?IResolvable | FunctionEnvironmentPropertyAWS::Serverless::Function.Environment.
eventInvokeConfig?IResolvable | EventInvokeConfigPropertyAWS::Serverless::Function.EventInvokeConfig.
events?IResolvable | { [string]: IResolvable | EventSourceProperty }AWS::Serverless::Function.Events.
fileSystemConfigs?IResolvable | IResolvable | FileSystemConfigProperty[]AWS::Serverless::Function.FileSystemConfigs.
functionName?stringAWS::Serverless::Function.FunctionName.
handler?stringAWS::Serverless::Function.Handler.
imageConfig?IResolvable | ImageConfigPropertyAWS::Serverless::Function.ImageConfig.
imageUri?stringAWS::Serverless::Function.ImageUri.
inlineCode?stringAWS::Serverless::Function.InlineCode.
kmsKeyArn?stringAWS::Serverless::Function.KmsKeyArn.
layers?string[]AWS::Serverless::Function.Layers.
memorySize?numberAWS::Serverless::Function.MemorySize.
packageType?stringAWS::Serverless::Function.PackageType.
permissionsBoundary?stringAWS::Serverless::Function.PermissionsBoundary.
policies?string | IResolvable | IAMPolicyDocumentProperty | string | IResolvable | IAMPolicyDocumentProperty | SAMPolicyTemplateProperty[]AWS::Serverless::Function.Policies.
provisionedConcurrencyConfig?IResolvable | ProvisionedConcurrencyConfigPropertyAWS::Serverless::Function.ProvisionedConcurrencyConfig.
reservedConcurrentExecutions?numberAWS::Serverless::Function.ReservedConcurrentExecutions.
role?stringAWS::Serverless::Function.Role.
runtime?stringAWS::Serverless::Function.Runtime.
tags?{ [string]: string }AWS::Serverless::Function.Tags.
timeout?numberAWS::Serverless::Function.Timeout.
tracing?stringAWS::Serverless::Function.Tracing.
versionDescription?stringAWS::Serverless::Function.VersionDescription.
vpcConfig?IResolvable | VpcConfigPropertyAWS::Serverless::Function.VpcConfig.

architectures?

Type: string[] (optional)

AWS::Serverless::Function.Architectures.


assumeRolePolicyDocument?

Type: any (optional)

AWS::Serverless::Function.AssumeRolePolicyDocument.


autoPublishAlias?

Type: string (optional)

AWS::Serverless::Function.AutoPublishAlias.


autoPublishCodeSha256?

Type: string (optional)

AWS::Serverless::Function.AutoPublishCodeSha256.


codeSigningConfigArn?

Type: string (optional)

AWS::Serverless::Function.CodeSigningConfigArn.


codeUri?

Type: string | IResolvable | S3LocationProperty (optional)

AWS::Serverless::Function.CodeUri.


deadLetterQueue?

Type: IResolvable | DeadLetterQueueProperty (optional)

AWS::Serverless::Function.DeadLetterQueue.


deploymentPreference?

Type: IResolvable | DeploymentPreferenceProperty (optional)

AWS::Serverless::Function.DeploymentPreference.


description?

Type: string (optional)

AWS::Serverless::Function.Description.


environment?

Type: IResolvable | FunctionEnvironmentProperty (optional)

AWS::Serverless::Function.Environment.


eventInvokeConfig?

Type: IResolvable | EventInvokeConfigProperty (optional)

AWS::Serverless::Function.EventInvokeConfig.


events?

Type: IResolvable | { [string]: IResolvable | EventSourceProperty } (optional)

AWS::Serverless::Function.Events.


fileSystemConfigs?

Type: IResolvable | IResolvable | FileSystemConfigProperty[] (optional)

AWS::Serverless::Function.FileSystemConfigs.


functionName?

Type: string (optional)

AWS::Serverless::Function.FunctionName.


handler?

Type: string (optional)

AWS::Serverless::Function.Handler.


imageConfig?

Type: IResolvable | ImageConfigProperty (optional)

AWS::Serverless::Function.ImageConfig.


imageUri?

Type: string (optional)

AWS::Serverless::Function.ImageUri.


inlineCode?

Type: string (optional)

AWS::Serverless::Function.InlineCode.


kmsKeyArn?

Type: string (optional)

AWS::Serverless::Function.KmsKeyArn.


layers?

Type: string[] (optional)

AWS::Serverless::Function.Layers.


memorySize?

Type: number (optional)

AWS::Serverless::Function.MemorySize.


packageType?

Type: string (optional)

AWS::Serverless::Function.PackageType.


permissionsBoundary?

Type: string (optional)

AWS::Serverless::Function.PermissionsBoundary.


policies?

Type: string | IResolvable | IAMPolicyDocumentProperty | string | IResolvable | IAMPolicyDocumentProperty | SAMPolicyTemplateProperty[] (optional)

AWS::Serverless::Function.Policies.


provisionedConcurrencyConfig?

Type: IResolvable | ProvisionedConcurrencyConfigProperty (optional)

AWS::Serverless::Function.ProvisionedConcurrencyConfig.


reservedConcurrentExecutions?

Type: number (optional)

AWS::Serverless::Function.ReservedConcurrentExecutions.


role?

Type: string (optional)

AWS::Serverless::Function.Role.


runtime?

Type: string (optional)

AWS::Serverless::Function.Runtime.


tags?

Type: { [string]: string } (optional)

AWS::Serverless::Function.Tags.


timeout?

Type: number (optional)

AWS::Serverless::Function.Timeout.


tracing?

Type: string (optional)

AWS::Serverless::Function.Tracing.


versionDescription?

Type: string (optional)

AWS::Serverless::Function.VersionDescription.


vpcConfig?

Type: IResolvable | VpcConfigProperty (optional)

AWS::Serverless::Function.VpcConfig.