Class CfnFunction
Inherited Members
Namespace: Amazon.CDK.AWS.SAM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFunction : CfnResource, IInspectable, IFunctionRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnFunction Inherits CfnResource Implements IInspectable, IFunctionRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
Synopsis
Constructors
| CfnFunction(Construct, string, ICfnFunctionProps?) | Create a new |
Properties
| Architectures | |
| AssumeRolePolicyDocument | |
| AutoPublishAlias | |
| AutoPublishCodeSha256 | |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | |
| CodeSigningConfigArn | |
| CodeUri | |
| DeadLetterQueue | |
| DeploymentPreference | |
| Description | |
| Environment | |
| EphemeralStorage | |
| EventInvokeConfig | |
| Events | |
| FileSystemConfigs | |
| FunctionName | |
| FunctionRef | A reference to a Function resource. |
| FunctionUrlConfig | |
| Handler | |
| ImageConfig | |
| ImageUri | |
| InlineCode | |
| KmsKeyArn | |
| Layers | |
| MemorySize | |
| PackageType | |
| PermissionsBoundary | |
| Policies | |
| ProvisionedConcurrencyConfig | |
| REQUIRED_TRANSFORM | The |
| ReservedConcurrentExecutions | |
| Role | |
| Runtime | |
| Tags | Tag Manager which manages the tags for this resource. |
| TagsRaw | |
| Timeout | |
| Tracing | |
| VersionDescription | |
| VpcConfig |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnFunction(object) | Checks whether the given object is a CfnFunction. |
| RenderProperties(IDictionary<string, object>) |
Constructors
CfnFunction(Construct, string, ICfnFunctionProps?)
Create a new AWS::Serverless::Function.
public CfnFunction(Construct scope, string id, ICfnFunctionProps? props = null)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnFunctionProps
Resource properties.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Properties
Architectures
public virtual string[]? Architectures { get; set; }
Property Value
string[]
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
AssumeRolePolicyDocument
public virtual object AssumeRolePolicyDocument { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
AutoPublishAlias
public virtual string? AutoPublishAlias { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
AutoPublishCodeSha256
public virtual string? AutoPublishCodeSha256 { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
CodeSigningConfigArn
public virtual string? CodeSigningConfigArn { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
CodeUri
public virtual object? CodeUri { get; set; }
Property Value
Remarks
Type union: either string or IResolvable or CfnFunction.IS3LocationProperty
DeadLetterQueue
public virtual object? DeadLetterQueue { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnFunction.IDeadLetterQueueProperty
DeploymentPreference
public virtual object? DeploymentPreference { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnFunction.IDeploymentPreferenceProperty
Description
public virtual string? Description { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
Environment
public virtual object? Environment { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnFunction.IFunctionEnvironmentProperty
EphemeralStorage
public virtual object? EphemeralStorage { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnFunction.IEphemeralStorageProperty
EventInvokeConfig
public virtual object? EventInvokeConfig { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnFunction.IEventInvokeConfigProperty
Events
public virtual object? Events { get; set; }
Property Value
Remarks
Type union: either IResolvable or Dictionary<string, either IResolvable or CfnFunction.IEventSourceProperty>
FileSystemConfigs
public virtual object? FileSystemConfigs { get; set; }
Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnFunction.IFileSystemConfigProperty)[]
FunctionName
public virtual string? FunctionName { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
FunctionRef
A reference to a Function resource.
public virtual IFunctionReference FunctionRef { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
FunctionUrlConfig
public virtual object? FunctionUrlConfig { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnFunction.IFunctionUrlConfigProperty
Handler
public virtual string? Handler { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
ImageConfig
public virtual object? ImageConfig { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnFunction.IImageConfigProperty
ImageUri
public virtual string? ImageUri { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
InlineCode
public virtual string? InlineCode { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
KmsKeyArn
public virtual string? KmsKeyArn { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
Layers
public virtual string[]? Layers { get; set; }
Property Value
string[]
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
MemorySize
public virtual double? MemorySize { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
PackageType
public virtual string? PackageType { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
PermissionsBoundary
public virtual string? PermissionsBoundary { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
Policies
public virtual object? Policies { get; set; }
Property Value
Remarks
Type union: either string or IResolvable or CfnFunction.IIAMPolicyDocumentProperty or (either string or IResolvable or CfnFunction.IIAMPolicyDocumentProperty or CfnFunction.ISAMPolicyTemplateProperty)[]
ProvisionedConcurrencyConfig
public virtual object? ProvisionedConcurrencyConfig { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnFunction.IProvisionedConcurrencyConfigProperty
REQUIRED_TRANSFORM
The Transform a template must use in order to use this resource.
public static string REQUIRED_TRANSFORM { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
ReservedConcurrentExecutions
public virtual double? ReservedConcurrentExecutions { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
Role
public virtual string? Role { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
Runtime
public virtual string? Runtime { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
TagsRaw
public virtual IDictionary<string, string>? TagsRaw { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
Timeout
public virtual double? Timeout { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
Tracing
public virtual string? Tracing { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
VersionDescription
public virtual string? VersionDescription { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
Examples
// 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 cfnFunction = new CfnFunction(this, "MyCfnFunction", 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 AlexaSkillEventProperty {
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" }
}
});
VpcConfig
public virtual object? VpcConfig { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnFunction.IVpcConfigProperty
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
IsCfnFunction(object)
Checks whether the given object is a CfnFunction.
public static bool IsCfnFunction(object x)
Parameters
- x object
Returns
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
CloudformationResource: AWS::Serverless::Function
ExampleMetadata: fixture=_generated