software.amazon.awscdk.services.lambda

Interface CfnPermissionProps

All Known Implementing Classes:

CfnPermissionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:44.103Z")
public interface CfnPermissionProps

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getAction

java.lang.String getAction()

The action that the principal can use on the function.

For example, lambda:InvokeFunction or lambda:GetFunction .

getFunctionName

java.lang.String getFunctionName()

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.

getPrincipal

java.lang.String getPrincipal()

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.

getEventSourceToken

default java.lang.String getEventSourceToken()

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

getFunctionUrlAuthType

default java.lang.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 .

getPrincipalOrgId

default java.lang.String getPrincipalOrgId()

The identifier for your organization in AWS Organizations .

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

getSourceAccount

default java.lang.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.

getSourceArn

default java.lang.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.

builder

static CfnPermissionProps.Builder builder()

Returns:

a CfnPermissionProps.Builder of CfnPermissionProps