Skip to content
v2.277.0

CfnParametersCodeProps Struct ​

Construction properties for CfnParametersCode.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_lambda as lambda } from 'aws-cdk-lib';
import { aws_kms as interfaces_kms } from 'aws-cdk-lib/interfaces';

declare const cfnParameter: cdk.CfnParameter;
declare const keyRef: interfaces_kms.IKeyRef;
const cfnParametersCodeProps: lambda.CfnParametersCodeProps = {
  bucketNameParam: cfnParameter,
  objectKeyParam: cfnParameter,
  sourceKMSKey: keyRef,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_lambda as lambda_
from aws_cdk.interfaces import aws_kms as interfaces_kms

# cfn_parameter: cdk.CfnParameter
# key_ref: interfaces_kms.IKeyRef

cfn_parameters_code_props = lambda.CfnParametersCodeProps(
    bucket_name_param=cfn_parameter,
    object_key_param=cfn_parameter,
    source_kms_key=key_ref
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.lambda.*;
import software.amazon.awscdk.interfaces.kms.*;

CfnParameter cfnParameter;
IKeyRef keyRef;

CfnParametersCodeProps cfnParametersCodeProps = CfnParametersCodeProps.builder()
        .bucketNameParam(cfnParameter)
        .objectKeyParam(cfnParameter)
        .sourceKMSKey(keyRef)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.Lambda;
using Amazon.CDK.Interfaces.KMS;

CfnParameter cfnParameter;
IKeyRef keyRef;

var cfnParametersCodeProps = new CfnParametersCodeProps {
    BucketNameParam = cfnParameter,
    ObjectKeyParam = cfnParameter,
    SourceKMSKey = keyRef
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var cfnParameter CfnParameter
var keyRef IKeyRef

cfnParametersCodeProps := &CfnParametersCodeProps{
	BucketNameParam: cfnParameter,
	ObjectKeyParam: cfnParameter,
	SourceKMSKey: keyRef,
}

Properties ​

bucketNameParamoptionalCfnParameterbucket_name_paramoptionalCfnParameterbucketNameParamoptionalCfnParameterBucketNameParamoptionalCfnParameterBucketNameParamoptionalCfnParameter#
The CloudFormation parameter that represents the name of the S3 Bucket where the Lambda code will be located in.

Default: a new parameter will be created

Must be of type 'String'.

objectKeyParamoptionalCfnParameterobject_key_paramoptionalCfnParameterobjectKeyParamoptionalCfnParameterObjectKeyParamoptionalCfnParameterObjectKeyParamoptionalCfnParameter#
The CloudFormation parameter that represents the path inside the S3 Bucket where the Lambda code will be located at.

Default: a new parameter will be created

Must be of type 'String'.

sourceKMSKeyoptionalIKeyRefsource_kms_keyoptionalIKeyRefsourceKMSKeyoptionalIKeyRefSourceKMSKeyoptionalIKeyRefSourceKMSKeyoptionalIKeyRef#
The KMS key that Lambda uses to encrypt the deployment package in Lambda-managed storage.

Default: Lambda uses an AWS owned key

This is not the key used to encrypt the source object in Amazon S3.