AWS CDK Reference

Appearance

v2.277.0

BuildtimeSettingsProperty Struct ​

Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Source
Generated code
Type last changed
v2.203.0 · 1 Jul 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lex as lex } from 'aws-cdk-lib';
const buildtimeSettingsProperty: lex.CfnBot.BuildtimeSettingsProperty = {
  descriptiveBotBuilderSpecification: {
    enabled: false,

    // the properties below are optional
    bedrockModelSpecification: {
      modelArn: 'modelArn',

      // the properties below are optional
      bedrockGuardrailConfiguration: {
        bedrockGuardrailIdentifier: 'bedrockGuardrailIdentifier',
        bedrockGuardrailVersion: 'bedrockGuardrailVersion',
      },
      bedrockModelCustomPrompt: 'bedrockModelCustomPrompt',
      bedrockTraceStatus: 'bedrockTraceStatus',
    },
  },
  sampleUtteranceGenerationSpecification: {
    enabled: false,

    // the properties below are optional
    bedrockModelSpecification: {
      modelArn: 'modelArn',

      // the properties below are optional
      bedrockGuardrailConfiguration: {
        bedrockGuardrailIdentifier: 'bedrockGuardrailIdentifier',
        bedrockGuardrailVersion: 'bedrockGuardrailVersion',
      },
      bedrockModelCustomPrompt: 'bedrockModelCustomPrompt',
      bedrockTraceStatus: 'bedrockTraceStatus',
    },
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lex as lex

buildtime_settings_property = lex.CfnBot.BuildtimeSettingsProperty(
    descriptive_bot_builder_specification=lex.CfnBot.DescriptiveBotBuilderSpecificationProperty(
        enabled=False,

        # the properties below are optional
        bedrock_model_specification=lex.CfnBot.BedrockModelSpecificationProperty(
            model_arn="modelArn",

            # the properties below are optional
            bedrock_guardrail_configuration=lex.CfnBot.BedrockGuardrailConfigurationProperty(
                bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
                bedrock_guardrail_version="bedrockGuardrailVersion"
            ),
            bedrock_model_custom_prompt="bedrockModelCustomPrompt",
            bedrock_trace_status="bedrockTraceStatus"
        )
    ),
    sample_utterance_generation_specification=lex.CfnBot.SampleUtteranceGenerationSpecificationProperty(
        enabled=False,

        # the properties below are optional
        bedrock_model_specification=lex.CfnBot.BedrockModelSpecificationProperty(
            model_arn="modelArn",

            # the properties below are optional
            bedrock_guardrail_configuration=lex.CfnBot.BedrockGuardrailConfigurationProperty(
                bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
                bedrock_guardrail_version="bedrockGuardrailVersion"
            ),
            bedrock_model_custom_prompt="bedrockModelCustomPrompt",
            bedrock_trace_status="bedrockTraceStatus"
        )
    )
)
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.lex.*;

BuildtimeSettingsProperty buildtimeSettingsProperty = BuildtimeSettingsProperty.builder()
        .descriptiveBotBuilderSpecification(DescriptiveBotBuilderSpecificationProperty.builder()
                .enabled(false)

                // the properties below are optional
                .bedrockModelSpecification(BedrockModelSpecificationProperty.builder()
                        .modelArn("modelArn")

                        // the properties below are optional
                        .bedrockGuardrailConfiguration(BedrockGuardrailConfigurationProperty.builder()
                                .bedrockGuardrailIdentifier("bedrockGuardrailIdentifier")
                                .bedrockGuardrailVersion("bedrockGuardrailVersion")
                                .build())
                        .bedrockModelCustomPrompt("bedrockModelCustomPrompt")
                        .bedrockTraceStatus("bedrockTraceStatus")
                        .build())
                .build())
        .sampleUtteranceGenerationSpecification(SampleUtteranceGenerationSpecificationProperty.builder()
                .enabled(false)

                // the properties below are optional
                .bedrockModelSpecification(BedrockModelSpecificationProperty.builder()
                        .modelArn("modelArn")

                        // the properties below are optional
                        .bedrockGuardrailConfiguration(BedrockGuardrailConfigurationProperty.builder()
                                .bedrockGuardrailIdentifier("bedrockGuardrailIdentifier")
                                .bedrockGuardrailVersion("bedrockGuardrailVersion")
                                .build())
                        .bedrockModelCustomPrompt("bedrockModelCustomPrompt")
                        .bedrockTraceStatus("bedrockTraceStatus")
                        .build())
                .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.Lex;

var buildtimeSettingsProperty = new BuildtimeSettingsProperty {
    DescriptiveBotBuilderSpecification = new DescriptiveBotBuilderSpecificationProperty {
        Enabled = false,

        // the properties below are optional
        BedrockModelSpecification = new BedrockModelSpecificationProperty {
            ModelArn = "modelArn",

            // the properties below are optional
            BedrockGuardrailConfiguration = new BedrockGuardrailConfigurationProperty {
                BedrockGuardrailIdentifier = "bedrockGuardrailIdentifier",
                BedrockGuardrailVersion = "bedrockGuardrailVersion"
            },
            BedrockModelCustomPrompt = "bedrockModelCustomPrompt",
            BedrockTraceStatus = "bedrockTraceStatus"
        }
    },
    SampleUtteranceGenerationSpecification = new SampleUtteranceGenerationSpecificationProperty {
        Enabled = false,

        // the properties below are optional
        BedrockModelSpecification = new BedrockModelSpecificationProperty {
            ModelArn = "modelArn",

            // the properties below are optional
            BedrockGuardrailConfiguration = new BedrockGuardrailConfigurationProperty {
                BedrockGuardrailIdentifier = "bedrockGuardrailIdentifier",
                BedrockGuardrailVersion = "bedrockGuardrailVersion"
            },
            BedrockModelCustomPrompt = "bedrockModelCustomPrompt",
            BedrockTraceStatus = "bedrockTraceStatus"
        }
    }
};
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"

buildtimeSettingsProperty := &BuildtimeSettingsProperty{
	DescriptiveBotBuilderSpecification: &DescriptiveBotBuilderSpecificationProperty{
		Enabled: jsii.Boolean(false),

		// the properties below are optional
		BedrockModelSpecification: &BedrockModelSpecificationProperty{
			ModelArn: jsii.String("modelArn"),

			// the properties below are optional
			BedrockGuardrailConfiguration: &BedrockGuardrailConfigurationProperty{
				BedrockGuardrailIdentifier: jsii.String("bedrockGuardrailIdentifier"),
				BedrockGuardrailVersion: jsii.String("bedrockGuardrailVersion"),
			},
			BedrockModelCustomPrompt: jsii.String("bedrockModelCustomPrompt"),
			BedrockTraceStatus: jsii.String("bedrockTraceStatus"),
		},
	},
	SampleUtteranceGenerationSpecification: &SampleUtteranceGenerationSpecificationProperty{
		Enabled: jsii.Boolean(false),

		// the properties below are optional
		BedrockModelSpecification: &BedrockModelSpecificationProperty{
			ModelArn: jsii.String("modelArn"),

			// the properties below are optional
			BedrockGuardrailConfiguration: &BedrockGuardrailConfigurationProperty{
				BedrockGuardrailIdentifier: jsii.String("bedrockGuardrailIdentifier"),
				BedrockGuardrailVersion: jsii.String("bedrockGuardrailVersion"),
			},
			BedrockModelCustomPrompt: jsii.String("bedrockModelCustomPrompt"),
			BedrockTraceStatus: jsii.String("bedrockTraceStatus"),
		},
	},
}

Properties ​

descriptiveBotBuilderSpecificationoptionalIResolvable | CfnBot.DescriptiveBotBuilderSpecificationPropertydescriptive_bot_builder_specificationoptionaltyping.Union[IResolvable, DescriptiveBotBuilderSpecificationProperty]descriptiveBotBuilderSpecificationoptionalIResolvableDescriptiveBotBuilderSpecificationoptionalIResolvableDescriptiveBotBuilderSpecificationoptionalinterface{}#
sampleUtteranceGenerationSpecificationoptionalIResolvable | CfnBot.SampleUtteranceGenerationSpecificationPropertysample_utterance_generation_specificationoptionaltyping.Union[IResolvable, SampleUtteranceGenerationSpecificationProperty]sampleUtteranceGenerationSpecificationoptionalIResolvableSampleUtteranceGenerationSpecificationoptionalIResolvableSampleUtteranceGenerationSpecificationoptionalinterface{}#