Skip to content
v2.277.0

CodeConfig Struct ​

Configuration of the code class.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_synthetics as synthetics } from 'aws-cdk-lib';
const codeConfig: synthetics.CodeConfig = {
  inlineCode: 'inlineCode',
  s3Location: {
    bucketName: 'bucketName',
    objectKey: 'objectKey',

    // the properties below are optional
    objectVersion: 'objectVersion',
  },
};
python
from aws_cdk.aws_s3 import Location
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_synthetics as synthetics

code_config = synthetics.CodeConfig(
    inline_code="inlineCode",
    s3_location=Location(
        bucket_name="bucketName",
        object_key="objectKey",

        # the properties below are optional
        object_version="objectVersion"
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.synthetics.*;

CodeConfig codeConfig = CodeConfig.builder()
        .inlineCode("inlineCode")
        .s3Location(Location.builder()
                .bucketName("bucketName")
                .objectKey("objectKey")

                // the properties below are optional
                .objectVersion("objectVersion")
                .build())
        .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.AWS.Synthetics;

var codeConfig = new CodeConfig {
    InlineCode = "inlineCode",
    S3Location = new Location {
        BucketName = "bucketName",
        ObjectKey = "objectKey",

        // the properties below are optional
        ObjectVersion = "objectVersion"
    }
};
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 "github.com/aws/aws-cdk-go/awscdk"

codeConfig := &CodeConfig{
	InlineCode: jsii.String("inlineCode"),
	S3Location: &Location{
		BucketName: jsii.String("bucketName"),
		ObjectKey: jsii.String("objectKey"),

		// the properties below are optional
		ObjectVersion: jsii.String("objectVersion"),
	},
}

Properties ​

inlineCodeoptionalstringinline_codeoptionalstrinlineCodeoptionalStringInlineCodeoptionalstringInlineCodeoptional*string= none#
Inline code (mutually exclusive with `s3Location`).
s3LocationoptionalLocations3_locationoptionalLocations3LocationoptionalLocationS3LocationoptionalLocationS3LocationoptionalLocation= none#
The location of the code in S3 (mutually exclusive with `inlineCode`).