Class AddPermissionRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The AWS Lambda action you want to allow in this statement.Name of the Lambda function whose resource policy you are updating by adding a new permission.The principal who is getting this permission.You can use this optional query parameter to describe a qualified ARN using a function version or an alias name.The AWS account ID (without a hyphen) of the source owner.This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value.A unique statement identifier.int
hashCode()
void
The AWS Lambda action you want to allow in this statement.void
setEventSourceToken
(String eventSourceToken) void
setFunctionName
(String functionName) Name of the Lambda function whose resource policy you are updating by adding a new permission.void
setPrincipal
(String principal) The principal who is getting this permission.void
setQualifier
(String qualifier) You can use this optional query parameter to describe a qualified ARN using a function version or an alias name.void
setSourceAccount
(String sourceAccount) The AWS account ID (without a hyphen) of the source owner.void
setSourceArn
(String sourceArn) This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value.void
setStatementId
(String statementId) A unique statement identifier.toString()
Returns a string representation of this object; useful for testing and debugging.withAction
(String action) The AWS Lambda action you want to allow in this statement.withEventSourceToken
(String eventSourceToken) withFunctionName
(String functionName) Name of the Lambda function whose resource policy you are updating by adding a new permission.withPrincipal
(String principal) The principal who is getting this permission.withQualifier
(String qualifier) You can use this optional query parameter to describe a qualified ARN using a function version or an alias name.withSourceAccount
(String sourceAccount) The AWS account ID (without a hyphen) of the source owner.withSourceArn
(String sourceArn) This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value.withStatementId
(String statementId) A unique statement identifier.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
AddPermissionRequest
public AddPermissionRequest()
-
-
Method Details
-
setFunctionName
Name of the Lambda function whose resource policy you are updating by adding a new permission.
You can specify a function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS Lambda also allows you to specify partial ARN (for example,account-id:Thumbnail
). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.- Parameters:
functionName
- Name of the Lambda function whose resource policy you are updating by adding a new permission.You can specify a function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS Lambda also allows you to specify partial ARN (for example,account-id:Thumbnail
). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
-
getFunctionName
Name of the Lambda function whose resource policy you are updating by adding a new permission.
You can specify a function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS Lambda also allows you to specify partial ARN (for example,account-id:Thumbnail
). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.- Returns:
- Name of the Lambda function whose resource policy you are
updating by adding a new permission.
You can specify a function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS Lambda also allows you to specify partial ARN (for example,account-id:Thumbnail
). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
-
withFunctionName
Name of the Lambda function whose resource policy you are updating by adding a new permission.
You can specify a function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS Lambda also allows you to specify partial ARN (for example,account-id:Thumbnail
). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.- Parameters:
functionName
- Name of the Lambda function whose resource policy you are updating by adding a new permission.You can specify a function name (for example,
Thumbnail
) or you can specify Amazon Resource Name (ARN) of the function (for example,arn:aws:lambda:us-west-2:account-id:function:ThumbNail
). AWS Lambda also allows you to specify partial ARN (for example,account-id:Thumbnail
). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatementId
A unique statement identifier.
- Parameters:
statementId
- A unique statement identifier.
-
getStatementId
A unique statement identifier.
- Returns:
- A unique statement identifier.
-
withStatementId
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
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 (see Operations). 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 withlambda:
followed by the API name (see Operations). For example,lambda:CreateFunction
. You can use wildcard (lambda:*
) to grant permission for all AWS Lambda actions.
-
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 (see Operations). 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 (see Operations). For example,lambda:CreateFunction
. You can use wildcard (lambda:*
) to grant permission for all AWS Lambda actions.
-
withAction
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 (see Operations). 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 withlambda:
followed by the API name (see Operations). 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
The principal who is getting this permission. It can be Amazon S3 service Principal (
s3.amazonaws.com
) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such assns.amazonaws.com
. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.- Parameters:
principal
- The principal who is getting this permission. It can be Amazon S3 service Principal (s3.amazonaws.com
) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such assns.amazonaws.com
. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.
-
getPrincipal
The principal who is getting this permission. It can be Amazon S3 service Principal (
s3.amazonaws.com
) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such assns.amazonaws.com
. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.- Returns:
- The principal who is getting this permission. It can be Amazon S3
service Principal (
s3.amazonaws.com
) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such assns.amazonaws.com
. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.
-
withPrincipal
The principal who is getting this permission. It can be Amazon S3 service Principal (
s3.amazonaws.com
) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such assns.amazonaws.com
. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.- Parameters:
principal
- The principal who is getting this permission. It can be Amazon S3 service Principal (s3.amazonaws.com
) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such assns.amazonaws.com
. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSourceArn
This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified bucket can invoke the function.
If you add a permission for the Amazon S3 principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function from Amazon S3. - Parameters:
sourceArn
- This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified bucket can invoke the function.If you add a permission for the Amazon S3 principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function from Amazon S3.
-
getSourceArn
This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified bucket can invoke the function.
If you add a permission for the Amazon S3 principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function from Amazon S3. - Returns:
- This is optional; however, when granting Amazon S3 permission to
invoke your function, you should specify this field with the
bucket Amazon Resource Name (ARN) as its value. This ensures that
only events generated from the specified bucket can invoke the
function.
If you add a permission for the Amazon S3 principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function from Amazon S3.
-
withSourceArn
This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified bucket can invoke the function.
If you add a permission for the Amazon S3 principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function from Amazon S3. - Parameters:
sourceArn
- This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified bucket can invoke the function.If you add a permission for the Amazon S3 principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function from Amazon S3. - Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSourceAccount
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 theSourceArn
) owned by a specific account.- Parameters:
sourceAccount
- The AWS account ID (without a hyphen) of the source owner. For example, if theSourceArn
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 theSourceArn
) owned by a specific account.
-
getSourceAccount
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 theSourceArn
) owned by a specific account.- Returns:
- 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 theSourceArn
) owned by a specific account.
-
withSourceAccount
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 theSourceArn
) owned by a specific account.- Parameters:
sourceAccount
- The AWS account ID (without a hyphen) of the source owner. For example, if theSourceArn
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 theSourceArn
) owned by a specific account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEventSourceToken
- Parameters:
eventSourceToken
-
-
getEventSourceToken
- Returns:
-
withEventSourceToken
- Parameters:
eventSourceToken
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setQualifier
You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:
arn:aws:lambda:aws-region:acct-id:function:function-name:2
If you specify an alias name, for example
PROD
, then the permission is valid only for requests made using the alias ARN:arn:aws:lambda:aws-region:acct-id:function:function-name:PROD
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.
arn:aws:lambda:aws-region:acct-id:function:function-name
- Parameters:
qualifier
- You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:arn:aws:lambda:aws-region:acct-id:function:function-name:2
If you specify an alias name, for example
PROD
, then the permission is valid only for requests made using the alias ARN:arn:aws:lambda:aws-region:acct-id:function:function-name:PROD
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.
arn:aws:lambda:aws-region:acct-id:function:function-name
-
getQualifier
You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:
arn:aws:lambda:aws-region:acct-id:function:function-name:2
If you specify an alias name, for example
PROD
, then the permission is valid only for requests made using the alias ARN:arn:aws:lambda:aws-region:acct-id:function:function-name:PROD
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.
arn:aws:lambda:aws-region:acct-id:function:function-name
- Returns:
- You can use this optional query parameter to describe a qualified
ARN using a function version or an alias name. The permission
will then apply to the specific qualified ARN. For example, if
you specify function version 2 as the qualifier, then permission
applies only when request is made using qualified function ARN:
arn:aws:lambda:aws-region:acct-id:function:function-name:2
If you specify an alias name, for example
PROD
, then the permission is valid only for requests made using the alias ARN:arn:aws:lambda:aws-region:acct-id:function:function-name:PROD
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.
arn:aws:lambda:aws-region:acct-id:function:function-name
-
withQualifier
You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:
arn:aws:lambda:aws-region:acct-id:function:function-name:2
If you specify an alias name, for example
PROD
, then the permission is valid only for requests made using the alias ARN:arn:aws:lambda:aws-region:acct-id:function:function-name:PROD
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.
arn:aws:lambda:aws-region:acct-id:function:function-name
- Parameters:
qualifier
- You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:arn:aws:lambda:aws-region:acct-id:function:function-name:2
If you specify an alias name, for example
PROD
, then the permission is valid only for requests made using the alias ARN:arn:aws:lambda:aws-region:acct-id:function:function-name:PROD
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.
arn:aws:lambda:aws-region:acct-id:function:function-name
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-