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) Indicates whether some other object is "equal to" this one by SDK fields.
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) Used to retrieve the value of a field from any class that extends SdkRequest.
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 Amazon S3, 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() Take this object and create a builder that contains all of the current property values of this object.
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

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 Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn to ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

Returns:

For Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn to ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to 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()

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 AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

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.