Class RuntimeProps.Builder
java.lang.Object
software.amazon.awscdk.services.bedrockagentcore.RuntimeProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<RuntimeProps>
- Enclosing interface:
RuntimeProps
@Stability(Stable)
public static final class RuntimeProps.Builder
extends Object
implements software.amazon.jsii.Builder<RuntimeProps>
A builder for
RuntimeProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionagentRuntimeArtifact(AgentRuntimeArtifact agentRuntimeArtifact) Sets the value ofRuntimeProps.getAgentRuntimeArtifact()authorizerConfiguration(RuntimeAuthorizerConfiguration authorizerConfiguration) Sets the value ofRuntimeProps.getAuthorizerConfiguration()build()Builds the configured instance.description(String description) Sets the value ofRuntimeProps.getDescription()environmentVariables(Map<String, String> environmentVariables) Sets the value ofRuntimeProps.getEnvironmentVariables()executionRole(IRole executionRole) Sets the value ofRuntimeProps.getExecutionRole()lifecycleConfiguration(LifecycleConfiguration lifecycleConfiguration) Sets the value ofRuntimeProps.getLifecycleConfiguration()loggingConfigs(List<? extends LoggingConfig> loggingConfigs) Sets the value ofRuntimeProps.getLoggingConfigs()manageDeliveryResourcePolicy(Boolean manageDeliveryResourcePolicy) Sets the value ofRuntimeProps.getManageDeliveryResourcePolicy()networkConfiguration(RuntimeNetworkConfiguration networkConfiguration) Sets the value ofRuntimeProps.getNetworkConfiguration()protocolConfiguration(ProtocolType protocolConfiguration) Sets the value ofRuntimeProps.getProtocolConfiguration()requestHeaderConfiguration(RequestHeaderConfiguration requestHeaderConfiguration) Sets the value ofRuntimeProps.getRequestHeaderConfiguration()runtimeName(String runtimeName) Sets the value ofRuntimeProps.getRuntimeName()Sets the value ofRuntimeProps.getTags()tracingEnabled(Boolean tracingEnabled) Sets the value ofRuntimeProps.getTracingEnabled()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
agentRuntimeArtifact
@Stability(Stable) public RuntimeProps.Builder agentRuntimeArtifact(AgentRuntimeArtifact agentRuntimeArtifact) Sets the value ofRuntimeProps.getAgentRuntimeArtifact()- Parameters:
agentRuntimeArtifact- The artifact configuration for the agent runtime Contains the container configuration with ECR URI. This parameter is required.- Returns:
this
-
authorizerConfiguration
@Stability(Stable) public RuntimeProps.Builder authorizerConfiguration(RuntimeAuthorizerConfiguration authorizerConfiguration) Sets the value ofRuntimeProps.getAuthorizerConfiguration()- Parameters:
authorizerConfiguration- Authorizer configuration for the agent runtime Use RuntimeAuthorizerConfiguration static methods to create the configuration.- Returns:
this
-
description
Sets the value ofRuntimeProps.getDescription()- Parameters:
description- Optional description for the agent runtime.- Returns:
this
-
environmentVariables
@Stability(Stable) public RuntimeProps.Builder environmentVariables(Map<String, String> environmentVariables) Sets the value ofRuntimeProps.getEnvironmentVariables()- Parameters:
environmentVariables- Environment variables for the agent runtime - Maximum 50 environment variables - Key: Must be 1-100 characters, start with letter or underscore, contain only letters, numbers, and underscores - Value: Must be 0-2048 characters (per CloudFormation specification).- Returns:
this
-
executionRole
Sets the value ofRuntimeProps.getExecutionRole()- Parameters:
executionRole- The IAM role that provides permissions for the agent runtime If not provided, a role will be created automatically.- Returns:
this
-
lifecycleConfiguration
@Stability(Stable) public RuntimeProps.Builder lifecycleConfiguration(LifecycleConfiguration lifecycleConfiguration) Sets the value ofRuntimeProps.getLifecycleConfiguration()- Parameters:
lifecycleConfiguration- The life cycle configuration for the AgentCore Runtime.- Returns:
this
-
loggingConfigs
@Stability(Stable) public RuntimeProps.Builder loggingConfigs(List<? extends LoggingConfig> loggingConfigs) Sets the value ofRuntimeProps.getLoggingConfigs()- Parameters:
loggingConfigs- Logging configuration for the runtime. Allows sending APPLICATION_LOGS and USAGE_LOGS to CloudWatch Logs, S3, or Kinesis Data Firehose.- Returns:
this
-
manageDeliveryResourcePolicy
@Stability(Stable) public RuntimeProps.Builder manageDeliveryResourcePolicy(Boolean manageDeliveryResourcePolicy) Sets the value ofRuntimeProps.getManageDeliveryResourcePolicy()- Parameters:
manageDeliveryResourcePolicy- Whether to create resource policies for log/trace delivery. Whenfalse, theAWS::Logs::ResourcePolicyandAWS::XRay::ResourcePolicyare not created. This is useful when deploying many runtimes per account/Region, as each resource policy consumes an account-level quota slot (CloudWatch Logs: 10, X-Ray: lower).Setting
falsemeans you are responsible for ensuring delivery permissions exist. There are two safe ways to use this:- Same-account delivery to a
/aws/vendedlogs/log group, where the log-delivery service-linked role grants write access implicitly. - Attaching the delivery resource policy yourself.
Otherwise delivery silently fails: synthesis and deploy succeed, but nothing is delivered. Per the vended-logs delivery docs, a resource policy is required for CloudWatch Logs delivery outside the
/aws/vendedlogs/same-account case.- Same-account delivery to a
- Returns:
this
-
networkConfiguration
@Stability(Stable) public RuntimeProps.Builder networkConfiguration(RuntimeNetworkConfiguration networkConfiguration) Sets the value ofRuntimeProps.getNetworkConfiguration()- Parameters:
networkConfiguration- Network configuration for the agent runtime.- Returns:
this
-
protocolConfiguration
@Stability(Stable) public RuntimeProps.Builder protocolConfiguration(ProtocolType protocolConfiguration) Sets the value ofRuntimeProps.getProtocolConfiguration()- Parameters:
protocolConfiguration- Protocol configuration for the agent runtime.- Returns:
this
-
requestHeaderConfiguration
@Stability(Stable) public RuntimeProps.Builder requestHeaderConfiguration(RequestHeaderConfiguration requestHeaderConfiguration) Sets the value ofRuntimeProps.getRequestHeaderConfiguration()- Parameters:
requestHeaderConfiguration- Configuration for HTTP request headers that will be passed through to the runtime.- Returns:
this
-
runtimeName
Sets the value ofRuntimeProps.getRuntimeName()- Parameters:
runtimeName- The name of the agent runtime Valid characters are a-z, A-Z, 0-9, _ (underscore) Must start with a letter and can be up to 48 characters long Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,47}$.- Returns:
this
-
tags
Sets the value ofRuntimeProps.getTags()- Parameters:
tags- Tags for the agent runtime A list of key:value pairs of tags to apply to this Runtime resource.- Returns:
this
-
tracingEnabled
Sets the value ofRuntimeProps.getTracingEnabled()- Parameters:
tracingEnabled- Whether to enable X-Ray tracing for this runtime. When enabled, traces will be delivered to AWS X-Ray.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<RuntimeProps>- Returns:
- a new instance of
RuntimeProps - Throws:
NullPointerException- if any required attribute was not provided
-