software.amazon.awssdk.services.lambda.model

Class AddPermissionRequest

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

Method Summary

Modifier and Type	Method and 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 must be supplied by the invoker.
String	functionName() The name of the Lambda function, version, or alias.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	principal() The AWS service or account that invokes the function.
String	qualifier() Specify a version or alias to add permissions to a published version of the function.
String	revisionId() Only update the policy if the revision ID matches the ID that's specified.
List<SdkField<?>>	sdkFields()
static Class<? extends AddPermissionRequest.Builder>	serializableBuilderClass()
String	sourceAccount() For AWS services, the ID of the account that owns the resource.
String	sourceArn() For AWS services, the ARN of the AWS 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 String functionName()

The name 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 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 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 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 String principal()

The AWS service or account 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 AWS service or account 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 String sourceArn()

For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

Returns:

For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

sourceAccount

public String sourceAccount()

For AWS services, the ID of the account that owns the resource. Use this instead of SourceArn to grant permission to resources that are owned by another account (for example, all of an account's Amazon S3 buckets). Or use it together with SourceArn to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account.

Returns:

For AWS services, the ID of the account that owns the resource. Use this instead of SourceArn to grant permission to resources that are owned by another account (for example, all of an account's Amazon S3 buckets). Or use it together with SourceArn to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account.

eventSourceToken

public String eventSourceToken()

For Alexa Smart Home functions, a token that must be supplied by the invoker.

Returns:

For Alexa Smart Home functions, a token that must be supplied by the invoker.

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()

Only update the policy 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:

Only update the policy 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.

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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo