@Generated(value="software.amazon.awssdk:codegen") public final class AddPermissionRequest extends LambdaRequest implements ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
AddPermissionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
action()
The action that the principal can use on the function.
|
static AddPermissionRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
eventSourceToken()
For Alexa Smart Home functions, a token that must be supplied by the invoker.
|
String |
functionName()
The name of the Lambda function, version, or alias.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
principal()
The AWS service or account that invokes the function.
|
String |
qualifier()
Specify a version or alias to add permissions to a published version of the function.
|
String |
revisionId()
Only update the policy if the revision ID matches the ID that's specified.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AddPermissionRequest.Builder> |
serializableBuilderClass() |
String |
sourceAccount()
For Amazon S3, the ID of the account that owns the resource.
|
String |
sourceArn()
For AWS services, the ARN of the AWS resource that invokes the function.
|
String |
statementId()
A statement identifier that differentiates the statement from others in the same policy.
|
AddPermissionRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final 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.
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.
public final String statementId()
A statement identifier that differentiates the statement from others in the same policy.
public final String action()
The action that the principal can use on the function. For example, lambda:InvokeFunction
or
lambda:GetFunction
.
lambda:InvokeFunction
or
lambda:GetFunction
.public final 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.
SourceArn
or SourceAccount
to limit who can invoke the function through that
service.public final 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.
public final String sourceAccount()
For Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn
to
ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted
by its owner and recreated by another account.
SourceArn
to ensure that the resource is owned by the specified account. It is possible for
an Amazon S3 bucket to be deleted by its owner and recreated by another account.public final String eventSourceToken()
For Alexa Smart Home functions, a token that must be supplied by the invoker.
public final String qualifier()
Specify a version or alias to add permissions to a published version of the function.
public final 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.
public AddPermissionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>
toBuilder
in class LambdaRequest
public static AddPermissionRequest.Builder builder()
public static Class<? extends AddPermissionRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.