Class AddPermissionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lambda.model.LambdaRequest
software.amazon.awssdk.services.lambda.model.AddPermissionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>
@Generated("software.amazon.awssdk:codegen") public final class AddPermissionRequest extends LambdaRequest implements ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>

  • Method Details

    • functionName

      public final 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.

      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.

    • statementId

      public final String statementId()

      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.

    • action

      public final String action()

      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.

    • principal

      public final String principal()

      The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role 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 Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

    • sourceArn

      public final String sourceArn()

      For Amazon Web Services 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 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.

    • sourceAccount

      public final String sourceAccount()

      For Amazon Web Services 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 Services 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.

    • eventSourceToken

      public final String eventSourceToken()

      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.

    • qualifier

      public final String qualifier()

      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.

    • revisionId

      public final 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.

      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.

    • principalOrgID

      public final String principalOrgID()

      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.

    • functionUrlAuthType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, functionUrlAuthType will return FunctionUrlAuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from functionUrlAuthTypeAsString().

      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:

    • functionUrlAuthTypeAsString

      public final String functionUrlAuthTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, functionUrlAuthType will return FunctionUrlAuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from functionUrlAuthTypeAsString().

      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:

    • toBuilder

      public AddPermissionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AddPermissionRequest.Builder,AddPermissionRequest>
      Specified by:
      toBuilder in class LambdaRequest
      Returns:
      a builder for type T

    • builder

      public static AddPermissionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AddPermissionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.