Package software.amazon.awssdk.services.lambda.model

Interface AddPermissionRequest.Builder

    • Method Detail

      • functionName

        AddPermissionRequest.Builder functionName​(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.

      • statementId

        AddPermissionRequest.Builder statementId​(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.

      • action

        AddPermissionRequest.Builder action​(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.

      • principal

        AddPermissionRequest.Builder principal​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • sourceArn

        AddPermissionRequest.Builder sourceArn​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • sourceAccount

        AddPermissionRequest.Builder sourceAccount​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • eventSourceToken

        AddPermissionRequest.Builder eventSourceToken​(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.

      • qualifier

        AddPermissionRequest.Builder qualifier​(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.

      • revisionId

        AddPermissionRequest.Builder revisionId​(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.

      • principalOrgID

        AddPermissionRequest.Builder principalOrgID​(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.

      • functionUrlAuthType

        AddPermissionRequest.Builder functionUrlAuthType​(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, FunctionUrlAuthType