Skip to content

Commit 7b59ec1

Browse files
committed
Add AgentCore Runtime network configuration section to EN and KO docs
1 parent d7ce10e commit 7b59ec1

File tree

2 files changed

+122
-0
lines changed

2 files changed

+122
-0
lines changed

docs/en/DEPLOY_OPTION.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -754,6 +754,67 @@ const envs: Record<string, Partial<StackInput>> = {
754754
}
755755
```
756756

757+
> [!NOTE]
758+
> After enabling AgentCore use case settings, if you want to disable them again, you can disable the AgentCore use case by setting `createGenericAgentCoreRuntime: false` and redeploying, but the `AgentCoreStack` itself will remain. You can completely remove it by opening the Management Console and deleting the `AgentCoreStack` stack from CloudFormation in the `agentCoreRegion`.
759+
760+
#### AgentCore Runtime Network Configuration
761+
762+
AgentCore Runtime can operate in the following network modes:
763+
764+
- `PUBLIC` (default): Operates on public network
765+
- `PRIVATE`: Operates on private network within VPC
766+
767+
Network settings apply to both Generic Runtime and AgentBuilder Runtime.
768+
769+
**Use cases for VPC mode**:
770+
771+
- When AgentCore Runtime needs to access internal systems or private databases
772+
- For example, when you want to communicate directly with other AWS services (RDS, ElastiCache, etc.) within the VPC
773+
774+
When using VPC mode, configure the following parameters:
775+
776+
- `agentCoreNetworkType`: Set to `PRIVATE`
777+
- `agentCoreVpcId`: VPC ID to use
778+
- `agentCoreSubnetIds`: List of subnet IDs to use
779+
780+
> [!IMPORTANT]
781+
> **Availability Zone (AZ) Support**: AgentCore Runtime has limited supported AZs per region. Subnets must be placed within supported AZs. For details, please refer to the [AWS official documentation](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/agentcore-vpc.html#agentcore-supported-azs).
782+
>
783+
> **Internet Access**: AgentCore Runtime requires internet access for MCP server installation. If connecting to private subnets, configure routes to NAT Gateway.
784+
785+
**Edit [parameter.ts](/packages/cdk/parameter.ts)**
786+
787+
```typescript
788+
// parameter.ts
789+
const envs: Record<string, Partial<StackInput>> = {
790+
dev: {
791+
createGenericAgentCoreRuntime: true,
792+
agentBuilderEnabled: true,
793+
agentCoreNetworkType: 'PRIVATE',
794+
agentCoreVpcId: 'vpc-xxxxxxxxx',
795+
agentCoreSubnetIds: ['subnet-xxxxxxxxx', 'subnet-yyyyyyyyy'],
796+
},
797+
};
798+
```
799+
800+
**Edit [packages/cdk/cdk.json](/packages/cdk/cdk.json)**
801+
802+
```json
803+
// cdk.json
804+
{
805+
"context": {
806+
"createGenericAgentCoreRuntime": true,
807+
"agentBuilderEnabled": true,
808+
"agentCoreNetworkType": "PRIVATE",
809+
"agentCoreVpcId": "vpc-xxxxxxxxx",
810+
"agentCoreSubnetIds": ["subnet-xxxxxxxxx", "subnet-yyyyyyyyy"]
811+
}
812+
}
813+
```
814+
815+
> [!WARNING]
816+
> When using VPC mode, security groups are not automatically deleted when AgentCore Runtime is deleted due to changes such as from PRIVATE to PUBLIC. This is because AWS-managed ENIs created by AgentCore Runtime reference the security groups, making them undeletable by CloudFormation. After deleting AgentCore Runtime, wait for the managed ENIs to be automatically deleted, then manually delete the security groups. The security group IDs that need to be deleted are displayed in the CloudFormation outputs.
817+
757818
### Enabling Voice Chat Use Case
758819

759820
> [!NOTE]

docs/ko/DEPLOY_OPTION.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -753,6 +753,67 @@ const envs: Record<string, Partial<StackInput>> = {
753753
}
754754
```
755755

