Package software.amazon.awssdk.services.lambda.model

Class CreateFunctionRequest

    • Method Detail

      • functionName

        public final String functionName()

        The name of the Lambda function.

        Name formats

        • Function name – my-function.

        • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

        • Partial ARN – 123456789012:function:my-function.

        The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

        Returns:
        The name of the Lambda function.

        Name formats

        • Function name – my-function.

        • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

        • Partial ARN – 123456789012:function:my-function.

        The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

      • runtime

        public final Runtime runtime()

        The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

        The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

        If the service returns an enum value that is not available in the current SDK version, runtime will return Runtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runtimeAsString().

        Returns:
        The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

        The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

        See Also:
        Runtime

      • runtimeAsString

        public final String runtimeAsString()

        The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

        The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

        If the service returns an enum value that is not available in the current SDK version, runtime will return Runtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runtimeAsString().

        Returns:
        The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

        The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

        See Also:
        Runtime

      • role

        public final String role()

        The Amazon Resource Name (ARN) of the function's execution role.

        Returns:
        The Amazon Resource Name (ARN) of the function's execution role.

      • handler

        public final String handler()

        The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

        Returns:
        The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

      • code

        public final FunctionCode code()

        The code for the function.

        Returns:
        The code for the function.

      • description

        public final String description()

        A description of the function.

        Returns:
        A description of the function.

      • timeout

        public final Integer timeout()

        The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

        Returns:
        The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

      • memorySize

        public final Integer memorySize()

        The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

        Returns:
        The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

      • publish

        public final Boolean publish()

        Set to true to publish the first version of the function during creation.

        Returns:
        Set to true to publish the first version of the function during creation.

      • vpcConfig

        public final VpcConfig vpcConfig()

        For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

        Returns:
        For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

      • packageType

        public final PackageType packageType()

        The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.

        If the service returns an enum value that is not available in the current SDK version, packageType will return PackageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packageTypeAsString().

        Returns:
        The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.
        See Also:
        PackageType

      • packageTypeAsString

        public final String packageTypeAsString()

        The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.

        If the service returns an enum value that is not available in the current SDK version, packageType will return PackageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packageTypeAsString().

        Returns:
        The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.
        See Also:
        PackageType

      • deadLetterConfig

        public final DeadLetterConfig deadLetterConfig()

        A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.

        Returns:
        A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.

      • environment

        public final Environment environment()

        Environment variables that are accessible from function code during execution.

        Returns:
        Environment variables that are accessible from function code during execution.

      • kmsKeyArn

        public final String kmsKeyArn()

        The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.

        Returns:
        The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.

      • tracingConfig

        public final TracingConfig tracingConfig()

        Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

        Returns:
        Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

        A list of tags to apply to the function.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        A list of tags to apply to the function.

      • hasLayers

        public final boolean hasLayers()
        For responses, this returns true if the service returned a value for the Layers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • layers

        public final List<String> layers()

        A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLayers() method.

        Returns:
        A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

      • hasFileSystemConfigs

        public final boolean hasFileSystemConfigs()
        For responses, this returns true if the service returned a value for the FileSystemConfigs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • fileSystemConfigs

        public final List<FileSystemConfig> fileSystemConfigs()

        Connection settings for an Amazon EFS file system.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFileSystemConfigs() method.

        Returns:
        Connection settings for an Amazon EFS file system.

      • imageConfig

        public final ImageConfig imageConfig()

        Container image configuration values that override the values in the container image Dockerfile.

        Returns:
        Container image configuration values that override the values in the container image Dockerfile.

      • codeSigningConfigArn

        public final String codeSigningConfigArn()

        To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

        Returns:
        To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

      • architectures

        public final List<Architecture> architectures()

        The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasArchitectures() method.

        Returns:
        The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

      • hasArchitectures

        public final boolean hasArchitectures()
        For responses, this returns true if the service returned a value for the Architectures property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • architecturesAsStrings

        public final List<String> architecturesAsStrings()

        The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasArchitectures() method.

        Returns:
        The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

      • ephemeralStorage

        public final EphemeralStorage ephemeralStorage()

        The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

        Returns:
        The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

      • loggingConfig

        public final LoggingConfig loggingConfig()

        The function's Amazon CloudWatch Logs configuration settings.

        Returns:
        The function's Amazon CloudWatch Logs configuration settings.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object