CfnFunctionProps Struct
Properties for defining a CfnFunction.
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 assumeRolePolicyDocument: any;
const cfnFunctionProps: sam.CfnFunctionProps = {
architectures: ['architectures'],
assumeRolePolicyDocument: assumeRolePolicyDocument,
autoPublishAlias: 'autoPublishAlias',
autoPublishCodeSha256: 'autoPublishCodeSha256',
codeSigningConfigArn: 'codeSigningConfigArn',
codeUri: 'codeUri',
deadLetterQueue: {
targetArn: 'targetArn',
type: 'type',
},
deploymentPreference: {
alarms: ['alarms'],
enabled: false,
hooks: {
postTraffic: 'postTraffic',
preTraffic: 'preTraffic',
},
role: 'role',
type: 'type',
},
description: 'description',
environment: {
variables: {
variablesKey: 'variables',
},
},
ephemeralStorage: {
size: 123,
},
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: {
skillId: 'skillId',
},
type: 'type',
},
},
fileSystemConfigs: [{
arn: 'arn',
localMountPath: 'localMountPath',
}],
functionName: 'functionName',
functionUrlConfig: {
authType: 'authType',
// the properties below are optional
cors: 'cors',
invokeMode: 'invokeMode',
},
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
architecturesoptionalstring[]architecturesoptionaltyping.List[str]architecturesoptionalList<String>Architecturesoptionalstring[]Architecturesoptional*[]*string#assumeRolePolicyDocumentoptionalanyassume_role_policy_documentoptionalAnyassumeRolePolicyDocumentoptionalObjectAssumeRolePolicyDocumentoptionalobjectAssumeRolePolicyDocumentoptionalinterface{}#autoPublishAliasoptionalstringauto_publish_aliasoptionalstrautoPublishAliasoptionalStringAutoPublishAliasoptionalstringAutoPublishAliasoptional*string#autoPublishCodeSha256optionalstringauto_publish_code_sha256optionalstrautoPublishCodeSha256optionalStringAutoPublishCodeSha256optionalstringAutoPublishCodeSha256optional*string#codeSigningConfigArnoptionalstringcode_signing_config_arnoptionalstrcodeSigningConfigArnoptionalStringCodeSigningConfigArnoptionalstringCodeSigningConfigArnoptional*string#codeUrioptionalstring | IResolvable | CfnFunction.S3LocationPropertycode_urioptionaltyping.Union[str, IResolvable, S3LocationProperty]codeUrioptionalStringCodeUrioptionalstringCodeUrioptionalinterface{}#deadLetterQueueoptionalIResolvable | CfnFunction.DeadLetterQueuePropertydead_letter_queueoptionaltyping.Union[IResolvable, DeadLetterQueueProperty]deadLetterQueueoptionalIResolvableDeadLetterQueueoptionalIResolvableDeadLetterQueueoptionalinterface{}#deploymentPreferenceoptionalIResolvable | CfnFunction.DeploymentPreferencePropertydeployment_preferenceoptionaltyping.Union[IResolvable, DeploymentPreferenceProperty]deploymentPreferenceoptionalIResolvableDeploymentPreferenceoptionalIResolvableDeploymentPreferenceoptionalinterface{}#descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#environmentoptionalIResolvable | CfnFunction.FunctionEnvironmentPropertyenvironmentoptionaltyping.Union[IResolvable, FunctionEnvironmentProperty]environmentoptionalIResolvableEnvironmentoptionalIResolvableEnvironmentoptionalinterface{}#ephemeralStorageoptionalIResolvable | CfnFunction.EphemeralStoragePropertyephemeral_storageoptionaltyping.Union[IResolvable, EphemeralStorageProperty]ephemeralStorageoptionalIResolvableEphemeralStorageoptionalIResolvableEphemeralStorageoptionalinterface{}#eventInvokeConfigoptionalIResolvable | CfnFunction.EventInvokeConfigPropertyevent_invoke_configoptionaltyping.Union[IResolvable, EventInvokeConfigProperty]eventInvokeConfigoptionalIResolvableEventInvokeConfigoptionalIResolvableEventInvokeConfigoptionalinterface{}#eventsoptionalIResolvable | { [key: string]: IResolvable | CfnFunction.EventSourceProperty }eventsoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, EventSourceProperty]]]eventsoptionalIResolvableEventsoptionalIResolvableEventsoptionalinterface{}#fileSystemConfigsoptionalIResolvable | IResolvable | CfnFunction.FileSystemConfigProperty[]file_system_configsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FileSystemConfigProperty]]]fileSystemConfigsoptionalIResolvableFileSystemConfigsoptionalIResolvableFileSystemConfigsoptionalinterface{}#functionNameoptionalstringfunction_nameoptionalstrfunctionNameoptionalStringFunctionNameoptionalstringFunctionNameoptional*string#functionUrlConfigoptionalIResolvable | CfnFunction.FunctionUrlConfigPropertyfunction_url_configoptionaltyping.Union[IResolvable, FunctionUrlConfigProperty]functionUrlConfigoptionalIResolvableFunctionUrlConfigoptionalIResolvableFunctionUrlConfigoptionalinterface{}#handleroptionalstringhandleroptionalstrhandleroptionalStringHandleroptionalstringHandleroptional*string#imageConfigoptionalIResolvable | CfnFunction.ImageConfigPropertyimage_configoptionaltyping.Union[IResolvable, ImageConfigProperty]imageConfigoptionalIResolvableImageConfigoptionalIResolvableImageConfigoptionalinterface{}#imageUrioptionalstringimage_urioptionalstrimageUrioptionalStringImageUrioptionalstringImageUrioptional*string#inlineCodeoptionalstringinline_codeoptionalstrinlineCodeoptionalStringInlineCodeoptionalstringInlineCodeoptional*string#kmsKeyArnoptionalstringkms_key_arnoptionalstrkmsKeyArnoptionalStringKmsKeyArnoptionalstringKmsKeyArnoptional*string#layersoptionalstring[]layersoptionaltyping.List[str]layersoptionalList<String>Layersoptionalstring[]Layersoptional*[]*string#memorySizeoptionalnumbermemory_sizeoptionalint | floatmemorySizeoptionalNumberMemorySizeoptionaldoubleMemorySizeoptional*float64#packageTypeoptionalstringpackage_typeoptionalstrpackageTypeoptionalStringPackageTypeoptionalstringPackageTypeoptional*string#permissionsBoundaryoptionalstringpermissions_boundaryoptionalstrpermissionsBoundaryoptionalStringPermissionsBoundaryoptionalstringPermissionsBoundaryoptional*string#policiesoptionalstring | IResolvable | CfnFunction.IAMPolicyDocumentProperty | string | IResolvable | CfnFunction.IAMPolicyDocumentProperty | CfnFunction.SAMPolicyTemplateProperty[]policiesoptionaltyping.Union[str, IResolvable, IAMPolicyDocumentProperty, typing.List[typing.Union[str, IResolvable, IAMPolicyDocumentProperty, SAMPolicyTemplateProperty]]]policiesoptionalStringPoliciesoptionalstringPoliciesoptionalinterface{}#provisionedConcurrencyConfigoptionalIResolvable | CfnFunction.ProvisionedConcurrencyConfigPropertyprovisioned_concurrency_configoptionaltyping.Union[IResolvable, ProvisionedConcurrencyConfigProperty]provisionedConcurrencyConfigoptionalIResolvableProvisionedConcurrencyConfigoptionalIResolvableProvisionedConcurrencyConfigoptionalinterface{}#reservedConcurrentExecutionsoptionalnumberreserved_concurrent_executionsoptionalint | floatreservedConcurrentExecutionsoptionalNumberReservedConcurrentExecutionsoptionaldoubleReservedConcurrentExecutionsoptional*float64#runtimeoptionalstringruntimeoptionalstrruntimeoptionalStringRuntimeoptionalstringRuntimeoptional*string#tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#timeoutoptionalnumbertimeoutoptionalint | floattimeoutoptionalNumberTimeoutoptionaldoubleTimeoutoptional*float64#tracingoptionalstringtracingoptionalstrtracingoptionalStringTracingoptionalstringTracingoptional*string#versionDescriptionoptionalstringversion_descriptionoptionalstrversionDescriptionoptionalStringVersionDescriptionoptionalstringVersionDescriptionoptional*string#vpcConfigoptionalIResolvable | CfnFunction.VpcConfigPropertyvpc_configoptionaltyping.Union[IResolvable, VpcConfigProperty]vpcConfigoptionalIResolvableVpcConfigoptionalIResolvableVpcConfigoptionalinterface{}#