Interface AddPermissionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<AddPermissionRequest.Builder,
,AddPermissionRequest> LambdaRequest.Builder
,SdkBuilder<AddPermissionRequest.Builder,
,AddPermissionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
AddPermissionRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe action that the principal can use on the function.eventSourceToken
(String eventSourceToken) For Alexa Smart Home functions, a token that the invoker must supply.functionName
(String functionName) The name or ARN of the Lambda function, version, or alias.functionUrlAuthType
(String functionUrlAuthType) The type of authentication that your function URL uses.functionUrlAuthType
(FunctionUrlAuthType functionUrlAuthType) The type of authentication that your function URL uses.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The Amazon Web Service or Amazon Web Services account that invokes the function.principalOrgID
(String principalOrgID) The identifier for your organization in Organizations.Specify a version or alias to add permissions to a published version of the function.revisionId
(String revisionId) Update the policy only if the revision ID matches the ID that's specified.sourceAccount
(String sourceAccount) For Amazon Web Service, the ID of the Amazon Web Services account that owns the resource.For Amazon Web Services, the ARN of the Amazon Web Services resource that invokes the function.statementId
(String statementId) A statement identifier that differentiates the statement from others in the same policy.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.lambda.model.LambdaRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
statementId
A statement identifier that differentiates the statement from others in the same policy.
- Parameters:
statementId
- A statement identifier that differentiates the statement from others in the same policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
action
The action that the principal can use on the function. For example,
lambda:InvokeFunction
orlambda:GetFunction
.- Parameters:
action
- The action that the principal can use on the function. For example,lambda:InvokeFunction
orlambda:GetFunction
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
principal
The Amazon Web Service or Amazon Web Services account that invokes the function. If you specify a service, use
SourceArn
orSourceAccount
to limit who can invoke the function through that service.- Parameters:
principal
- The Amazon Web Service or Amazon Web Services account that invokes the function. If you specify a service, useSourceArn
orSourceAccount
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
For Amazon Web 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.- Parameters:
sourceArn
- For Amazon Web 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:
- Returns a reference to this object so that method calls can be chained together.
-
sourceAccount
For Amazon Web 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.- Parameters:
sourceAccount
- For Amazon Web Service, the ID of the Amazon Web Services account that owns the resource. Use this together withSourceArn
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:
- Returns a reference to this object so that method calls can be chained together.
-
eventSourceToken
For Alexa Smart Home functions, a token that the invoker must supply.
- Parameters:
eventSourceToken
- For Alexa Smart Home functions, a token that the invoker must supply.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
principalOrgID
The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.
- Parameters:
principalOrgID
- The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 toNONE
if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.- Parameters:
functionUrlAuthType
- The type of authentication that your function URL uses. Set toAWS_IAM
if you want to restrict access to authenticated users only. Set toNONE
if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 toNONE
if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.- Parameters:
functionUrlAuthType
- The type of authentication that your function URL uses. Set toAWS_IAM
if you want to restrict access to authenticated users only. Set toNONE
if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
AddPermissionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-