756+
> [!NOTE]
757+
> AgentCore 사용 사례 설정을 활성화한 후 다시 비활성화하려면 `createGenericAgentCoreRuntime: false`로 설정하고 재배포하면 AgentCore 사용 사례가 비활성화되지만 `AgentCoreStack` 자체는 남아있습니다. 관리 콘솔을 열고 `agentCoreRegion`의 CloudFormation에서 `AgentCoreStack` 스택을 삭제하여 완전히 제거할 수 있습니다.
758+
759+
#### AgentCore Runtime 네트워크 설정
760+
761+
AgentCore Runtime은 다음 네트워크 모드에서 작동할 수 있습니다:
762+
763+
- `PUBLIC` (기본값): 퍼블릭 네트워크에서 작동
764+
- `PRIVATE`: VPC 내 프라이빗 네트워크에서 작동
765+
766+
네트워크 설정은 Generic Runtime과 AgentBuilder Runtime 모두에 적용됩니다.
767+
768+
**VPC 모드 사용 사례**:
769+
770+
- AgentCore Runtime에서 사내 시스템이나 프라이빗 데이터베이스에 액세스해야 하는 경우
771+
- 예를 들어, VPC 내의 다른 AWS 서비스(RDS, ElastiCache 등)와 직접 통신하고 싶은 경우
772+
773+
VPC 모드를 사용할 때는 다음 매개변수를 설정하세요:
774+
775+
- `agentCoreNetworkType`: `PRIVATE`로 설정
776+
- `agentCoreVpcId`: 사용할 VPC ID
777+
- `agentCoreSubnetIds`: 사용할 서브넷 ID 목록
778+
779+
> [!IMPORTANT]
780+
> **가용 영역(AZ) 지원**: AgentCore Runtime은 리전별로 지원되는 AZ가 제한되어 있습니다. 서브넷은 반드시 지원되는 AZ 내에 배치해야 합니다. 자세한 내용은 [AWS 공식 문서](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/agentcore-vpc.html#agentcore-supported-azs)를 확인하세요.
781+
>
782+
> **인터넷 액세스**: AgentCore Runtime에서 MCP 서버 설치에는 인터넷 액세스가 필요합니다. 프라이빗 서브넷이 연결 대상인 경우 NAT Gateway로의 경로를 설정하세요.
783+
784+
**[parameter.ts](/packages/cdk/parameter.ts) 편집**
785+
786+
```typescript
787+
// parameter.ts
788+
const envs: Record<string, Partial<StackInput>> = {
789+
dev: {
790+
createGenericAgentCoreRuntime: true,
791+
agentBuilderEnabled: true,
792+
agentCoreNetworkType: 'PRIVATE',
793+
agentCoreVpcId: 'vpc-xxxxxxxxx',
794+
agentCoreSubnetIds: ['subnet-xxxxxxxxx', 'subnet-yyyyyyyyy'],
795+
},
796+
};
797+
```
798+
799+
**[packages/cdk/cdk.json](/packages/cdk/cdk.json) 편집**
800+
801+
```json
802+
// cdk.json
803+
{
804+
"context": {
805+
"createGenericAgentCoreRuntime": true,
806+
"agentBuilderEnabled": true,
807+
"agentCoreNetworkType": "PRIVATE",
808+
"agentCoreVpcId": "vpc-xxxxxxxxx",
809+
"agentCoreSubnetIds": ["subnet-xxxxxxxxx", "subnet-yyyyyyyyy"]
810+
}
811+
}
812+
```
813+
814+
> [!WARNING]
815+
> VPC 모드를 사용할 때, 예를 들어 PRIVATE에서 PUBLIC으로의 변경으로 인해 AgentCore Runtime 삭제 시 보안 그룹이 자동 삭제되지 않습니다. AgentCore Runtime이 생성하는 AWS 관리형 ENI가 보안 그룹을 참조하기 때문에 CloudFormation에서는 삭제할 수 없습니다. AgentCore Runtime 삭제 후 관리형 ENI가 자동 삭제될 때까지 기다린 다음 수동으로 보안 그룹을 삭제하세요. 삭제가 필요한 보안 그룹 ID는 CloudFormation 출력에 표시됩니다.
816+
756817
### Voice Chat 사용 사례 활성화
757818

758819
> [!NOTE]

0 commit comments

Comments
 (0)