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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateFunctionUrlConfigRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FunctionUrlAuthTypeauthType()The type of authentication that your function URL uses.StringauthTypeAsString()The type of authentication that your function URL uses.static CreateFunctionUrlConfigRequest.Builderbuilder()Corscors()The cross-origin resource sharing (CORS) settings for your function URL.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfunctionName()The name or ARN of the Lambda function.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()InvokeModeinvokeMode()Use one of the following options:StringinvokeModeAsString()Use one of the following options:Stringqualifier()The alias name.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateFunctionUrlConfigRequest.Builder>serializableBuilderClass()CreateFunctionUrlConfigRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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_IAMif you want to restrict access to authenticated users only. Set toNONEif 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,
authTypewill returnFunctionUrlAuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthTypeAsString().- Returns:
- The type of authentication that your function URL uses. Set to
AWS_IAMif you want to restrict access to authenticated users only. Set toNONEif 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:
FunctionUrlAuthType
-
authTypeAsString
public final String authTypeAsString()
The type of authentication that your function URL uses. Set to
AWS_IAMif you want to restrict access to authenticated users only. Set toNONEif 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,
authTypewill returnFunctionUrlAuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthTypeAsString().- Returns:
- The type of authentication that your function URL uses. Set to
AWS_IAMif you want to restrict access to authenticated users only. Set toNONEif 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:
FunctionUrlAuthType
-
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 theInvokeAPI 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 theInvokeWithResponseStreamAPI 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,
invokeModewill returnInvokeMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominvokeModeAsString().- Returns:
- Use one of the following options:
-
BUFFERED– This is the default option. Lambda invokes your function using theInvokeAPI 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 theInvokeWithResponseStreamAPI operation. The maximum response payload size is 200 MB.
-
- See Also:
InvokeMode
-
-
invokeModeAsString
public final String invokeModeAsString()
Use one of the following options:
-
BUFFERED– This is the default option. Lambda invokes your function using theInvokeAPI 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 theInvokeWithResponseStreamAPI 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,
invokeModewill returnInvokeMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominvokeModeAsString().- Returns:
- Use one of the following options:
-
BUFFERED– This is the default option. Lambda invokes your function using theInvokeAPI 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 theInvokeWithResponseStreamAPI operation. The maximum response payload size is 200 MB.
-
- See Also:
InvokeMode
-
-
toBuilder
public CreateFunctionUrlConfigRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateFunctionUrlConfigRequest.Builder,CreateFunctionUrlConfigRequest>- Specified by:
toBuilderin classLambdaRequest
-
builder
public static CreateFunctionUrlConfigRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateFunctionUrlConfigRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-