software.amazon.awsconstructs.services.lambdassmstringparameter

Class LambdaToSsmstringparameterProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.lambdassmstringparameter.LambdaToSsmstringparameterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaToSsmstringparameterProps>

Enclosing interface:

LambdaToSsmstringparameterProps

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

A builder for LambdaToSsmstringparameterProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
LambdaToSsmstringparameterProps	build() Builds the configured instance.
LambdaToSsmstringparameterProps.Builder	deployVpc(Boolean deployVpc) Sets the value of LambdaToSsmstringparameterProps.getDeployVpc()
LambdaToSsmstringparameterProps.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Sets the value of LambdaToSsmstringparameterProps.getExistingLambdaObj()
LambdaToSsmstringparameterProps.Builder	existingStringParameterObj(software.amazon.awscdk.services.ssm.StringParameter existingStringParameterObj) Sets the value of LambdaToSsmstringparameterProps.getExistingStringParameterObj()
LambdaToSsmstringparameterProps.Builder	existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc) Sets the value of LambdaToSsmstringparameterProps.getExistingVpc()
LambdaToSsmstringparameterProps.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) Sets the value of LambdaToSsmstringparameterProps.getLambdaFunctionProps()
LambdaToSsmstringparameterProps.Builder	stringParameterEnvironmentVariableName(String stringParameterEnvironmentVariableName) Sets the value of LambdaToSsmstringparameterProps.getStringParameterEnvironmentVariableName()
LambdaToSsmstringparameterProps.Builder	stringParameterPermissions(String stringParameterPermissions) Sets the value of LambdaToSsmstringparameterProps.getStringParameterPermissions()
LambdaToSsmstringparameterProps.Builder	stringParameterProps(software.amazon.awscdk.services.ssm.StringParameterProps stringParameterProps) Sets the value of LambdaToSsmstringparameterProps.getStringParameterProps()
LambdaToSsmstringparameterProps.Builder	vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps) Sets the value of LambdaToSsmstringparameterProps.getVpcProps()

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

deployVpc

public LambdaToSsmstringparameterProps.Builder deployVpc(Boolean deployVpc)

Sets the value of LambdaToSsmstringparameterProps.getDeployVpc()

Parameters:

deployVpc - Whether to deploy a new VPC.

Returns:

this

existingLambdaObj

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

Sets the value of LambdaToSsmstringparameterProps.getExistingLambdaObj()

Parameters:

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

Returns:

this

existingStringParameterObj

public LambdaToSsmstringparameterProps.Builder existingStringParameterObj(software.amazon.awscdk.services.ssm.StringParameter existingStringParameterObj)

Sets the value of LambdaToSsmstringparameterProps.getExistingStringParameterObj()

Parameters:

existingStringParameterObj - Existing instance of SSM String parameter object, If this is set then the stringParameterProps is ignored.

Returns:

this

existingVpc

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

Sets the value of LambdaToSsmstringparameterProps.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 LambdaToSsmstringparameterProps.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)

Sets the value of LambdaToSsmstringparameterProps.getLambdaFunctionProps()

Parameters:

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

Returns:

this

stringParameterEnvironmentVariableName

public LambdaToSsmstringparameterProps.Builder stringParameterEnvironmentVariableName(String stringParameterEnvironmentVariableName)

Sets the value of LambdaToSsmstringparameterProps.getStringParameterEnvironmentVariableName()

Parameters:

stringParameterEnvironmentVariableName - Optional Name for the SSM String parameter environment variable set for the Lambda function.

Returns:

this

stringParameterPermissions

public LambdaToSsmstringparameterProps.Builder stringParameterPermissions(String stringParameterPermissions)

Sets the value of LambdaToSsmstringparameterProps.getStringParameterPermissions()

Parameters:

stringParameterPermissions - Optional SSM String parameter permissions to grant to the Lambda function. One of the following may be specified: "Read", "ReadWrite".

Returns:

this

stringParameterProps

public LambdaToSsmstringparameterProps.Builder stringParameterProps(software.amazon.awscdk.services.ssm.StringParameterProps stringParameterProps)

Sets the value of LambdaToSsmstringparameterProps.getStringParameterProps()

Parameters:

stringParameterProps - Optional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supported string parameter type is ParameterType.STRING.

Returns:

this

vpcProps

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

Sets the value of LambdaToSsmstringparameterProps.getVpcProps()

Parameters:

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

Returns:

this

build

public LambdaToSsmstringparameterProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of LambdaToSsmstringparameterProps

Throws:

NullPointerException - if any required attribute was not provided