Package software.amazon.awsconstructs.services.lambdassmstringparameter

Class LambdaToSsmstringparameter.Builder

java.lang.Object
software.amazon.awsconstructs.services.lambdassmstringparameter.LambdaToSsmstringparameter.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<LambdaToSsmstringparameter>
Enclosing class:
LambdaToSsmstringparameter
public static final class LambdaToSsmstringparameter.Builder extends Object implements software.amazon.jsii.Builder<LambdaToSsmstringparameter>
A fluent builder for LambdaToSsmstringparameter.

  • Method Details

    • create

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

    • deployVpc

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

    • existingStringParameterObj

      public LambdaToSsmstringparameter.Builder existingStringParameterObj(software.amazon.awscdk.services.ssm.StringParameter existingStringParameterObj)
      Existing instance of SSM String parameter object, If this is set then the stringParameterProps is ignored.

      Default: - Default props are used

      Parameters:
      existingStringParameterObj - Existing instance of SSM String parameter object, If this is set then the stringParameterProps is ignored. This parameter is required.
      Returns:
      this

    • existingVpc

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

    • stringParameterEnvironmentVariableName

      public LambdaToSsmstringparameter.Builder stringParameterEnvironmentVariableName(String stringParameterEnvironmentVariableName)
      Optional Name for the Lambda function environment variable set to the name of the parameter.

      Default: - SSM_STRING_PARAMETER_NAME

      Parameters:
      stringParameterEnvironmentVariableName - Optional Name for the Lambda function environment variable set to the name of the parameter. This parameter is required.
      Returns:
      this

    • stringParameterPermissions

      public LambdaToSsmstringparameter.Builder stringParameterPermissions(String stringParameterPermissions)
      Optional SSM String parameter permissions to grant to the Lambda function.

      One of the following may be specified: "Read", "ReadWrite".

      Default: - Read access is given to the Lambda function if no value is specified.

      Parameters:
      stringParameterPermissions - Optional SSM String parameter permissions to grant to the Lambda function. This parameter is required.
      Returns:
      this

    • stringParameterProps

      public LambdaToSsmstringparameter.Builder stringParameterProps(software.amazon.awscdk.services.ssm.StringParameterProps 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.

      Default: - Default props are used

      Parameters:
      stringParameterProps - Optional user provided props to override the default props for SSM String parameter. This parameter is required.
      Returns:
      this

    • vpcProps

      public LambdaToSsmstringparameter.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 LambdaToSsmstringparameter build()
      Specified by:
      build in interface software.amazon.jsii.Builder<LambdaToSsmstringparameter>
      Returns:
      a newly built instance of LambdaToSsmstringparameter.