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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AddPermissionRequest
extends LambdaRequest
implements ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AddPermissionRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`action()`	The action that the principal can use on the function.
`static AddPermissionRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`eventSourceToken()`	For Alexa Smart Home functions, a token that the invoker must supply.
`String`	`functionName()`	The name or ARN of the Lambda function, version, or alias.
`FunctionUrlAuthType`	`functionUrlAuthType()`	The type of authentication that your function URL uses.
`String`	`functionUrlAuthTypeAsString()`	The type of authentication that your function URL uses.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`invokedViaFunctionUrl()`	Restricts the `lambda:InvokeFunction` action to calls coming from a function URL.
`String`	`principal()`	The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function.
`String`	`principalOrgID()`	The identifier for your organization in Organizations.
`String`	`qualifier()`	Specify a version or alias to add permissions to a published version of the function.
`String`	`revisionId()`	Update the policy only if the revision ID matches the ID that's specified.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AddPermissionRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceAccount()`	For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource.
`String`	`sourceArn()`	For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function.
`String`	`statementId()`	A statement identifier that differentiates the statement from others in the same policy.
`AddPermissionRequest.Builder`	`toBuilder()`
`String`	`toString()`	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, version, or alias.
    
    Name formats
    
    Function name – my-function (name-only), my-function:v1 (with alias).
    
    Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
    
    Partial ARN – 123456789012:function:my-function.
    
    You can append a version number or alias to any of the formats. 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, version, or alias.
    
    Name formats
    
    Function name – my-function (name-only), my-function:v1 (with alias).
    
    Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
    
    Partial ARN – 123456789012:function:my-function.
    
    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
  - statementId
```
public final String statementId()
```
    A statement identifier that differentiates the statement from others in the same policy.
    
    Returns:
    
    A statement identifier that differentiates the statement from others in the same policy.
  - action
```
public final String action()
```
    The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.
    
    Returns:
    
    The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.
  - principal
```
public final String principal()
```
    The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
    
    Returns:
    
    The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
  - sourceArn
```
public final String sourceArn()
```
    For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
    
    Note that Lambda configures the comparison using the StringLike operator.
    
    Returns:
    
    For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
    
    Note that Lambda configures the comparison using the StringLike operator.
  - sourceAccount
```
public final String sourceAccount()
```
    For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
    
    Returns:
    
    For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
  - eventSourceToken
```
public final String eventSourceToken()
```
    For Alexa Smart Home functions, a token that the invoker must supply.
    
    Returns:
    
    For Alexa Smart Home functions, a token that the invoker must supply.
  - qualifier
```
public final String qualifier()
```
    Specify a version or alias to add permissions to a published version of the function.
    
    Returns:
    
    Specify a version or alias to add permissions to a published version of the function.
  - revisionId
```
public final String revisionId()
```
    Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
    
    Returns:
    
    Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
  - principalOrgID
```
public final String principalOrgID()
```
    The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.
    
    Returns:
    
    The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.
  - functionUrlAuthType
```
public final FunctionUrlAuthType functionUrlAuthType()
```
    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, functionUrlAuthType will return FunctionUrlAuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from functionUrlAuthTypeAsString().
    
    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:
    
    FunctionUrlAuthType
  - functionUrlAuthTypeAsString
```
public final String functionUrlAuthTypeAsString()
```
    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, functionUrlAuthType will return FunctionUrlAuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from functionUrlAuthTypeAsString().
    
    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:
    
    FunctionUrlAuthType
  - invokedViaFunctionUrl
```
public final Boolean invokedViaFunctionUrl()
```
    Restricts the lambda:InvokeFunction action to calls coming from a function URL. When set to true, this prevents the principal from invoking the function by any means other than the function URL. For more information, see Control access to Lambda function URLs.
    
    Returns:
    
    Restricts the lambda:InvokeFunction action to calls coming from a function URL. When set to true, this prevents the principal from invoking the function by any means other than the function URL. For more information, see Control access to Lambda function URLs.
  - toBuilder
```
public AddPermissionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>
    
    Specified by:
    
    toBuilder in class LambdaRequest
  - builder
```
public static AddPermissionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AddPermissionRequest.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

Class AddPermissionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

functionName

statementId

action

principal

sourceArn

sourceAccount

eventSourceToken

qualifier

revisionId

principalOrgID

functionUrlAuthType

functionUrlAuthTypeAsString

invokedViaFunctionUrl

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField