Interface CfnRuntimeProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRuntimeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-13T16:10:00.091Z")
@Stability(Stable)
public interface CfnRuntimeProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnRuntime.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrockagentcore.*;
CfnRuntimeProps cfnRuntimeProps = CfnRuntimeProps.builder()
.agentRuntimeArtifact(AgentRuntimeArtifactProperty.builder()
.codeConfiguration(CodeConfigurationProperty.builder()
.code(CodeProperty.builder()
.s3(S3LocationProperty.builder()
.bucket("bucket")
.prefix("prefix")
// the properties below are optional
.versionId("versionId")
.build())
.build())
.entryPoint(List.of("entryPoint"))
.runtime("runtime")
.build())
.containerConfiguration(ContainerConfigurationProperty.builder()
.containerUri("containerUri")
.build())
.build())
.agentRuntimeName("agentRuntimeName")
.networkConfiguration(NetworkConfigurationProperty.builder()
.networkMode("networkMode")
// the properties below are optional
.networkModeConfig(VpcConfigProperty.builder()
.securityGroups(List.of("securityGroups"))
.subnets(List.of("subnets"))
.build())
.build())
.roleArn("roleArn")
// the properties below are optional
.authorizerConfiguration(AuthorizerConfigurationProperty.builder()
.customJwtAuthorizer(CustomJWTAuthorizerConfigurationProperty.builder()
.discoveryUrl("discoveryUrl")
// the properties below are optional
.allowedAudience(List.of("allowedAudience"))
.allowedClients(List.of("allowedClients"))
.build())
.build())
.description("description")
.environmentVariables(Map.of(
"environmentVariablesKey", "environmentVariables"))
.lifecycleConfiguration(LifecycleConfigurationProperty.builder()
.idleRuntimeSessionTimeout(123)
.maxLifetime(123)
.build())
.protocolConfiguration("protocolConfiguration")
.requestHeaderConfiguration(RequestHeaderConfigurationProperty.builder()
.requestHeaderAllowlist(List.of("requestHeaderAllowlist"))
.build())
.tags(Map.of(
"tagsKey", "tags"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnRuntimePropsstatic final classAn implementation forCfnRuntimeProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnRuntimeProps.Builderbuilder()The artifact of the agent.The name of the AgentCore Runtime endpoint.default ObjectRepresents inbound authorization configuration options used to authenticate incoming requests.default StringThe agent runtime description.default ObjectThe environment variables for the agent.default ObjectConfiguration for managing the lifecycle of runtime sessions and resources.The network configuration.default StringThe protocol configuration for an agent runtime.default ObjectConfiguration for HTTP request headers.The Amazon Resource Name (ARN) for for the role.getTags()The tags for the agent.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAgentRuntimeArtifact
The artifact of the agent.Returns union: either
IResolvableorCfnRuntime.AgentRuntimeArtifactProperty- See Also:
-
getAgentRuntimeName
The name of the AgentCore Runtime endpoint.- See Also:
-
getNetworkConfiguration
The network configuration.Returns union: either
IResolvableorCfnRuntime.NetworkConfigurationProperty- See Also:
-
getRoleArn
The Amazon Resource Name (ARN) for for the role.- See Also:
-
getAuthorizerConfiguration
Represents inbound authorization configuration options used to authenticate incoming requests.Returns union: either
IResolvableorCfnRuntime.AuthorizerConfigurationProperty- See Also:
-
getDescription
The agent runtime description.- See Also:
-
getEnvironmentVariables
The environment variables for the agent.Returns union: either Mapinvalid input: '<'String,
String> orIResolvable- See Also:
-
getLifecycleConfiguration
Configuration for managing the lifecycle of runtime sessions and resources.Returns union: either
IResolvableorCfnRuntime.LifecycleConfigurationProperty- See Also:
-
getProtocolConfiguration
The protocol configuration for an agent runtime.This structure defines how the agent runtime communicates with clients.
- See Also:
-
getRequestHeaderConfiguration
Configuration for HTTP request headers.Returns union: either
IResolvableorCfnRuntime.RequestHeaderConfigurationProperty- See Also:
-
getTags
The tags for the agent.- See Also:
-
builder
- Returns:
- a
CfnRuntimeProps.BuilderofCfnRuntimeProps
-