software.amazon.awssdk.services.lambda.model

Interface AddPermissionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>, LambdaRequest.Builder, SdkBuilder<AddPermissionRequest.Builder,AddPermissionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

AddPermissionRequest

public static interface AddPermissionRequest.Builder
extends LambdaRequest.Builder, SdkPojo, CopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

Method Summary

Modifier and Type	Method and Description
AddPermissionRequest.Builder	action(String action) The AWS Lambda action you want to allow in this statement.
AddPermissionRequest.Builder	eventSourceToken(String eventSourceToken) A unique token that must be supplied by the principal invoking the function.
AddPermissionRequest.Builder	functionName(String functionName) The name of the Lambda function.
AddPermissionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
AddPermissionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
AddPermissionRequest.Builder	principal(String principal) The principal who is getting this permission.
AddPermissionRequest.Builder	qualifier(String qualifier) Specify a version or alias to add permissions to a published version of the function.
AddPermissionRequest.Builder	revisionId(String revisionId) An optional value you can use to ensure you are updating the latest update of the function version or alias.
AddPermissionRequest.Builder	sourceAccount(String sourceAccount) This parameter is used for S3 and SES.
AddPermissionRequest.Builder	sourceArn(String sourceArn) The Amazon Resource Name of the invoker.
AddPermissionRequest.Builder	statementId(String statementId) A unique statement identifier.

Methods inherited from interface software.amazon.awssdk.services.lambda.model.LambdaRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

functionName

AddPermissionRequest.Builder functionName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

statementId

AddPermissionRequest.Builder statementId(String statementId)

A unique statement identifier.

Parameters:

statementId - A unique statement identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

action

AddPermissionRequest.Builder action(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

principal

AddPermissionRequest.Builder principal(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

sourceArn

AddPermissionRequest.Builder sourceArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

sourceAccount

AddPermissionRequest.Builder sourceAccount(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

eventSourceToken

AddPermissionRequest.Builder eventSourceToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

qualifier

AddPermissionRequest.Builder qualifier(String qualifier)

Specify a version or alias to add permissions to a published version of the function.

Parameters:

qualifier - Specify a version or alias to add permissions to a published version of the function.

Returns:

Returns a reference to this object so that method calls can be chained together.

revisionId

AddPermissionRequest.Builder revisionId(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

AddPermissionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

AddPermissionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.