Class CreateFunctionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.lambda.model.LambdaResponse
software.amazon.awssdk.services.lambda.model.CreateFunctionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateFunctionResponse.Builder,CreateFunctionResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateFunctionResponse extends LambdaResponse implements ToCopyableBuilder<CreateFunctionResponse.Builder,CreateFunctionResponse>

Details about a function's configuration.

  • Method Details

    • functionName

      public final String functionName()

      The name of the function.

      Returns:
      The name of the function.

    • functionArn

      public final String functionArn()

      The function's Amazon Resource Name (ARN).

      Returns:
      The function's Amazon Resource Name (ARN).

    • runtime

      public final Runtime runtime()

      The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

      The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

      For a list of all currently supported runtimes, see Supported runtimes.

      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. Specifying a runtime results in an error if you're deploying a function using a container image.

      The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

      For a list of all currently supported runtimes, see Supported runtimes.

      See Also:

    • runtimeAsString

      public final String runtimeAsString()

      The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

      The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

      For a list of all currently supported runtimes, see Supported runtimes.

      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. Specifying a runtime results in an error if you're deploying a function using a container image.

      The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

      For a list of all currently supported runtimes, see Supported runtimes.

      See Also:

    • role

      public final String role()

      The function's execution role.

      Returns:
      The function's execution role.

    • handler

      public final String handler()

      The function that Lambda calls to begin running your function.

      Returns:
      The function that Lambda calls to begin running your function.

    • codeSize

      public final Long codeSize()

      The size of the function's deployment package, in bytes.

      Returns:
      The size of the function's deployment package, in bytes.

    • description

      public final String description()

      The function's description.

      Returns:
      The function's description.

    • timeout

      public final Integer timeout()

      The amount of time in seconds that Lambda allows a function to run before stopping it.

      Returns:
      The amount of time in seconds that Lambda allows a function to run before stopping it.

    • memorySize

      public final Integer memorySize()

      The amount of memory available to the function at runtime.

      Returns:
      The amount of memory available to the function at runtime.

    • lastModified

      public final String lastModified()

      The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

      Returns:
      The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    • codeSha256

      public final String codeSha256()

      The SHA256 hash of the function's deployment package.

      Returns:
      The SHA256 hash of the function's deployment package.

    • version

      public final String version()

      The version of the Lambda function.

      Returns:
      The version of the Lambda function.

    • vpcConfig

      public final VpcConfigResponse vpcConfig()

      The function's networking configuration.

      Returns:
      The function's networking configuration.

    • deadLetterConfig

      public final DeadLetterConfig deadLetterConfig()

      The function's dead letter queue.

      Returns:
      The function's dead letter queue.

    • environment

      public final EnvironmentResponse environment()

      The function's environment variables. Omitted from CloudTrail logs.

      Returns:
      The function's environment variables. Omitted from CloudTrail logs.

    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

      • The function's environment variables.

      • The function's Lambda SnapStart snapshots.

      • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

      • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

      If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

      Returns:
      The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

      • The function's environment variables.

      • The function's Lambda SnapStart snapshots.

      • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

      • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

      If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

    • tracingConfig

      public final TracingConfigResponse tracingConfig()

      The function's X-Ray tracing configuration.

      Returns:
      The function's X-Ray tracing configuration.

    • masterArn

      public final String masterArn()

      For Lambda@Edge functions, the ARN of the main function.

      Returns:
      For Lambda@Edge functions, the ARN of the main function.

    • revisionId

      public final String revisionId()

      The latest updated revision of the function or alias.

      Returns:
      The latest updated revision of the function or alias.

    • 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<Layer> layers()

      The function's layers.

      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:
      The function's layers.

    • state

      public final State state()

      The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

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

      Returns:
      The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

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

      Returns:
      The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.
      See Also:

    • stateReason

      public final String stateReason()

      The reason for the function's current state.

      Returns:
      The reason for the function's current state.

    • stateReasonCode

      public final StateReasonCode stateReasonCode()

      The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

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

      Returns:
      The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
      See Also:

    • stateReasonCodeAsString

      public final String stateReasonCodeAsString()

      The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

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

      Returns:
      The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.
      See Also:

    • lastUpdateStatus

      public final LastUpdateStatus lastUpdateStatus()

      The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

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

      Returns:
      The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
      See Also:

    • lastUpdateStatusAsString

      public final String lastUpdateStatusAsString()

      The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

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

      Returns:
      The status of the last update that was performed on the function. This is first set to Successful after function creation completes.
      See Also:

    • lastUpdateStatusReason

      public final String lastUpdateStatusReason()

      The reason for the last update that was performed on the function.

      Returns:
      The reason for the last update that was performed on the function.

    • lastUpdateStatusReasonCode

      public final LastUpdateStatusReasonCode lastUpdateStatusReasonCode()

      The reason code for the last update that was performed on the function.

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

      Returns:
      The reason code for the last update that was performed on the function.
      See Also:

    • lastUpdateStatusReasonCodeAsString

      public final String lastUpdateStatusReasonCodeAsString()

      The reason code for the last update that was performed on the function.

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

      Returns:
      The reason code for the last update that was performed on the function.
      See Also:

    • 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.

    • packageType

      public final PackageType packageType()

      The type of deployment package. Set to Image for container image and set 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 Zip for .zip file archive.
      See Also:

    • packageTypeAsString

      public final String packageTypeAsString()

      The type of deployment package. Set to Image for container image and set 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 Zip for .zip file archive.
      See Also:

    • imageConfigResponse

      public final ImageConfigResponse imageConfigResponse()

      The function's image configuration values.

      Returns:
      The function's image configuration values.

    • signingProfileVersionArn

      public final String signingProfileVersionArn()

      The ARN of the signing profile version.

      Returns:
      The ARN of the signing profile version.

    • signingJobArn

      public final String signingJobArn()

      The ARN of the signing job.

      Returns:
      The ARN of the signing job.

    • architectures

      public final List<Architecture> architectures()

      The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture 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. Architecture is a string array with one of the valid values. The default architecture 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. Architecture is a string array with one of the valid values. The default architecture 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. Architecture is a string array with one of the valid values. The default architecture 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).

    • snapStart

      public final SnapStartResponse snapStart()

      Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

      Returns:
      Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

    • runtimeVersionConfig

      public final RuntimeVersionConfig runtimeVersionConfig()

      The ARN of the runtime and any errors that occured.

      Returns:
      The ARN of the runtime and any errors that occured.

    • loggingConfig

      public final LoggingConfig loggingConfig()

      The function's Amazon CloudWatch Logs configuration settings.

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

    • toBuilder

      public CreateFunctionResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateFunctionResponse.Builder,CreateFunctionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateFunctionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateFunctionResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.