Package software.amazon.awscdk.services.lambda

Class CfnPermissionProps.Builder

java.lang.Object
software.amazon.awscdk.services.lambda.CfnPermissionProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPermissionProps>
Enclosing interface:
CfnPermissionProps
@Stability(Stable) public static final class CfnPermissionProps.Builder extends Object implements software.amazon.jsii.Builder<CfnPermissionProps>
A builder for CfnPermissionProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • action

      @Stability(Stable) public CfnPermissionProps.Builder action(String action)
      Sets the value of CfnPermissionProps.getAction()
      Parameters:
      action - The action that the principal can use on the function. This parameter is required. For example, lambda:InvokeFunction or lambda:GetFunction .
      Returns:
      this

    • functionName

      @Stability(Stable) public CfnPermissionProps.Builder functionName(String functionName)
      Sets the value of CfnPermissionProps.getFunctionName()
      Parameters:
      functionName - The name or ARN of the Lambda function, version, or alias. This parameter is required. 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:
      this

    • principal

      @Stability(Stable) public CfnPermissionProps.Builder principal(String principal)
      Sets the value of CfnPermissionProps.getPrincipal()
      Parameters:
      principal - The AWS service , AWS account , IAM user, or IAM role that invokes the function. This parameter is required. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
      Returns:
      this

    • eventSourceToken

      @Stability(Stable) public CfnPermissionProps.Builder eventSourceToken(String eventSourceToken)
      Sets the value of CfnPermissionProps.getEventSourceToken()
      Parameters:
      eventSourceToken - For Alexa Smart Home functions, a token that the invoker must supply.
      Returns:
      this

    • functionUrlAuthType

      @Stability(Stable) public CfnPermissionProps.Builder functionUrlAuthType(String functionUrlAuthType)
      Sets the value of CfnPermissionProps.getFunctionUrlAuthType()
      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 Control access to Lambda function URLs .
      Returns:
      this

    • invokedViaFunctionUrl

      @Stability(Stable) public CfnPermissionProps.Builder invokedViaFunctionUrl(Boolean invokedViaFunctionUrl)
      Sets the value of CfnPermissionProps.getInvokedViaFunctionUrl()
      Parameters:
      invokedViaFunctionUrl - Restricts the lambda:InvokeFunction action to function URL calls. When set to true , this prevents the principal from invoking the function by any means other than the function URL. For more information, see Control access to Lambda function URLs .
      Returns:
      this

    • invokedViaFunctionUrl

      @Stability(Stable) public CfnPermissionProps.Builder invokedViaFunctionUrl(IResolvable invokedViaFunctionUrl)
      Sets the value of CfnPermissionProps.getInvokedViaFunctionUrl()
      Parameters:
      invokedViaFunctionUrl - Restricts the lambda:InvokeFunction action to function URL calls. When set to true , this prevents the principal from invoking the function by any means other than the function URL. For more information, see Control access to Lambda function URLs .
      Returns:
      this

    • principalOrgId

      @Stability(Stable) public CfnPermissionProps.Builder principalOrgId(String principalOrgId)
      Sets the value of CfnPermissionProps.getPrincipalOrgId()
      Parameters:
      principalOrgId - The identifier for your organization in AWS Organizations . Use this to grant permissions to all the AWS accounts under this organization.
      Returns:
      this

    • sourceAccount

      @Stability(Stable) public CfnPermissionProps.Builder sourceAccount(String sourceAccount)
      Sets the value of CfnPermissionProps.getSourceAccount()
      Parameters:
      sourceAccount - For AWS service , the ID of the AWS 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:
      this

    • sourceArn

      @Stability(Stable) public CfnPermissionProps.Builder sourceArn(String sourceArn)
      Sets the value of CfnPermissionProps.getSourceArn()
      Parameters:
      sourceArn - For AWS services , the ARN of the AWS 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:
      this

    • build

      @Stability(Stable) public CfnPermissionProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnPermissionProps>
      Returns:
      a new instance of CfnPermissionProps
      Throws:
      NullPointerException - if any required attribute was not provided