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.constructs.Construct scope, String id)
SnsToLambda.Builder	enableEncryptionWithCustomerManagedKey(Boolean enableEncryptionWithCustomerManagedKey) If no key is provided, this flag determines whether the SNS Topic is encrypted with a new CMK or an AWS managed key.
SnsToLambda.Builder	encryptionKey(software.amazon.awscdk.services.kms.Key encryptionKey) An optional, imported encryption key to encrypt the SNS Topic with.
SnsToLambda.Builder	encryptionKeyProps(software.amazon.awscdk.services.kms.KeyProps encryptionKeyProps) Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SNS Topic with.
SnsToLambda.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
SnsToLambda.Builder	existingTopicObj(software.amazon.awscdk.services.sns.Topic existingTopicObj) Existing instance of SNS Topic object, providing both this and topicProps will cause an error..
SnsToLambda.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) User provided props to override the default props for the Lambda function.
SnsToLambda.Builder	topicProps(software.amazon.awscdk.services.sns.TopicProps 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.constructs.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.

enableEncryptionWithCustomerManagedKey

public SnsToLambda.Builder enableEncryptionWithCustomerManagedKey(Boolean enableEncryptionWithCustomerManagedKey)

If no key is provided, this flag determines whether the SNS Topic is encrypted with a new CMK or an AWS managed key.

This flag is ignored if any of the following are defined: topicProps.masterKey, encryptionKey or encryptionKeyProps.

Default: - False if topicProps.masterKey, encryptionKey, and encryptionKeyProps are all undefined.

Parameters:

enableEncryptionWithCustomerManagedKey - If no key is provided, this flag determines whether the SNS Topic is encrypted with a new CMK or an AWS managed key. 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: - None

Parameters:

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

Returns:

this

encryptionKeyProps

public SnsToLambda.Builder encryptionKeyProps(software.amazon.awscdk.services.kms.KeyProps encryptionKeyProps)

Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SNS Topic with.

Default: - None

Parameters:

encryptionKeyProps - Optional user provided properties to override the default properties for the KMS encryption key used 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, providing both this and `lambdaFunctionProps` will cause an error.

Default: - None

Parameters:

existingLambdaObj - Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error. This parameter is required.

Returns:

this

existingTopicObj

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

Existing instance of SNS Topic object, providing both this and topicProps will cause an error..

Default: - Default props are used

Parameters:

existingTopicObj - Existing instance of SNS Topic object, providing both this and topicProps will cause an error.. This parameter is required.

Returns:

this

lambdaFunctionProps

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

topicProps

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

build

public SnsToLambda build()

Specified by:

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