AddPermissionRequest (AWS SDK for Java

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(value="software.amazon.awssdk:codegen")
public final class AddPermissionRequest
extends LambdaRequest
implements ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AddPermissionRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AddPermissionRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`action()` The AWS Lambda action you want to allow in this statement.
`static AddPermissionRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`String`	`eventSourceToken()` A unique token that must be supplied by the principal invoking the function.
`String`	`functionName()` The name of the Lambda function.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`principal()` The principal who is getting this permission.
`String`	`qualifier()` Specify a version or alias to add permissions to a published version of the function.
`String`	`revisionId()` An optional value you can use to ensure you are updating the latest update of the function version or alias.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AddPermissionRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceAccount()` This parameter is used for S3 and SES.
`String`	`sourceArn()` The Amazon Resource Name of the invoker.
`String`	`statementId()` A unique statement identifier.
`AddPermissionRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - functionName
```
public String functionName()
```
    The name of the Lambda function.
    
    Name formats
    - Function name - MyFunction.
    - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
    - Partial ARN - 123456789012:function:MyFunction.
    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 of the Lambda function.
    
    Name formats
    
    Function name - MyFunction.
    
    Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
    
    Partial ARN - 123456789012:function:MyFunction.
    
    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 String statementId()
```
    A unique statement identifier.
    
    Returns:
    
    A unique statement identifier.
  - action
```
public String action()
```
    The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda: followed by the API name . For example, lambda:CreateFunction. You can use wildcard (lambda:*) to grant permission for all AWS Lambda actions.
    
    Returns:
    
    The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda: followed by the API name . For example, lambda:CreateFunction. You can use wildcard (lambda:*) to grant permission for all AWS Lambda actions.
  - principal
```
public String principal()
```
    The principal who is getting this permission. The principal can be an AWS service (e.g. s3.amazonaws.com or sns.amazonaws.com) for service triggers, or an account ID for cross-account access. If you specify a service as a principal, use the SourceArn parameter to limit who can invoke the function through that service.
    
    Returns:
    
    The principal who is getting this permission. The principal can be an AWS service (e.g. s3.amazonaws.com or sns.amazonaws.com) for service triggers, or an account ID for cross-account access. If you specify a service as a principal, use the SourceArn parameter to limit who can invoke the function through that service.
  - sourceArn
```
public String sourceArn()
```
    The Amazon Resource Name of the invoker.
    
    If you add a permission to a service principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can invoke your Lambda function.
    
    Returns:
    
    The Amazon Resource Name of the invoker.
    
    If you add a permission to a service principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can invoke your Lambda function.
  - sourceAccount
```
public String sourceAccount()
```
    This parameter is used for S3 and SES. The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner's account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don't specify the SourceArn) owned by a specific account.
    
    Returns:
    
    This parameter is used for S3 and SES. The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner's account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don't specify the SourceArn) owned by a specific account.
  - eventSourceToken
```
public String eventSourceToken()
```
    A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions.
    
    Returns:
    
    A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions.
  - qualifier
```
public 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 String revisionId()
```
    An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias
    
    Returns:
    
    An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn't match the latest RevisionId of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias
  - toBuilder
```
public AddPermissionRequest.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<AddPermissionRequest.Builder,AddPermissionRequest>
    
    Specified by:
    
    toBuilder in class LambdaRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static AddPermissionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AddPermissionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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 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.

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields