AWS CDK Reference

Appearance

v2.273.0

ParamsAndSecretsLayerVersion Class ​

Parameters and Secrets Extension layer version.

Source
aws-lambda/lib/params-and-secrets-layers.ts
Type last changed
v2.84.0 · 14 Jun 2023

Example ​

ts
import * as sm from 'aws-cdk-lib/aws-secretsmanager';
import * as ssm from 'aws-cdk-lib/aws-ssm';

const secret = new sm.Secret(this, 'Secret');
const parameter = new ssm.StringParameter(this, 'Parameter', {
  parameterName: 'mySsmParameterName',
  stringValue: 'mySsmParameterValue',
});

const paramsAndSecrets = lambda.ParamsAndSecretsLayerVersion.fromVersion(lambda.ParamsAndSecretsVersions.V1_0_103, {
  cacheSize: 500,
  logLevel: lambda.ParamsAndSecretsLogLevel.DEBUG,
});

const lambdaFunction = new lambda.Function(this, 'MyFunction', {
  runtime: lambda.Runtime.NODEJS_LATEST,
  handler: 'index.handler',
  architecture: lambda.Architecture.ARM_64,
  code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
  paramsAndSecrets,
});

secret.grantRead(lambdaFunction);
parameter.grantRead(lambdaFunction);

Methods ​

fromVersion(version: ParamsAndSecretsVersions, options?: ParamsAndSecretsOptions): ParamsAndSecretsLayerVersion // chainable@staticmethod def from_version(version: ParamsAndSecretsVersions, options: typing.Optional[ParamsAndSecretsOptions] = None) -> ParamsAndSecretsLayerVersionpublic static ParamsAndSecretsLayerVersion fromVersion(ParamsAndSecretsVersions version, ParamsAndSecretsOptions options)public static ParamsAndSecretsLayerVersion FromVersion(ParamsAndSecretsVersions version, ParamsAndSecretsOptions? options = null)func FromVersion(Version ParamsAndSecretsVersions, Options ParamsAndSecretsOptions) ParamsAndSecretsLayerVersionstatic#
Use a specific version of the Parameters and Secrets Extension to generate a layer version.
fromVersionArn(arn: string, options?: ParamsAndSecretsOptions): ParamsAndSecretsLayerVersion // chainable@staticmethod def from_version_arn(arn: str, options: typing.Optional[ParamsAndSecretsOptions] = None) -> ParamsAndSecretsLayerVersionpublic static ParamsAndSecretsLayerVersion fromVersionArn(String arn, ParamsAndSecretsOptions options)public static ParamsAndSecretsLayerVersion FromVersionArn(string arn, ParamsAndSecretsOptions? options = null)func FromVersionArn(Arn *string, Options ParamsAndSecretsOptions) ParamsAndSecretsLayerVersionstatic#
Use the Parameters and Secrets Extension associated with the provided ARN.

Make sure the ARN is associated with the same region and architecture as your function.