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() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAction() The action that the principal can use on the function.
String	getEventSourceToken() For Alexa Smart Home functions, a token that must be supplied by the invoker.
String	getFunctionName() The name of the Lambda function, version, or alias.
String	getPrincipal() The AWS service or account that invokes the function.
String	getQualifier() Specify a version or alias to add permissions to a published version of the function.
String	getRevisionId() Only update the policy if the revision ID matches the ID that's specified.
String	getSourceAccount() For AWS services, the ID of the account that owns the resource.
String	getSourceArn() For AWS services, the ARN of the AWS resource that invokes the function.
String	getStatementId() A statement identifier that differentiates the statement from others in the same policy.
int	hashCode()
void	setAction(String action) The action that the principal can use on the function.
void	setEventSourceToken(String eventSourceToken) For Alexa Smart Home functions, a token that must be supplied by the invoker.
void	setFunctionName(String functionName) The name of the Lambda function, version, or alias.
void	setPrincipal(String principal) The AWS service or account that invokes the function.
void	setQualifier(String qualifier) Specify a version or alias to add permissions to a published version of the function.
void	setRevisionId(String revisionId) Only update the policy if the revision ID matches the ID that's specified.
void	setSourceAccount(String sourceAccount) For AWS services, the ID of the account that owns the resource.
void	setSourceArn(String sourceArn) For AWS services, the ARN of the AWS resource that invokes the function.
void	setStatementId(String statementId) A statement identifier that differentiates the statement from others in the same policy.
String	toString() Returns a string representation of this object.
AddPermissionRequest	withAction(String action) The action that the principal can use on the function.
AddPermissionRequest	withEventSourceToken(String eventSourceToken) For Alexa Smart Home functions, a token that must be supplied by the invoker.
AddPermissionRequest	withFunctionName(String functionName) The name of the Lambda function, version, or alias.
AddPermissionRequest	withPrincipal(String principal) The AWS service or account that invokes the function.
AddPermissionRequest	withQualifier(String qualifier) Specify a version or alias to add permissions to a published version of the function.
AddPermissionRequest	withRevisionId(String revisionId) Only update the policy if the revision ID matches the ID that's specified.
AddPermissionRequest	withSourceAccount(String sourceAccount) For AWS services, the ID of the account that owns the resource.
AddPermissionRequest	withSourceArn(String sourceArn) For AWS services, the ARN of the AWS resource that invokes the function.
AddPermissionRequest	withStatementId(String statementId) A statement identifier that differentiates the statement from others in the same policy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

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, 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 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.

getFunctionName

public String getFunctionName()

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.

withFunctionName

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

Parameters:

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:

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

setStatementId

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

getStatementId

public String getStatementId()

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.

withStatementId

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

setAction

public void setAction(String action)

The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

Parameters:

action - The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

getAction

public String getAction()

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.

withAction

public AddPermissionRequest withAction(String action)

The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

Parameters:

action - The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

Returns:

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

setPrincipal

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

Parameters:

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.

getPrincipal

public String getPrincipal()

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.

withPrincipal

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

Parameters:

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:

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

setSourceArn

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

Parameters:

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

getSourceArn

public String getSourceArn()

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.

withSourceArn

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

Parameters:

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:

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

setSourceAccount

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

Parameters:

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.

getSourceAccount

public String getSourceAccount()

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.

withSourceAccount

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

Parameters:

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:

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

setEventSourceToken

public void setEventSourceToken(String eventSourceToken)

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

Parameters:

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

getEventSourceToken

public String getEventSourceToken()

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.

withEventSourceToken

public AddPermissionRequest withEventSourceToken(String eventSourceToken)

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

Parameters:

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

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)

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.

Parameters:

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.

getRevisionId

public String getRevisionId()

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.

withRevisionId

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

Parameters:

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:

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()