Interface ICfnFunctionProps
Properties for defining a CfnFunction
.
Namespace: Amazon.CDK.AWS.SAM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnFunctionProps
Syntax (vb)
Public Interface ICfnFunctionProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
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 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 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
Properties
Properties
Architectures
virtual string[] Architectures { get; }
Property Value
System.String[]
Remarks
AssumeRolePolicyDocument
virtual object AssumeRolePolicyDocument { get; }
Property Value
System.Object
Remarks
AutoPublishAlias
virtual string AutoPublishAlias { get; }
Property Value
System.String
Remarks
AutoPublishCodeSha256
virtual string AutoPublishCodeSha256 { get; }
Property Value
System.String
Remarks
CodeSigningConfigArn
virtual string CodeSigningConfigArn { get; }
Property Value
System.String
Remarks
CodeUri
virtual object CodeUri { get; }
Property Value
System.Object
Remarks
DeadLetterQueue
virtual object DeadLetterQueue { get; }
Property Value
System.Object
Remarks
DeploymentPreference
virtual object DeploymentPreference { get; }
Property Value
System.Object
Remarks
Description
virtual string Description { get; }
Property Value
System.String
Remarks
Environment
virtual object Environment { get; }
Property Value
System.Object
Remarks
EphemeralStorage
virtual object EphemeralStorage { get; }
Property Value
System.Object
Remarks
EventInvokeConfig
virtual object EventInvokeConfig { get; }
Property Value
System.Object
Remarks
Events
virtual object Events { get; }
Property Value
System.Object
Remarks
FileSystemConfigs
virtual object FileSystemConfigs { get; }
Property Value
System.Object
Remarks
FunctionName
virtual string FunctionName { get; }
Property Value
System.String
Remarks
FunctionUrlConfig
virtual object FunctionUrlConfig { get; }
Property Value
System.Object
Remarks
Handler
virtual string Handler { get; }
Property Value
System.String
Remarks
ImageConfig
virtual object ImageConfig { get; }
Property Value
System.Object
Remarks
ImageUri
virtual string ImageUri { get; }
Property Value
System.String
Remarks
InlineCode
virtual string InlineCode { get; }
Property Value
System.String
Remarks
KmsKeyArn
virtual string KmsKeyArn { get; }
Property Value
System.String
Remarks
Layers
virtual string[] Layers { get; }
Property Value
System.String[]
Remarks
MemorySize
virtual Nullable<double> MemorySize { get; }
Property Value
System.Nullable<System.Double>
Remarks
PackageType
virtual string PackageType { get; }
Property Value
System.String
Remarks
PermissionsBoundary
virtual string PermissionsBoundary { get; }
Property Value
System.String
Remarks
Policies
virtual object Policies { get; }
Property Value
System.Object
Remarks
ProvisionedConcurrencyConfig
virtual object ProvisionedConcurrencyConfig { get; }
Property Value
System.Object
Remarks
ReservedConcurrentExecutions
virtual Nullable<double> ReservedConcurrentExecutions { get; }
Property Value
System.Nullable<System.Double>
Remarks
Role
virtual string Role { get; }
Property Value
System.String
Remarks
Runtime
virtual string Runtime { get; }
Property Value
System.String
Remarks
Tags
virtual IDictionary<string, string> Tags { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Timeout
virtual Nullable<double> Timeout { get; }
Property Value
System.Nullable<System.Double>
Remarks
Tracing
virtual string Tracing { get; }
Property Value
System.String
Remarks
VersionDescription
virtual string VersionDescription { get; }
Property Value
System.String
Remarks
VpcConfig
virtual object VpcConfig { get; }
Property Value
System.Object