Package software.amazon.awscdk.services.s3.deployment

Interface JsonProcessingOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JsonProcessingOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:21.782Z")
@Stability(Stable)
public interface JsonProcessingOptions
extends software.amazon.jsii.JsiiSerializable

Define options which can be passed using the method Source.jsonData().

Example:

 Bucket bucket;
 StringParameter param;
 // Example with a secret value that contains double quotes
 BucketDeployment deployment = BucketDeployment.Builder.create(this, "JsonDeployment")
         .sources(List.of(Source.jsonData("config.json", Map.of(
                 "api_endpoint", "https://api.example.com",
                 "secretValue", param.getStringValue(),  // value with double quotes
                 "config", Map.of(
                         "enabled", true,
                         "features", List.of("feature1", "feature2"))), JsonProcessingOptions.builder().escape(true).build())))
         .destinationBucket(bucket)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	JsonProcessingOptions.Builder	A builder for JsonProcessingOptions
static final class	JsonProcessingOptions.Jsii$Proxy	An implementation for JsonProcessingOptions

Method Summary

Modifier and Type	Method	Description
static JsonProcessingOptions.Builder	builder()
default Boolean	getEscape()	If set to true, the marker substitution will make sure the value inserted in the file will be a valid JSON string.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEscape

@Stability(Stable)
@Nullable
default Boolean getEscape()

If set to true, the marker substitution will make sure the value inserted in the file will be a valid JSON string.

Default: - false

builder

@Stability(Stable)
static JsonProcessingOptions.Builder builder()

Returns:

a JsonProcessingOptions.Builder of JsonProcessingOptions