CfnFunctionProps Struct
Properties for defining a CfnFunction.
| Source | |
|---|---|
| Type last changed |
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'],
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam
# assume_role_policy_document: Any
cfn_function_props = sam.CfnFunctionProps(
architectures=["architectures"],
assume_role_policy_document=assume_role_policy_document,
auto_publish_alias="autoPublishAlias",
auto_publish_code_sha256="autoPublishCodeSha256",
code_signing_config_arn="codeSigningConfigArn",
code_uri="codeUri",
dead_letter_queue=sam.CfnFunction.DeadLetterQueueProperty(
target_arn="targetArn",
type="type"
),
deployment_preference=sam.CfnFunction.DeploymentPreferenceProperty(
alarms=["alarms"],
enabled=False,
hooks=sam.CfnFunction.HooksProperty(
post_traffic="postTraffic",
pre_traffic="preTraffic"
),
role="role",
type="type"
),
description="description",
environment=sam.CfnFunction.FunctionEnvironmentProperty(
variables={
"variables_key": "variables"
}
),
ephemeral_storage=sam.CfnFunction.EphemeralStorageProperty(
size=123
),
event_invoke_config=sam.CfnFunction.EventInvokeConfigProperty(
destination_config=sam.CfnFunction.EventInvokeDestinationConfigProperty(
on_failure=sam.CfnFunction.DestinationProperty(
destination="destination",
# the properties below are optional
type="type"
),
on_success=sam.CfnFunction.DestinationProperty(
destination="destination",
# the properties below are optional
type="type"
)
),
maximum_event_age_in_seconds=123,
maximum_retry_attempts=123
),
events={
"events_key": sam.CfnFunction.EventSourceProperty(
properties=sam.CfnFunction.S3EventProperty(
skill_id="skillId"
),
type="type"
)
},
file_system_configs=[sam.CfnFunction.FileSystemConfigProperty(
arn="arn",
local_mount_path="localMountPath"
)],
function_name="functionName",
function_url_config=sam.CfnFunction.FunctionUrlConfigProperty(
auth_type="authType",
# the properties below are optional
cors="cors",
invoke_mode="invokeMode"
),
handler="handler",
image_config=sam.CfnFunction.ImageConfigProperty(
command=["command"],
entry_point=["entryPoint"],
working_directory="workingDirectory"
),
image_uri="imageUri",
inline_code="inlineCode",
kms_key_arn="kmsKeyArn",
layers=["layers"],
memory_size=123,
package_type="packageType",
permissions_boundary="permissionsBoundary",
policies="policies",
provisioned_concurrency_config=sam.CfnFunction.ProvisionedConcurrencyConfigProperty(
provisioned_concurrent_executions="provisionedConcurrentExecutions"
),
reserved_concurrent_executions=123,
role="role",
runtime="runtime",
tags={
"tags_key": "tags"
},
timeout=123,
tracing="tracing",
version_description="versionDescription",
vpc_config=sam.CfnFunction.VpcConfigProperty(
security_group_ids=["securityGroupIds"],
subnet_ids=["subnetIds"]
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sam.*;
Object assumeRolePolicyDocument;
CfnFunctionProps cfnFunctionProps = CfnFunctionProps.builder()
.architectures(List.of("architectures"))
.assumeRolePolicyDocument(assumeRolePolicyDocument)
.autoPublishAlias("autoPublishAlias")
.autoPublishCodeSha256("autoPublishCodeSha256")
.codeSigningConfigArn("codeSigningConfigArn")
.codeUri("codeUri")
.deadLetterQueue(DeadLetterQueueProperty.builder()
.targetArn("targetArn")
.type("type")
.build())
.deploymentPreference(DeploymentPreferenceProperty.builder()
.alarms(List.of("alarms"))
.enabled(false)
.hooks(HooksProperty.builder()
.postTraffic("postTraffic")
.preTraffic("preTraffic")
.build())
.role("role")
.type("type")
.build())
.description("description")
.environment(FunctionEnvironmentProperty.builder()
.variables(Map.of(
"variablesKey", "variables"))
.build())
.ephemeralStorage(EphemeralStorageProperty.builder()
.size(123)
.build())
.eventInvokeConfig(EventInvokeConfigProperty.builder()
.destinationConfig(EventInvokeDestinationConfigProperty.builder()
.onFailure(DestinationProperty.builder()
.destination("destination")
// the properties below are optional
.type("type")
.build())
.onSuccess(DestinationProperty.builder()
.destination("destination")
// the properties below are optional
.type("type")
.build())
.build())
.maximumEventAgeInSeconds(123)
.maximumRetryAttempts(123)
.build())
.events(Map.of(
"eventsKey", EventSourceProperty.builder()
.properties(S3EventProperty.builder()
.skillId("skillId")
.build())
.type("type")
.build()))
.fileSystemConfigs(List.of(FileSystemConfigProperty.builder()
.arn("arn")
.localMountPath("localMountPath")
.build()))
.functionName("functionName")
.functionUrlConfig(FunctionUrlConfigProperty.builder()
.authType("authType")
// the properties below are optional
.cors("cors")
.invokeMode("invokeMode")
.build())
.handler("handler")
.imageConfig(ImageConfigProperty.builder()
.command(List.of("command"))
.entryPoint(List.of("entryPoint"))
.workingDirectory("workingDirectory")
.build())
.imageUri("imageUri")
.inlineCode("inlineCode")
.kmsKeyArn("kmsKeyArn")
.layers(List.of("layers"))
.memorySize(123)
.packageType("packageType")
.permissionsBoundary("permissionsBoundary")
.policies("policies")
.provisionedConcurrencyConfig(ProvisionedConcurrencyConfigProperty.builder()
.provisionedConcurrentExecutions("provisionedConcurrentExecutions")
.build())
.reservedConcurrentExecutions(123)
.role("role")
.runtime("runtime")
.tags(Map.of(
"tagsKey", "tags"))
.timeout(123)
.tracing("tracing")
.versionDescription("versionDescription")
.vpcConfig(VpcConfigProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SAM;
var assumeRolePolicyDocument;
var cfnFunctionProps = new CfnFunctionProps {
Architectures = new [] { "architectures" },
AssumeRolePolicyDocument = assumeRolePolicyDocument,
AutoPublishAlias = "autoPublishAlias",
AutoPublishCodeSha256 = "autoPublishCodeSha256",
CodeSigningConfigArn = "codeSigningConfigArn",
CodeUri = "codeUri",
DeadLetterQueue = new DeadLetterQueueProperty {
TargetArn = "targetArn",
Type = "type"
},
DeploymentPreference = new DeploymentPreferenceProperty {
Alarms = new [] { "alarms" },
Enabled = false,
Hooks = new HooksProperty {
PostTraffic = "postTraffic",
PreTraffic = "preTraffic"
},
Role = "role",
Type = "type"
},
Description = "description",
Environment = new FunctionEnvironmentProperty {
Variables = new Dictionary<string, string> {
{ "variablesKey", "variables" }
}
},
EphemeralStorage = new EphemeralStorageProperty {
Size = 123
},
EventInvokeConfig = new EventInvokeConfigProperty {
DestinationConfig = new EventInvokeDestinationConfigProperty {
OnFailure = new DestinationProperty {
Destination = "destination",
// the properties below are optional
Type = "type"
},
OnSuccess = new DestinationProperty {
Destination = "destination",
// the properties below are optional
Type = "type"
}
},
MaximumEventAgeInSeconds = 123,
MaximumRetryAttempts = 123
},
Events = new Dictionary<string, object> {
{ "eventsKey", new EventSourceProperty {
Properties = new S3EventProperty {
SkillId = "skillId"
},
Type = "type"
} }
},
FileSystemConfigs = new [] { new FileSystemConfigProperty {
Arn = "arn",
LocalMountPath = "localMountPath"
} },
FunctionName = "functionName",
FunctionUrlConfig = new FunctionUrlConfigProperty {
AuthType = "authType",
// the properties below are optional
Cors = "cors",
InvokeMode = "invokeMode"
},
Handler = "handler",
ImageConfig = new ImageConfigProperty {
Command = new [] { "command" },
EntryPoint = new [] { "entryPoint" },
WorkingDirectory = "workingDirectory"
},
ImageUri = "imageUri",
InlineCode = "inlineCode",
KmsKeyArn = "kmsKeyArn",
Layers = new [] { "layers" },
MemorySize = 123,
PackageType = "packageType",
PermissionsBoundary = "permissionsBoundary",
Policies = "policies",
ProvisionedConcurrencyConfig = new ProvisionedConcurrencyConfigProperty {
ProvisionedConcurrentExecutions = "provisionedConcurrentExecutions"
},
ReservedConcurrentExecutions = 123,
Role = "role",
Runtime = "runtime",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
Timeout = 123,
Tracing = "tracing",
VersionDescription = "versionDescription",
VpcConfig = new VpcConfigProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var assumeRolePolicyDocument interface{}
cfnFunctionProps := &CfnFunctionProps{
Architectures: []*string{
jsii.String("architectures"),
},
AssumeRolePolicyDocument: assumeRolePolicyDocument,
AutoPublishAlias: jsii.String("autoPublishAlias"),
AutoPublishCodeSha256: jsii.String("autoPublishCodeSha256"),
CodeSigningConfigArn: jsii.String("codeSigningConfigArn"),
CodeUri: jsii.String("codeUri"),
DeadLetterQueue: &DeadLetterQueueProperty{
TargetArn: jsii.String("targetArn"),
Type: jsii.String("type"),
},
DeploymentPreference: &DeploymentPreferenceProperty{
Alarms: []*string{
jsii.String("alarms"),
},
Enabled: jsii.Boolean(false),
Hooks: &HooksProperty{
PostTraffic: jsii.String("postTraffic"),
PreTraffic: jsii.String("preTraffic"),
},
Role: jsii.String("role"),
Type: jsii.String("type"),
},
Description: jsii.String("description"),
Environment: &FunctionEnvironmentProperty{
Variables: map[string]*string{
"variablesKey": jsii.String("variables"),
},
},
EphemeralStorage: &EphemeralStorageProperty{
Size: jsii.Number(123),
},
EventInvokeConfig: &EventInvokeConfigProperty{
DestinationConfig: &EventInvokeDestinationConfigProperty{
OnFailure: &DestinationProperty{
Destination: jsii.String("destination"),
// the properties below are optional
Type: jsii.String("type"),
},
OnSuccess: &DestinationProperty{
Destination: jsii.String("destination"),
// the properties below are optional
Type: jsii.String("type"),
},
},
MaximumEventAgeInSeconds: jsii.Number(123),
MaximumRetryAttempts: jsii.Number(123),
},
Events: map[string]interface{}{
"eventsKey": &EventSourceProperty{
"properties": &S3EventProperty{
"skillId": jsii.String("skillId"),
},
"type": jsii.String("type"),
},
},
FileSystemConfigs: []interface{}{
&FileSystemConfigProperty{
Arn: jsii.String("arn"),
LocalMountPath: jsii.String("localMountPath"),
},
},
FunctionName: jsii.String("functionName"),
FunctionUrlConfig: &FunctionUrlConfigProperty{
AuthType: jsii.String("authType"),
// the properties below are optional
Cors: jsii.String("cors"),
InvokeMode: jsii.String("invokeMode"),
},
Handler: jsii.String("handler"),
ImageConfig: &ImageConfigProperty{
Command: []*string{
jsii.String("command"),
},
EntryPoint: []*string{
jsii.String("entryPoint"),
},
WorkingDirectory: jsii.String("workingDirectory"),
},
ImageUri: jsii.String("imageUri"),
InlineCode: jsii.String("inlineCode"),
KmsKeyArn: jsii.String("kmsKeyArn"),
Layers: []*string{
jsii.String("layers"),
},
MemorySize: jsii.Number(123),
PackageType: jsii.String("packageType"),
PermissionsBoundary: jsii.String("permissionsBoundary"),
Policies: jsii.String("policies"),
ProvisionedConcurrencyConfig: &ProvisionedConcurrencyConfigProperty{
ProvisionedConcurrentExecutions: jsii.String("provisionedConcurrentExecutions"),
},
ReservedConcurrentExecutions: jsii.Number(123),
Role: jsii.String("role"),
Runtime: jsii.String("runtime"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
Timeout: jsii.Number(123),
Tracing: jsii.String("tracing"),
VersionDescription: jsii.String("versionDescription"),
VpcConfig: &VpcConfigProperty{
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SubnetIds: []*string{
jsii.String("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.dead_letter_queueoptionaltyping.Union[IResolvable, DeadLetterQueueProperty]deadLetterQueueoptionalIResolvableDeadLetterQueueoptionalIResolvableDeadLetterQueueoptionalinterface{} #deploymentPreferenceoptionalIResolvable | CfnFunction.deployment_preferenceoptionaltyping.Union[IResolvable, DeploymentPreferenceProperty]deploymentPreferenceoptionalIResolvableDeploymentPreferenceoptionalIResolvableDeploymentPreferenceoptionalinterface{} #descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #environmentoptionalIResolvable | CfnFunction.environmentoptionaltyping.Union[IResolvable, FunctionEnvironmentProperty]environmentoptionalIResolvableEnvironmentoptionalIResolvableEnvironmentoptionalinterface{} #ephemeralStorageoptionalIResolvable | CfnFunction.ephemeral_storageoptionaltyping.Union[IResolvable, EphemeralStorageProperty]ephemeralStorageoptionalIResolvableEphemeralStorageoptionalIResolvableEphemeralStorageoptionalinterface{} #eventInvokeConfigoptionalIResolvable | CfnFunction.event_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.file_system_configsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FileSystemConfigProperty]]]fileSystemConfigsoptionalIResolvableFileSystemConfigsoptionalIResolvableFileSystemConfigsoptionalinterface{} #functionNameoptionalstringfunction_nameoptionalstrfunctionNameoptionalStringFunctionNameoptionalstringFunctionNameoptional*string #functionUrlConfigoptionalIResolvable | CfnFunction.function_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.policiesoptionaltyping.Union[str, IResolvable, IAMPolicyDocumentProperty, typing.List[typing.Union[str, IResolvable, IAMPolicyDocumentProperty, SAMPolicyTemplateProperty]]]policiesoptionalStringPoliciesoptionalstringPoliciesoptionalinterface{} #provisionedConcurrencyConfigoptionalIResolvable | CfnFunction.provisioned_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{} #