@Generated(value="software.amazon.awssdk:codegen") public final class CreateFunctionRequest extends LambdaRequest implements ToCopyableBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateFunctionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
List<Architecture> |
architectures()
The instruction set architecture that the function supports.
|
List<String> |
architecturesAsStrings()
The instruction set architecture that the function supports.
|
static CreateFunctionRequest.Builder |
builder() |
FunctionCode |
code()
The code for the function.
|
String |
codeSigningConfigArn()
To enable code signing for this function, specify the ARN of a code-signing configuration.
|
DeadLetterConfig |
deadLetterConfig()
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when
they fail processing.
|
String |
description()
A description of the function.
|
Environment |
environment()
Environment variables that are accessible from function code during execution.
|
EphemeralStorage |
ephemeralStorage()
The size of the function’s /tmp directory in MB.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<FileSystemConfig> |
fileSystemConfigs()
Connection settings for an Amazon EFS file system.
|
String |
functionName()
The name of the Lambda function.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
handler()
The name of the method within your code that Lambda calls to execute your function.
|
boolean |
hasArchitectures()
For responses, this returns true if the service returned a value for the Architectures property.
|
boolean |
hasFileSystemConfigs()
For responses, this returns true if the service returned a value for the FileSystemConfigs property.
|
int |
hashCode() |
boolean |
hasLayers()
For responses, this returns true if the service returned a value for the Layers property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
ImageConfig |
imageConfig()
Container image configuration values that override the values in the container image Dockerfile.
|
String |
kmsKeyArn()
The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's
environment variables.
|
List<String> |
layers()
A list of function layers to
add to the function's execution environment.
|
Integer |
memorySize()
The amount of memory available
to the function at runtime.
|
PackageType |
packageType()
The type of deployment package.
|
String |
packageTypeAsString()
The type of deployment package.
|
Boolean |
publish()
Set to true to publish the first version of the function during creation.
|
String |
role()
The Amazon Resource Name (ARN) of the function's execution role.
|
Runtime |
runtime()
The identifier of the function's runtime.
|
String |
runtimeAsString()
The identifier of the function's runtime.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateFunctionRequest.Builder> |
serializableBuilderClass() |
Map<String,String> |
tags()
A list of tags to apply to the function.
|
Integer |
timeout()
The amount of time (in seconds) that Lambda allows a function to run before stopping it.
|
CreateFunctionRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
TracingConfig |
tracingConfig()
|
VpcConfig |
vpcConfig()
For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets
in the VPC.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
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.
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.
public final Runtime runtime()
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.
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()
.
public final String runtimeAsString()
The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.
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()
.
public final String role()
The Amazon Resource Name (ARN) of the function's execution role.
public final String handler()
The name of the method within your code that Lambda calls to execute 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 Programming Model.
public final FunctionCode code()
The code for the function.
public final String description()
A description of the function.
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 additional information, see Lambda execution environment.
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.
public final Boolean publish()
Set to true to publish the first version of the function during creation.
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 only access resources and the internet through that VPC. For more information, see VPC Settings.
public final PackageType packageType()
The type of deployment package. Set to Image
for container image and set Zip
for ZIP
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()
.
Image
for container image and set Zip
for ZIP archive.PackageType
public final String packageTypeAsString()
The type of deployment package. Set to Image
for container image and set Zip
for ZIP
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()
.
Image
for container image and set Zip
for ZIP archive.PackageType
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.
public final Environment environment()
Environment variables that are accessible from function code during execution.
public final String kmsKeyArn()
The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.
public final TracingConfig tracingConfig()
Set Mode
to Active
to sample and trace a subset of incoming requests with X-Ray.
Mode
to Active
to sample and trace a subset of incoming requests with X-Ray.public final boolean hasTags()
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.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.
public final boolean hasLayers()
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.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.
public final boolean hasFileSystemConfigs()
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.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.
public final ImageConfig imageConfig()
Container image configuration values that override the values in the container image Dockerfile.
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.
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.
x86_64
.public final boolean hasArchitectures()
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.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.
x86_64
.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 10240 MB.
public CreateFunctionRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest>
toBuilder
in class LambdaRequest
public static CreateFunctionRequest.Builder builder()
public static Class<? extends CreateFunctionRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.