Interface CfnPermissionProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPermissionProps.Jsii$Proxy
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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnPermissionProps
static final class
An implementation forCfnPermissionProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnPermissionProps.Builder
builder()
The action that the principal can use on the function.default String
For Alexa Smart Home functions, a token that the invoker must supply.The name of the Lambda function, version, or alias.default String
The type of authentication that your function URL uses.The AWS service or AWS account that invokes the function.default String
The identifier for your organization in AWS Organizations .default String
For AWS service , the ID of the AWS account that owns the resource.default String
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
The action that the principal can use on the function.For example,
lambda:InvokeFunction
orlambda:GetFunction
. -
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.
- Function ARN –
-
getPrincipal
The AWS service or AWS account that invokes the function.If you specify a service, use
SourceArn
orSourceAccount
to limit who can invoke the function through that service. -
getEventSourceToken
For Alexa Smart Home functions, a token that the invoker must supply. -
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 toNONE
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
The identifier for your organization in AWS Organizations .Use this to grant permissions to all the AWS accounts under this organization.
-
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
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
- Returns:
- a
CfnPermissionProps.Builder
ofCfnPermissionProps
-