Package software.amazon.awscdk.cfnpropertymixins.services.lambda

Class CfnPermissionMixinProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • action

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

    • eventSourceToken

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

    • functionName

      @Stability(Stable) public CfnPermissionMixinProps.Builder functionName(String functionName)
      Sets the value of CfnPermissionMixinProps.getFunctionName()
      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:
      this

    • functionName

      @Stability(Stable) public CfnPermissionMixinProps.Builder functionName(IFunctionRef functionName)
      Sets the value of CfnPermissionMixinProps.getFunctionName()
      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:
      this

    • functionName

      @Stability(Stable) public CfnPermissionMixinProps.Builder functionName(IVersionRef functionName)
      Sets the value of CfnPermissionMixinProps.getFunctionName()
      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:
      this

    • functionUrlAuthType

      @Stability(Stable) public CfnPermissionMixinProps.Builder functionUrlAuthType(String functionUrlAuthType)
      Sets the value of CfnPermissionMixinProps.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 CfnPermissionMixinProps.Builder invokedViaFunctionUrl(Boolean invokedViaFunctionUrl)
      Sets the value of CfnPermissionMixinProps.getInvokedViaFunctionUrl()
      Parameters:
      invokedViaFunctionUrl - Indicates whether the permission applies when the function is invoked through a function URL.
      Returns:
      this

    • invokedViaFunctionUrl

      @Stability(Stable) public CfnPermissionMixinProps.Builder invokedViaFunctionUrl(IResolvable invokedViaFunctionUrl)
      Sets the value of CfnPermissionMixinProps.getInvokedViaFunctionUrl()
      Parameters:
      invokedViaFunctionUrl - Indicates whether the permission applies when the function is invoked through a function URL.
      Returns:
      this

    • principal

      @Stability(Stable) public CfnPermissionMixinProps.Builder principal(String principal)
      Sets the value of CfnPermissionMixinProps.getPrincipal()
      Parameters:
      principal - The AWS service , AWS 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:
      this

    • principal

      @Stability(Stable) public CfnPermissionMixinProps.Builder principal(IRoleRef principal)
      Sets the value of CfnPermissionMixinProps.getPrincipal()
      Parameters:
      principal - The AWS service , AWS 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:
      this

    • principal

      @Stability(Stable) public CfnPermissionMixinProps.Builder principal(IUserRef principal)
      Sets the value of CfnPermissionMixinProps.getPrincipal()
      Parameters:
      principal - The AWS service , AWS 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:
      this

    • principalOrgId

      @Stability(Stable) public CfnPermissionMixinProps.Builder principalOrgId(String principalOrgId)
      Sets the value of CfnPermissionMixinProps.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 CfnPermissionMixinProps.Builder sourceAccount(String sourceAccount)
      Sets the value of CfnPermissionMixinProps.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 CfnPermissionMixinProps.Builder sourceArn(String sourceArn)
      Sets the value of CfnPermissionMixinProps.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

    • sourceArn

      @Stability(Stable) public CfnPermissionMixinProps.Builder sourceArn(IUserPoolRef sourceArn)
      Sets the value of CfnPermissionMixinProps.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

    • sourceArn

      @Stability(Stable) public CfnPermissionMixinProps.Builder sourceArn(IRuleRef sourceArn)
      Sets the value of CfnPermissionMixinProps.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

    • sourceArn

      @Stability(Stable) public CfnPermissionMixinProps.Builder sourceArn(IRoleRef sourceArn)
      Sets the value of CfnPermissionMixinProps.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

    • sourceArn

      @Stability(Stable) public CfnPermissionMixinProps.Builder sourceArn(ITopicRuleRef sourceArn)
      Sets the value of CfnPermissionMixinProps.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

    • sourceArn

      @Stability(Stable) public CfnPermissionMixinProps.Builder sourceArn(IDeliveryStreamRef sourceArn)
      Sets the value of CfnPermissionMixinProps.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

    • sourceArn

      @Stability(Stable) public CfnPermissionMixinProps.Builder sourceArn(IFunctionRef sourceArn)
      Sets the value of CfnPermissionMixinProps.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

    • sourceArn

      @Stability(Stable) public CfnPermissionMixinProps.Builder sourceArn(ILogGroupRef sourceArn)
      Sets the value of CfnPermissionMixinProps.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

    • sourceArn

      @Stability(Stable) public CfnPermissionMixinProps.Builder sourceArn(IBucketRef sourceArn)
      Sets the value of CfnPermissionMixinProps.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

    • sourceArn

      @Stability(Stable) public CfnPermissionMixinProps.Builder sourceArn(ITopicRef sourceArn)
      Sets the value of CfnPermissionMixinProps.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

    • sourceArn

      @Stability(Stable) public CfnPermissionMixinProps.Builder sourceArn(IQueueRef sourceArn)
      Sets the value of CfnPermissionMixinProps.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 CfnPermissionMixinProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnPermissionMixinProps>
      Returns:
      a new instance of CfnPermissionMixinProps
      Throws:
      NullPointerException - if any required attribute was not provided