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 Control access to 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 Control access to 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 Control access to 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 Control access to 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 200 MB.

      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 200 MB.

      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 200 MB.

      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 200 MB.

      See Also:

    • toBuilder

      public CreateFunctionUrlConfigRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateFunctionUrlConfigRequest.Builder,CreateFunctionUrlConfigRequest>
      Specified by:
      toBuilder in class LambdaRequest

    • 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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo