com.amazonaws.services.lambda.model

Class AddPermissionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lambda.model.AddPermissionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AddPermissionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AddPermissionRequest()

Method Summary

Modifier and Type	Method and Description
AddPermissionRequest	clone()
boolean	equals(Object obj)
String	getAction() The AWS Lambda action you want to allow in this statement.
String	getEventSourceToken() A unique token that must be supplied by the principal invoking the function.
String	getFunctionName() The name of the lambda function.
String	getPrincipal() The principal who is getting this permission.
String	getQualifier() Specify a version or alias to add permissions to a published version of the function.
String	getRevisionId() An optional value you can use to ensure you are updating the latest update of the function version or alias.
String	getSourceAccount() This parameter is used for S3 and SES.
String	getSourceArn() The Amazon Resource Name of the invoker.
String	getStatementId() A unique statement identifier.
int	hashCode()
void	setAction(String action) The AWS Lambda action you want to allow in this statement.
void	setEventSourceToken(String eventSourceToken) A unique token that must be supplied by the principal invoking the function.
void	setFunctionName(String functionName) The name of the lambda function.
void	setPrincipal(String principal) The principal who is getting this permission.
void	setQualifier(String qualifier) Specify a version or alias to add permissions to a published version of the function.
void	setRevisionId(String revisionId) An optional value you can use to ensure you are updating the latest update of the function version or alias.
void	setSourceAccount(String sourceAccount) This parameter is used for S3 and SES.
void	setSourceArn(String sourceArn) The Amazon Resource Name of the invoker.
void	setStatementId(String statementId) A unique statement identifier.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AddPermissionRequest	withAction(String action) The AWS Lambda action you want to allow in this statement.
AddPermissionRequest	withEventSourceToken(String eventSourceToken) A unique token that must be supplied by the principal invoking the function.
AddPermissionRequest	withFunctionName(String functionName) The name of the lambda function.
AddPermissionRequest	withPrincipal(String principal) The principal who is getting this permission.
AddPermissionRequest	withQualifier(String qualifier) Specify a version or alias to add permissions to a published version of the function.
AddPermissionRequest	withRevisionId(String revisionId) An optional value you can use to ensure you are updating the latest update of the function version or alias.
AddPermissionRequest	withSourceAccount(String sourceAccount) This parameter is used for S3 and SES.
AddPermissionRequest	withSourceArn(String sourceArn) The Amazon Resource Name of the invoker.
AddPermissionRequest	withStatementId(String statementId) A unique statement identifier.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AddPermissionRequest

public AddPermissionRequest()

Method Detail

setFunctionName

public void setFunctionName(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.

getFunctionName

public String getFunctionName()

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.

withFunctionName

public AddPermissionRequest withFunctionName(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.

setStatementId

public void setStatementId(String statementId)

A unique statement identifier.

Parameters:

statementId - A unique statement identifier.

getStatementId

public String getStatementId()

A unique statement identifier.

Returns:

A unique statement identifier.

withStatementId

public AddPermissionRequest withStatementId(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.

setAction

public void setAction(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.

getAction

public String getAction()

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.

withAction

public AddPermissionRequest withAction(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.

setPrincipal

public void setPrincipal(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.

getPrincipal

public String getPrincipal()

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.

withPrincipal

public AddPermissionRequest withPrincipal(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.

setSourceArn

public void setSourceArn(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.

getSourceArn

public String getSourceArn()

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.

withSourceArn

public AddPermissionRequest withSourceArn(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.

setSourceAccount

public void setSourceAccount(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.

getSourceAccount

public String getSourceAccount()

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.

withSourceAccount

public AddPermissionRequest withSourceAccount(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.

setEventSourceToken

public void setEventSourceToken(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.

getEventSourceToken

public String getEventSourceToken()

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.

withEventSourceToken

public AddPermissionRequest withEventSourceToken(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.

setQualifier

public void setQualifier(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.

getQualifier

public String getQualifier()

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.

withQualifier

public AddPermissionRequest withQualifier(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.

setRevisionId

public void setRevisionId(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

getRevisionId

public String getRevisionId()

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

withRevisionId

public AddPermissionRequest withRevisionId(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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AddPermissionRequest clone()

Overrides:

clone in class AmazonWebServiceRequest