software.amazon.awscdk.services.lambda

Class CfnPermissionProps.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.CfnPermissionProps.Builder

Enclosing interface:

CfnPermissionProps

public static final class CfnPermissionProps.Builder
extends java.lang.Object

A builder for CfnPermissionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnPermissionProps.Builder	action(java.lang.String action) Sets the value of CfnPermissionProps.getAction()
CfnPermissionProps	build() Builds the configured instance.
CfnPermissionProps.Builder	eventSourceToken(java.lang.String eventSourceToken) Sets the value of CfnPermissionProps.getEventSourceToken()
CfnPermissionProps.Builder	functionName(java.lang.String functionName) Sets the value of CfnPermissionProps.getFunctionName()
CfnPermissionProps.Builder	functionUrlAuthType(java.lang.String functionUrlAuthType) Sets the value of CfnPermissionProps.getFunctionUrlAuthType()
CfnPermissionProps.Builder	principal(java.lang.String principal) Sets the value of CfnPermissionProps.getPrincipal()
CfnPermissionProps.Builder	principalOrgId(java.lang.String principalOrgId) Sets the value of CfnPermissionProps.getPrincipalOrgId()
CfnPermissionProps.Builder	sourceAccount(java.lang.String sourceAccount) Sets the value of CfnPermissionProps.getSourceAccount()
CfnPermissionProps.Builder	sourceArn(java.lang.String sourceArn) Sets the value of CfnPermissionProps.getSourceArn()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

action

public CfnPermissionProps.Builder action(java.lang.String action)

Sets the value of CfnPermissionProps.getAction()

Parameters:

action - The action that the principal can use on the function. This parameter is required. For example, lambda:InvokeFunction or lambda:GetFunction .

Returns:

this

functionName

public CfnPermissionProps.Builder functionName(java.lang.String functionName)

Sets the value of CfnPermissionProps.getFunctionName()

Parameters:

functionName - The name of the Lambda function, version, or alias. This parameter is required. 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

principal

public CfnPermissionProps.Builder principal(java.lang.String principal)

Sets the value of CfnPermissionProps.getPrincipal()

Parameters:

principal - The AWS service or account that invokes the function. This parameter is required. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

Returns:

this

eventSourceToken

public CfnPermissionProps.Builder eventSourceToken(java.lang.String eventSourceToken)

Sets the value of CfnPermissionProps.getEventSourceToken()

Parameters:

eventSourceToken - For Alexa Smart Home functions, a token that must be supplied by the invoker.

Returns:

this

functionUrlAuthType

public CfnPermissionProps.Builder functionUrlAuthType(java.lang.String functionUrlAuthType)

Sets the value of CfnPermissionProps.getFunctionUrlAuthType()

Parameters:

functionUrlAuthType - The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated IAM 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 .

Returns:

this

principalOrgId

public CfnPermissionProps.Builder principalOrgId(java.lang.String principalOrgId)

Sets the value of CfnPermissionProps.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

public CfnPermissionProps.Builder sourceAccount(java.lang.String sourceAccount)

Sets the value of CfnPermissionProps.getSourceAccount()

Parameters:

sourceAccount - For Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn to ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

Returns:

this

sourceArn

public CfnPermissionProps.Builder sourceArn(java.lang.String sourceArn)

Sets the value of CfnPermissionProps.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

public CfnPermissionProps build()

Builds the configured instance.

Returns:

a new instance of CfnPermissionProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided