Package software.amazon.awsconstructs.services.lambdassmstringparameter

Interface LambdaToSsmstringparameterProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
LambdaToSsmstringparameterProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-08T13:26:38.770Z") public interface LambdaToSsmstringparameterProps extends software.amazon.jsii.JsiiSerializable

  • Method Details

    • getDeployVpc

      @Nullable default Boolean getDeployVpc()
      Whether to deploy a new VPC.

      Default: - false

    • getExistingLambdaObj

      @Nullable default software.amazon.awscdk.services.lambda.Function getExistingLambdaObj()
      Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored.

      Default: - None

    • getExistingStringParameterObj

      @Nullable default software.amazon.awscdk.services.ssm.StringParameter getExistingStringParameterObj()
      Existing instance of SSM String parameter object, If this is set then the stringParameterProps is ignored.

      Default: - Default props are used

    • getExistingVpc

      @Nullable default software.amazon.awscdk.services.ec2.IVpc getExistingVpc()
      An existing VPC for the construct to use (construct will NOT create a new VPC in this case).

    • getLambdaFunctionProps

      @Nullable default software.amazon.awscdk.services.lambda.FunctionProps getLambdaFunctionProps()
      User provided props to override the default props for the Lambda function.

      Default: - Default properties are used.

    • getStringParameterEnvironmentVariableName

      @Nullable default String getStringParameterEnvironmentVariableName()
      Optional Name for the Lambda function environment variable set to the name of the parameter.

      Default: - SSM_STRING_PARAMETER_NAME

    • getStringParameterPermissions

      @Nullable default String getStringParameterPermissions()
      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.

    • getStringParameterProps

      @Nullable default software.amazon.awscdk.services.ssm.StringParameterProps getStringParameterProps()
      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

    • getVpcProps

      @Nullable default software.amazon.awscdk.services.ec2.VpcProps getVpcProps()
      Properties to override default properties if deployVpc is true.

    • builder

      static LambdaToSsmstringparameterProps.Builder builder()
      Returns:
      a LambdaToSsmstringparameterProps.Builder of LambdaToSsmstringparameterProps