software.amazon.awsconstructs.services.lambdasns

Class LambdaToSns.Builder

java.lang.Object

software.amazon.awsconstructs.services.lambdasns.LambdaToSns.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaToSns>

Enclosing class:

LambdaToSns

public static final class LambdaToSns.Builder
extends Object
implements software.amazon.jsii.Builder<LambdaToSns>

A fluent builder for LambdaToSns.

Method Summary

Modifier and Type	Method and Description
LambdaToSns	build()
static LambdaToSns.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
LambdaToSns.Builder	deployVpc(Boolean deployVpc) Whether to deploy a new VPC.
LambdaToSns.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored.
LambdaToSns.Builder	existingTopicObj(software.amazon.awscdk.services.sns.Topic existingTopicObj) Existing instance of SNS Topic object, if this is set then topicProps is ignored.
LambdaToSns.Builder	existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc) An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
LambdaToSns.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) User provided props to override the default props for the Lambda function.
LambdaToSns.Builder	topicArnEnvironmentVariableName(String topicArnEnvironmentVariableName) Optional Name for the SNS topic arn environment variable set for the Lambda function.
LambdaToSns.Builder	topicNameEnvironmentVariableName(String topicNameEnvironmentVariableName) Optional Name for the SNS topic name environment variable set for the Lambda function.
LambdaToSns.Builder	topicProps(software.amazon.awscdk.services.sns.TopicProps topicProps) Optional user provided properties to override the default properties for the SNS topic.
LambdaToSns.Builder	vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps) Properties to override default properties if deployVpc is true.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static LambdaToSns.Builder create(software.amazon.awscdk.core.Construct scope,
                                         String id)

Parameters:

scope - - represents the scope for all the resources. This parameter is required.

id - - this is a a scope-unique id. This parameter is required.

Returns:

a new instance of LambdaToSns.Builder.

deployVpc

public LambdaToSns.Builder deployVpc(Boolean deployVpc)

Whether to deploy a new VPC.

Default: - false

Parameters:

deployVpc - Whether to deploy a new VPC. This parameter is required.

Returns:

this

existingLambdaObj

public LambdaToSns.Builder existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)

Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored.

Default: - None

Parameters:

existingLambdaObj - Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored. This parameter is required.

Returns:

this

existingTopicObj

public LambdaToSns.Builder existingTopicObj(software.amazon.awscdk.services.sns.Topic existingTopicObj)

Existing instance of SNS Topic object, if this is set then topicProps is ignored.

Default: - Default props are used

Parameters:

existingTopicObj - Existing instance of SNS Topic object, if this is set then topicProps is ignored. This parameter is required.

Returns:

this

existingVpc

public LambdaToSns.Builder existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc)

An existing VPC for the construct to use (construct will NOT create a new VPC in this case).

Parameters:

existingVpc - An existing VPC for the construct to use (construct will NOT create a new VPC in this case). This parameter is required.

Returns:

this

lambdaFunctionProps

public LambdaToSns.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)

User provided props to override the default props for the Lambda function.

Default: - Default properties are used.

Parameters:

lambdaFunctionProps - User provided props to override the default props for the Lambda function. This parameter is required.

Returns:

this

topicArnEnvironmentVariableName

public LambdaToSns.Builder topicArnEnvironmentVariableName(String topicArnEnvironmentVariableName)

Optional Name for the SNS topic arn environment variable set for the Lambda function.

Default: - None

Parameters:

topicArnEnvironmentVariableName - Optional Name for the SNS topic arn environment variable set for the Lambda function. This parameter is required.

Returns:

this

topicNameEnvironmentVariableName

public LambdaToSns.Builder topicNameEnvironmentVariableName(String topicNameEnvironmentVariableName)

Optional Name for the SNS topic name environment variable set for the Lambda function.

Default: - None

Parameters:

topicNameEnvironmentVariableName - Optional Name for the SNS topic name environment variable set for the Lambda function. This parameter is required.

Returns:

this

topicProps

public LambdaToSns.Builder topicProps(software.amazon.awscdk.services.sns.TopicProps topicProps)

Optional user provided properties to override the default properties for the SNS topic.

Default: - Default properties are used.

Parameters:

topicProps - Optional user provided properties to override the default properties for the SNS topic. This parameter is required.

Returns:

this

vpcProps

public LambdaToSns.Builder vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps)

Properties to override default properties if deployVpc is true.

Parameters:

vpcProps - Properties to override default properties if deployVpc is true. This parameter is required.

Returns:

this

build

public LambdaToSns build()

Specified by:

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