@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateFunctionRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateFunctionRequest() |
Modifier and Type | Method and Description |
---|---|
CreateFunctionRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateFunctionRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateFunctionRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
FunctionCode |
getCode()
The code for the function.
|
String |
getCodeSigningConfigArn()
To enable code signing for this function, specify the ARN of a code-signing configuration.
|
DeadLetterConfig |
getDeadLetterConfig()
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when
they fail processing.
|
String |
getDescription()
A description of the function.
|
Environment |
getEnvironment()
Environment variables that are accessible from function code during execution.
|
List<FileSystemConfig> |
getFileSystemConfigs()
Connection settings for an Amazon EFS file system.
|
String |
getFunctionName()
The name of the Lambda function.
|
String |
getHandler()
The name of the method within your code that Lambda calls to execute your function.
|
ImageConfig |
getImageConfig()
Container image configuration values
that override the values in the container image Dockerfile.
|
String |
getKMSKeyArn()
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment
variables.
|
List<String> |
getLayers()
A list of function layers to
add to the function's execution environment.
|
Integer |
getMemorySize()
The amount of memory available to the function at runtime.
|
String |
getPackageType()
The type of deployment package.
|
Boolean |
getPublish()
Set to true to publish the first version of the function during creation.
|
String |
getRole()
The Amazon Resource Name (ARN) of the function's execution role.
|
String |
getRuntime()
The identifier of the function's runtime.
|
Map<String,String> |
getTags()
A list of tags to apply to the function.
|
Integer |
getTimeout()
The amount of time that Lambda allows a function to run before stopping it.
|
TracingConfig |
getTracingConfig()
Set
Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray. |
VpcConfig |
getVpcConfig()
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.
|
int |
hashCode() |
Boolean |
isPublish()
Set to true to publish the first version of the function during creation.
|
void |
setCode(FunctionCode code)
The code for the function.
|
void |
setCodeSigningConfigArn(String codeSigningConfigArn)
To enable code signing for this function, specify the ARN of a code-signing configuration.
|
void |
setDeadLetterConfig(DeadLetterConfig deadLetterConfig)
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when
they fail processing.
|
void |
setDescription(String description)
A description of the function.
|
void |
setEnvironment(Environment environment)
Environment variables that are accessible from function code during execution.
|
void |
setFileSystemConfigs(Collection<FileSystemConfig> fileSystemConfigs)
Connection settings for an Amazon EFS file system.
|
void |
setFunctionName(String functionName)
The name of the Lambda function.
|
void |
setHandler(String handler)
The name of the method within your code that Lambda calls to execute your function.
|
void |
setImageConfig(ImageConfig imageConfig)
Container image configuration values
that override the values in the container image Dockerfile.
|
void |
setKMSKeyArn(String kMSKeyArn)
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment
variables.
|
void |
setLayers(Collection<String> layers)
A list of function layers to
add to the function's execution environment.
|
void |
setMemorySize(Integer memorySize)
The amount of memory available to the function at runtime.
|
void |
setPackageType(PackageType packageType)
The type of deployment package.
|
void |
setPackageType(String packageType)
The type of deployment package.
|
void |
setPublish(Boolean publish)
Set to true to publish the first version of the function during creation.
|
void |
setRole(String role)
The Amazon Resource Name (ARN) of the function's execution role.
|
void |
setRuntime(Runtime runtime)
The identifier of the function's runtime.
|
void |
setRuntime(String runtime)
The identifier of the function's runtime.
|
void |
setTags(Map<String,String> tags)
A list of tags to apply to the function.
|
void |
setTimeout(Integer timeout)
The amount of time that Lambda allows a function to run before stopping it.
|
void |
setTracingConfig(TracingConfig tracingConfig)
Set
Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray. |
void |
setVpcConfig(VpcConfig vpcConfig)
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.
|
String |
toString()
Returns a string representation of this object.
|
CreateFunctionRequest |
withCode(FunctionCode code)
The code for the function.
|
CreateFunctionRequest |
withCodeSigningConfigArn(String codeSigningConfigArn)
To enable code signing for this function, specify the ARN of a code-signing configuration.
|
CreateFunctionRequest |
withDeadLetterConfig(DeadLetterConfig deadLetterConfig)
A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when
they fail processing.
|
CreateFunctionRequest |
withDescription(String description)
A description of the function.
|
CreateFunctionRequest |
withEnvironment(Environment environment)
Environment variables that are accessible from function code during execution.
|
CreateFunctionRequest |
withFileSystemConfigs(Collection<FileSystemConfig> fileSystemConfigs)
Connection settings for an Amazon EFS file system.
|
CreateFunctionRequest |
withFileSystemConfigs(FileSystemConfig... fileSystemConfigs)
Connection settings for an Amazon EFS file system.
|
CreateFunctionRequest |
withFunctionName(String functionName)
The name of the Lambda function.
|
CreateFunctionRequest |
withHandler(String handler)
The name of the method within your code that Lambda calls to execute your function.
|
CreateFunctionRequest |
withImageConfig(ImageConfig imageConfig)
Container image configuration values
that override the values in the container image Dockerfile.
|
CreateFunctionRequest |
withKMSKeyArn(String kMSKeyArn)
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment
variables.
|
CreateFunctionRequest |
withLayers(Collection<String> layers)
A list of function layers to
add to the function's execution environment.
|
CreateFunctionRequest |
withLayers(String... layers)
A list of function layers to
add to the function's execution environment.
|
CreateFunctionRequest |
withMemorySize(Integer memorySize)
The amount of memory available to the function at runtime.
|
CreateFunctionRequest |
withPackageType(PackageType packageType)
The type of deployment package.
|
CreateFunctionRequest |
withPackageType(String packageType)
The type of deployment package.
|
CreateFunctionRequest |
withPublish(Boolean publish)
Set to true to publish the first version of the function during creation.
|
CreateFunctionRequest |
withRole(String role)
The Amazon Resource Name (ARN) of the function's execution role.
|
CreateFunctionRequest |
withRuntime(Runtime runtime)
The identifier of the function's runtime.
|
CreateFunctionRequest |
withRuntime(String runtime)
The identifier of the function's runtime.
|
CreateFunctionRequest |
withTags(Map<String,String> tags)
A list of tags to apply to the function.
|
CreateFunctionRequest |
withTimeout(Integer timeout)
The amount of time that Lambda allows a function to run before stopping it.
|
CreateFunctionRequest |
withTracingConfig(TracingConfig tracingConfig)
Set
Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray. |
CreateFunctionRequest |
withVpcConfig(VpcConfig vpcConfig)
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setFunctionName(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.
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.
public String getFunctionName()
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 CreateFunctionRequest withFunctionName(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.
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.
public CreateFunctionRequest withRuntime(String runtime)
The identifier of the function's runtime.
public CreateFunctionRequest withRuntime(Runtime runtime)
The identifier of the function's runtime.
public void setRole(String role)
The Amazon Resource Name (ARN) of the function's execution role.
role
- The Amazon Resource Name (ARN) of the function's execution role.public String getRole()
The Amazon Resource Name (ARN) of the function's execution role.
public CreateFunctionRequest withRole(String role)
The Amazon Resource Name (ARN) of the function's execution role.
role
- The Amazon Resource Name (ARN) of the function's execution role.public void setHandler(String handler)
The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
handler
- The name of the method within your code that Lambda calls to execute your function. 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 String getHandler()
The name of the method within your code that Lambda calls to execute your function. 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 CreateFunctionRequest withHandler(String handler)
The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
handler
- The name of the method within your code that Lambda calls to execute your function. 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 void setCode(FunctionCode code)
The code for the function.
code
- The code for the function.public FunctionCode getCode()
The code for the function.
public CreateFunctionRequest withCode(FunctionCode code)
The code for the function.
code
- The code for the function.public void setDescription(String description)
A description of the function.
description
- A description of the function.public String getDescription()
A description of the function.
public CreateFunctionRequest withDescription(String description)
A description of the function.
description
- A description of the function.public void setTimeout(Integer timeout)
The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
timeout
- The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The
maximum allowed value is 900 seconds.public Integer getTimeout()
The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
public CreateFunctionRequest withTimeout(Integer timeout)
The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
timeout
- The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The
maximum allowed value is 900 seconds.public void setMemorySize(Integer memorySize)
The amount of memory available to the function at runtime. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
memorySize
- The amount of memory available to the function at runtime. Increasing the function's memory also increases
its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.public Integer getMemorySize()
The amount of memory available to the function at runtime. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
public CreateFunctionRequest withMemorySize(Integer memorySize)
The amount of memory available to the function at runtime. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
memorySize
- The amount of memory available to the function at runtime. Increasing the function's memory also increases
its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.public void setPublish(Boolean publish)
Set to true to publish the first version of the function during creation.
publish
- Set to true to publish the first version of the function during creation.public Boolean getPublish()
Set to true to publish the first version of the function during creation.
public CreateFunctionRequest withPublish(Boolean publish)
Set to true to publish the first version of the function during creation.
publish
- Set to true to publish the first version of the function during creation.public Boolean isPublish()
Set to true to publish the first version of the function during creation.
public void setVpcConfig(VpcConfig vpcConfig)
For network connectivity to AWS 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.
vpcConfig
- For network connectivity to AWS 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 VpcConfig getVpcConfig()
For network connectivity to AWS 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 CreateFunctionRequest withVpcConfig(VpcConfig vpcConfig)
For network connectivity to AWS 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.
vpcConfig
- For network connectivity to AWS 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 void setPackageType(String packageType)
The type of deployment package. Set to Image
for container image and set Zip
for ZIP
archive.
packageType
- The type of deployment package. Set to Image
for container image and set Zip
for
ZIP archive.PackageType
public String getPackageType()
The type of deployment package. Set to Image
for container image and set Zip
for ZIP
archive.
Image
for container image and set Zip
for ZIP archive.PackageType
public CreateFunctionRequest withPackageType(String packageType)
The type of deployment package. Set to Image
for container image and set Zip
for ZIP
archive.
packageType
- The type of deployment package. Set to Image
for container image and set Zip
for
ZIP archive.PackageType
public void setPackageType(PackageType packageType)
The type of deployment package. Set to Image
for container image and set Zip
for ZIP
archive.
packageType
- The type of deployment package. Set to Image
for container image and set Zip
for
ZIP archive.PackageType
public CreateFunctionRequest withPackageType(PackageType packageType)
The type of deployment package. Set to Image
for container image and set Zip
for ZIP
archive.
packageType
- The type of deployment package. Set to Image
for container image and set Zip
for
ZIP archive.PackageType
public void setDeadLetterConfig(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.
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 DeadLetterConfig getDeadLetterConfig()
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 CreateFunctionRequest withDeadLetterConfig(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.
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 void setEnvironment(Environment environment)
Environment variables that are accessible from function code during execution.
environment
- Environment variables that are accessible from function code during execution.public Environment getEnvironment()
Environment variables that are accessible from function code during execution.
public CreateFunctionRequest withEnvironment(Environment environment)
Environment variables that are accessible from function code during execution.
environment
- Environment variables that are accessible from function code during execution.public void setKMSKeyArn(String kMSKeyArn)
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
kMSKeyArn
- The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment
variables. If it's not provided, AWS Lambda uses a default service key.public String getKMSKeyArn()
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
public CreateFunctionRequest withKMSKeyArn(String kMSKeyArn)
The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
kMSKeyArn
- The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment
variables. If it's not provided, AWS Lambda uses a default service key.public void setTracingConfig(TracingConfig tracingConfig)
Set Mode
to Active
to sample and trace a subset of incoming requests with AWS X-Ray.
tracingConfig
- Set Mode
to Active
to sample and trace a subset of incoming requests with AWS
X-Ray.public TracingConfig getTracingConfig()
Set Mode
to Active
to sample and trace a subset of incoming requests with AWS X-Ray.
Mode
to Active
to sample and trace a subset of incoming requests with AWS
X-Ray.public CreateFunctionRequest withTracingConfig(TracingConfig tracingConfig)
Set Mode
to Active
to sample and trace a subset of incoming requests with AWS X-Ray.
tracingConfig
- Set Mode
to Active
to sample and trace a subset of incoming requests with AWS
X-Ray.public Map<String,String> getTags()
A list of tags to apply to the function.
public void setTags(Map<String,String> tags)
A list of tags to apply to the function.
tags
- A list of tags to apply to the
function.public CreateFunctionRequest withTags(Map<String,String> tags)
A list of tags to apply to the function.
tags
- A list of tags to apply to the
function.public CreateFunctionRequest addTagsEntry(String key, String value)
public CreateFunctionRequest clearTagsEntries()
public List<String> getLayers()
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
public void setLayers(Collection<String> layers)
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
layers
- A list of function
layers to add to the function's execution environment. Specify each layer by its ARN, including the
version.public CreateFunctionRequest withLayers(String... layers)
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
NOTE: This method appends the values to the existing list (if any). Use
setLayers(java.util.Collection)
or withLayers(java.util.Collection)
if you want to override the
existing values.
layers
- A list of function
layers to add to the function's execution environment. Specify each layer by its ARN, including the
version.public CreateFunctionRequest withLayers(Collection<String> layers)
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
layers
- A list of function
layers to add to the function's execution environment. Specify each layer by its ARN, including the
version.public List<FileSystemConfig> getFileSystemConfigs()
Connection settings for an Amazon EFS file system.
public void setFileSystemConfigs(Collection<FileSystemConfig> fileSystemConfigs)
Connection settings for an Amazon EFS file system.
fileSystemConfigs
- Connection settings for an Amazon EFS file system.public CreateFunctionRequest withFileSystemConfigs(FileSystemConfig... fileSystemConfigs)
Connection settings for an Amazon EFS file system.
NOTE: This method appends the values to the existing list (if any). Use
setFileSystemConfigs(java.util.Collection)
or withFileSystemConfigs(java.util.Collection)
if
you want to override the existing values.
fileSystemConfigs
- Connection settings for an Amazon EFS file system.public CreateFunctionRequest withFileSystemConfigs(Collection<FileSystemConfig> fileSystemConfigs)
Connection settings for an Amazon EFS file system.
fileSystemConfigs
- Connection settings for an Amazon EFS file system.public void setImageConfig(ImageConfig imageConfig)
Container image configuration values that override the values in the container image Dockerfile.
imageConfig
- Container image configuration
values that override the values in the container image Dockerfile.public ImageConfig getImageConfig()
Container image configuration values that override the values in the container image Dockerfile.
public CreateFunctionRequest withImageConfig(ImageConfig imageConfig)
Container image configuration values that override the values in the container image Dockerfile.
imageConfig
- Container image configuration
values that override the values in the container image Dockerfile.public void setCodeSigningConfigArn(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.
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 String getCodeSigningConfigArn()
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 CreateFunctionRequest withCodeSigningConfigArn(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.
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 String toString()
toString
in class Object
Object.toString()
public CreateFunctionRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()