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

Class CreateFunctionUrlConfigRequest

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

  • Method Details

    • functionName

      public final String functionName()

      The name or ARN 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 or ARN 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.

    • qualifier

      public final String qualifier()

      The alias name.

      Returns:
      The alias name.

    • authType

      public final FunctionUrlAuthType authType()

      The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

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

      Returns:
      The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.
      See Also:

    • authTypeAsString

      public final String authTypeAsString()

      The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

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

      Returns:
      The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.
      See Also:

    • cors

      public final Cors cors()

      The cross-origin resource sharing (CORS) settings for your function URL.

      Returns:
      The cross-origin resource sharing (CORS) settings for your function URL.

    • invokeMode

      public final InvokeMode invokeMode()

      Use one of the following options:

      • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

      • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

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

      Returns:
      Use one of the following options:

      • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

      • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

      See Also:

    • invokeModeAsString

      public final String invokeModeAsString()

      Use one of the following options:

      • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

      • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

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

      Returns:
      Use one of the following options:

      • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

      • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

      See Also:

    • toBuilder

      public CreateFunctionUrlConfigRequest.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<CreateFunctionUrlConfigRequest.Builder,CreateFunctionUrlConfigRequest>
      Specified by:
      toBuilder in class LambdaRequest
      Returns:
      a builder for type T

    • builder

      public static CreateFunctionUrlConfigRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.