AddPermissionRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

Constructors
Constructor and Description
`AddPermissionRequest ()`

Method Summary

All Methods
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 the invoker must supply.
`String`	`getFunctionName ()` The name or ARN of the Lambda function, version, or alias.
`String`	`getFunctionUrlAuthType ()` The type of authentication that your function URL uses.
`String`	`getPrincipal ()` The Amazon Web Service or Amazon Web Services account that invokes the function.
`String`	`getPrincipalOrgID ()` The identifier for your organization in Organizations.
`String`	`getQualifier ()` Specify a version or alias to add permissions to a published version of the function.
`String`	`getRevisionId ()` Update the policy only if the revision ID matches the ID that's specified.
`String`	`getSourceAccount ()` For Amazon Web Service, the ID of the Amazon Web Services account that owns the resource.
`String`	`getSourceArn ()` For Amazon Web Services, the ARN of the Amazon Web Services 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 the invoker must supply.
`void`	`setFunctionName (String functionName)` The name or ARN of the Lambda function, version, or alias.
`void`	`setFunctionUrlAuthType (String functionUrlAuthType)` The type of authentication that your function URL uses.
`void`	`setPrincipal (String principal)` The Amazon Web Service or Amazon Web Services account that invokes the function.
`void`	`setPrincipalOrgID (String principalOrgID)` The identifier for your organization in Organizations.
`void`	`setQualifier (String qualifier)` Specify a version or alias to add permissions to a published version of the function.
`void`	`setRevisionId (String revisionId)` Update the policy only if the revision ID matches the ID that's specified.
`void`	`setSourceAccount (String sourceAccount)` For Amazon Web Service, the ID of the Amazon Web Services account that owns the resource.
`void`	`setSourceArn (String sourceArn)` For Amazon Web Services, the ARN of the Amazon Web Services 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 the invoker must supply.
`AddPermissionRequest`	`withFunctionName (String functionName)` The name or ARN of the Lambda function, version, or alias.
`AddPermissionRequest`	`withFunctionUrlAuthType (FunctionUrlAuthType functionUrlAuthType)` The type of authentication that your function URL uses.
`AddPermissionRequest`	`withFunctionUrlAuthType (String functionUrlAuthType)` The type of authentication that your function URL uses.
`AddPermissionRequest`	`withPrincipal (String principal)` The Amazon Web Service or Amazon Web Services account that invokes the function.
`AddPermissionRequest`	`withPrincipalOrgID (String principalOrgID)` The identifier for your organization in Organizations.
`AddPermissionRequest`	`withQualifier (String qualifier)` Specify a version or alias to add permissions to a published version of the function.
`AddPermissionRequest`	`withRevisionId (String revisionId)` Update the policy only if the revision ID matches the ID that's specified.
`AddPermissionRequest`	`withSourceAccount (String sourceAccount)` For Amazon Web Service, the ID of the Amazon Web Services account that owns the resource.
`AddPermissionRequest`	`withSourceArn (String sourceArn)` For Amazon Web Services, the ARN of the Amazon Web Services 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 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.
  - getFunctionName
```
public String getFunctionName()
```
    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:
    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.
  - withFunctionName
```
public AddPermissionRequest withFunctionName(String 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.
  - 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 Amazon Web Service or Amazon Web Services 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 Amazon Web Service or Amazon Web Services 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 Amazon Web Service or Amazon Web Services 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 Amazon Web Service or Amazon Web Services 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 Amazon Web Service or Amazon Web Services 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 Amazon Web Service or Amazon Web Services 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 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.
  - getSourceArn
```
public String getSourceArn()
```
    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:
    
    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.
  - withSourceArn
```
public AddPermissionRequest withSourceArn(String 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.
  - setSourceAccount
```
public void setSourceAccount(String 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 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.
  - getSourceAccount
```
public String getSourceAccount()
```
    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.
    
    Returns:
    
    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.
  - withSourceAccount
```
public AddPermissionRequest withSourceAccount(String 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 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.
    
    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 the invoker must supply.
    
    Parameters:
    
    eventSourceToken - For Alexa Smart Home functions, a token that the invoker must supply.
  - getEventSourceToken
```
public String getEventSourceToken()
```
    For Alexa Smart Home functions, a token that the invoker must supply.
    
    Returns:
    
    For Alexa Smart Home functions, a token that the invoker must supply.
  - withEventSourceToken
```
public AddPermissionRequest withEventSourceToken(String 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.
  - 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)
```
    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.
  - getRevisionId
```
public String getRevisionId()
```
    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:
    
    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.
  - withRevisionId
```
public AddPermissionRequest withRevisionId(String 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.
  - setPrincipalOrgID
```
public void setPrincipalOrgID(String 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.
  - getPrincipalOrgID
```
public String getPrincipalOrgID()
```
    The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.
    
    Returns:
    
    The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.
  - withPrincipalOrgID
```
public AddPermissionRequest withPrincipalOrgID(String 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.
  - setFunctionUrlAuthType
```
public void setFunctionUrlAuthType(String 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 to NONE 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 to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.
    
    See Also:
    
    FunctionUrlAuthType
  - getFunctionUrlAuthType
```
public String getFunctionUrlAuthType()
```
    The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE 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:
    
    The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.
    
    See Also:
    
    FunctionUrlAuthType
  - withFunctionUrlAuthType
```
public AddPermissionRequest withFunctionUrlAuthType(String 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 to NONE 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 to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE 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
  - withFunctionUrlAuthType
```
public AddPermissionRequest withFunctionUrlAuthType(FunctionUrlAuthType 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 to NONE 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 to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE 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
  - 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()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class AddPermissionRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AddPermissionRequest

Method Detail

setFunctionName

getFunctionName

withFunctionName

setStatementId

getStatementId

withStatementId

setAction

getAction

withAction

setPrincipal

getPrincipal

withPrincipal

setSourceArn

getSourceArn

withSourceArn

setSourceAccount

getSourceAccount

withSourceAccount

setEventSourceToken

getEventSourceToken

withEventSourceToken

setQualifier

getQualifier

withQualifier

setRevisionId

getRevisionId

withRevisionId

setPrincipalOrgID

getPrincipalOrgID

withPrincipalOrgID

setFunctionUrlAuthType

getFunctionUrlAuthType

withFunctionUrlAuthType

withFunctionUrlAuthType

toString

equals

hashCode

clone