software.amazon.awsconstructs.services.snslambda

Class SnsToLambda.Builder

java.lang.Object

software.amazon.awsconstructs.services.snslambda.SnsToLambda.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SnsToLambda>

Enclosing class:

SnsToLambda

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

A fluent builder for SnsToLambda.

Method Summary

Modifier and Type	Method and Description
SnsToLambda	build()
static SnsToLambda.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
SnsToLambda.Builder	deployLambda(Boolean deployLambda) Whether to create a new Lambda function or use an existing Lambda function.
SnsToLambda.Builder	enableEncryption(Boolean enableEncryption) Use a KMS Key, either managed by this CDK app, or imported.
SnsToLambda.Builder	encryptionKey(software.amazon.awscdk.services.kms.Key encryptionKey) An optional, imported encryption key to encrypt the SNS topic with.
SnsToLambda.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object.
SnsToLambda.Builder	lambdaFunctionProps(Object lambdaFunctionProps) Optional user provided properties to override the default properties for the Lambda function.
SnsToLambda.Builder	topicProps(Object topicProps) Optional user provided properties to override the default properties for the SNS topic.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SnsToLambda.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 SnsToLambda.Builder.

deployLambda

public SnsToLambda.Builder deployLambda(Boolean deployLambda)

Whether to create a new Lambda function or use an existing Lambda function.

If set to false, you must provide an existing function for the existingLambdaObj property.

Default: - true

Parameters:

deployLambda - Whether to create a new Lambda function or use an existing Lambda function. This parameter is required.

Returns:

this

enableEncryption

public SnsToLambda.Builder enableEncryption(Boolean enableEncryption)

Use a KMS Key, either managed by this CDK app, or imported.

If importing an encryption key, it must be specified in the encryptionKey property for this construct.

Default: - true (encryption enabled, managed by this CDK app).

Parameters:

enableEncryption - Use a KMS Key, either managed by this CDK app, or imported. This parameter is required.

Returns:

this

encryptionKey

public SnsToLambda.Builder encryptionKey(software.amazon.awscdk.services.kms.Key encryptionKey)

An optional, imported encryption key to encrypt the SNS topic with.

Default: - not specified.

Parameters:

encryptionKey - An optional, imported encryption key to encrypt the SNS topic with. This parameter is required.

Returns:

this

existingLambdaObj

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

Existing instance of Lambda Function object.

If deploy is set to false only then this property is required

Default: - None

Parameters:

existingLambdaObj - Existing instance of Lambda Function object. This parameter is required.

Returns:

this

lambdaFunctionProps

public SnsToLambda.Builder lambdaFunctionProps(Object lambdaFunctionProps)

Optional user provided properties to override the default properties for the Lambda function.

If deploy is set to true only then this property is required.

Default: - Default properties are used.

Parameters:

lambdaFunctionProps - Optional user provided properties to override the default properties for the Lambda function. This parameter is required.

Returns:

this

topicProps

public SnsToLambda.Builder topicProps(Object 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

build

public SnsToLambda build()

Specified by:

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