Package software.amazon.awscdk.cfnpropertymixins.services.sam

Class CfnFunctionPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.sam.CfnFunctionPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:05.230Z") @Stability(Stable) public class CfnFunctionPropsMixin extends Mixin implements software.constructs.IMixin
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sam.*;
 import software.amazon.awscdk.*;
 Object assumeRolePolicyDocument;
 IMergeStrategy mergeStrategy;
 CfnFunctionPropsMixin cfnFunctionPropsMixin = CfnFunctionPropsMixin.Builder.create(CfnFunctionMixinProps.builder()
         .architectures(List.of("architectures"))
         .assumeRolePolicyDocument(assumeRolePolicyDocument)
         .autoPublishAlias("autoPublishAlias")
         .autoPublishCodeSha256("autoPublishCodeSha256")
         .codeSigningConfigArn("codeSigningConfigArn")
         .codeUri("codeUri")
         .deadLetterQueue(DeadLetterQueueProperty.builder()
                 .targetArn("targetArn")
                 .type("type")
                 .build())
         .deploymentPreference(DeploymentPreferenceProperty.builder()
                 .alarms(List.of("alarms"))
                 .enabled(false)
                 .hooks(HooksProperty.builder()
                         .postTraffic("postTraffic")
                         .preTraffic("preTraffic")
                         .build())
                 .role("role")
                 .type("type")
                 .build())
         .description("description")
         .environment(FunctionEnvironmentProperty.builder()
                 .variables(Map.of(
                         "variablesKey", "variables"))
                 .build())
         .ephemeralStorage(EphemeralStorageProperty.builder()
                 .size(123)
                 .build())
         .eventInvokeConfig(EventInvokeConfigProperty.builder()
                 .destinationConfig(EventInvokeDestinationConfigProperty.builder()
                         .onFailure(DestinationProperty.builder()
                                 .destination("destination")
                                 .type("type")
                                 .build())
                         .onSuccess(DestinationProperty.builder()
                                 .destination("destination")
                                 .type("type")
                                 .build())
                         .build())
                 .maximumEventAgeInSeconds(123)
                 .maximumRetryAttempts(123)
                 .build())
         .events(Map.of(
                 "eventsKey", EventSourceProperty.builder()
                         .properties(AlexaSkillEventProperty.builder()
                                 .skillId("skillId")
                                 .build())
                         .type("type")
                         .build()))
         .fileSystemConfigs(List.of(FileSystemConfigProperty.builder()
                 .arn("arn")
                 .localMountPath("localMountPath")
                 .build()))
         .functionName("functionName")
         .functionUrlConfig(FunctionUrlConfigProperty.builder()
                 .authType("authType")
                 .cors("cors")
                 .invokeMode("invokeMode")
                 .build())
         .handler("handler")
         .imageConfig(ImageConfigProperty.builder()
                 .command(List.of("command"))
                 .entryPoint(List.of("entryPoint"))
                 .workingDirectory("workingDirectory")
                 .build())
         .imageUri("imageUri")
         .inlineCode("inlineCode")
         .kmsKeyArn("kmsKeyArn")
         .layers(List.of("layers"))
         .memorySize(123)
         .packageType("packageType")
         .permissionsBoundary("permissionsBoundary")
         .policies("policies")
         .provisionedConcurrencyConfig(ProvisionedConcurrencyConfigProperty.builder()
                 .provisionedConcurrentExecutions("provisionedConcurrentExecutions")
                 .build())
         .reservedConcurrentExecutions(123)
         .role("role")
         .runtime("runtime")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .timeout(123)
         .tracing("tracing")
         .versionDescription("versionDescription")
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnFunctionPropsMixin

      protected CfnFunctionPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFunctionPropsMixin

      protected CfnFunctionPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFunctionPropsMixin

      @Stability(Stable) public CfnFunctionPropsMixin(@NotNull CfnFunctionMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Serverless::Function.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnFunctionPropsMixin

      @Stability(Stable) public CfnFunctionPropsMixin(@NotNull CfnFunctionMixinProps props)
      Create a mixin to apply properties to AWS::Serverless::Function.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnFunctionMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()