Bedrock
22 resource kinds. Generated from the operator's CRD schemas.
aws.konfig.io/v1alpha1
BedrockAgent # CLOUD CONTROL · AWS::Bedrock::Agent
BedrockAgent manages AWS::Bedrock::Agent through the AWS Cloud Control API.
kubectl get bedrockagents · example on GitHub
Example
# BedrockAgent — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockagent
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockAgent
metadata:
name: example-bedrockagent
namespace: default
spec:
actionGroups:
- actionGroupName: example-bedrockagent
actionGroupState: ENABLED
description: Managed by konfig-konector
functionSchema:
functions:
- description: Managed by konfig-konector
name: example-bedrockagent
requireConfirmation: ENABLED
parentActionGroupSignature: AMAZON.UserInput
skipResourceInUseCheckOnDelete: false
agentCollaboration: DISABLED
agentCollaborators:
- agentDescriptor:
aliasArn: arn:aws:iam::123456789012:role/example-role
collaborationInstruction: example
collaboratorName: example-bedrockagent
relayConversationHistory: TO_COLLABORATOR
agentName: example-bedrockagent
agentResourceRoleArn: arn:aws:iam::123456789012:role/example-role
autoPrepare: false
customOrchestration:
executor:
lambda: example
customerEncryptionKeyArn: arn:aws:iam::123456789012:role/example-role
description: Managed by konfig-konector
foundationModel: example
guardrailConfiguration:
guardrailIdentifier: example
guardrailVersion: '1.0'
idleSessionTTLInSeconds: 300
instruction: example
knowledgeBases:
- description: Managed by konfig-konector
knowledgeBaseId: example-id
knowledgeBaseState: ENABLED
memoryConfiguration:
enabledMemoryTypes:
- example
sessionSummaryConfiguration:
maxRecentSessions: 1
storageDays: 7
orchestrationType: DEFAULT
promptOverrideConfiguration:
overrideLambda: example
promptConfigurations:
- basePromptTemplate: example
foundationModel: example
parserMode: DEFAULT
promptCreationMode: DEFAULT
promptState: ENABLED
promptType: PRE_PROCESSING
providerRef:
name: example-bedrockagent
region: us-east-1
skipResourceInUseCheckOnDelete: false
tags:
environment: dev
team: platform
testAliasTags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
actionGroups | array<object> | — | List of ActionGroups |
actionGroups[].actionGroupExecutor | object | — | |
actionGroups[].actionGroupName | string | yes | Name of the action group |
actionGroups[].actionGroupState | enum | — | Allowed: ENABLED, DISABLED |
actionGroups[].apiSchema | object | — | |
actionGroups[].description | string | — | Description of action group |
actionGroups[].functionSchema | object | — | BedrockAgentFunctionSchema is a nested property type of AWS::Bedrock::Agent. |
actionGroups[].functionSchema.functions | array<object> | yes | List of Function definitions |
actionGroups[].functionSchema.functions[].description | string | — | Description of function |
actionGroups[].functionSchema.functions[].name | string | yes | Name for a resource. |
actionGroups[].functionSchema.functions[].parameters | map<string> | — | |
actionGroups[].functionSchema.functions[].requireConfirmation | enum | — | Allowed: ENABLED, DISABLED |
actionGroups[].parentActionGroupSignature | enum | — | Allowed: AMAZON.UserInput, AMAZON.CodeInterpreter |
actionGroups[].skipResourceInUseCheckOnDelete | boolean | — | Specifies whether to allow deleting action group while it is in use. |
agentCollaboration | enum | — | Allowed: DISABLED, SUPERVISOR, SUPERVISOR_ROUTER |
agentCollaborators | array<object> | — | List of Agent Collaborators |
agentCollaborators[].agentDescriptor | object | yes | Agent descriptor for agent collaborator |
agentCollaborators[].agentDescriptor.aliasArn | string | — | Alias ARN for agent descriptor |
agentCollaborators[].collaborationInstruction | string | yes | Agent collaborator instruction |
agentCollaborators[].collaboratorName | string | yes | Agent collaborator name |
agentCollaborators[].relayConversationHistory | enum | — | Allowed: TO_COLLABORATOR, DISABLED |
agentName | string | yes | Name for a resource. |
agentResourceRoleArn | string | — | ARN of a IAM role. |
autoPrepare | boolean | — | Specifies whether to automatically prepare after creating or updating the agent. |
customOrchestration | object | — | BedrockAgentCustomOrchestration is a nested property type of AWS::Bedrock::Agent. |
customOrchestration.executor | object | — | BedrockAgentOrchestrationExecutor is a nested property type of AWS::Bedrock::Agent. |
customOrchestration.executor.lambda | string | yes | ARN of a Lambda. |
customerEncryptionKeyArn | string | — | A KMS key ARN |
description | string | — | Description of the Resource. |
foundationModel | string | — | |
guardrailConfiguration | object | — | BedrockAgentGuardrailConfiguration is a nested property type of AWS::Bedrock::Agent. |
guardrailConfiguration.guardrailIdentifier | string | — | Identifier for the guardrail, could be the id or the arn |
guardrailConfiguration.guardrailVersion | string | — | Version of the guardrail |
idleSessionTTLInSeconds | number | — | Max Session Time. |
instruction | string | — | Instruction for the agent. |
knowledgeBases | array<object> | — | List of Agent Knowledge Bases |
knowledgeBases[].description | string | yes | Description of the Resource. |
knowledgeBases[].knowledgeBaseId | string | yes | Identifier for a resource. |
knowledgeBases[].knowledgeBaseState | enum | — | Allowed: ENABLED, DISABLED |
memoryConfiguration | object | — | BedrockAgentMemoryConfiguration is a nested property type of AWS::Bedrock::Agent. |
memoryConfiguration.enabledMemoryTypes | array<string> | — | |
memoryConfiguration.sessionSummaryConfiguration | object | — | BedrockAgentSessionSummaryConfiguration is a nested property type of AWS::Bedrock::Agent. |
memoryConfiguration.sessionSummaryConfiguration.maxRecentSessions | number | — | Maximum number of Sessions to Summarize |
memoryConfiguration.storageDays | number | — | Maximum number of days to store session details |
orchestrationType | enum | — | Allowed: DEFAULT, CUSTOM_ORCHESTRATION |
promptOverrideConfiguration | object | — | BedrockAgentPromptOverrideConfiguration is a nested property type of AWS::Bedrock::Agent. |
promptOverrideConfiguration.overrideLambda | string | — | ARN of a Lambda. |
promptOverrideConfiguration.promptConfigurations | array<object> | yes | List of BasePromptConfiguration |
promptOverrideConfiguration.promptConfigurations[].additionalModelRequestFields | object | — | |
promptOverrideConfiguration.promptConfigurations[].basePromptTemplate | string | — | Base Prompt Template. |
promptOverrideConfiguration.promptConfigurations[].foundationModel | string | — | |
promptOverrideConfiguration.promptConfigurations[].inferenceConfiguration | object | — | BedrockAgentInferenceConfiguration is a nested property type of AWS::Bedrock::Agent. |
promptOverrideConfiguration.promptConfigurations[].inferenceConfiguration.maximumLength | number | — | Maximum length of output |
promptOverrideConfiguration.promptConfigurations[].inferenceConfiguration.stopSequences | array<string> | — | List of stop sequences |
promptOverrideConfiguration.promptConfigurations[].inferenceConfiguration.temperature | number | — | Controls randomness, higher values increase diversity |
promptOverrideConfiguration.promptConfigurations[].inferenceConfiguration.topK | number | — | Sample from the k most likely next tokens |
promptOverrideConfiguration.promptConfigurations[].inferenceConfiguration.topP | number | — | Cumulative probability cutoff for token selection |
promptOverrideConfiguration.promptConfigurations[].parserMode | enum | — | Allowed: DEFAULT, OVERRIDDEN |
promptOverrideConfiguration.promptConfigurations[].promptCreationMode | enum | — | Allowed: DEFAULT, OVERRIDDEN |
promptOverrideConfiguration.promptConfigurations[].promptState | enum | — | Allowed: ENABLED, DISABLED |
promptOverrideConfiguration.promptConfigurations[].promptType | enum | — | Allowed: PRE_PROCESSING, ORCHESTRATION, POST_PROCESSING, ROUTING_CLASSIFIER, MEMORY_SUMMARIZATION, KNOWLEDGE_BASE_RESPONSE_GENERATION |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
skipResourceInUseCheckOnDelete | boolean | — | Specifies whether to allow deleting agent while it is in use. |
tags | map<string> | — | |
testAliasTags | map<string> | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
agentArn | string | — | Arn representation of the Agent. |
agentId | string | — | Identifier for a resource. |
agentStatus | enum | — | Read-only: reported by AWS after creation. Allowed: CREATING, PREPARING, PREPARED, NOT_PREPARED, DELETING, FAILED, VERSIONING, UPDATING |
agentVersion | string | — | Draft Agent Version. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Time Stamp. |
failureReasons | array<string> | — | Failure Reasons for Error. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
preparedAt | string | — | Time Stamp. |
recommendedActions | array<string> | — | The recommended actions users can take to resolve an error in failureReasons. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
updatedAt | string | — | Time Stamp. |
BedrockAgentAlias # CLOUD CONTROL · AWS::Bedrock::AgentAlias
BedrockAgentAlias manages AWS::Bedrock::AgentAlias through the AWS Cloud Control API.
kubectl get bedrockagentaliases · example on GitHub
Example
# BedrockAgentAlias — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockagentalias
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockAgentAlias
metadata:
name: example-bedrockagentalias
namespace: default
spec:
agentAliasName: example-bedrockagentalias
agentId: example-id
description: Managed by konfig-konector
providerRef:
name: example-bedrockagentalias
region: us-east-1
routingConfiguration:
- agentVersion: '1.0'
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
agentAliasName | string | yes | Name for a resource. |
agentId | string | yes | Identifier for a resource. |
description | string | — | Description of the Resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
routingConfiguration | array<object> | — | Routing configuration for an Agent alias. |
routingConfiguration[].agentVersion | string | yes | Agent Version. |
tags | map<string> | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
agentAliasArn | string | — | Arn representation of the Agent Alias. |
agentAliasHistoryEvents | array<object> | — | The list of history events for an alias for an Agent. |
agentAliasHistoryEvents[].endDate | string | — | Time Stamp. |
agentAliasHistoryEvents[].routingConfiguration | array<object> | — | Routing configuration for an Agent alias. |
agentAliasHistoryEvents[].routingConfiguration[].agentVersion | string | yes | Agent Version. |
agentAliasHistoryEvents[].startDate | string | — | Time Stamp. |
agentAliasId | string | — | Id for an Agent Alias generated at the server side. |
agentAliasStatus | enum | — | Read-only: reported by AWS after creation. Allowed: CREATING, PREPARED, FAILED, UPDATING, DELETING |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Time Stamp. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
updatedAt | string | — | Time Stamp. |
BedrockApplicationInferenceProfile # CLOUD CONTROL · AWS::Bedrock::ApplicationInferenceProfile
BedrockApplicationInferenceProfile manages AWS::Bedrock::ApplicationInferenceProfile through the AWS Cloud Control API.
kubectl get bedrockapplicationinferenceprofiles · example on GitHub
Example
# BedrockApplicationInferenceProfile — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockapplicationinferenceprofile
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockApplicationInferenceProfile
metadata:
name: example-bedrockapplicationinferenceprofile
namespace: default
spec:
description: Managed by konfig-konector
inferenceProfileName: example-bedrockapplicationinferenceprofile
providerRef:
name: example-bedrockapplicationinferenceprofile
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description of the inference profile Create-only in AWS: changing it requires replacing the resource. |
inferenceProfileName | string | yes | Create-only in AWS: changing it requires replacing the resource. |
modelSource | object | — | Create-only in AWS: changing it requires replacing the resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | array<object> | — | List of Tags |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Time Stamp Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
inferenceProfileArn | string | — | Read-only: reported by AWS after creation. |
inferenceProfileId | string | — | Read-only: reported by AWS after creation. |
inferenceProfileIdentifier | string | — | Inference profile identifier. |
lastSyncTime | string | — | |
models | array<object> | — | List of model configuration Read-only: reported by AWS after creation. |
models[].modelArn | string | — | ARN for Foundation Models in Bedrock. |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | enum | — | Read-only: reported by AWS after creation. Allowed: ACTIVE |
type | enum | — | Read-only: reported by AWS after creation. Allowed: APPLICATION, SYSTEM_DEFINED |
updatedAt | string | — | Time Stamp Read-only: reported by AWS after creation. |
BedrockAutomatedReasoningPolicy # CLOUD CONTROL · AWS::Bedrock::AutomatedReasoningPolicy
BedrockAutomatedReasoningPolicy manages AWS::Bedrock::AutomatedReasoningPolicy through the AWS Cloud Control API.
kubectl get bedrockautomatedreasoningpolicies · example on GitHub
Example
# BedrockAutomatedReasoningPolicy — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockautomatedreasoningpolicy
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockAutomatedReasoningPolicy
metadata:
name: example-bedrockautomatedreasoningpolicy
namespace: default
spec:
description: Managed by konfig-konector
forceDelete: false
kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
name: example-bedrockautomatedreasoningpolicy
policyDefinition:
rules:
- alternateExpression: example
expression: example
id: example-id-x
types:
- description: Managed by konfig-konector
name: example-bedrockautomatedreasoningpolicy
values:
- description: Managed by konfig-konector
value: example
variables:
- description: Managed by konfig-konector
name: example-bedrockautomatedreasoningpolicy
type: example
version: '1.0'
providerRef:
name: example-bedrockautomatedreasoningpolicy
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | |
forceDelete | boolean | — | |
kmsKeyId | string | — | Create-only in AWS: changing it requires replacing the resource. |
name | string | yes | |
policyDefinition | object | — | BedrockAutomatedReasoningPolicyPolicyDefinition is a nested property type of AWS::Bedrock::AutomatedReasoningPolicy. |
policyDefinition.rules | array<object> | — | The rules definition block of an AutomatedReasoningPolicyDefinition. |
policyDefinition.rules[].alternateExpression | string | — | An alternate expression for this rule |
policyDefinition.rules[].expression | string | yes | The SMT expression for this rule |
policyDefinition.rules[].id | string | yes | A unique id within the PolicyDefinition |
policyDefinition.types | array<object> | — | The types definition block of an AutomatedReasoningPolicyDefinition. |
policyDefinition.types[].description | string | — | A natural language description of this type. |
policyDefinition.types[].name | string | yes | A name for this type. |
policyDefinition.types[].values | array<object> | yes | A list of valid values for this type. |
policyDefinition.types[].values[].description | string | — | A natural language description of the type's value. |
policyDefinition.types[].values[].value | string | yes | The value of the type value. |
policyDefinition.variables | array<object> | — | The variables definition block of an AutomatedReasoningPolicyDefinition. |
policyDefinition.variables[].description | string | yes | A natural language description of this variable. |
policyDefinition.variables[].name | string | yes | A name from this variable. |
policyDefinition.variables[].type | string | yes | A type for this variable. |
policyDefinition.version | string | — | The policy format version. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | array<object> | — | |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Read-only: reported by AWS after creation. |
definitionHash | string | — | Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
kmsKeyArn | string | — | Read-only: reported by AWS after creation. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
policyArn | string | — | Read-only: reported by AWS after creation. |
policyId | string | — | Read-only: reported by AWS after creation. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
updatedAt | string | — | Read-only: reported by AWS after creation. |
version | string | — | Read-only: reported by AWS after creation. |
BedrockAutomatedReasoningPolicyVersion # CLOUD CONTROL · AWS::Bedrock::AutomatedReasoningPolicyVersion
BedrockAutomatedReasoningPolicyVersion manages AWS::Bedrock::AutomatedReasoningPolicyVersion through the AWS Cloud Control API.
kubectl get bedrockautomatedreasoningpolicyversions · example on GitHub
Example
# BedrockAutomatedReasoningPolicyVersion — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockautomatedreasoningpolicyversion
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockAutomatedReasoningPolicyVersion
metadata:
name: example-bedrockautomatedreasoningpolicyversion
namespace: default
spec:
lastUpdatedDefinitionHash: example
policyArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-bedrockautomatedreasoningpolicyversion
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
lastUpdatedDefinitionHash | string | — | Create-only in AWS: changing it requires replacing the resource. |
policyArn | string | yes | Create-only in AWS: changing it requires replacing the resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | array<object> | — | Create-only in AWS: changing it requires replacing the resource. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Read-only: reported by AWS after creation. |
definitionHash | string | — | Read-only: reported by AWS after creation. |
description | string | — | Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
name | string | — | Read-only: reported by AWS after creation. |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
policyId | string | — | Read-only: reported by AWS after creation. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
updatedAt | string | — | Read-only: reported by AWS after creation. |
version | string | — | Read-only: reported by AWS after creation. |
BedrockBlueprint # CLOUD CONTROL · AWS::Bedrock::Blueprint
BedrockBlueprint manages AWS::Bedrock::Blueprint through the AWS Cloud Control API.
kubectl get bedrockblueprints · example on GitHub
Example
# BedrockBlueprint — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockblueprint
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockBlueprint
metadata:
name: example-bedrockblueprint
namespace: default
spec:
blueprintName: example-bedrockblueprint
kmsEncryptionContext:
key: value
kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
providerRef:
name: example-bedrockblueprint
region: us-east-1
tags:
- key: example
value: example
type: DOCUMENT
Spec
| Field | Type | Required | Description |
|---|---|---|---|
blueprintName | string | yes | Name of the Blueprint Create-only in AWS: changing it requires replacing the resource. |
kmsEncryptionContext | map<string> | — | KMS encryption context |
kmsKeyId | string | — | KMS key identifier |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
schema | object | yes | Schema of the blueprint |
tags | array<object> | — | List of Tags |
tags[].key | string | yes | |
tags[].value | string | yes | |
type | enum | yes | Modality Type Create-only in AWS: changing it requires replacing the resource. Allowed: DOCUMENT, IMAGE, AUDIO, VIDEO |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
blueprintArn | string | — | ARN of a Blueprint Read-only: reported by AWS after creation. |
blueprintStage | enum | — | Stage of the Blueprint Read-only: reported by AWS after creation. Allowed: DEVELOPMENT, LIVE |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
creationTime | string | — | Creation timestamp Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastModifiedTime | string | — | Last modified timestamp Read-only: reported by AWS after creation. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
BedrockDataAutomationLibrary # CLOUD CONTROL · AWS::Bedrock::DataAutomationLibrary
BedrockDataAutomationLibrary manages AWS::Bedrock::DataAutomationLibrary through the AWS Cloud Control API.
kubectl get bedrockdataautomationlibraries · example on GitHub
Example
# BedrockDataAutomationLibrary — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockdataautomationlibrary
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockDataAutomationLibrary
metadata:
name: example-bedrockdataautomationlibrary
namespace: default
spec:
encryptionConfiguration:
kmsEncryptionContext:
key: value
kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
libraryDescription: Managed by konfig-konector
libraryName: example-bedrockdataautomationlibrary
providerRef:
name: example-bedrockdataautomationlibrary
region: us-east-1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
encryptionConfiguration | object | — | Create-only in AWS: changing it requires replacing the resource. |
encryptionConfiguration.kmsEncryptionContext | map<string> | — | |
encryptionConfiguration.kmsKeyId | string | yes | KMS Key Identifier |
libraryDescription | string | — | Description of the DataAutomationLibrary |
libraryName | string | yes | Name of the DataAutomationLibrary Create-only in AWS: changing it requires replacing the resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | array<object> | — | List of tags |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
creationTime | string | — | Time Stamp Read-only: reported by AWS after creation. |
entityTypes | array<object> | — | List of info for each entity type in the DataAutomationLibrary Read-only: reported by AWS after creation. |
entityTypes[].entityMetadata | string | — | JSON string representing relevant metadata for the entity type |
entityTypes[].entityType | enum | yes | Allowed: VOCABULARY |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
libraryArn | string | — | ARN generated at the server side when a DataAutomationLibrary is created Read-only: reported by AWS after creation. |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | enum | — | Read-only: reported by AWS after creation. Allowed: ACTIVE, DELETING |
BedrockDataAutomationProject # CLOUD CONTROL · AWS::Bedrock::DataAutomationProject
BedrockDataAutomationProject manages AWS::Bedrock::DataAutomationProject through the AWS Cloud Control API.
kubectl get bedrockdataautomationprojects · example on GitHub
Example
# BedrockDataAutomationProject — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockdataautomationproject
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockDataAutomationProject
metadata:
name: example-bedrockdataautomationproject
namespace: default
spec:
customOutputConfiguration:
blueprints:
- blueprintArn: arn:aws:iam::123456789012:role/example-role
blueprintStage: DEVELOPMENT
blueprintVersion: '1.0'
kmsEncryptionContext:
key: value
kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
overrideConfiguration:
audio:
languageConfiguration:
generativeOutputLanguage: DEFAULT
identifyMultipleLanguages: false
inputLanguages:
- example
modalityProcessing:
state: ENABLED
sensitiveDataConfiguration:
detectionMode: DETECTION
detectionScope:
- example
document:
modalityProcessing:
state: ENABLED
sensitiveDataConfiguration:
detectionMode: DETECTION
detectionScope:
- example
splitter:
state: ENABLED
image:
modalityProcessing:
state: ENABLED
sensitiveDataConfiguration:
detectionMode: DETECTION
detectionScope:
- example
modalityRouting:
jpeg: DOCUMENT
mov: DOCUMENT
mp4: DOCUMENT
png: DOCUMENT
video:
modalityProcessing:
state: ENABLED
sensitiveDataConfiguration:
detectionMode: DETECTION
detectionScope:
- example
projectDescription: Managed by konfig-konector
projectName: example-bedrockdataautomationproject
projectType: ASYNC
providerRef:
name: example-bedrockdataautomationproject
region: us-east-1
standardOutputConfiguration:
audio:
extraction:
category:
state: ENABLED
types:
- example
generativeField:
state: ENABLED
types:
- example
document:
extraction:
boundingBox:
state: ENABLED
granularity:
types:
- example
generativeField:
state: ENABLED
outputFormat:
additionalFileFormat:
state: ENABLED
textFormat:
types:
- example
image:
extraction:
boundingBox:
state: ENABLED
category:
state: ENABLED
types:
- example
generativeField:
state: ENABLED
types:
- example
video:
extraction:
boundingBox:
state: ENABLED
category:
state: ENABLED
types:
- example
generativeField:
state: ENABLED
types:
- example
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
customOutputConfiguration | object | — | BedrockDataAutomationProjectCustomOutputConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
customOutputConfiguration.blueprints | array<object> | — | |
customOutputConfiguration.blueprints[].blueprintArn | string | yes | ARN of a Blueprint |
customOutputConfiguration.blueprints[].blueprintStage | enum | — | Allowed: DEVELOPMENT, LIVE |
customOutputConfiguration.blueprints[].blueprintVersion | string | — | Blueprint Version |
kmsEncryptionContext | map<string> | — | KMS encryption context |
kmsKeyId | string | — | KMS key identifier |
overrideConfiguration | object | — | BedrockDataAutomationProjectOverrideConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.audio | object | — | BedrockDataAutomationProjectAudioOverrideConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.audio.languageConfiguration | object | — | BedrockDataAutomationProjectAudioLanguageConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.audio.languageConfiguration.generativeOutputLanguage | enum | — | Allowed: DEFAULT, EN |
overrideConfiguration.audio.languageConfiguration.identifyMultipleLanguages | boolean | — | |
overrideConfiguration.audio.languageConfiguration.inputLanguages | array<string> | — | |
overrideConfiguration.audio.modalityProcessing | object | — | BedrockDataAutomationProjectModalityProcessingConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.audio.modalityProcessing.state | enum | — | Allowed: ENABLED, DISABLED |
overrideConfiguration.audio.sensitiveDataConfiguration | object | — | BedrockDataAutomationProjectSensitiveDataConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.audio.sensitiveDataConfiguration.detectionMode | enum | — | Allowed: DETECTION, DETECTION_AND_REDACTION |
overrideConfiguration.audio.sensitiveDataConfiguration.detectionScope | array<string> | — | |
overrideConfiguration.audio.sensitiveDataConfiguration.piiEntitiesConfiguration | object | — | BedrockDataAutomationProjectPIIEntitiesConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.audio.sensitiveDataConfiguration.piiEntitiesConfiguration.piiEntityTypes | array<string> | — | |
overrideConfiguration.audio.sensitiveDataConfiguration.piiEntitiesConfiguration.redactionMaskMode | enum | — | Allowed: PII, ENTITY_TYPE |
overrideConfiguration.document | object | — | BedrockDataAutomationProjectDocumentOverrideConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.document.modalityProcessing | object | — | BedrockDataAutomationProjectModalityProcessingConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.document.modalityProcessing.state | enum | — | Allowed: ENABLED, DISABLED |
overrideConfiguration.document.sensitiveDataConfiguration | object | — | BedrockDataAutomationProjectSensitiveDataConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.document.sensitiveDataConfiguration.detectionMode | enum | — | Allowed: DETECTION, DETECTION_AND_REDACTION |
overrideConfiguration.document.sensitiveDataConfiguration.detectionScope | array<string> | — | |
overrideConfiguration.document.sensitiveDataConfiguration.piiEntitiesConfiguration | object | — | BedrockDataAutomationProjectPIIEntitiesConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.document.sensitiveDataConfiguration.piiEntitiesConfiguration.piiEntityTypes | array<string> | — | |
overrideConfiguration.document.sensitiveDataConfiguration.piiEntitiesConfiguration.redactionMaskMode | enum | — | Allowed: PII, ENTITY_TYPE |
overrideConfiguration.document.splitter | object | — | BedrockDataAutomationProjectSplitterConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.document.splitter.state | enum | — | Allowed: ENABLED, DISABLED |
overrideConfiguration.image | object | — | BedrockDataAutomationProjectImageOverrideConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.image.modalityProcessing | object | — | BedrockDataAutomationProjectModalityProcessingConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.image.modalityProcessing.state | enum | — | Allowed: ENABLED, DISABLED |
overrideConfiguration.image.sensitiveDataConfiguration | object | — | BedrockDataAutomationProjectSensitiveDataConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.image.sensitiveDataConfiguration.detectionMode | enum | — | Allowed: DETECTION, DETECTION_AND_REDACTION |
overrideConfiguration.image.sensitiveDataConfiguration.detectionScope | array<string> | — | |
overrideConfiguration.image.sensitiveDataConfiguration.piiEntitiesConfiguration | object | — | BedrockDataAutomationProjectPIIEntitiesConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.image.sensitiveDataConfiguration.piiEntitiesConfiguration.piiEntityTypes | array<string> | — | |
overrideConfiguration.image.sensitiveDataConfiguration.piiEntitiesConfiguration.redactionMaskMode | enum | — | Allowed: PII, ENTITY_TYPE |
overrideConfiguration.modalityRouting | object | — | BedrockDataAutomationProjectModalityRoutingConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.modalityRouting.jpeg | enum | — | Allowed: DOCUMENT, IMAGE, VIDEO, AUDIO |
overrideConfiguration.modalityRouting.mov | enum | — | Allowed: DOCUMENT, IMAGE, VIDEO, AUDIO |
overrideConfiguration.modalityRouting.mp4 | enum | — | Allowed: DOCUMENT, IMAGE, VIDEO, AUDIO |
overrideConfiguration.modalityRouting.png | enum | — | Allowed: DOCUMENT, IMAGE, VIDEO, AUDIO |
overrideConfiguration.video | object | — | BedrockDataAutomationProjectVideoOverrideConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.video.modalityProcessing | object | — | BedrockDataAutomationProjectModalityProcessingConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.video.modalityProcessing.state | enum | — | Allowed: ENABLED, DISABLED |
overrideConfiguration.video.sensitiveDataConfiguration | object | — | BedrockDataAutomationProjectSensitiveDataConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.video.sensitiveDataConfiguration.detectionMode | enum | — | Allowed: DETECTION, DETECTION_AND_REDACTION |
overrideConfiguration.video.sensitiveDataConfiguration.detectionScope | array<string> | — | |
overrideConfiguration.video.sensitiveDataConfiguration.piiEntitiesConfiguration | object | — | BedrockDataAutomationProjectPIIEntitiesConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
overrideConfiguration.video.sensitiveDataConfiguration.piiEntitiesConfiguration.piiEntityTypes | array<string> | — | |
overrideConfiguration.video.sensitiveDataConfiguration.piiEntitiesConfiguration.redactionMaskMode | enum | — | Allowed: PII, ENTITY_TYPE |
projectDescription | string | — | Description of the DataAutomationProject |
projectName | string | yes | Name of the DataAutomationProject Create-only in AWS: changing it requires replacing the resource. |
projectType | enum | — | Type of the DataAutomationProject - Sync or Async Create-only in AWS: changing it requires replacing the resource. Allowed: ASYNC, SYNC |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
standardOutputConfiguration | object | — | BedrockDataAutomationProjectStandardOutputConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.audio | object | — | BedrockDataAutomationProjectAudioStandardOutputConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.audio.extraction | object | — | BedrockDataAutomationProjectAudioStandardExtraction is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.audio.extraction.category | object | yes | BedrockDataAutomationProjectAudioExtractionCategory is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.audio.extraction.category.state | enum | yes | Allowed: ENABLED, DISABLED |
standardOutputConfiguration.audio.extraction.category.typeConfiguration | object | — | BedrockDataAutomationProjectAudioExtractionCategoryTypeConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.audio.extraction.category.typeConfiguration.transcript | object | — | BedrockDataAutomationProjectTranscriptConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.audio.extraction.category.types | array<string> | — | |
standardOutputConfiguration.audio.generativeField | object | — | BedrockDataAutomationProjectAudioStandardGenerativeField is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.audio.generativeField.state | enum | yes | Allowed: ENABLED, DISABLED |
standardOutputConfiguration.audio.generativeField.types | array<string> | — | |
standardOutputConfiguration.document | object | — | BedrockDataAutomationProjectDocumentStandardOutputConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.document.extraction | object | — | BedrockDataAutomationProjectDocumentStandardExtraction is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.document.extraction.boundingBox | object | yes | BedrockDataAutomationProjectDocumentBoundingBox is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.document.extraction.boundingBox.state | enum | yes | Allowed: ENABLED, DISABLED |
standardOutputConfiguration.document.extraction.granularity | object | yes | BedrockDataAutomationProjectDocumentExtractionGranularity is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.document.extraction.granularity.types | array<string> | — | |
standardOutputConfiguration.document.generativeField | object | — | BedrockDataAutomationProjectDocumentStandardGenerativeField is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.document.generativeField.state | enum | yes | Allowed: ENABLED, DISABLED |
standardOutputConfiguration.document.outputFormat | object | — | BedrockDataAutomationProjectDocumentOutputFormat is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.document.outputFormat.additionalFileFormat | object | yes | BedrockDataAutomationProjectDocumentOutputAdditionalFileFormat is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.document.outputFormat.additionalFileFormat.state | enum | yes | Allowed: ENABLED, DISABLED |
standardOutputConfiguration.document.outputFormat.textFormat | object | yes | BedrockDataAutomationProjectDocumentOutputTextFormat is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.document.outputFormat.textFormat.types | array<string> | — | |
standardOutputConfiguration.image | object | — | BedrockDataAutomationProjectImageStandardOutputConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.image.extraction | object | — | BedrockDataAutomationProjectImageStandardExtraction is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.image.extraction.boundingBox | object | yes | BedrockDataAutomationProjectImageBoundingBox is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.image.extraction.boundingBox.state | enum | yes | Allowed: ENABLED, DISABLED |
standardOutputConfiguration.image.extraction.category | object | yes | BedrockDataAutomationProjectImageExtractionCategory is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.image.extraction.category.state | enum | yes | Allowed: ENABLED, DISABLED |
standardOutputConfiguration.image.extraction.category.types | array<string> | — | |
standardOutputConfiguration.image.generativeField | object | — | BedrockDataAutomationProjectImageStandardGenerativeField is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.image.generativeField.state | enum | yes | Allowed: ENABLED, DISABLED |
standardOutputConfiguration.image.generativeField.types | array<string> | — | |
standardOutputConfiguration.video | object | — | BedrockDataAutomationProjectVideoStandardOutputConfiguration is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.video.extraction | object | — | BedrockDataAutomationProjectVideoStandardExtraction is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.video.extraction.boundingBox | object | yes | BedrockDataAutomationProjectVideoBoundingBox is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.video.extraction.boundingBox.state | enum | yes | Allowed: ENABLED, DISABLED |
standardOutputConfiguration.video.extraction.category | object | yes | BedrockDataAutomationProjectVideoExtractionCategory is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.video.extraction.category.state | enum | yes | Allowed: ENABLED, DISABLED |
standardOutputConfiguration.video.extraction.category.types | array<string> | — | |
standardOutputConfiguration.video.generativeField | object | — | BedrockDataAutomationProjectVideoStandardGenerativeField is a nested property type of AWS::Bedrock::DataAutomationProject. |
standardOutputConfiguration.video.generativeField.state | enum | yes | Allowed: ENABLED, DISABLED |
standardOutputConfiguration.video.generativeField.types | array<string> | — | |
tags | array<object> | — | List of Tags |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
creationTime | string | — | Time Stamp Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastModifiedTime | string | — | Time Stamp Read-only: reported by AWS after creation. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
projectArn | string | — | ARN of a DataAutomationProject Read-only: reported by AWS after creation. |
projectStage | enum | — | Read-only: reported by AWS after creation. Allowed: DEVELOPMENT, LIVE |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | enum | — | Read-only: reported by AWS after creation. Allowed: COMPLETED, IN_PROGRESS, FAILED |
BedrockDataSource # CLOUD CONTROL · AWS::Bedrock::DataSource
BedrockDataSource manages AWS::Bedrock::DataSource through the AWS Cloud Control API.
kubectl get bedrockdatasources · example on GitHub
Example
# BedrockDataSource — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockdatasource
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockDataSource
metadata:
name: example-bedrockdatasource
namespace: default
spec:
dataDeletionPolicy: RETAIN
dataSourceConfiguration:
confluenceConfiguration:
sourceConfiguration:
authType: BASIC
credentialsSecretArn: arn:aws:iam::123456789012:role/example-role
hostType: SAAS
hostUrl: example
managedKnowledgeBaseConnectorConfiguration:
deletionProtectionConfiguration:
deletionProtectionStatus: ENABLED
deletionProtectionThreshold: 1
s3Configuration:
bucketArn: arn:aws:iam::123456789012:role/example-role
bucketOwnerAccountId: '123456789012'
inclusionPrefixes:
- example
salesforceConfiguration:
sourceConfiguration:
authType: OAUTH2_CLIENT_CREDENTIALS
credentialsSecretArn: arn:aws:iam::123456789012:role/example-role
hostUrl: example
sharePointConfiguration:
sourceConfiguration:
authType: OAUTH2_CLIENT_CREDENTIALS
credentialsSecretArn: arn:aws:iam::123456789012:role/example-role
domain: example
hostType: ONLINE
siteUrls:
- example
type: S3
webConfiguration:
crawlerConfiguration:
exclusionFilters:
- example
inclusionFilters:
- example
scope: HOST_ONLY
userAgent: example
userAgentHeader: example
sourceConfiguration:
urlConfiguration:
seedUrls:
- url: example
description: Managed by konfig-konector
knowledgeBaseId: example-id
name: example-bedrockdatasource
providerRef:
name: example-bedrockdatasource
region: us-east-1
serverSideEncryptionConfiguration:
kmsKeyArn: arn:aws:iam::123456789012:role/example-role
vectorIngestionConfiguration:
chunkingConfiguration:
chunkingStrategy: FIXED_SIZE
fixedSizeChunkingConfiguration:
maxTokens: 1
overlapPercentage: 1
hierarchicalChunkingConfiguration:
levelConfigurations:
- maxTokens: 1
overlapTokens: 1
semanticChunkingConfiguration:
breakpointPercentileThreshold: 50
bufferSize: 1
maxTokens: 1
contextEnrichmentConfiguration:
bedrockFoundationModelConfiguration:
enrichmentStrategyConfiguration:
method: CHUNK_ENTITY_EXTRACTION
modelArn: arn:aws:iam::123456789012:role/example-role
type: BEDROCK_FOUNDATION_MODEL
customTransformationConfiguration:
intermediateStorage:
s3Location:
uri: example
transformations:
- stepToApply: POST_CHUNKING
transformationFunction:
transformationLambdaConfiguration:
lambdaArn: arn:aws:iam::123456789012:role/example-role
parsingConfiguration:
bedrockDataAutomationConfiguration:
parsingModality: MULTIMODAL
bedrockFoundationModelConfiguration:
modelArn: arn:aws:iam::123456789012:role/example-role
parsingModality: MULTIMODAL
parsingStrategy: BEDROCK_FOUNDATION_MODEL
Spec
| Field | Type | Required | Description |
|---|---|---|---|
dataDeletionPolicy | enum | — | Allowed: RETAIN, DELETE |
dataSourceConfiguration | object | yes | BedrockDataSourceDataSourceConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.confluenceConfiguration | object | — | BedrockDataSourceConfluenceDataSourceConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.confluenceConfiguration.crawlerConfiguration | object | — | BedrockDataSourceConfluenceCrawlerConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.confluenceConfiguration.crawlerConfiguration.filterConfiguration | object | — | BedrockDataSourceCrawlFilterConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.confluenceConfiguration.crawlerConfiguration.filterConfiguration.patternObjectFilter | object | — | BedrockDataSourcePatternObjectFilterConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.confluenceConfiguration.crawlerConfiguration.filterConfiguration.patternObjectFilter.filters | array<object> | yes | |
dataSourceConfiguration.confluenceConfiguration.crawlerConfiguration.filterConfiguration.type | enum | yes | The crawl filter type. Allowed: PATTERN |
dataSourceConfiguration.confluenceConfiguration.sourceConfiguration | object | yes | BedrockDataSourceConfluenceSourceConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.confluenceConfiguration.sourceConfiguration.authType | enum | yes | The supported authentication type to authenticate and connect to your Confluence instance. Allowed: BASIC, OAUTH2_CLIENT_CREDENTIALS |
dataSourceConfiguration.confluenceConfiguration.sourceConfiguration.credentialsSecretArn | string | yes | The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. |
dataSourceConfiguration.confluenceConfiguration.sourceConfiguration.hostType | enum | yes | The supported host type, whether online/cloud or server/on-premises. Allowed: SAAS |
dataSourceConfiguration.confluenceConfiguration.sourceConfiguration.hostUrl | string | yes | The Confluence host URL or instance URL. |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration | object | — | BedrockDataSourceManagedKnowledgeBaseConnectorConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration.connectorParameters | object | — | Connector-specific parameters. |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration.deletionProtectionConfiguration | object | — | BedrockDataSourceDeletionProtectionConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration.deletionProtectionConfiguration.deletionProtectionStatus | enum | yes | Allowed: ENABLED, DISABLED |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration.deletionProtectionConfiguration.deletionProtectionThreshold | integer | — | Threshold for deletion protection. |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration.mediaExtractionConfiguration | object | — | BedrockDataSourceMediaExtractionConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration.mediaExtractionConfiguration.audioExtractionConfiguration | object | — | BedrockDataSourceAudioExtractionConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration.mediaExtractionConfiguration.audioExtractionConfiguration.audioExtractionStatus | enum | yes | Allowed: ENABLED, DISABLED |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration.mediaExtractionConfiguration.imageExtractionConfiguration | object | — | BedrockDataSourceImageExtractionConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration.mediaExtractionConfiguration.imageExtractionConfiguration.imageExtractionStatus | enum | yes | Allowed: ENABLED, DISABLED |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration.mediaExtractionConfiguration.videoExtractionConfiguration | object | — | BedrockDataSourceVideoExtractionConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.managedKnowledgeBaseConnectorConfiguration.mediaExtractionConfiguration.videoExtractionConfiguration.videoExtractionStatus | enum | yes | Allowed: ENABLED, DISABLED |
dataSourceConfiguration.s3Configuration | object | — | BedrockDataSourceS3DataSourceConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.s3Configuration.bucketArn | string | yes | The ARN of the bucket that contains the data source. |
dataSourceConfiguration.s3Configuration.bucketOwnerAccountId | string | — | The account ID for the owner of the S3 bucket. |
dataSourceConfiguration.s3Configuration.inclusionPrefixes | array<string> | — | A list of S3 prefixes that define the object containing the data sources. |
dataSourceConfiguration.salesforceConfiguration | object | — | BedrockDataSourceSalesforceDataSourceConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.salesforceConfiguration.crawlerConfiguration | object | — | BedrockDataSourceSalesforceCrawlerConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.salesforceConfiguration.crawlerConfiguration.filterConfiguration | object | — | BedrockDataSourceCrawlFilterConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.salesforceConfiguration.crawlerConfiguration.filterConfiguration.patternObjectFilter | object | — | BedrockDataSourcePatternObjectFilterConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.salesforceConfiguration.crawlerConfiguration.filterConfiguration.patternObjectFilter.filters | array<object> | yes | |
dataSourceConfiguration.salesforceConfiguration.crawlerConfiguration.filterConfiguration.type | enum | yes | The crawl filter type. Allowed: PATTERN |
dataSourceConfiguration.salesforceConfiguration.sourceConfiguration | object | yes | BedrockDataSourceSalesforceSourceConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.salesforceConfiguration.sourceConfiguration.authType | enum | yes | The supported authentication type to authenticate and connect to your Salesforce instance. Allowed: OAUTH2_CLIENT_CREDENTIALS |
dataSourceConfiguration.salesforceConfiguration.sourceConfiguration.credentialsSecretArn | string | yes | The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. |
dataSourceConfiguration.salesforceConfiguration.sourceConfiguration.hostUrl | string | yes | The Salesforce host URL or instance URL. |
dataSourceConfiguration.sharePointConfiguration | object | — | BedrockDataSourceSharePointDataSourceConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.sharePointConfiguration.crawlerConfiguration | object | — | BedrockDataSourceSharePointCrawlerConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.sharePointConfiguration.crawlerConfiguration.filterConfiguration | object | — | BedrockDataSourceCrawlFilterConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.sharePointConfiguration.crawlerConfiguration.filterConfiguration.patternObjectFilter | object | — | BedrockDataSourcePatternObjectFilterConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.sharePointConfiguration.crawlerConfiguration.filterConfiguration.patternObjectFilter.filters | array<object> | yes | |
dataSourceConfiguration.sharePointConfiguration.crawlerConfiguration.filterConfiguration.type | enum | yes | The crawl filter type. Allowed: PATTERN |
dataSourceConfiguration.sharePointConfiguration.sourceConfiguration | object | yes | BedrockDataSourceSharePointSourceConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.sharePointConfiguration.sourceConfiguration.authType | enum | yes | The supported authentication type to authenticate and connect to your SharePoint site/sites. Allowed: OAUTH2_CLIENT_CREDENTIALS, OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS |
dataSourceConfiguration.sharePointConfiguration.sourceConfiguration.credentialsSecretArn | string | yes | The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. |
dataSourceConfiguration.sharePointConfiguration.sourceConfiguration.domain | string | yes | The domain of your SharePoint instance or site URL/URLs. |
dataSourceConfiguration.sharePointConfiguration.sourceConfiguration.hostType | enum | yes | The supported host type, whether online/cloud or server/on-premises. Allowed: ONLINE |
dataSourceConfiguration.sharePointConfiguration.sourceConfiguration.siteUrls | array<string> | yes | A list of one or more SharePoint site URLs. |
dataSourceConfiguration.sharePointConfiguration.sourceConfiguration.tenantId | string | — | The identifier of your Microsoft 365 tenant. |
dataSourceConfiguration.type | enum | yes | Allowed: S3, CONFLUENCE, SALESFORCE, SHAREPOINT, WEB, CUSTOM, REDSHIFT_METADATA, MANAGED_KNOWLEDGE_BASE_CONNECTOR |
dataSourceConfiguration.webConfiguration | object | — | BedrockDataSourceWebDataSourceConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.webConfiguration.crawlerConfiguration | object | — | BedrockDataSourceWebCrawlerConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.webConfiguration.crawlerConfiguration.crawlerLimits | object | — | BedrockDataSourceWebCrawlerLimits is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.webConfiguration.crawlerConfiguration.crawlerLimits.maxPages | integer | — | Maximum number of pages the crawler can crawl. |
dataSourceConfiguration.webConfiguration.crawlerConfiguration.crawlerLimits.rateLimit | integer | — | Rate of web URLs retrieved per minute. |
dataSourceConfiguration.webConfiguration.crawlerConfiguration.exclusionFilters | array<string> | — | |
dataSourceConfiguration.webConfiguration.crawlerConfiguration.inclusionFilters | array<string> | — | |
dataSourceConfiguration.webConfiguration.crawlerConfiguration.scope | enum | — | Allowed: HOST_ONLY, SUBDOMAINS |
dataSourceConfiguration.webConfiguration.crawlerConfiguration.userAgent | string | — | The suffix that will be included in the user agent header. |
dataSourceConfiguration.webConfiguration.crawlerConfiguration.userAgentHeader | string | — | The full user agent header, including UUID and suffix. |
dataSourceConfiguration.webConfiguration.sourceConfiguration | object | yes | BedrockDataSourceWebSourceConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.webConfiguration.sourceConfiguration.urlConfiguration | object | yes | BedrockDataSourceUrlConfiguration is a nested property type of AWS::Bedrock::DataSource. |
dataSourceConfiguration.webConfiguration.sourceConfiguration.urlConfiguration.seedUrls | array<object> | yes | |
dataSourceConfiguration.webConfiguration.sourceConfiguration.urlConfiguration.seedUrls[].url | string | yes | A web url. |
description | string | — | Description of the Resource. |
knowledgeBaseId | string | yes | The unique identifier of the knowledge base to which to add the data source. |
name | string | yes | The name of the data source. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
serverSideEncryptionConfiguration | object | — | BedrockDataSourceServerSideEncryptionConfiguration is a nested property type of AWS::Bedrock::DataSource. |
serverSideEncryptionConfiguration.kmsKeyArn | string | — | The ARN of the AWS KMS key used to encrypt the resource. |
vectorIngestionConfiguration | object | — | BedrockDataSourceVectorIngestionConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.chunkingConfiguration | object | — | BedrockDataSourceChunkingConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.chunkingConfiguration.chunkingStrategy | enum | yes | Allowed: FIXED_SIZE, NONE, HIERARCHICAL, SEMANTIC |
vectorIngestionConfiguration.chunkingConfiguration.fixedSizeChunkingConfiguration | object | — | BedrockDataSourceFixedSizeChunkingConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.chunkingConfiguration.fixedSizeChunkingConfiguration.maxTokens | integer | yes | The maximum number of tokens to include in a chunk. |
vectorIngestionConfiguration.chunkingConfiguration.fixedSizeChunkingConfiguration.overlapPercentage | integer | yes | The percentage of overlap between adjacent chunks of a data source. |
vectorIngestionConfiguration.chunkingConfiguration.hierarchicalChunkingConfiguration | object | — | BedrockDataSourceHierarchicalChunkingConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.chunkingConfiguration.hierarchicalChunkingConfiguration.levelConfigurations | array<object> | yes | Token settings for each layer. |
vectorIngestionConfiguration.chunkingConfiguration.hierarchicalChunkingConfiguration.levelConfigurations[].maxTokens | integer | yes | The maximum number of tokens that a chunk can contain in this layer. |
vectorIngestionConfiguration.chunkingConfiguration.hierarchicalChunkingConfiguration.overlapTokens | integer | yes | The number of tokens to repeat across chunks in the same layer. |
vectorIngestionConfiguration.chunkingConfiguration.semanticChunkingConfiguration | object | — | BedrockDataSourceSemanticChunkingConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.chunkingConfiguration.semanticChunkingConfiguration.breakpointPercentileThreshold | integer | yes | The dissimilarity threshold for splitting chunks. |
vectorIngestionConfiguration.chunkingConfiguration.semanticChunkingConfiguration.bufferSize | integer | yes | The buffer size. |
vectorIngestionConfiguration.chunkingConfiguration.semanticChunkingConfiguration.maxTokens | integer | yes | The maximum number of tokens that a chunk can contain. |
vectorIngestionConfiguration.contextEnrichmentConfiguration | object | — | BedrockDataSourceContextEnrichmentConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.contextEnrichmentConfiguration.bedrockFoundationModelConfiguration | object | — | BedrockDataSourceBedrockFoundationModelContextEnrichmentConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.contextEnrichmentConfiguration.bedrockFoundationModelConfiguration.enrichmentStrategyConfiguration | object | yes | BedrockDataSourceEnrichmentStrategyConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.contextEnrichmentConfiguration.bedrockFoundationModelConfiguration.enrichmentStrategyConfiguration.method | enum | yes | Allowed: CHUNK_ENTITY_EXTRACTION |
vectorIngestionConfiguration.contextEnrichmentConfiguration.bedrockFoundationModelConfiguration.modelArn | string | yes | |
vectorIngestionConfiguration.contextEnrichmentConfiguration.type | enum | yes | Allowed: BEDROCK_FOUNDATION_MODEL |
vectorIngestionConfiguration.customTransformationConfiguration | object | — | BedrockDataSourceCustomTransformationConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.customTransformationConfiguration.intermediateStorage | object | yes | BedrockDataSourceIntermediateStorage is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.customTransformationConfiguration.intermediateStorage.s3Location | object | yes | BedrockDataSourceS3Location is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.customTransformationConfiguration.intermediateStorage.s3Location.uri | string | yes | The location's URI |
vectorIngestionConfiguration.customTransformationConfiguration.transformations | array<object> | yes | A list of Lambda functions that process documents. |
vectorIngestionConfiguration.customTransformationConfiguration.transformations[].stepToApply | enum | yes | When the service applies the transformation. Allowed: POST_CHUNKING |
vectorIngestionConfiguration.customTransformationConfiguration.transformations[].transformationFunction | object | yes | BedrockDataSourceTransformationFunction is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.customTransformationConfiguration.transformations[].transformationFunction.transformationLambdaConfiguration | object | yes | BedrockDataSourceTransformationLambdaConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.customTransformationConfiguration.transformations[].transformationFunction.transformationLambdaConfiguration.lambdaArn | string | yes | The function's ARN identifier. |
vectorIngestionConfiguration.parsingConfiguration | object | — | BedrockDataSourceParsingConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.parsingConfiguration.bedrockDataAutomationConfiguration | object | — | BedrockDataSourceBedrockDataAutomationConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.parsingConfiguration.bedrockDataAutomationConfiguration.parsingModality | enum | — | Allowed: MULTIMODAL |
vectorIngestionConfiguration.parsingConfiguration.bedrockFoundationModelConfiguration | object | — | BedrockDataSourceBedrockFoundationModelConfiguration is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.parsingConfiguration.bedrockFoundationModelConfiguration.modelArn | string | yes | |
vectorIngestionConfiguration.parsingConfiguration.bedrockFoundationModelConfiguration.parsingModality | enum | — | Allowed: MULTIMODAL |
vectorIngestionConfiguration.parsingConfiguration.bedrockFoundationModelConfiguration.parsingPrompt | object | — | BedrockDataSourceParsingPrompt is a nested property type of AWS::Bedrock::DataSource. |
vectorIngestionConfiguration.parsingConfiguration.bedrockFoundationModelConfiguration.parsingPrompt.parsingPromptText | string | yes | Instructions for interpreting the contents of a document. |
vectorIngestionConfiguration.parsingConfiguration.parsingStrategy | enum | yes | Allowed: BEDROCK_FOUNDATION_MODEL, BEDROCK_DATA_AUTOMATION, SMART_PARSING |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | The time at which the data source was created. |
dataSourceId | string | — | Identifier for a resource. |
dataSourceStatus | enum | — | Read-only: reported by AWS after creation. Allowed: AVAILABLE, DELETING, DELETE_UNSUCCESSFUL, CREATING, UPDATING, FAILED |
failureReasons | array<string> | — | The details of the failure reasons related to the data source. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
updatedAt | string | — | The time at which the knowledge base was last updated. |
BedrockEnforcedGuardrailConfiguration # CLOUD CONTROL · AWS::Bedrock::EnforcedGuardrailConfiguration
BedrockEnforcedGuardrailConfiguration manages AWS::Bedrock::EnforcedGuardrailConfiguration through the AWS Cloud Control API.
kubectl get bedrockenforcedguardrailconfigurations · example on GitHub
Example
# BedrockEnforcedGuardrailConfiguration — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockenforcedguardrailconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockEnforcedGuardrailConfiguration
metadata:
name: example-bedrockenforcedguardrailconfiguration
namespace: default
spec:
guardrailIdentifier: example
guardrailVersion: '1.0'
modelEnforcement:
excludedModels:
- example
includedModels:
- example
providerRef:
name: example-bedrockenforcedguardrailconfiguration
region: us-east-1
selectiveContentGuarding:
messages: SELECTIVE
system: SELECTIVE
Spec
| Field | Type | Required | Description |
|---|---|---|---|
guardrailIdentifier | string | yes | Identifier for the guardrail, could be the ID or the ARN |
guardrailVersion | string | yes | Numerical guardrail version (not DRAFT) |
modelEnforcement | object | — | BedrockEnforcedGuardrailConfigurationModelEnforcement is a nested property type of AWS::Bedrock::EnforcedGuardrailConfiguration. |
modelEnforcement.excludedModels | array<string> | yes | Models to exclude from enforcement. |
modelEnforcement.includedModels | array<string> | yes | Models to enforce the guardrail on |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
selectiveContentGuarding | object | — | BedrockEnforcedGuardrailConfigurationSelectiveContentGuarding is a nested property type of AWS::Bedrock::EnforcedGuardrailConfiguration. |
selectiveContentGuarding.messages | enum | — | Selective guarding mode for user messages Allowed: SELECTIVE, COMPREHENSIVE |
selectiveContentGuarding.system | enum | — | Selective guarding mode for system prompts Allowed: SELECTIVE, COMPREHENSIVE |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
configId | string | — | Unique ID for the account enforced configuration Read-only: reported by AWS after creation. |
createdAt | string | — | Timestamp when the configuration was created Read-only: reported by AWS after creation. |
createdBy | string | — | The ARN of the role used to create the configuration Read-only: reported by AWS after creation. |
guardrailArn | string | — | ARN representation for the guardrail Read-only: reported by AWS after creation. |
guardrailId | string | — | Unique ID for the guardrail Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
owner | enum | — | Read-only: reported by AWS after creation. Allowed: ACCOUNT, ORGANIZATION |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
updatedAt | string | — | Timestamp when the configuration was last updated Read-only: reported by AWS after creation. |
updatedBy | string | — | The ARN of the role used to update the configuration Read-only: reported by AWS after creation. |
BedrockFlow # CLOUD CONTROL · AWS::Bedrock::Flow
BedrockFlow manages AWS::Bedrock::Flow through the AWS Cloud Control API.
kubectl get bedrockflows · example on GitHub
Example
# BedrockFlow — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockflow
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockFlow
metadata:
name: example-bedrockflow
namespace: default
spec:
customerEncryptionKeyArn: arn:aws:iam::123456789012:role/example-role
definition:
connections:
- name: example-bedrockflow
source: example
target: example
type: Data
nodes:
- inputs:
- category: LoopCondition
expression: example
name: example-bedrockflow
type: String
name: example-bedrockflow
outputs:
- name: example-bedrockflow
type: String
type: Input
definitionS3Location:
bucket: example
key: example
version: '1.0'
definitionString: example
definitionSubstitutions: {}
description: Managed by konfig-konector
executionRoleArn: arn:aws:iam::123456789012:role/example-role
name: example-bedrockflow
providerRef:
name: example-bedrockflow
region: us-east-1
tags:
environment: dev
team: platform
testAliasTags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
customerEncryptionKeyArn | string | — | A KMS key ARN |
definition | object | — | BedrockFlowFlowDefinition is a nested property type of AWS::Bedrock::Flow. |
definition.connections | array<object> | — | List of connections |
definition.connections[].configuration | object | — | |
definition.connections[].name | string | yes | Name of a connection in a flow |
definition.connections[].source | string | yes | Name of a node in a flow |
definition.connections[].target | string | yes | Name of a node in a flow |
definition.connections[].type | enum | yes | Allowed: Data, Conditional |
definition.nodes | array<object> | — | List of nodes in a flow |
definition.nodes[].configuration | object | — | |
definition.nodes[].inputs | array<object> | — | List of node inputs in a flow |
definition.nodes[].inputs[].category | enum | — | Allowed: LoopCondition, ReturnValueToLoopStart, ExitLoop |
definition.nodes[].inputs[].expression | string | yes | Expression for a node input in a flow |
definition.nodes[].inputs[].name | string | yes | Name of a node input in a flow |
definition.nodes[].inputs[].type | enum | yes | Allowed: String, Number, Boolean, Object, Array |
definition.nodes[].name | string | yes | Name of a node in a flow |
definition.nodes[].outputs | array<object> | — | List of node outputs in a flow |
definition.nodes[].outputs[].name | string | yes | Name of a node output in a flow |
definition.nodes[].outputs[].type | enum | yes | Allowed: String, Number, Boolean, Object, Array |
definition.nodes[].type | enum | yes | Allowed: Input, Output, KnowledgeBase, Condition, Lex, Prompt, LambdaFunction, Agent… |
definitionS3Location | object | — | BedrockFlowS3Location is a nested property type of AWS::Bedrock::Flow. |
definitionS3Location.bucket | string | yes | A bucket in S3 |
definitionS3Location.key | string | yes | A object key in S3 |
definitionS3Location.version | string | — | The version of the the S3 object to use |
definitionString | string | — | A JSON string containing a Definition with the same schema as the Definition property of this resource |
definitionSubstitutions | map<string> | — | |
description | string | — | Description of the flow |
executionRoleArn | string | yes | ARN of a IAM role |
name | string | yes | Name for the flow |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | map<string> | — | |
testAliasTags | map<string> | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | Arn representation of the Flow Read-only: reported by AWS after creation. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Time Stamp. |
id | string | — | Identifier for a Flow Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | enum | — | Read-only: reported by AWS after creation. Allowed: Failed, Prepared, Preparing, NotPrepared |
updatedAt | string | — | Time Stamp. |
validations | array<object> | — | Read-only: reported by AWS after creation. |
validations[].message | string | yes | validation message |
version | string | — | Draft Version. |
BedrockFlowAlias # CLOUD CONTROL · AWS::Bedrock::FlowAlias
BedrockFlowAlias manages AWS::Bedrock::FlowAlias through the AWS Cloud Control API.
kubectl get bedrockflowaliases · example on GitHub
Example
# BedrockFlowAlias — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockflowalias
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockFlowAlias
metadata:
name: example-bedrockflowalias
namespace: default
spec:
concurrencyConfiguration:
maxConcurrency: 1
type: Automatic
description: Managed by konfig-konector
flowArn: arn:aws:iam::123456789012:role/example-role
name: example-bedrockflowalias
providerRef:
name: example-bedrockflowalias
region: us-east-1
routingConfiguration:
- flowVersion: '1.0'
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
concurrencyConfiguration | object | — | BedrockFlowAliasFlowAliasConcurrencyConfiguration is a nested property type of AWS::Bedrock::FlowAlias. |
concurrencyConfiguration.maxConcurrency | number | — | Number of nodes executed concurrently at a time |
concurrencyConfiguration.type | enum | yes | Allowed: Automatic, Manual |
description | string | — | Description of the Resource. |
flowArn | string | yes | Arn representation of the Flow Create-only in AWS: changing it requires replacing the resource. |
name | string | yes | Name for a resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
routingConfiguration | array<object> | yes | Routing configuration for a Flow alias. |
routingConfiguration[].flowVersion | string | — | Version. |
tags | map<string> | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | Arn of the Flow Alias Read-only: reported by AWS after creation. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Time Stamp. |
flowId | string | — | Identifier for a flow resource. |
id | string | — | Id for a Flow Alias generated at the server side. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
updatedAt | string | — | Time Stamp. |
BedrockFlowVersion # CLOUD CONTROL · AWS::Bedrock::FlowVersion
BedrockFlowVersion manages AWS::Bedrock::FlowVersion through the AWS Cloud Control API.
kubectl get bedrockflowversions · example on GitHub
Example
# BedrockFlowVersion — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockflowversion
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockFlowVersion
metadata:
name: example-bedrockflowversion
namespace: default
spec:
description: Managed by konfig-konector
flowArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-bedrockflowversion
region: us-east-1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description of the flow version Create-only in AWS: changing it requires replacing the resource. |
flowArn | string | yes | Arn representation of the Flow Create-only in AWS: changing it requires replacing the resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Time Stamp. |
customerEncryptionKeyArn | string | — | A KMS key ARN Read-only: reported by AWS after creation. |
definition | object | — | Read-only: reported by AWS after creation. |
definition.connections | array<object> | — | List of connections |
definition.connections[].configuration | object | — | |
definition.connections[].name | string | yes | Name of a connection in a flow |
definition.connections[].source | string | yes | Name of a node in a flow |
definition.connections[].target | string | yes | Name of a node in a flow |
definition.connections[].type | enum | yes | Allowed: Data, Conditional |
definition.nodes | array<object> | — | List of nodes in a flow |
definition.nodes[].configuration | object | — | |
definition.nodes[].inputs | array<object> | — | List of node inputs in a flow |
definition.nodes[].inputs[].expression | string | yes | Expression for a node input in a flow |
definition.nodes[].inputs[].name | string | yes | Name of a node input in a flow |
definition.nodes[].inputs[].type | enum | yes | Allowed: String, Number, Boolean, Object, Array |
definition.nodes[].name | string | yes | Name of a node in a flow |
definition.nodes[].outputs | array<object> | — | List of node outputs in a flow |
definition.nodes[].outputs[].name | string | yes | Name of a node output in a flow |
definition.nodes[].outputs[].type | enum | yes | Allowed: String, Number, Boolean, Object, Array |
definition.nodes[].type | enum | yes | Allowed: Input, Output, KnowledgeBase, Condition, Lex, Prompt, LambdaFunction, Agent… |
executionRoleArn | string | — | ARN of a IAM role Read-only: reported by AWS after creation. |
flowId | string | — | Identifier for a Flow Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
name | string | — | Name for the flow Read-only: reported by AWS after creation. |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | enum | — | Read-only: reported by AWS after creation. Allowed: Failed, Prepared, Preparing, NotPrepared |
version | string | — | Numerical Version. |
BedrockGuardrail # CLOUD CONTROL · AWS::Bedrock::Guardrail
BedrockGuardrail manages AWS::Bedrock::Guardrail through the AWS Cloud Control API.
kubectl get bedrockguardrails · example on GitHub
Example
# BedrockGuardrail — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockguardrail
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockGuardrail
metadata:
name: example-bedrockguardrail
namespace: default
spec:
automatedReasoningPolicyConfig:
confidenceThreshold: 1
policies:
- example
blockedInputMessaging: example
blockedOutputsMessaging: example
contentPolicyConfig:
contentFiltersTierConfig:
tierName: CLASSIC
filtersConfig:
- inputAction: BLOCK
inputEnabled: true
inputModalities:
- example
inputStrength: NONE
outputAction: BLOCK
outputEnabled: true
outputModalities:
- example
outputStrength: NONE
type: SEXUAL
contextualGroundingPolicyConfig:
filtersConfig:
- action: BLOCK
enabled: true
threshold: 1
type: GROUNDING
crossRegionConfig:
guardrailProfileArn: arn:aws:iam::123456789012:role/example-role
description: Managed by konfig-konector
kmsKeyArn: arn:aws:iam::123456789012:role/example-role
name: example-bedrockguardrail
providerRef:
name: example-bedrockguardrail
region: us-east-1
sensitiveInformationPolicyConfig:
piiEntitiesConfig:
- action: BLOCK
inputAction: BLOCK
inputEnabled: true
outputAction: BLOCK
outputEnabled: true
type: ADDRESS
regexesConfig:
- action: BLOCK
description: Managed by konfig-konector
inputAction: BLOCK
inputEnabled: true
name: example-bedrockguardrail
outputAction: BLOCK
outputEnabled: true
pattern: example
tags:
- key: example
value: example
topicPolicyConfig:
topicsConfig:
- definition: example
examples:
- example
inputAction: BLOCK
inputEnabled: true
name: example-bedrockguardrail
outputAction: BLOCK
outputEnabled: true
type: DENY
topicsTierConfig:
tierName: CLASSIC
wordPolicyConfig:
managedWordListsConfig:
- inputAction: BLOCK
inputEnabled: true
outputAction: BLOCK
outputEnabled: true
type: PROFANITY
wordsConfig:
- inputAction: BLOCK
inputEnabled: true
outputAction: BLOCK
outputEnabled: true
text: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
automatedReasoningPolicyConfig | object | — | BedrockGuardrailAutomatedReasoningPolicyConfig is a nested property type of AWS::Bedrock::Guardrail. |
automatedReasoningPolicyConfig.confidenceThreshold | number | — | The confidence threshold for triggering guardrail actions based on Automated Reasoning policy violations. |
automatedReasoningPolicyConfig.policies | array<string> | yes | The list of Automated Reasoning policy ARNs to include in the guardrail configuration |
blockedInputMessaging | string | yes | Messaging for when violations are detected in text |
blockedOutputsMessaging | string | yes | Messaging for when violations are detected in text |
contentPolicyConfig | object | — | BedrockGuardrailContentPolicyConfig is a nested property type of AWS::Bedrock::Guardrail. |
contentPolicyConfig.contentFiltersTierConfig | object | — | Guardrail tier config for content policy |
contentPolicyConfig.contentFiltersTierConfig.tierName | enum | yes | Allowed: CLASSIC, STANDARD |
contentPolicyConfig.filtersConfig | array<object> | yes | List of content filter configs in content policy. |
contentPolicyConfig.filtersConfig[].inputAction | enum | — | Allowed: BLOCK, NONE |
contentPolicyConfig.filtersConfig[].inputEnabled | boolean | — | |
contentPolicyConfig.filtersConfig[].inputModalities | array<string> | — | List of modalities |
contentPolicyConfig.filtersConfig[].inputStrength | enum | yes | Allowed: NONE, LOW, MEDIUM, HIGH |
contentPolicyConfig.filtersConfig[].outputAction | enum | — | Allowed: BLOCK, NONE |
contentPolicyConfig.filtersConfig[].outputEnabled | boolean | — | |
contentPolicyConfig.filtersConfig[].outputModalities | array<string> | — | List of modalities |
contentPolicyConfig.filtersConfig[].outputStrength | enum | yes | Allowed: NONE, LOW, MEDIUM, HIGH |
contentPolicyConfig.filtersConfig[].type | enum | yes | Allowed: SEXUAL, VIOLENCE, HATE, INSULTS, MISCONDUCT, PROMPT_ATTACK |
contextualGroundingPolicyConfig | object | — | BedrockGuardrailContextualGroundingPolicyConfig is a nested property type of AWS::Bedrock::Guardrail. |
contextualGroundingPolicyConfig.filtersConfig | array<object> | yes | List of contextual grounding filter configs. |
contextualGroundingPolicyConfig.filtersConfig[].action | enum | — | Allowed: BLOCK, NONE |
contextualGroundingPolicyConfig.filtersConfig[].enabled | boolean | — | |
contextualGroundingPolicyConfig.filtersConfig[].threshold | number | yes | The threshold for this filter. |
contextualGroundingPolicyConfig.filtersConfig[].type | enum | yes | Allowed: GROUNDING, RELEVANCE |
crossRegionConfig | object | — | BedrockGuardrailGuardrailCrossRegionConfig is a nested property type of AWS::Bedrock::Guardrail. |
crossRegionConfig.guardrailProfileArn | string | yes | The Amazon Resource Name (ARN) of the guardrail profile |
description | string | — | Description of the guardrail or its version |
kmsKeyArn | string | — | The KMS key with which the guardrail was encrypted at rest |
name | string | yes | Name of the guardrail |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
sensitiveInformationPolicyConfig | object | — | BedrockGuardrailSensitiveInformationPolicyConfig is a nested property type of AWS::Bedrock::Guardrail. |
sensitiveInformationPolicyConfig.piiEntitiesConfig | array<object> | — | List of entities. |
sensitiveInformationPolicyConfig.piiEntitiesConfig[].action | enum | yes | Allowed: BLOCK, ANONYMIZE, NONE |
sensitiveInformationPolicyConfig.piiEntitiesConfig[].inputAction | enum | — | Allowed: BLOCK, ANONYMIZE, NONE |
sensitiveInformationPolicyConfig.piiEntitiesConfig[].inputEnabled | boolean | — | |
sensitiveInformationPolicyConfig.piiEntitiesConfig[].outputAction | enum | — | Allowed: BLOCK, ANONYMIZE, NONE |
sensitiveInformationPolicyConfig.piiEntitiesConfig[].outputEnabled | boolean | — | |
sensitiveInformationPolicyConfig.piiEntitiesConfig[].type | enum | yes | Allowed: ADDRESS, AGE, AWS_ACCESS_KEY, AWS_SECRET_KEY, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY… |
sensitiveInformationPolicyConfig.regexesConfig | array<object> | — | List of regex. |
sensitiveInformationPolicyConfig.regexesConfig[].action | enum | yes | Allowed: BLOCK, ANONYMIZE, NONE |
sensitiveInformationPolicyConfig.regexesConfig[].description | string | — | The regex description. |
sensitiveInformationPolicyConfig.regexesConfig[].inputAction | enum | — | Allowed: BLOCK, ANONYMIZE, NONE |
sensitiveInformationPolicyConfig.regexesConfig[].inputEnabled | boolean | — | |
sensitiveInformationPolicyConfig.regexesConfig[].name | string | yes | The regex name. |
sensitiveInformationPolicyConfig.regexesConfig[].outputAction | enum | — | Allowed: BLOCK, ANONYMIZE, NONE |
sensitiveInformationPolicyConfig.regexesConfig[].outputEnabled | boolean | — | |
sensitiveInformationPolicyConfig.regexesConfig[].pattern | string | yes | The regex pattern. |
tags | array<object> | — | List of Tags |
tags[].key | string | yes | |
tags[].value | string | yes | |
topicPolicyConfig | object | — | BedrockGuardrailTopicPolicyConfig is a nested property type of AWS::Bedrock::Guardrail. |
topicPolicyConfig.topicsConfig | array<object> | yes | List of topic configs in topic policy. |
topicPolicyConfig.topicsConfig[].definition | string | yes | Definition of topic in topic policy |
topicPolicyConfig.topicsConfig[].examples | array<string> | — | List of text examples |
topicPolicyConfig.topicsConfig[].inputAction | enum | — | Allowed: BLOCK, NONE |
topicPolicyConfig.topicsConfig[].inputEnabled | boolean | — | |
topicPolicyConfig.topicsConfig[].name | string | yes | Name of topic in topic policy |
topicPolicyConfig.topicsConfig[].outputAction | enum | — | Allowed: BLOCK, NONE |
topicPolicyConfig.topicsConfig[].outputEnabled | boolean | — | |
topicPolicyConfig.topicsConfig[].type | enum | yes | Allowed: DENY |
topicPolicyConfig.topicsTierConfig | object | — | Guardrail tier config for topic policy |
topicPolicyConfig.topicsTierConfig.tierName | enum | yes | Allowed: CLASSIC, STANDARD |
wordPolicyConfig | object | — | BedrockGuardrailWordPolicyConfig is a nested property type of AWS::Bedrock::Guardrail. |
wordPolicyConfig.managedWordListsConfig | array<object> | — | A config for the list of managed words. |
wordPolicyConfig.managedWordListsConfig[].inputAction | enum | — | Allowed: BLOCK, NONE |
wordPolicyConfig.managedWordListsConfig[].inputEnabled | boolean | — | |
wordPolicyConfig.managedWordListsConfig[].outputAction | enum | — | Allowed: BLOCK, NONE |
wordPolicyConfig.managedWordListsConfig[].outputEnabled | boolean | — | |
wordPolicyConfig.managedWordListsConfig[].type | enum | yes | Allowed: PROFANITY |
wordPolicyConfig.wordsConfig | array<object> | — | List of custom word configs. |
wordPolicyConfig.wordsConfig[].inputAction | enum | — | Allowed: BLOCK, NONE |
wordPolicyConfig.wordsConfig[].inputEnabled | boolean | — | |
wordPolicyConfig.wordsConfig[].outputAction | enum | — | Allowed: BLOCK, NONE |
wordPolicyConfig.wordsConfig[].outputEnabled | boolean | — | |
wordPolicyConfig.wordsConfig[].text | string | yes | The custom word text. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Time Stamp Read-only: reported by AWS after creation. |
failureRecommendations | array<string> | — | List of failure recommendations Read-only: reported by AWS after creation. |
guardrailArn | string | — | Arn representation for the guardrail Read-only: reported by AWS after creation. |
guardrailId | string | — | Unique id for the guardrail Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | enum | — | Read-only: reported by AWS after creation. Allowed: CREATING, UPDATING, VERSIONING, READY, FAILED, DELETING |
statusReasons | array<string> | — | List of status reasons Read-only: reported by AWS after creation. |
updatedAt | string | — | Time Stamp Read-only: reported by AWS after creation. |
version | string | — | Guardrail version Read-only: reported by AWS after creation. |
BedrockGuardrailVersion # CLOUD CONTROL · AWS::Bedrock::GuardrailVersion
BedrockGuardrailVersion manages AWS::Bedrock::GuardrailVersion through the AWS Cloud Control API.
kubectl get bedrockguardrailversions · example on GitHub
Example
# BedrockGuardrailVersion — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockguardrailversion
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockGuardrailVersion
metadata:
name: example-bedrockguardrailversion
namespace: default
spec:
description: Managed by konfig-konector
guardrailIdentifier: example
providerRef:
name: example-bedrockguardrailversion
region: us-east-1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description of the Guardrail version Create-only in AWS: changing it requires replacing the resource. |
guardrailIdentifier | string | yes | Identifier (GuardrailId or GuardrailArn) for the guardrail Create-only in AWS: changing it requires replacing the resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
guardrailArn | string | — | Arn representation for the guardrail Read-only: reported by AWS after creation. |
guardrailId | string | — | Unique id for the guardrail Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
version | string | — | Guardrail version Read-only: reported by AWS after creation. |
BedrockIntelligentPromptRouter # CLOUD CONTROL · AWS::Bedrock::IntelligentPromptRouter
BedrockIntelligentPromptRouter manages AWS::Bedrock::IntelligentPromptRouter through the AWS Cloud Control API.
kubectl get bedrockintelligentpromptrouters · example on GitHub
Example
# BedrockIntelligentPromptRouter — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockintelligentpromptrouter
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockIntelligentPromptRouter
metadata:
name: example-bedrockintelligentpromptrouter
namespace: default
spec:
description: Managed by konfig-konector
fallbackModel:
modelArn: arn:aws:iam::123456789012:role/example-role
models:
- modelArn: arn:aws:iam::123456789012:role/example-role
promptRouterName: example-bedrockintelligentpromptrouter
providerRef:
name: example-bedrockintelligentpromptrouter
region: us-east-1
routingCriteria:
responseQualityDifference: 1
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description of the Prompt Router. |
fallbackModel | object | yes | Create-only in AWS: changing it requires replacing the resource. |
fallbackModel.modelArn | string | yes | Arn of underlying model which are added in the Prompt Router. |
models | array<object> | yes | List of model configuration Create-only in AWS: changing it requires replacing the resource. |
models[].modelArn | string | yes | Arn of underlying model which are added in the Prompt Router. |
promptRouterName | string | yes | Name of the Prompt Router. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
routingCriteria | object | yes | Create-only in AWS: changing it requires replacing the resource. |
routingCriteria.responseQualityDifference | number | yes | |
tags | array<object> | — | List of Tags |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Time Stamp Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
promptRouterArn | string | — | Arn of the Prompt Router. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | enum | — | Read-only: reported by AWS after creation. Allowed: AVAILABLE |
type | enum | — | Read-only: reported by AWS after creation. Allowed: custom, default |
updatedAt | string | — | Time Stamp Read-only: reported by AWS after creation. |
BedrockKnowledgeBase # CLOUD CONTROL · AWS::Bedrock::KnowledgeBase
BedrockKnowledgeBase manages AWS::Bedrock::KnowledgeBase through the AWS Cloud Control API.
kubectl get bedrockknowledgebases · example on GitHub
Example
# BedrockKnowledgeBase — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockknowledgebase
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockKnowledgeBase
metadata:
name: example-bedrockknowledgebase
namespace: default
spec:
description: Managed by konfig-konector
knowledgeBaseConfiguration:
kendraKnowledgeBaseConfiguration:
kendraIndexArn: arn:aws:iam::123456789012:role/example-role
managedKnowledgeBaseConfiguration:
embeddingModelArn: arn:aws:iam::123456789012:role/example-role
embeddingModelType: CUSTOM
serverSideEncryptionConfiguration:
kmsKeyArn: arn:aws:iam::123456789012:role/example-role
sqlKnowledgeBaseConfiguration:
redshiftConfiguration:
queryEngineConfiguration:
type: SERVERLESS
storageConfigurations:
- type: REDSHIFT
type: REDSHIFT
type: VECTOR
vectorKnowledgeBaseConfiguration:
embeddingModelArn: arn:aws:iam::123456789012:role/example-role
supplementalDataStorageConfiguration:
supplementalDataStorageLocations:
- supplementalDataStorageLocationType: S3
name: example-bedrockknowledgebase
providerRef:
name: example-bedrockknowledgebase
region: us-east-1
roleArn: arn:aws:iam::123456789012:role/example-role
storageConfiguration:
mongoDbAtlasConfiguration:
collectionName: example-bedrockknowledgebase
credentialsSecretArn: arn:aws:iam::123456789012:role/example-role
databaseName: example-bedrockknowledgebase
endpoint: example
endpointServiceName: example-bedrockknowledgebase
fieldMapping:
metadataField: example
textField: example
vectorField: example
textIndexName: example-bedrockknowledgebase
vectorIndexName: example-bedrockknowledgebase
neptuneAnalyticsConfiguration:
fieldMapping:
metadataField: example
textField: example
graphArn: arn:aws:iam::123456789012:role/example-role
opensearchManagedClusterConfiguration:
domainArn: arn:aws:iam::123456789012:role/example-role
domainEndpoint: example
fieldMapping:
metadataField: example
textField: example
vectorField: example
vectorIndexName: example-bedrockknowledgebase
opensearchServerlessConfiguration:
collectionArn: arn:aws:iam::123456789012:role/example-role
fieldMapping:
metadataField: example
textField: example
vectorField: example
vectorIndexName: example-bedrockknowledgebase
pineconeConfiguration:
connectionString: example
credentialsSecretArn: arn:aws:iam::123456789012:role/example-role
fieldMapping:
metadataField: example
textField: example
namespace: example
rdsConfiguration:
credentialsSecretArn: arn:aws:iam::123456789012:role/example-role
databaseName: example-bedrockknowledgebase
fieldMapping:
customMetadataField: example
metadataField: example
primaryKeyField: example
textField: example
vectorField: example
resourceArn: arn:aws:iam::123456789012:role/example-role
tableName: example-bedrockknowledgebase
s3VectorsConfiguration:
indexArn: arn:aws:iam::123456789012:role/example-role
indexName: example-bedrockknowledgebase
vectorBucketArn: arn:aws:iam::123456789012:role/example-role
type: OPENSEARCH_SERVERLESS
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description of the Resource. |
knowledgeBaseConfiguration | object | yes | BedrockKnowledgeBaseKnowledgeBaseConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.kendraKnowledgeBaseConfiguration | object | — | BedrockKnowledgeBaseKendraKnowledgeBaseConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.kendraKnowledgeBaseConfiguration.kendraIndexArn | string | yes | |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration | object | — | BedrockKnowledgeBaseManagedKnowledgeBaseConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.embeddingModelArn | string | — | The ARN of the model used to create vector embeddings for the knowledge base. |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.embeddingModelConfiguration | object | — | BedrockKnowledgeBaseEmbeddingModelConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration | object | — | BedrockKnowledgeBaseBedrockEmbeddingModelConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.audio | array<object> | — | |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.audio[].segmentationConfiguration | object | yes | BedrockKnowledgeBaseAudioSegmentationConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.dimensions | integer | — | The dimensions details for the vector configuration used on the Bedrock embeddings model. |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.embeddingDataType | enum | — | The data type for the vectors when using a model to convert text into vector embeddings. Allowed: FLOAT32, BINARY |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.video | array<object> | — | |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.video[].segmentationConfiguration | object | yes | BedrockKnowledgeBaseVideoSegmentationConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.embeddingModelType | enum | — | Allowed: CUSTOM, MANAGED |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.serverSideEncryptionConfiguration | object | — | BedrockKnowledgeBaseManagedKnowledgeBaseServerSideEncryptionConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.managedKnowledgeBaseConfiguration.serverSideEncryptionConfiguration.kmsKeyArn | string | — | The ARN of the AWS KMS key used to encrypt the managed knowledge base. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration | object | — | BedrockKnowledgeBaseSqlKnowledgeBaseConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration | object | — | BedrockKnowledgeBaseRedshiftConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryEngineConfiguration | object | yes | BedrockKnowledgeBaseRedshiftQueryEngineConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryEngineConfiguration.provisionedConfiguration | object | — | BedrockKnowledgeBaseRedshiftProvisionedConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryEngineConfiguration.provisionedConfiguration.authConfiguration | object | yes | BedrockKnowledgeBaseRedshiftProvisionedAuthConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryEngineConfiguration.provisionedConfiguration.clusterIdentifier | string | yes | |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryEngineConfiguration.serverlessConfiguration | object | — | BedrockKnowledgeBaseRedshiftServerlessConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryEngineConfiguration.serverlessConfiguration.authConfiguration | object | yes | BedrockKnowledgeBaseRedshiftServerlessAuthConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryEngineConfiguration.serverlessConfiguration.workgroupArn | string | yes | |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryEngineConfiguration.type | enum | yes | Allowed: SERVERLESS, PROVISIONED |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryGenerationConfiguration | object | — | BedrockKnowledgeBaseQueryGenerationConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryGenerationConfiguration.executionTimeoutSeconds | integer | — | |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryGenerationConfiguration.generationContext | object | — | BedrockKnowledgeBaseQueryGenerationContext is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryGenerationConfiguration.generationContext.curatedQueries | array<object> | — | |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.queryGenerationConfiguration.generationContext.tables | array<object> | — | |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.storageConfigurations | array<object> | yes | |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.storageConfigurations[].awsDataCatalogConfiguration | object | — | BedrockKnowledgeBaseRedshiftQueryEngineAwsDataCatalogStorageConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.storageConfigurations[].awsDataCatalogConfiguration.tableNames | array<string> | yes | |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.storageConfigurations[].redshiftConfiguration | object | — | BedrockKnowledgeBaseRedshiftQueryEngineRedshiftStorageConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.storageConfigurations[].redshiftConfiguration.databaseName | string | yes | |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.redshiftConfiguration.storageConfigurations[].type | enum | yes | Allowed: REDSHIFT, AWS_DATA_CATALOG |
knowledgeBaseConfiguration.sqlKnowledgeBaseConfiguration.type | enum | yes | Allowed: REDSHIFT |
knowledgeBaseConfiguration.type | enum | yes | Allowed: VECTOR, KENDRA, SQL, MANAGED |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration | object | — | BedrockKnowledgeBaseVectorKnowledgeBaseConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.embeddingModelArn | string | yes | The ARN of the model used to create vector embeddings for the knowledge base. |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.embeddingModelConfiguration | object | — | BedrockKnowledgeBaseEmbeddingModelConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration | object | — | BedrockKnowledgeBaseBedrockEmbeddingModelConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.audio | array<object> | — | |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.audio[].segmentationConfiguration | object | yes | BedrockKnowledgeBaseAudioSegmentationConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.dimensions | integer | — | The dimensions details for the vector configuration used on the Bedrock embeddings model. |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.embeddingDataType | enum | — | The data type for the vectors when using a model to convert text into vector embeddings. Allowed: FLOAT32, BINARY |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.video | array<object> | — | |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.embeddingModelConfiguration.bedrockEmbeddingModelConfiguration.video[].segmentationConfiguration | object | yes | BedrockKnowledgeBaseVideoSegmentationConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.supplementalDataStorageConfiguration | object | — | BedrockKnowledgeBaseSupplementalDataStorageConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.supplementalDataStorageConfiguration.supplementalDataStorageLocations | array<object> | yes | |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.supplementalDataStorageConfiguration.supplementalDataStorageLocations[].s3Location | object | — | BedrockKnowledgeBaseS3Location is a nested property type of AWS::Bedrock::KnowledgeBase. |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.supplementalDataStorageConfiguration.supplementalDataStorageLocations[].s3Location.uri | string | yes | The location's URI |
knowledgeBaseConfiguration.vectorKnowledgeBaseConfiguration.supplementalDataStorageConfiguration.supplementalDataStorageLocations[].supplementalDataStorageLocationType | enum | yes | Allowed: S3 |
name | string | yes | The name of the knowledge base. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
roleArn | string | yes | The ARN of the IAM role with permissions to invoke API operations on the knowledge base. |
storageConfiguration | object | — | Create-only in AWS: changing it requires replacing the resource. |
storageConfiguration.mongoDbAtlasConfiguration | object | — | BedrockKnowledgeBaseMongoDbAtlasConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.mongoDbAtlasConfiguration.collectionName | string | yes | Name of the collection within MongoDB Atlas. |
storageConfiguration.mongoDbAtlasConfiguration.credentialsSecretArn | string | yes | The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database. |
storageConfiguration.mongoDbAtlasConfiguration.databaseName | string | yes | Name of the database within MongoDB Atlas. |
storageConfiguration.mongoDbAtlasConfiguration.endpoint | string | yes | MongoDB Atlas endpoint. |
storageConfiguration.mongoDbAtlasConfiguration.endpointServiceName | string | — | MongoDB Atlas endpoint service name. |
storageConfiguration.mongoDbAtlasConfiguration.fieldMapping | object | yes | BedrockKnowledgeBaseMongoDbAtlasFieldMapping is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.mongoDbAtlasConfiguration.fieldMapping.metadataField | string | yes | The name of the field in which Amazon Bedrock stores metadata about the vector store. |
storageConfiguration.mongoDbAtlasConfiguration.fieldMapping.textField | string | yes | The name of the field in which Amazon Bedrock stores the raw text from your data. |
storageConfiguration.mongoDbAtlasConfiguration.fieldMapping.vectorField | string | yes | The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. |
storageConfiguration.mongoDbAtlasConfiguration.textIndexName | string | — | Name of a MongoDB Atlas text index. |
storageConfiguration.mongoDbAtlasConfiguration.vectorIndexName | string | yes | Name of a MongoDB Atlas index. |
storageConfiguration.neptuneAnalyticsConfiguration | object | — | BedrockKnowledgeBaseNeptuneAnalyticsConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.neptuneAnalyticsConfiguration.fieldMapping | object | yes | BedrockKnowledgeBaseNeptuneAnalyticsFieldMapping is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.neptuneAnalyticsConfiguration.fieldMapping.metadataField | string | yes | The name of the field in which Amazon Bedrock stores metadata about the vector store. |
storageConfiguration.neptuneAnalyticsConfiguration.fieldMapping.textField | string | yes | The name of the field in which Amazon Bedrock stores the raw text from your data. |
storageConfiguration.neptuneAnalyticsConfiguration.graphArn | string | yes | ARN for Neptune Analytics graph database. |
storageConfiguration.opensearchManagedClusterConfiguration | object | — | BedrockKnowledgeBaseOpenSearchManagedClusterConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.opensearchManagedClusterConfiguration.domainArn | string | yes | The Amazon Resource Name (ARN) of the OpenSearch domain. |
storageConfiguration.opensearchManagedClusterConfiguration.domainEndpoint | string | yes | The endpoint URL the OpenSearch domain. |
storageConfiguration.opensearchManagedClusterConfiguration.fieldMapping | object | yes | BedrockKnowledgeBaseOpenSearchManagedClusterFieldMapping is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.opensearchManagedClusterConfiguration.fieldMapping.metadataField | string | yes | The name of the field in which Amazon Bedrock stores metadata about the vector store. |
storageConfiguration.opensearchManagedClusterConfiguration.fieldMapping.textField | string | yes | The name of the field in which Amazon Bedrock stores the raw text from your data. |
storageConfiguration.opensearchManagedClusterConfiguration.fieldMapping.vectorField | string | yes | The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. |
storageConfiguration.opensearchManagedClusterConfiguration.vectorIndexName | string | yes | The name of the vector store. |
storageConfiguration.opensearchServerlessConfiguration | object | — | BedrockKnowledgeBaseOpenSearchServerlessConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.opensearchServerlessConfiguration.collectionArn | string | yes | The ARN of the OpenSearch Service vector store. |
storageConfiguration.opensearchServerlessConfiguration.fieldMapping | object | yes | BedrockKnowledgeBaseOpenSearchServerlessFieldMapping is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.opensearchServerlessConfiguration.fieldMapping.metadataField | string | yes | The name of the field in which Amazon Bedrock stores metadata about the vector store. |
storageConfiguration.opensearchServerlessConfiguration.fieldMapping.textField | string | yes | The name of the field in which Amazon Bedrock stores the raw text from your data. |
storageConfiguration.opensearchServerlessConfiguration.fieldMapping.vectorField | string | yes | The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. |
storageConfiguration.opensearchServerlessConfiguration.vectorIndexName | string | yes | The name of the vector store. |
storageConfiguration.pineconeConfiguration | object | — | BedrockKnowledgeBasePineconeConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.pineconeConfiguration.connectionString | string | yes | The endpoint URL for your index management page. |
storageConfiguration.pineconeConfiguration.credentialsSecretArn | string | yes | The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key. |
storageConfiguration.pineconeConfiguration.fieldMapping | object | yes | BedrockKnowledgeBasePineconeFieldMapping is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.pineconeConfiguration.fieldMapping.metadataField | string | yes | The name of the field in which Amazon Bedrock stores metadata about the vector store. |
storageConfiguration.pineconeConfiguration.fieldMapping.textField | string | yes | The name of the field in which Amazon Bedrock stores the raw text from your data. |
storageConfiguration.pineconeConfiguration.namespace | string | — | The namespace to be used to write new data to your database. |
storageConfiguration.rdsConfiguration | object | — | BedrockKnowledgeBaseRdsConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.rdsConfiguration.credentialsSecretArn | string | yes | The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database. |
storageConfiguration.rdsConfiguration.databaseName | string | yes | The name of your Amazon RDS database. |
storageConfiguration.rdsConfiguration.fieldMapping | object | yes | BedrockKnowledgeBaseRdsFieldMapping is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.rdsConfiguration.fieldMapping.customMetadataField | string | — | The name of the field in which Amazon Bedrock stores custom metadata about the vector store. |
storageConfiguration.rdsConfiguration.fieldMapping.metadataField | string | yes | The name of the field in which Amazon Bedrock stores metadata about the vector store. |
storageConfiguration.rdsConfiguration.fieldMapping.primaryKeyField | string | yes | The name of the field in which Amazon Bedrock stores the ID for each entry. |
storageConfiguration.rdsConfiguration.fieldMapping.textField | string | yes | The name of the field in which Amazon Bedrock stores the raw text from your data. |
storageConfiguration.rdsConfiguration.fieldMapping.vectorField | string | yes | The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. |
storageConfiguration.rdsConfiguration.resourceArn | string | yes | The ARN of the vector store. |
storageConfiguration.rdsConfiguration.tableName | string | yes | The name of the table in the database. |
storageConfiguration.s3VectorsConfiguration | object | — | BedrockKnowledgeBaseS3VectorsConfiguration is a nested property type of AWS::Bedrock::KnowledgeBase. |
storageConfiguration.s3VectorsConfiguration.indexArn | string | — | The Amazon Resource Name (ARN) of the vector index used for the knowledge base. |
storageConfiguration.s3VectorsConfiguration.indexName | string | — | The name of the vector index used for the knowledge base. |
storageConfiguration.s3VectorsConfiguration.vectorBucketArn | string | — | The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored. |
storageConfiguration.type | enum | yes | Allowed: OPENSEARCH_SERVERLESS, PINECONE, RDS, MONGO_DB_ATLAS, NEPTUNE_ANALYTICS, S3_VECTORS, OPENSEARCH_MANAGED_CLUSTER |
tags | map<string> | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | The time at which the knowledge base was created. |
failureReasons | array<string> | — | A list of reasons that the API operation on the knowledge base failed. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
knowledgeBaseArn | string | — | The ARN of the knowledge base. |
knowledgeBaseId | string | — | The unique identifier of the knowledge base. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
status | enum | — | Read-only: reported by AWS after creation. Allowed: CREATING, ACTIVE, DELETING, UPDATING, FAILED, DELETE_UNSUCCESSFUL, UPDATE_UNSUCCESSFUL |
updatedAt | string | — | The time at which the knowledge base was last updated. |
BedrockKnowledgeBasePolicy # CLOUD CONTROL · AWS::Bedrock::KnowledgeBasePolicy
BedrockKnowledgeBasePolicy manages AWS::Bedrock::KnowledgeBasePolicy through the AWS Cloud Control API.
kubectl get bedrockknowledgebasepolicies · example on GitHub
Example
# BedrockKnowledgeBasePolicy — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockknowledgebasepolicy
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockKnowledgeBasePolicy
metadata:
name: example-bedrockknowledgebasepolicy
namespace: default
spec:
knowledgeBaseId: example-id
providerRef:
name: example-bedrockknowledgebasepolicy
region: us-east-1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
knowledgeBaseId | string | yes | The unique identifier of the knowledge base Create-only in AWS: changing it requires replacing the resource. |
policyDocument | object | yes | The IAM policy document defining access permissions for the knowledge base |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
revisionId | string | — | The revision identifier for the policy, used for optimistic concurrency control Read-only: reported by AWS after creation. |
BedrockPrompt # CLOUD CONTROL · AWS::Bedrock::Prompt
BedrockPrompt manages AWS::Bedrock::Prompt through the AWS Cloud Control API.
kubectl get bedrockprompts · example on GitHub
Example
# BedrockPrompt — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockprompt
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockPrompt
metadata:
name: example-bedrockprompt
namespace: default
spec:
customerEncryptionKeyArn: arn:aws:iam::123456789012:role/example-role
defaultVariant: example
description: Managed by konfig-konector
name: example-bedrockprompt
providerRef:
name: example-bedrockprompt
region: us-east-1
tags:
environment: dev
team: platform
variants:
- metadata:
- key: example
value: example
name: example-bedrockprompt
templateType: TEXT
Spec
| Field | Type | Required | Description |
|---|---|---|---|
customerEncryptionKeyArn | string | — | A KMS key ARN |
defaultVariant | string | — | Name for a variant. |
description | string | — | Name for a prompt resource. |
name | string | yes | Name for a prompt resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | map<string> | — | |
variants | array<object> | — | List of prompt variants |
variants[].additionalModelRequestFields | object | — | |
variants[].genAiResource | object | — | |
variants[].inferenceConfiguration | object | — | |
variants[].metadata | array<object> | — | |
variants[].metadata[].key | string | yes | |
variants[].metadata[].value | string | yes | |
variants[].modelId | string | — | ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models. |
variants[].name | string | yes | Name for a variant. |
variants[].templateConfiguration | object | yes | |
variants[].templateType | enum | yes | Allowed: TEXT, CHAT |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | ARN of a prompt resource possibly with a version Read-only: reported by AWS after creation. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Time Stamp. |
id | string | — | Identifier for a Prompt Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
updatedAt | string | — | Time Stamp. |
version | string | — | Draft Version. |
BedrockPromptVersion # CLOUD CONTROL · AWS::Bedrock::PromptVersion
BedrockPromptVersion manages AWS::Bedrock::PromptVersion through the AWS Cloud Control API.
kubectl get bedrockpromptversions · example on GitHub
Example
# BedrockPromptVersion — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockpromptversion
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockPromptVersion
metadata:
name: example-bedrockpromptversion
namespace: default
spec:
description: Managed by konfig-konector
promptArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-bedrockpromptversion
region: us-east-1
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description for a prompt version resource. |
promptArn | string | yes | ARN of a prompt resource possibly with a version Create-only in AWS: changing it requires replacing the resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | map<string> | — | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | ARN of a prompt version resource Read-only: reported by AWS after creation. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | Time Stamp. |
customerEncryptionKeyArn | string | — | A KMS key ARN Read-only: reported by AWS after creation. |
defaultVariant | string | — | Name for a variant. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
name | string | — | Name for a prompt resource. |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
promptId | string | — | Identifier for a Prompt Read-only: reported by AWS after creation. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
updatedAt | string | — | Time Stamp. |
variants | array<object> | — | List of prompt variants Read-only: reported by AWS after creation. |
variants[].additionalModelRequestFields | object | — | |
variants[].genAiResource | object | — | |
variants[].inferenceConfiguration | object | — | |
variants[].metadata | array<object> | — | |
variants[].metadata[].key | string | yes | |
variants[].metadata[].value | string | yes | |
variants[].modelId | string | — | ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models. |
variants[].name | string | yes | Name for a variant. |
variants[].templateConfiguration | object | yes | |
variants[].templateType | enum | yes | Allowed: TEXT, CHAT |
version | string | — | Version. |
BedrockResourcePolicy # CLOUD CONTROL · AWS::Bedrock::ResourcePolicy
BedrockResourcePolicy manages AWS::Bedrock::ResourcePolicy through the AWS Cloud Control API.
kubectl get bedrockresourcepolicies · example on GitHub
Example
# BedrockResourcePolicy — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrockresourcepolicy
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockResourcePolicy
metadata:
name: example-bedrockresourcepolicy
namespace: default
spec:
providerRef:
name: example-bedrockresourcepolicy
region: us-east-1
resourceArn: arn:aws:iam::123456789012:role/example-role
Spec
| Field | Type | Required | Description |
|---|---|---|---|
policyDocument | object | yes | The IAM policy document defining access permissions for the guardrail and guardrail profile resources |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
resourceArn | string | yes | The ARN of the Bedrock Guardrail or Guardrail Profile resource Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
BedrockSession # CLOUD CONTROL · AWS::Bedrock::Session
BedrockSession manages AWS::Bedrock::Session through the AWS Cloud Control API.
kubectl get bedrocksessions · example on GitHub
Example
# BedrockSession — Bedrock
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/bedrock.html#bedrocksession
apiVersion: aws.konfig.io/v1alpha1
kind: BedrockSession
metadata:
name: example-bedrocksession
namespace: default
spec:
encryptionKeyArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-bedrocksession
region: us-east-1
sessionMetadata:
key: value
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
encryptionKeyArn | string | — | The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
sessionMetadata | map<string> | — | A map of key-value pairs containing attributes to be persisted across the session. |
tags | array<object> | — | A list of tags associated with the session. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
createdAt | string | — | The timestamp for when the session was created. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
lastUpdatedAt | string | — | The timestamp for when the session was last modified. |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
sessionArn | string | — | The Amazon Resource Name (ARN) of the session. |
sessionId | string | — | The unique identifier of the session in UUID format. |
sessionStatus | enum | — | The current status of the session. Allowed: ACTIVE, EXPIRED, ENDED |