/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.lambda.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateFunctionUrlConfigRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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. *
*/ private String functionName; /** ** The alias name. *
*/ private String qualifier; /** *
* 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.
*
* The cross-origin resource sharing (CORS) * settings for your function URL. *
*/ private Cors cors; /** ** 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.
*
* 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. *
* * @param 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 void setFunctionName(String functionName) { this.functionName = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateFunctionUrlConfigRequest withFunctionName(String functionName) { setFunctionName(functionName); return this; } /** *
* The alias name. *
* * @param qualifier * The alias name. */ public void setQualifier(String qualifier) { this.qualifier = qualifier; } /** ** The alias name. *
* * @return The alias name. */ public String getQualifier() { return this.qualifier; } /** ** The alias name. *
* * @param qualifier * The alias name. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateFunctionUrlConfigRequest withQualifier(String qualifier) { setQualifier(qualifier); return this; } /** *
* 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.
*
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 FunctionUrlAuthType
*/
public void setAuthType(String authType) {
this.authType = 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.
*
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 FunctionUrlAuthType
*/
public String getAuthType() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FunctionUrlAuthType
*/
public CreateFunctionUrlConfigRequest withAuthType(String authType) {
setAuthType(authType);
return this;
}
/**
*
* 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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FunctionUrlAuthType
*/
public CreateFunctionUrlConfigRequest withAuthType(FunctionUrlAuthType authType) {
this.authType = authType.toString();
return this;
}
/**
* * The cross-origin resource sharing (CORS) * settings for your function URL. *
* * @param cors * The cross-origin resource sharing * (CORS) settings for your function URL. */ public void setCors(Cors cors) { this.cors = cors; } /** ** The cross-origin resource sharing (CORS) * settings for your function URL. *
* * @return The cross-origin resource sharing * (CORS) settings for your function URL. */ public Cors getCors() { return this.cors; } /** ** The cross-origin resource sharing (CORS) * settings for your function URL. *
* * @param cors * The cross-origin resource sharing * (CORS) settings for your function URL. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateFunctionUrlConfigRequest withCors(Cors cors) { setCors(cors); return this; } /** ** 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*