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

Architectures	Properties for defining a CfnFunction.
AssumeRolePolicyDocument	Properties for defining a CfnFunction.
AutoPublishAlias	Properties for defining a CfnFunction.
AutoPublishCodeSha256	Properties for defining a CfnFunction.
CodeSigningConfigArn	Properties for defining a CfnFunction.
CodeUri	Properties for defining a CfnFunction.
DeadLetterQueue	Properties for defining a CfnFunction.
DeploymentPreference	Properties for defining a CfnFunction.
Description	Properties for defining a CfnFunction.
Environment	Properties for defining a CfnFunction.
EphemeralStorage	Properties for defining a CfnFunction.
EventInvokeConfig	Properties for defining a CfnFunction.
Events	Properties for defining a CfnFunction.
FileSystemConfigs	Properties for defining a CfnFunction.
FunctionName	Properties for defining a CfnFunction.
FunctionUrlConfig	Properties for defining a CfnFunction.
Handler	Properties for defining a CfnFunction.
ImageConfig	Properties for defining a CfnFunction.
ImageUri	Properties for defining a CfnFunction.
InlineCode	Properties for defining a CfnFunction.
KmsKeyArn	Properties for defining a CfnFunction.
Layers	Properties for defining a CfnFunction.
MemorySize	Properties for defining a CfnFunction.
PackageType	Properties for defining a CfnFunction.
PermissionsBoundary	Properties for defining a CfnFunction.
Policies	Properties for defining a CfnFunction.
ProvisionedConcurrencyConfig	Properties for defining a CfnFunction.
ReservedConcurrentExecutions	Properties for defining a CfnFunction.
Role	Properties for defining a CfnFunction.
Runtime	Properties for defining a CfnFunction.
Tags	Properties for defining a CfnFunction.
Timeout	Properties for defining a CfnFunction.
Tracing	Properties for defining a CfnFunction.
VersionDescription	Properties for defining a CfnFunction.
VpcConfig	Properties for defining a CfnFunction.

Properties

Architectures

Properties for defining a CfnFunction.

string[]? Architectures { get; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-architectures

AssumeRolePolicyDocument

Properties for defining a CfnFunction.

object? AssumeRolePolicyDocument { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-assumerolepolicydocument

AutoPublishAlias

Properties for defining a CfnFunction.

string? AutoPublishAlias { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-autopublishalias

AutoPublishCodeSha256

Properties for defining a CfnFunction.

string? AutoPublishCodeSha256 { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-autopublishcodesha256

CodeSigningConfigArn

Properties for defining a CfnFunction.

string? CodeSigningConfigArn { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-codesigningconfigarn

CodeUri

Properties for defining a CfnFunction.

object? CodeUri { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-codeuri

Type union: either string or IResolvable or CfnFunction.IS3LocationProperty

DeadLetterQueue

Properties for defining a CfnFunction.

object? DeadLetterQueue { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-deadletterqueue

Type union: either IResolvable or CfnFunction.IDeadLetterQueueProperty

DeploymentPreference

Properties for defining a CfnFunction.

object? DeploymentPreference { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-deploymentpreference

Type union: either IResolvable or CfnFunction.IDeploymentPreferenceProperty

Description

Properties for defining a CfnFunction.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-description

Environment

Properties for defining a CfnFunction.

object? Environment { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-environment

Type union: either IResolvable or CfnFunction.IFunctionEnvironmentProperty

EphemeralStorage

Properties for defining a CfnFunction.

object? EphemeralStorage { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-ephemeralstorage

Type union: either IResolvable or CfnFunction.IEphemeralStorageProperty

EventInvokeConfig

Properties for defining a CfnFunction.

object? EventInvokeConfig { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-eventinvokeconfig

Type union: either IResolvable or CfnFunction.IEventInvokeConfigProperty

Events

Properties for defining a CfnFunction.

object? Events { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-events

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnFunction.IEventSourceProperty>

FileSystemConfigs

Properties for defining a CfnFunction.

object? FileSystemConfigs { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-filesystemconfigs

Type union: either IResolvable or (either IResolvable or CfnFunction.IFileSystemConfigProperty)[]

FunctionName

Properties for defining a CfnFunction.

string? FunctionName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-functionname

FunctionUrlConfig

Properties for defining a CfnFunction.

object? FunctionUrlConfig { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-functionurlconfig

Type union: either IResolvable or CfnFunction.IFunctionUrlConfigProperty

Handler

Properties for defining a CfnFunction.

string? Handler { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-handler

ImageConfig

Properties for defining a CfnFunction.

object? ImageConfig { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-imageconfig

Type union: either IResolvable or CfnFunction.IImageConfigProperty

ImageUri

Properties for defining a CfnFunction.

string? ImageUri { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-imageuri

InlineCode

Properties for defining a CfnFunction.

string? InlineCode { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-inlinecode

KmsKeyArn

Properties for defining a CfnFunction.

string? KmsKeyArn { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-kmskeyarn

Layers

Properties for defining a CfnFunction.

string[]? Layers { get; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-layers

MemorySize

Properties for defining a CfnFunction.

double? MemorySize { get; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-memorysize

PackageType

Properties for defining a CfnFunction.

string? PackageType { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-packagetype

PermissionsBoundary

Properties for defining a CfnFunction.

string? PermissionsBoundary { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-permissionsboundary

Policies

Properties for defining a CfnFunction.

object? Policies { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-policies

Type union: either string or IResolvable or CfnFunction.IIAMPolicyDocumentProperty or (either string or IResolvable or CfnFunction.IIAMPolicyDocumentProperty or CfnFunction.ISAMPolicyTemplateProperty)[]

ProvisionedConcurrencyConfig

Properties for defining a CfnFunction.

object? ProvisionedConcurrencyConfig { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-provisionedconcurrencyconfig

Type union: either IResolvable or CfnFunction.IProvisionedConcurrencyConfigProperty

ReservedConcurrentExecutions

Properties for defining a CfnFunction.

double? ReservedConcurrentExecutions { get; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-reservedconcurrentexecutions

Role

Properties for defining a CfnFunction.

string? Role { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-role

Runtime

Properties for defining a CfnFunction.

string? Runtime { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-runtime

Tags

Properties for defining a CfnFunction.

IDictionary<string, string>? Tags { get; }

Property Value

IDictionary<string, string>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-tags

Timeout

Properties for defining a CfnFunction.

double? Timeout { get; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-timeout

Tracing

Properties for defining a CfnFunction.

string? Tracing { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-tracing

VersionDescription

Properties for defining a CfnFunction.

string? VersionDescription { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-versiondescription

VpcConfig

Properties for defining a CfnFunction.

object? VpcConfig { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-vpcconfig

Type union: either IResolvable or CfnFunction.IVpcConfigProperty