software.amazon.awscdk.services.lambda

Class CfnPermission.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.CfnPermission.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPermission>

Enclosing class:

CfnPermission

@Stability(value=Stable)
public static final class CfnPermission.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPermission>

A fluent builder for CfnPermission.

Method Summary

Modifier and Type	Method and Description
CfnPermission.Builder	action(String action) The action that the principal can use on the function.
CfnPermission	build()
static CfnPermission.Builder	create(Construct scope, String id)
CfnPermission.Builder	eventSourceToken(String eventSourceToken) For Alexa Smart Home functions, a token that the invoker must supply.
CfnPermission.Builder	functionName(String functionName) The name of the Lambda function, version, or alias.
CfnPermission.Builder	functionUrlAuthType(String functionUrlAuthType) The type of authentication that your function URL uses.
CfnPermission.Builder	principal(String principal) The AWS service or AWS account that invokes the function.
CfnPermission.Builder	principalOrgId(String principalOrgId) The identifier for your organization in AWS Organizations .
CfnPermission.Builder	sourceAccount(String sourceAccount) For AWS service , the ID of the AWS account that owns the resource.
CfnPermission.Builder	sourceArn(String sourceArn) For AWS services , the ARN of the AWS resource that invokes the function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnPermission.Builder create(Construct scope,
                                                                    String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnPermission.Builder.

action

@Stability(value=Stable)
public CfnPermission.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. This parameter is required.

Returns:

this

functionName

@Stability(value=Stable)
public CfnPermission.Builder functionName(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.

Parameters:

functionName - The name of the Lambda function, version, or alias. This parameter is required.

Returns:

this

principal

@Stability(value=Stable)
public CfnPermission.Builder principal(String principal)

The AWS service or AWS account 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 AWS service or AWS account that invokes the function. This parameter is required.

Returns:

this

eventSourceToken

@Stability(value=Stable)
public CfnPermission.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. This parameter is required.

Returns:

this

functionUrlAuthType

@Stability(value=Stable)
public CfnPermission.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. This parameter is required.

Returns:

this

principalOrgId

@Stability(value=Stable)
public CfnPermission.Builder principalOrgId(String principalOrgId)

The identifier for your organization in AWS Organizations .

Use this to grant permissions to all the AWS accounts under this organization.

Parameters:

principalOrgId - The identifier for your organization in AWS Organizations . This parameter is required.

Returns:

this

sourceAccount

@Stability(value=Stable)
public CfnPermission.Builder sourceAccount(String 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.

Parameters:

sourceAccount - For AWS service , the ID of the AWS account that owns the resource. This parameter is required.

Returns:

this

sourceArn

@Stability(value=Stable)
public CfnPermission.Builder sourceArn(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.

Note that Lambda configures the comparison using the StringLike operator.

Parameters:

sourceArn - For AWS services , the ARN of the AWS resource that invokes the function. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnPermission build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPermission>