Package software.amazon.awsconstructs.services.lambdasns

Class LambdaToSnsProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.lambdasns.LambdaToSnsProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaToSnsProps>

Enclosing interface:

LambdaToSnsProps

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

A builder for LambdaToSnsProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
LambdaToSnsProps	build()	Builds the configured instance.
LambdaToSnsProps.Builder	deployVpc(Boolean deployVpc)	Sets the value of LambdaToSnsProps.getDeployVpc()
LambdaToSnsProps.Builder	enableEncryptionWithCustomerManagedKey(Boolean enableEncryptionWithCustomerManagedKey)	Sets the value of LambdaToSnsProps.getEnableEncryptionWithCustomerManagedKey()
LambdaToSnsProps.Builder	encryptionKey(software.amazon.awscdk.services.kms.Key encryptionKey)	Sets the value of LambdaToSnsProps.getEncryptionKey()
LambdaToSnsProps.Builder	encryptionKeyProps(software.amazon.awscdk.services.kms.KeyProps encryptionKeyProps)	Sets the value of LambdaToSnsProps.getEncryptionKeyProps()
LambdaToSnsProps.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)	Sets the value of LambdaToSnsProps.getExistingLambdaObj()
LambdaToSnsProps.Builder	existingTopicObj(software.amazon.awscdk.services.sns.Topic existingTopicObj)	Sets the value of LambdaToSnsProps.getExistingTopicObj()
LambdaToSnsProps.Builder	existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc)	Sets the value of LambdaToSnsProps.getExistingVpc()
LambdaToSnsProps.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)	Sets the value of LambdaToSnsProps.getLambdaFunctionProps()
LambdaToSnsProps.Builder	topicArnEnvironmentVariableName(String topicArnEnvironmentVariableName)	Sets the value of LambdaToSnsProps.getTopicArnEnvironmentVariableName()
LambdaToSnsProps.Builder	topicNameEnvironmentVariableName(String topicNameEnvironmentVariableName)	Sets the value of LambdaToSnsProps.getTopicNameEnvironmentVariableName()
LambdaToSnsProps.Builder	topicProps(software.amazon.awscdk.services.sns.TopicProps topicProps)	Sets the value of LambdaToSnsProps.getTopicProps()
LambdaToSnsProps.Builder	vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps)	Sets the value of LambdaToSnsProps.getVpcProps()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

deployVpc

public LambdaToSnsProps.Builder deployVpc(Boolean deployVpc)

Sets the value of LambdaToSnsProps.getDeployVpc()

Parameters:

deployVpc - Whether to deploy a new VPC.

Returns:

this

enableEncryptionWithCustomerManagedKey

public LambdaToSnsProps.Builder enableEncryptionWithCustomerManagedKey(Boolean enableEncryptionWithCustomerManagedKey)

Sets the value of LambdaToSnsProps.getEnableEncryptionWithCustomerManagedKey()

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 flag is ignored if any of the following are defined: topicProps.masterKey, encryptionKey or encryptionKeyProps.

Returns:

this

encryptionKey

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

Sets the value of LambdaToSnsProps.getEncryptionKey()

Parameters:

encryptionKey - An optional, imported encryption key to encrypt the SNS Topic with.

Returns:

this

encryptionKeyProps

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

Sets the value of LambdaToSnsProps.getEncryptionKeyProps()

Parameters:

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

Returns:

this

existingLambdaObj

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

Sets the value of LambdaToSnsProps.getExistingLambdaObj()

Parameters:

existingLambdaObj - Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.

Returns:

this

existingTopicObj

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

Sets the value of LambdaToSnsProps.getExistingTopicObj()

Parameters:

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

Returns:

this

existingVpc

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

Sets the value of LambdaToSnsProps.getExistingVpc()

Parameters:

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

Returns:

this

lambdaFunctionProps

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

Sets the value of LambdaToSnsProps.getLambdaFunctionProps()

Parameters:

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

Returns:

this

topicArnEnvironmentVariableName

public LambdaToSnsProps.Builder topicArnEnvironmentVariableName(String topicArnEnvironmentVariableName)

Sets the value of LambdaToSnsProps.getTopicArnEnvironmentVariableName()

Parameters:

topicArnEnvironmentVariableName - Optional Name for the Lambda function environment variable set to the arn of the Topic.

Returns:

this

topicNameEnvironmentVariableName

public LambdaToSnsProps.Builder topicNameEnvironmentVariableName(String topicNameEnvironmentVariableName)

Sets the value of LambdaToSnsProps.getTopicNameEnvironmentVariableName()

Parameters:

topicNameEnvironmentVariableName - Optional Name for the Lambda function environment variable set to the name of the Topic.

Returns:

this

topicProps

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

Sets the value of LambdaToSnsProps.getTopicProps()

Parameters:

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

Returns:

this

vpcProps

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

Sets the value of LambdaToSnsProps.getVpcProps()

Parameters:

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

Returns:

this

build

public LambdaToSnsProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of LambdaToSnsProps

Throws:

NullPointerException - if any required attribute was not provided