Package software.amazon.awscdk.services.lambda

Interface CfnPermissionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPermissionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:03.874Z")
@Stability(Stable)
public interface CfnPermissionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPermission.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 CfnPermissionProps cfnPermissionProps = CfnPermissionProps.builder()
         .action("action")
         .functionName("functionName")
         .principal("principal")
         // the properties below are optional
         .eventSourceToken("eventSourceToken")
         .functionUrlAuthType("functionUrlAuthType")
         .principalOrgId("principalOrgId")
         .sourceAccount("sourceAccount")
         .sourceArn("sourceArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPermissionProps.Builder	A builder for CfnPermissionProps
static final class	CfnPermissionProps.Jsii$Proxy	An implementation for CfnPermissionProps

Method Summary

Modifier and Type	Method	Description
static CfnPermissionProps.Builder	builder()
String	getAction()	The action that the principal can use on the function.
default String	getEventSourceToken()	For Alexa Smart Home functions, a token that the invoker must supply.
String	getFunctionName()	The name or ARN of the Lambda function, version, or alias.
default String	getFunctionUrlAuthType()	The type of authentication that your function URL uses.
String	getPrincipal()	The AWS service , AWS account , IAM user, or IAM role that invokes the function.
default String	getPrincipalOrgId()	The identifier for your organization in AWS Organizations .
default String	getSourceAccount()	For AWS service , the ID of the AWS account that owns the resource.
default String	getSourceArn()	For AWS services , the ARN of the AWS resource that invokes the function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
String getAction()

The action that the principal can use on the function.

For example, lambda:InvokeFunction or lambda:GetFunction .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-action

getFunctionName

@Stability(Stable)
@NotNull
String getFunctionName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionname

getPrincipal

@Stability(Stable)
@NotNull
String getPrincipal()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principal

getEventSourceToken

@Stability(Stable)
@Nullable
default String getEventSourceToken()

For Alexa Smart Home functions, a token that the invoker must supply.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-eventsourcetoken

getFunctionUrlAuthType

@Stability(Stable)
@Nullable
default String getFunctionUrlAuthType()

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionurlauthtype

getPrincipalOrgId

@Stability(Stable)
@Nullable
default String getPrincipalOrgId()

The identifier for your organization in AWS Organizations .

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principalorgid

getSourceAccount

@Stability(Stable)
@Nullable
default String getSourceAccount()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourceaccount

getSourceArn

@Stability(Stable)
@Nullable
default String getSourceArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourcearn

builder

@Stability(Stable)
static CfnPermissionProps.Builder builder()

Returns:

a CfnPermissionProps.Builder of CfnPermissionProps