CodeInterpreter
bedrockagentcorecontrol.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | bedrockagentcorecontrol-controller/apis/v1alpha1#CodeInterpreter |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | CodeInterpreter |
| ListKind | CodeInterpreterList |
| Plural | codeinterpreters |
| Singular | codeinterpreter |
Spec
certificates:
location:
secretsManager:
secretARN: string
secretRef:
from:
name: string
namespace: string
description: string
executionRoleARN: string
executionRoleRef:
from:
name: string
namespace: string
name: string
networkConfiguration:
networkMode: string
vpcConfig:
securityGroupRefs:
from:
name: string
namespace: string
securityGroups:
- string
subnetRefs:
from:
name: string
namespace: string
subnets:
- string
tags: {}
| Field | Description |
|---|---|
| certificates Optional | array A list of certificates to install in the code interpreter. |
| certificates.[] Required | object A certificate to install in the browser or code interpreter. |
| certificates.[].location.secretsManager Optional | object The Amazon Web Services Secrets Manager location configuration. |
| certificates.[].location.secretsManager.secretARN Optional | string |
| certificates.[].location.secretsManager.secretRef Optional | object Reference field for SecretARN |
| certificates.[].location.secretsManager.secretRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| certificates.[].location.secretsManager.secretRef.from.name Optional | string |
| certificates.[].location.secretsManager.secretRef.from.namespace Optional | string |
| description Optional | string The description of the code interpreter. |
| executionRoleARN Optional | string The Amazon Resource Name (ARN) of the IAM role that provides permissions for the code interpreter to access Amazon Web Services services. Regex Pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$ |
| executionRoleRef Optional | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api |
| executionRoleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| executionRoleRef.from.name Optional | string |
| executionRoleRef.from.namespace Optional | string |
| name Required | string The name of the code interpreter. The name must be unique within your account. Regex Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,47}$ |
| networkConfiguration Required | object The network configuration for the code interpreter. This configuration specifies the network mode for the code interpreter. |
| networkConfiguration.networkMode Optional | string |
| networkConfiguration.vpcConfig Optional | object VpcConfig for the Agent. |
| networkConfiguration.vpcConfig.securityGroupRefs Optional | array Reference field for SecurityGroups |
| networkConfiguration.vpcConfig.securityGroupRefs.[] Required | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference |
| type to provide more user friendly syntax for references using ‘from’ field | |
| Ex: | |
| APIIDRef: |
from:
name: my-api || **networkConfiguration.vpcConfig.securityGroupRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| networkConfiguration.vpcConfig.securityGroupRefs.[].from.name
Optional | string
|
| networkConfiguration.vpcConfig.securityGroupRefs.[].from.namespace
Optional | string
|
| networkConfiguration.vpcConfig.securityGroups
Optional | array
|
| networkConfiguration.vpcConfig.securityGroups.[]
Required | string
|| networkConfiguration.vpcConfig.subnetRefs
Optional | array
Reference field for Subnets |
| networkConfiguration.vpcConfig.subnetRefs.[]
Required | object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:
from:
name: my-api || **networkConfiguration.vpcConfig.subnetRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| networkConfiguration.vpcConfig.subnetRefs.[].from.name
Optional | string
|
| networkConfiguration.vpcConfig.subnetRefs.[].from.namespace
Optional | string
|
| networkConfiguration.vpcConfig.subnets
Optional | array
|
| networkConfiguration.vpcConfig.subnets.[]
Required | string
|| tags
Optional | object
A map of tag keys and values to assign to the code interpreter. Tags enable
you to categorize your resources in different ways, for example, by purpose,
owner, or environment. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdAt: string
failureReason: string
id: string
lastUpdatedAt: string
status: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.partition Optional | string Partition is the AWS partition in which the resource exists or will exist |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| createdAt Optional | string The timestamp when the code interpreter was created. |
| failureReason Optional | string The reason for failure if the code interpreter is in a failed state. |
| id Optional | string The unique identifier of the created code interpreter. Regex Pattern: `^(aws.codeinterpreter.v1 |
| lastUpdatedAt Optional | string The timestamp when the code interpreter was last updated. |
| status Optional | string The current status of the code interpreter. |