Documentation
¶
Index ¶
- func CfnApiKeyCredentialProvider_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApiKeyCredentialProvider_IsCfnApiKeyCredentialProvider(x interface{}) *bool
- func CfnApiKeyCredentialProvider_IsCfnElement(x interface{}) *bool
- func CfnApiKeyCredentialProvider_IsCfnResource(x interface{}) *bool
- func CfnApiKeyCredentialProvider_IsConstruct(x interface{}) *bool
- func CfnBrowserCustom_ArnForBrowserCustom(resource interfacesawsbedrockagentcore.IBrowserCustomRef) *string
- func CfnBrowserCustom_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBrowserCustom_FromBrowserCustomArn(scope constructs.Construct, id *string, arn *string) interfacesawsbedrockagentcore.IBrowserCustomRef
- func CfnBrowserCustom_FromBrowserId(scope constructs.Construct, id *string, browserId *string) interfacesawsbedrockagentcore.IBrowserCustomRef
- func CfnBrowserCustom_IsCfnBrowserCustom(x interface{}) *bool
- func CfnBrowserCustom_IsCfnElement(x interface{}) *bool
- func CfnBrowserCustom_IsCfnResource(x interface{}) *bool
- func CfnBrowserCustom_IsConstruct(x interface{}) *bool
- func CfnBrowserProfile_ArnForBrowserProfile(resource interfacesawsbedrockagentcore.IBrowserProfileRef) *string
- func CfnBrowserProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBrowserProfile_IsCfnBrowserProfile(x interface{}) *bool
- func CfnBrowserProfile_IsCfnElement(x interface{}) *bool
- func CfnBrowserProfile_IsCfnResource(x interface{}) *bool
- func CfnBrowserProfile_IsConstruct(x interface{}) *bool
- func CfnCodeInterpreterCustom_ArnForCodeInterpreterCustom(resource interfacesawsbedrockagentcore.ICodeInterpreterCustomRef) *string
- func CfnCodeInterpreterCustom_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCodeInterpreterCustom_FromCodeInterpreterCustomArn(scope constructs.Construct, id *string, arn *string) interfacesawsbedrockagentcore.ICodeInterpreterCustomRef
- func CfnCodeInterpreterCustom_FromCodeInterpreterId(scope constructs.Construct, id *string, codeInterpreterId *string) interfacesawsbedrockagentcore.ICodeInterpreterCustomRef
- func CfnCodeInterpreterCustom_IsCfnCodeInterpreterCustom(x interface{}) *bool
- func CfnCodeInterpreterCustom_IsCfnElement(x interface{}) *bool
- func CfnCodeInterpreterCustom_IsCfnResource(x interface{}) *bool
- func CfnCodeInterpreterCustom_IsConstruct(x interface{}) *bool
- func CfnEvaluator_ArnForEvaluator(resource interfacesawsbedrockagentcore.IEvaluatorRef) *string
- func CfnEvaluator_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEvaluator_IsCfnElement(x interface{}) *bool
- func CfnEvaluator_IsCfnEvaluator(x interface{}) *bool
- func CfnEvaluator_IsCfnResource(x interface{}) *bool
- func CfnEvaluator_IsConstruct(x interface{}) *bool
- func CfnGatewayTarget_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGatewayTarget_IsCfnElement(x interface{}) *bool
- func CfnGatewayTarget_IsCfnGatewayTarget(x interface{}) *bool
- func CfnGatewayTarget_IsCfnResource(x interface{}) *bool
- func CfnGatewayTarget_IsConstruct(x interface{}) *bool
- func CfnGateway_ArnForGateway(resource interfacesawsbedrockagentcore.IGatewayRef) *string
- func CfnGateway_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGateway_IsCfnElement(x interface{}) *bool
- func CfnGateway_IsCfnGateway(x interface{}) *bool
- func CfnGateway_IsCfnResource(x interface{}) *bool
- func CfnGateway_IsConstruct(x interface{}) *bool
- func CfnMemory_ArnForMemory(resource interfacesawsbedrockagentcore.IMemoryRef) *string
- func CfnMemory_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMemory_IsCfnElement(x interface{}) *bool
- func CfnMemory_IsCfnMemory(x interface{}) *bool
- func CfnMemory_IsCfnResource(x interface{}) *bool
- func CfnMemory_IsConstruct(x interface{}) *bool
- func CfnOAuth2CredentialProvider_CFN_RESOURCE_TYPE_NAME() *string
- func CfnOAuth2CredentialProvider_IsCfnElement(x interface{}) *bool
- func CfnOAuth2CredentialProvider_IsCfnOAuth2CredentialProvider(x interface{}) *bool
- func CfnOAuth2CredentialProvider_IsCfnResource(x interface{}) *bool
- func CfnOAuth2CredentialProvider_IsConstruct(x interface{}) *bool
- func CfnOnlineEvaluationConfig_ArnForOnlineEvaluationConfig(resource interfacesawsbedrockagentcore.IOnlineEvaluationConfigRef) *string
- func CfnOnlineEvaluationConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnOnlineEvaluationConfig_IsCfnElement(x interface{}) *bool
- func CfnOnlineEvaluationConfig_IsCfnOnlineEvaluationConfig(x interface{}) *bool
- func CfnOnlineEvaluationConfig_IsCfnResource(x interface{}) *bool
- func CfnOnlineEvaluationConfig_IsConstruct(x interface{}) *bool
- func CfnPolicyEngine_ArnForPolicyEngine(resource interfacesawsbedrockagentcore.IPolicyEngineRef) *string
- func CfnPolicyEngine_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPolicyEngine_IsCfnElement(x interface{}) *bool
- func CfnPolicyEngine_IsCfnPolicyEngine(x interface{}) *bool
- func CfnPolicyEngine_IsCfnResource(x interface{}) *bool
- func CfnPolicyEngine_IsConstruct(x interface{}) *bool
- func CfnPolicy_ArnForPolicy(resource interfacesawsbedrockagentcore.IPolicyRef) *string
- func CfnPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPolicy_IsCfnElement(x interface{}) *bool
- func CfnPolicy_IsCfnPolicy(x interface{}) *bool
- func CfnPolicy_IsCfnResource(x interface{}) *bool
- func CfnPolicy_IsConstruct(x interface{}) *bool
- func CfnRuntimeEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRuntimeEndpoint_IsCfnElement(x interface{}) *bool
- func CfnRuntimeEndpoint_IsCfnResource(x interface{}) *bool
- func CfnRuntimeEndpoint_IsCfnRuntimeEndpoint(x interface{}) *bool
- func CfnRuntimeEndpoint_IsConstruct(x interface{}) *bool
- func CfnRuntime_ArnForRuntime(resource interfacesawsbedrockagentcore.IRuntimeRef) *string
- func CfnRuntime_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRuntime_IsCfnElement(x interface{}) *bool
- func CfnRuntime_IsCfnResource(x interface{}) *bool
- func CfnRuntime_IsCfnRuntime(x interface{}) *bool
- func CfnRuntime_IsConstruct(x interface{}) *bool
- func CfnWorkloadIdentity_ArnForWorkloadIdentity(resource interfacesawsbedrockagentcore.IWorkloadIdentityRef) *string
- func CfnWorkloadIdentity_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWorkloadIdentity_IsCfnElement(x interface{}) *bool
- func CfnWorkloadIdentity_IsCfnResource(x interface{}) *bool
- func CfnWorkloadIdentity_IsCfnWorkloadIdentity(x interface{}) *bool
- func CfnWorkloadIdentity_IsConstruct(x interface{}) *bool
- func NewCfnApiKeyCredentialProvider_Override(c CfnApiKeyCredentialProvider, scope constructs.Construct, id *string, ...)
- func NewCfnBrowserCustom_Override(c CfnBrowserCustom, scope constructs.Construct, id *string, ...)
- func NewCfnBrowserProfile_Override(c CfnBrowserProfile, scope constructs.Construct, id *string, ...)
- func NewCfnCodeInterpreterCustom_Override(c CfnCodeInterpreterCustom, scope constructs.Construct, id *string, ...)
- func NewCfnEvaluator_Override(c CfnEvaluator, scope constructs.Construct, id *string, ...)
- func NewCfnGatewayTarget_Override(c CfnGatewayTarget, scope constructs.Construct, id *string, ...)
- func NewCfnGateway_Override(c CfnGateway, scope constructs.Construct, id *string, props *CfnGatewayProps)
- func NewCfnMemory_Override(c CfnMemory, scope constructs.Construct, id *string, props *CfnMemoryProps)
- func NewCfnOAuth2CredentialProvider_Override(c CfnOAuth2CredentialProvider, scope constructs.Construct, id *string, ...)
- func NewCfnOnlineEvaluationConfig_Override(c CfnOnlineEvaluationConfig, scope constructs.Construct, id *string, ...)
- func NewCfnPolicyEngine_Override(c CfnPolicyEngine, scope constructs.Construct, id *string, ...)
- func NewCfnPolicy_Override(c CfnPolicy, scope constructs.Construct, id *string, props *CfnPolicyProps)
- func NewCfnRuntimeEndpoint_Override(c CfnRuntimeEndpoint, scope constructs.Construct, id *string, ...)
- func NewCfnRuntime_Override(c CfnRuntime, scope constructs.Construct, id *string, props *CfnRuntimeProps)
- func NewCfnWorkloadIdentity_Override(c CfnWorkloadIdentity, scope constructs.Construct, id *string, ...)
- type CfnApiKeyCredentialProvider
- type CfnApiKeyCredentialProviderProps
- type CfnApiKeyCredentialProvider_ApiKeySecretArnProperty
- type CfnBrowserCustom
- type CfnBrowserCustomProps
- type CfnBrowserCustom_BrowserNetworkConfigurationProperty
- type CfnBrowserCustom_BrowserSigningProperty
- type CfnBrowserCustom_RecordingConfigProperty
- type CfnBrowserCustom_S3LocationProperty
- type CfnBrowserCustom_VpcConfigProperty
- type CfnBrowserProfile
- type CfnBrowserProfileProps
- type CfnCodeInterpreterCustom
- type CfnCodeInterpreterCustomProps
- type CfnCodeInterpreterCustom_CodeInterpreterNetworkConfigurationProperty
- type CfnCodeInterpreterCustom_VpcConfigProperty
- type CfnEvaluator
- type CfnEvaluatorProps
- type CfnEvaluator_BedrockEvaluatorModelConfigProperty
- type CfnEvaluator_CategoricalScaleDefinitionProperty
- type CfnEvaluator_CodeBasedEvaluatorConfigProperty
- type CfnEvaluator_EvaluatorConfigProperty
- type CfnEvaluator_EvaluatorModelConfigProperty
- type CfnEvaluator_InferenceConfigurationProperty
- type CfnEvaluator_LambdaEvaluatorConfigProperty
- type CfnEvaluator_LlmAsAJudgeEvaluatorConfigProperty
- type CfnEvaluator_NumericalScaleDefinitionProperty
- type CfnEvaluator_RatingScaleProperty
- type CfnGateway
- type CfnGatewayProps
- type CfnGatewayTarget
- type CfnGatewayTargetProps
- type CfnGatewayTarget_ApiGatewayTargetConfigurationProperty
- type CfnGatewayTarget_ApiGatewayToolConfigurationProperty
- type CfnGatewayTarget_ApiGatewayToolFilterProperty
- type CfnGatewayTarget_ApiGatewayToolOverrideProperty
- type CfnGatewayTarget_ApiKeyCredentialProviderProperty
- type CfnGatewayTarget_ApiSchemaConfigurationProperty
- type CfnGatewayTarget_CredentialProviderConfigurationProperty
- type CfnGatewayTarget_CredentialProviderProperty
- type CfnGatewayTarget_IamCredentialProviderProperty
- type CfnGatewayTarget_McpLambdaTargetConfigurationProperty
- type CfnGatewayTarget_McpServerTargetConfigurationProperty
- type CfnGatewayTarget_McpTargetConfigurationProperty
- type CfnGatewayTarget_MetadataConfigurationProperty
- type CfnGatewayTarget_OAuthCredentialProviderProperty
- type CfnGatewayTarget_S3ConfigurationProperty
- type CfnGatewayTarget_SchemaDefinitionProperty
- type CfnGatewayTarget_TargetConfigurationProperty
- type CfnGatewayTarget_ToolDefinitionProperty
- type CfnGatewayTarget_ToolSchemaProperty
- type CfnGateway_AuthorizerConfigurationProperty
- type CfnGateway_AuthorizingClaimMatchValueTypeProperty
- type CfnGateway_ClaimMatchValueTypeProperty
- type CfnGateway_CustomClaimValidationTypeProperty
- type CfnGateway_CustomJWTAuthorizerConfigurationProperty
- type CfnGateway_GatewayInterceptorConfigurationProperty
- type CfnGateway_GatewayPolicyEngineConfigurationProperty
- type CfnGateway_GatewayProtocolConfigurationProperty
- type CfnGateway_InterceptorConfigurationProperty
- type CfnGateway_InterceptorInputConfigurationProperty
- type CfnGateway_LambdaInterceptorConfigurationProperty
- type CfnGateway_MCPGatewayConfigurationProperty
- type CfnGateway_WorkloadIdentityDetailsProperty
- type CfnMemory
- type CfnMemoryProps
- type CfnMemory_ContentConfigurationProperty
- type CfnMemory_CustomConfigurationInputProperty
- type CfnMemory_CustomMemoryStrategyProperty
- type CfnMemory_EpisodicMemoryStrategyProperty
- type CfnMemory_EpisodicOverrideConsolidationConfigurationInputProperty
- type CfnMemory_EpisodicOverrideExtractionConfigurationInputProperty
- type CfnMemory_EpisodicOverrideProperty
- type CfnMemory_EpisodicOverrideReflectionConfigurationInputProperty
- type CfnMemory_EpisodicReflectionConfigurationInputProperty
- type CfnMemory_InvocationConfigurationInputProperty
- type CfnMemory_KinesisResourceProperty
- type CfnMemory_MemoryStrategyProperty
- type CfnMemory_MessageBasedTriggerInputProperty
- type CfnMemory_SelfManagedConfigurationProperty
- type CfnMemory_SemanticMemoryStrategyProperty
- type CfnMemory_SemanticOverrideConsolidationConfigurationInputProperty
- type CfnMemory_SemanticOverrideExtractionConfigurationInputProperty
- type CfnMemory_SemanticOverrideProperty
- type CfnMemory_StreamDeliveryResourceProperty
- type CfnMemory_StreamDeliveryResourcesProperty
- type CfnMemory_SummaryMemoryStrategyProperty
- type CfnMemory_SummaryOverrideConsolidationConfigurationInputProperty
- type CfnMemory_SummaryOverrideProperty
- type CfnMemory_TimeBasedTriggerInputProperty
- type CfnMemory_TokenBasedTriggerInputProperty
- type CfnMemory_TriggerConditionInputProperty
- type CfnMemory_UserPreferenceMemoryStrategyProperty
- type CfnMemory_UserPreferenceOverrideConsolidationConfigurationInputProperty
- type CfnMemory_UserPreferenceOverrideExtractionConfigurationInputProperty
- type CfnMemory_UserPreferenceOverrideProperty
- type CfnOAuth2CredentialProvider
- type CfnOAuth2CredentialProviderProps
- type CfnOAuth2CredentialProvider_AtlassianOauth2ProviderConfigInputProperty
- type CfnOAuth2CredentialProvider_ClientSecretArnProperty
- type CfnOAuth2CredentialProvider_CustomOauth2ProviderConfigInputProperty
- type CfnOAuth2CredentialProvider_GithubOauth2ProviderConfigInputProperty
- type CfnOAuth2CredentialProvider_GoogleOauth2ProviderConfigInputProperty
- type CfnOAuth2CredentialProvider_IncludedOauth2ProviderConfigInputProperty
- type CfnOAuth2CredentialProvider_LinkedinOauth2ProviderConfigInputProperty
- type CfnOAuth2CredentialProvider_MicrosoftOauth2ProviderConfigInputProperty
- type CfnOAuth2CredentialProvider_Oauth2AuthorizationServerMetadataProperty
- type CfnOAuth2CredentialProvider_Oauth2DiscoveryProperty
- type CfnOAuth2CredentialProvider_Oauth2ProviderConfigInputProperty
- type CfnOAuth2CredentialProvider_Oauth2ProviderConfigOutputProperty
- type CfnOAuth2CredentialProvider_SalesforceOauth2ProviderConfigInputProperty
- type CfnOAuth2CredentialProvider_SlackOauth2ProviderConfigInputProperty
- type CfnOnlineEvaluationConfig
- type CfnOnlineEvaluationConfigProps
- type CfnOnlineEvaluationConfig_CloudWatchLogsInputConfigProperty
- type CfnOnlineEvaluationConfig_CloudWatchOutputConfigProperty
- type CfnOnlineEvaluationConfig_DataSourceConfigProperty
- type CfnOnlineEvaluationConfig_EvaluatorReferenceProperty
- type CfnOnlineEvaluationConfig_FilterProperty
- type CfnOnlineEvaluationConfig_FilterValueProperty
- type CfnOnlineEvaluationConfig_OutputConfigProperty
- type CfnOnlineEvaluationConfig_RuleProperty
- type CfnOnlineEvaluationConfig_SamplingConfigProperty
- type CfnOnlineEvaluationConfig_SessionConfigProperty
- type CfnPolicy
- type CfnPolicyEngine
- type CfnPolicyEngineProps
- type CfnPolicyProps
- type CfnPolicy_CedarPolicyProperty
- type CfnPolicy_PolicyDefinitionProperty
- type CfnRuntime
- type CfnRuntimeEndpoint
- type CfnRuntimeEndpointProps
- type CfnRuntimeProps
- type CfnRuntime_AgentRuntimeArtifactProperty
- type CfnRuntime_AuthorizerConfigurationProperty
- type CfnRuntime_AuthorizingClaimMatchValueTypeProperty
- type CfnRuntime_ClaimMatchValueTypeProperty
- type CfnRuntime_CodeConfigurationProperty
- type CfnRuntime_CodeProperty
- type CfnRuntime_ContainerConfigurationProperty
- type CfnRuntime_CustomClaimValidationTypeProperty
- type CfnRuntime_CustomJWTAuthorizerConfigurationProperty
- type CfnRuntime_FilesystemConfigurationProperty
- type CfnRuntime_LifecycleConfigurationProperty
- type CfnRuntime_NetworkConfigurationProperty
- type CfnRuntime_RequestHeaderConfigurationProperty
- type CfnRuntime_S3LocationProperty
- type CfnRuntime_SessionStorageConfigurationProperty
- type CfnRuntime_VpcConfigProperty
- type CfnRuntime_WorkloadIdentityDetailsProperty
- type CfnWorkloadIdentity
- type CfnWorkloadIdentityProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnApiKeyCredentialProvider_CFN_RESOURCE_TYPE_NAME ¶ added in v2.250.0
func CfnApiKeyCredentialProvider_CFN_RESOURCE_TYPE_NAME() *string
func CfnApiKeyCredentialProvider_IsCfnApiKeyCredentialProvider ¶ added in v2.250.0
func CfnApiKeyCredentialProvider_IsCfnApiKeyCredentialProvider(x interface{}) *bool
Checks whether the given object is a CfnApiKeyCredentialProvider.
func CfnApiKeyCredentialProvider_IsCfnElement ¶ added in v2.250.0
func CfnApiKeyCredentialProvider_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnApiKeyCredentialProvider_IsCfnResource ¶ added in v2.250.0
func CfnApiKeyCredentialProvider_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnApiKeyCredentialProvider_IsConstruct ¶ added in v2.250.0
func CfnApiKeyCredentialProvider_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnBrowserCustom_ArnForBrowserCustom ¶ added in v2.227.0
func CfnBrowserCustom_ArnForBrowserCustom(resource interfacesawsbedrockagentcore.IBrowserCustomRef) *string
func CfnBrowserCustom_CFN_RESOURCE_TYPE_NAME ¶
func CfnBrowserCustom_CFN_RESOURCE_TYPE_NAME() *string
func CfnBrowserCustom_FromBrowserCustomArn ¶ added in v2.231.0
func CfnBrowserCustom_FromBrowserCustomArn(scope constructs.Construct, id *string, arn *string) interfacesawsbedrockagentcore.IBrowserCustomRef
Creates a new IBrowserCustomRef from an ARN.
func CfnBrowserCustom_FromBrowserId ¶ added in v2.219.0
func CfnBrowserCustom_FromBrowserId(scope constructs.Construct, id *string, browserId *string) interfacesawsbedrockagentcore.IBrowserCustomRef
Creates a new IBrowserCustomRef from a browserId.
func CfnBrowserCustom_IsCfnBrowserCustom ¶ added in v2.231.0
func CfnBrowserCustom_IsCfnBrowserCustom(x interface{}) *bool
Checks whether the given object is a CfnBrowserCustom.
func CfnBrowserCustom_IsCfnElement ¶
func CfnBrowserCustom_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnBrowserCustom_IsCfnResource ¶
func CfnBrowserCustom_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnBrowserCustom_IsConstruct ¶
func CfnBrowserCustom_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnBrowserProfile_ArnForBrowserProfile ¶ added in v2.242.0
func CfnBrowserProfile_ArnForBrowserProfile(resource interfacesawsbedrockagentcore.IBrowserProfileRef) *string
func CfnBrowserProfile_CFN_RESOURCE_TYPE_NAME ¶ added in v2.242.0
func CfnBrowserProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnBrowserProfile_IsCfnBrowserProfile ¶ added in v2.242.0
func CfnBrowserProfile_IsCfnBrowserProfile(x interface{}) *bool
Checks whether the given object is a CfnBrowserProfile.
func CfnBrowserProfile_IsCfnElement ¶ added in v2.242.0
func CfnBrowserProfile_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnBrowserProfile_IsCfnResource ¶ added in v2.242.0
func CfnBrowserProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnBrowserProfile_IsConstruct ¶ added in v2.242.0
func CfnBrowserProfile_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnCodeInterpreterCustom_ArnForCodeInterpreterCustom ¶ added in v2.227.0
func CfnCodeInterpreterCustom_ArnForCodeInterpreterCustom(resource interfacesawsbedrockagentcore.ICodeInterpreterCustomRef) *string
func CfnCodeInterpreterCustom_CFN_RESOURCE_TYPE_NAME ¶
func CfnCodeInterpreterCustom_CFN_RESOURCE_TYPE_NAME() *string
func CfnCodeInterpreterCustom_FromCodeInterpreterCustomArn ¶ added in v2.231.0
func CfnCodeInterpreterCustom_FromCodeInterpreterCustomArn(scope constructs.Construct, id *string, arn *string) interfacesawsbedrockagentcore.ICodeInterpreterCustomRef
Creates a new ICodeInterpreterCustomRef from an ARN.
func CfnCodeInterpreterCustom_FromCodeInterpreterId ¶ added in v2.219.0
func CfnCodeInterpreterCustom_FromCodeInterpreterId(scope constructs.Construct, id *string, codeInterpreterId *string) interfacesawsbedrockagentcore.ICodeInterpreterCustomRef
Creates a new ICodeInterpreterCustomRef from a codeInterpreterId.
func CfnCodeInterpreterCustom_IsCfnCodeInterpreterCustom ¶ added in v2.231.0
func CfnCodeInterpreterCustom_IsCfnCodeInterpreterCustom(x interface{}) *bool
Checks whether the given object is a CfnCodeInterpreterCustom.
func CfnCodeInterpreterCustom_IsCfnElement ¶
func CfnCodeInterpreterCustom_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCodeInterpreterCustom_IsCfnResource ¶
func CfnCodeInterpreterCustom_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCodeInterpreterCustom_IsConstruct ¶
func CfnCodeInterpreterCustom_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnEvaluator_ArnForEvaluator ¶ added in v2.242.0
func CfnEvaluator_ArnForEvaluator(resource interfacesawsbedrockagentcore.IEvaluatorRef) *string
func CfnEvaluator_CFN_RESOURCE_TYPE_NAME ¶ added in v2.242.0
func CfnEvaluator_CFN_RESOURCE_TYPE_NAME() *string
func CfnEvaluator_IsCfnElement ¶ added in v2.242.0
func CfnEvaluator_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnEvaluator_IsCfnEvaluator ¶ added in v2.242.0
func CfnEvaluator_IsCfnEvaluator(x interface{}) *bool
Checks whether the given object is a CfnEvaluator.
func CfnEvaluator_IsCfnResource ¶ added in v2.242.0
func CfnEvaluator_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEvaluator_IsConstruct ¶ added in v2.242.0
func CfnEvaluator_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnGatewayTarget_CFN_RESOURCE_TYPE_NAME ¶ added in v2.220.0
func CfnGatewayTarget_CFN_RESOURCE_TYPE_NAME() *string
func CfnGatewayTarget_IsCfnElement ¶ added in v2.220.0
func CfnGatewayTarget_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGatewayTarget_IsCfnGatewayTarget ¶ added in v2.231.0
func CfnGatewayTarget_IsCfnGatewayTarget(x interface{}) *bool
Checks whether the given object is a CfnGatewayTarget.
func CfnGatewayTarget_IsCfnResource ¶ added in v2.220.0
func CfnGatewayTarget_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnGatewayTarget_IsConstruct ¶ added in v2.220.0
func CfnGatewayTarget_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnGateway_ArnForGateway ¶ added in v2.227.0
func CfnGateway_ArnForGateway(resource interfacesawsbedrockagentcore.IGatewayRef) *string
func CfnGateway_CFN_RESOURCE_TYPE_NAME ¶ added in v2.220.0
func CfnGateway_CFN_RESOURCE_TYPE_NAME() *string
func CfnGateway_IsCfnElement ¶ added in v2.220.0
func CfnGateway_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGateway_IsCfnGateway ¶ added in v2.231.0
func CfnGateway_IsCfnGateway(x interface{}) *bool
Checks whether the given object is a CfnGateway.
func CfnGateway_IsCfnResource ¶ added in v2.220.0
func CfnGateway_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnGateway_IsConstruct ¶ added in v2.220.0
func CfnGateway_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnMemory_ArnForMemory ¶ added in v2.227.0
func CfnMemory_ArnForMemory(resource interfacesawsbedrockagentcore.IMemoryRef) *string
func CfnMemory_CFN_RESOURCE_TYPE_NAME ¶ added in v2.220.0
func CfnMemory_CFN_RESOURCE_TYPE_NAME() *string
func CfnMemory_IsCfnElement ¶ added in v2.220.0
func CfnMemory_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnMemory_IsCfnMemory ¶ added in v2.231.0
func CfnMemory_IsCfnMemory(x interface{}) *bool
Checks whether the given object is a CfnMemory.
func CfnMemory_IsCfnResource ¶ added in v2.220.0
func CfnMemory_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMemory_IsConstruct ¶ added in v2.220.0
func CfnMemory_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnOAuth2CredentialProvider_CFN_RESOURCE_TYPE_NAME ¶ added in v2.250.0
func CfnOAuth2CredentialProvider_CFN_RESOURCE_TYPE_NAME() *string
func CfnOAuth2CredentialProvider_IsCfnElement ¶ added in v2.250.0
func CfnOAuth2CredentialProvider_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnOAuth2CredentialProvider_IsCfnOAuth2CredentialProvider ¶ added in v2.250.0
func CfnOAuth2CredentialProvider_IsCfnOAuth2CredentialProvider(x interface{}) *bool
Checks whether the given object is a CfnOAuth2CredentialProvider.
func CfnOAuth2CredentialProvider_IsCfnResource ¶ added in v2.250.0
func CfnOAuth2CredentialProvider_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnOAuth2CredentialProvider_IsConstruct ¶ added in v2.250.0
func CfnOAuth2CredentialProvider_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnOnlineEvaluationConfig_ArnForOnlineEvaluationConfig ¶ added in v2.242.0
func CfnOnlineEvaluationConfig_ArnForOnlineEvaluationConfig(resource interfacesawsbedrockagentcore.IOnlineEvaluationConfigRef) *string
func CfnOnlineEvaluationConfig_CFN_RESOURCE_TYPE_NAME ¶ added in v2.242.0
func CfnOnlineEvaluationConfig_CFN_RESOURCE_TYPE_NAME() *string
func CfnOnlineEvaluationConfig_IsCfnElement ¶ added in v2.242.0
func CfnOnlineEvaluationConfig_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnOnlineEvaluationConfig_IsCfnOnlineEvaluationConfig ¶ added in v2.242.0
func CfnOnlineEvaluationConfig_IsCfnOnlineEvaluationConfig(x interface{}) *bool
Checks whether the given object is a CfnOnlineEvaluationConfig.
func CfnOnlineEvaluationConfig_IsCfnResource ¶ added in v2.242.0
func CfnOnlineEvaluationConfig_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnOnlineEvaluationConfig_IsConstruct ¶ added in v2.242.0
func CfnOnlineEvaluationConfig_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnPolicyEngine_ArnForPolicyEngine ¶ added in v2.242.0
func CfnPolicyEngine_ArnForPolicyEngine(resource interfacesawsbedrockagentcore.IPolicyEngineRef) *string
func CfnPolicyEngine_CFN_RESOURCE_TYPE_NAME ¶ added in v2.242.0
func CfnPolicyEngine_CFN_RESOURCE_TYPE_NAME() *string
func CfnPolicyEngine_IsCfnElement ¶ added in v2.242.0
func CfnPolicyEngine_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnPolicyEngine_IsCfnPolicyEngine ¶ added in v2.242.0
func CfnPolicyEngine_IsCfnPolicyEngine(x interface{}) *bool
Checks whether the given object is a CfnPolicyEngine.
func CfnPolicyEngine_IsCfnResource ¶ added in v2.242.0
func CfnPolicyEngine_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPolicyEngine_IsConstruct ¶ added in v2.242.0
func CfnPolicyEngine_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnPolicy_ArnForPolicy ¶ added in v2.242.0
func CfnPolicy_ArnForPolicy(resource interfacesawsbedrockagentcore.IPolicyRef) *string
func CfnPolicy_CFN_RESOURCE_TYPE_NAME ¶ added in v2.242.0
func CfnPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnPolicy_IsCfnElement ¶ added in v2.242.0
func CfnPolicy_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnPolicy_IsCfnPolicy ¶ added in v2.242.0
func CfnPolicy_IsCfnPolicy(x interface{}) *bool
Checks whether the given object is a CfnPolicy.
func CfnPolicy_IsCfnResource ¶ added in v2.242.0
func CfnPolicy_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPolicy_IsConstruct ¶ added in v2.242.0
func CfnPolicy_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnRuntimeEndpoint_CFN_RESOURCE_TYPE_NAME ¶
func CfnRuntimeEndpoint_CFN_RESOURCE_TYPE_NAME() *string
func CfnRuntimeEndpoint_IsCfnElement ¶
func CfnRuntimeEndpoint_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnRuntimeEndpoint_IsCfnResource ¶
func CfnRuntimeEndpoint_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRuntimeEndpoint_IsCfnRuntimeEndpoint ¶ added in v2.231.0
func CfnRuntimeEndpoint_IsCfnRuntimeEndpoint(x interface{}) *bool
Checks whether the given object is a CfnRuntimeEndpoint.
func CfnRuntimeEndpoint_IsConstruct ¶
func CfnRuntimeEndpoint_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnRuntime_ArnForRuntime ¶ added in v2.231.0
func CfnRuntime_ArnForRuntime(resource interfacesawsbedrockagentcore.IRuntimeRef) *string
func CfnRuntime_CFN_RESOURCE_TYPE_NAME ¶
func CfnRuntime_CFN_RESOURCE_TYPE_NAME() *string
func CfnRuntime_IsCfnElement ¶
func CfnRuntime_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnRuntime_IsCfnResource ¶
func CfnRuntime_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRuntime_IsCfnRuntime ¶ added in v2.231.0
func CfnRuntime_IsCfnRuntime(x interface{}) *bool
Checks whether the given object is a CfnRuntime.
func CfnRuntime_IsConstruct ¶
func CfnRuntime_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnWorkloadIdentity_ArnForWorkloadIdentity ¶ added in v2.227.0
func CfnWorkloadIdentity_ArnForWorkloadIdentity(resource interfacesawsbedrockagentcore.IWorkloadIdentityRef) *string
func CfnWorkloadIdentity_CFN_RESOURCE_TYPE_NAME ¶ added in v2.224.0
func CfnWorkloadIdentity_CFN_RESOURCE_TYPE_NAME() *string
func CfnWorkloadIdentity_IsCfnElement ¶ added in v2.224.0
func CfnWorkloadIdentity_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnWorkloadIdentity_IsCfnResource ¶ added in v2.224.0
func CfnWorkloadIdentity_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnWorkloadIdentity_IsCfnWorkloadIdentity ¶ added in v2.231.0
func CfnWorkloadIdentity_IsCfnWorkloadIdentity(x interface{}) *bool
Checks whether the given object is a CfnWorkloadIdentity.
func CfnWorkloadIdentity_IsConstruct ¶ added in v2.224.0
func CfnWorkloadIdentity_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnApiKeyCredentialProvider_Override ¶ added in v2.250.0
func NewCfnApiKeyCredentialProvider_Override(c CfnApiKeyCredentialProvider, scope constructs.Construct, id *string, props *CfnApiKeyCredentialProviderProps)
Create a new `AWS::BedrockAgentCore::ApiKeyCredentialProvider`.
func NewCfnBrowserCustom_Override ¶
func NewCfnBrowserCustom_Override(c CfnBrowserCustom, scope constructs.Construct, id *string, props *CfnBrowserCustomProps)
Create a new `AWS::BedrockAgentCore::BrowserCustom`.
func NewCfnBrowserProfile_Override ¶ added in v2.242.0
func NewCfnBrowserProfile_Override(c CfnBrowserProfile, scope constructs.Construct, id *string, props *CfnBrowserProfileProps)
Create a new `AWS::BedrockAgentCore::BrowserProfile`.
func NewCfnCodeInterpreterCustom_Override ¶
func NewCfnCodeInterpreterCustom_Override(c CfnCodeInterpreterCustom, scope constructs.Construct, id *string, props *CfnCodeInterpreterCustomProps)
Create a new `AWS::BedrockAgentCore::CodeInterpreterCustom`.
func NewCfnEvaluator_Override ¶ added in v2.242.0
func NewCfnEvaluator_Override(c CfnEvaluator, scope constructs.Construct, id *string, props *CfnEvaluatorProps)
Create a new `AWS::BedrockAgentCore::Evaluator`.
func NewCfnGatewayTarget_Override ¶ added in v2.220.0
func NewCfnGatewayTarget_Override(c CfnGatewayTarget, scope constructs.Construct, id *string, props *CfnGatewayTargetProps)
Create a new `AWS::BedrockAgentCore::GatewayTarget`.
func NewCfnGateway_Override ¶ added in v2.220.0
func NewCfnGateway_Override(c CfnGateway, scope constructs.Construct, id *string, props *CfnGatewayProps)
Create a new `AWS::BedrockAgentCore::Gateway`.
func NewCfnMemory_Override ¶ added in v2.220.0
func NewCfnMemory_Override(c CfnMemory, scope constructs.Construct, id *string, props *CfnMemoryProps)
Create a new `AWS::BedrockAgentCore::Memory`.
func NewCfnOAuth2CredentialProvider_Override ¶ added in v2.250.0
func NewCfnOAuth2CredentialProvider_Override(c CfnOAuth2CredentialProvider, scope constructs.Construct, id *string, props *CfnOAuth2CredentialProviderProps)
Create a new `AWS::BedrockAgentCore::OAuth2CredentialProvider`.
func NewCfnOnlineEvaluationConfig_Override ¶ added in v2.242.0
func NewCfnOnlineEvaluationConfig_Override(c CfnOnlineEvaluationConfig, scope constructs.Construct, id *string, props *CfnOnlineEvaluationConfigProps)
Create a new `AWS::BedrockAgentCore::OnlineEvaluationConfig`.
func NewCfnPolicyEngine_Override ¶ added in v2.242.0
func NewCfnPolicyEngine_Override(c CfnPolicyEngine, scope constructs.Construct, id *string, props *CfnPolicyEngineProps)
Create a new `AWS::BedrockAgentCore::PolicyEngine`.
func NewCfnPolicy_Override ¶ added in v2.242.0
func NewCfnPolicy_Override(c CfnPolicy, scope constructs.Construct, id *string, props *CfnPolicyProps)
Create a new `AWS::BedrockAgentCore::Policy`.
func NewCfnRuntimeEndpoint_Override ¶
func NewCfnRuntimeEndpoint_Override(c CfnRuntimeEndpoint, scope constructs.Construct, id *string, props *CfnRuntimeEndpointProps)
Create a new `AWS::BedrockAgentCore::RuntimeEndpoint`.
func NewCfnRuntime_Override ¶
func NewCfnRuntime_Override(c CfnRuntime, scope constructs.Construct, id *string, props *CfnRuntimeProps)
Create a new `AWS::BedrockAgentCore::Runtime`.
func NewCfnWorkloadIdentity_Override ¶ added in v2.224.0
func NewCfnWorkloadIdentity_Override(c CfnWorkloadIdentity, scope constructs.Construct, id *string, props *CfnWorkloadIdentityProps)
Create a new `AWS::BedrockAgentCore::WorkloadIdentity`.
Types ¶
type CfnApiKeyCredentialProvider ¶ added in v2.250.0
type CfnApiKeyCredentialProvider interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IApiKeyCredentialProviderRef
awscdk.ITaggableV2
// The API key to use for authentication.
ApiKey() *string
SetApiKey(val *string)
// A reference to a ApiKeyCredentialProvider resource.
ApiKeyCredentialProviderRef() *interfacesawsbedrockagentcore.ApiKeyCredentialProviderReference
// Contains information about the API key secret in AWS Secrets Manager.
AttrApiKeySecretArn() awscdk.IResolvable
// The timestamp when the credential provider was created.
AttrCreatedTime() *string
// The Amazon Resource Name (ARN) of the API key credential provider.
AttrCredentialProviderArn() *string
// The timestamp when the credential provider was last updated.
AttrLastUpdatedTime() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the API key credential provider.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tags to assign to the API key credential provider.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource Type definition for AWS::BedrockAgentCore::ApiKeyCredentialProvider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnApiKeyCredentialProvider := awscdk.Aws_bedrockagentcore.NewCfnApiKeyCredentialProvider(this, jsii.String("MyCfnApiKeyCredentialProvider"), &CfnApiKeyCredentialProviderProps{
Name: jsii.String("name"),
// the properties below are optional
ApiKey: jsii.String("apiKey"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnApiKeyCredentialProvider ¶ added in v2.250.0
func NewCfnApiKeyCredentialProvider(scope constructs.Construct, id *string, props *CfnApiKeyCredentialProviderProps) CfnApiKeyCredentialProvider
Create a new `AWS::BedrockAgentCore::ApiKeyCredentialProvider`.
type CfnApiKeyCredentialProviderProps ¶ added in v2.250.0
type CfnApiKeyCredentialProviderProps struct {
// The name of the API key credential provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The API key to use for authentication.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-apikey
//
ApiKey *string `field:"optional" json:"apiKey" yaml:"apiKey"`
// Tags to assign to the API key credential provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnApiKeyCredentialProvider`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnApiKeyCredentialProviderProps := &CfnApiKeyCredentialProviderProps{
Name: jsii.String("name"),
// the properties below are optional
ApiKey: jsii.String("apiKey"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnApiKeyCredentialProvider_ApiKeySecretArnProperty ¶ added in v2.250.0
type CfnApiKeyCredentialProvider_ApiKeySecretArnProperty struct {
// The ARN of the secret in AWS Secrets Manager.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-apikeycredentialprovider-apikeysecretarn.html#cfn-bedrockagentcore-apikeycredentialprovider-apikeysecretarn-secretarn
//
SecretArn *string `field:"required" json:"secretArn" yaml:"secretArn"`
}
Contains information about the API key secret in AWS Secrets Manager.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
apiKeySecretArnProperty := &ApiKeySecretArnProperty{
SecretArn: jsii.String("secretArn"),
}
type CfnBrowserCustom ¶
type CfnBrowserCustom interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IBrowserCustomRef
awscdk.ITaggableV2
// The ARN for the custom browser.
AttrBrowserArn() *string
// The ID for the custom browser.
AttrBrowserId() *string
// The time at which the custom browser was created.
AttrCreatedAt() *string
// The reason for failure if the browser creation or operation failed.
AttrFailureReason() *string
// The time at which the custom browser was last updated.
AttrLastUpdatedAt() *string
// The status of the custom browser.
AttrStatus() *string
// A reference to a BrowserCustom resource.
BrowserCustomRef() *interfacesawsbedrockagentcore.BrowserCustomReference
// Browser signing configuration.
BrowserSigning() interface{}
SetBrowserSigning(val interface{})
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The custom browser.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The Amazon Resource Name (ARN) of the execution role.
ExecutionRoleArn() *string
SetExecutionRoleArn(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the custom browser.
Name() *string
SetName(val *string)
// The network configuration for a code interpreter.
NetworkConfiguration() interface{}
SetNetworkConfiguration(val interface{})
// The tree node.
Node() constructs.Node
// THe custom browser configuration.
RecordingConfig() interface{}
SetRecordingConfig(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags for the custom browser.
Tags() *map[string]*string
SetTags(val *map[string]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
AgentCore Browser tool provides a fast, secure, cloud-based browser runtime to enable AI agents to interact with websites at scale.
For more information about using the custom browser, see [Interact with web applications using Amazon Bedrock AgentCore Browser](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/browser-tool.html) .
See the *Properties* section below for descriptions of both the required and optional properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnBrowserCustom := awscdk.Aws_bedrockagentcore.NewCfnBrowserCustom(this, jsii.String("MyCfnBrowserCustom"), &CfnBrowserCustomProps{
Name: jsii.String("name"),
NetworkConfiguration: &BrowserNetworkConfigurationProperty{
NetworkMode: jsii.String("networkMode"),
// the properties below are optional
VpcConfig: &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
},
},
// the properties below are optional
BrowserSigning: &BrowserSigningProperty{
Enabled: jsii.Boolean(false),
},
Description: jsii.String("description"),
ExecutionRoleArn: jsii.String("executionRoleArn"),
RecordingConfig: &RecordingConfigProperty{
Enabled: jsii.Boolean(false),
S3Location: &S3LocationProperty{
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnBrowserCustom ¶
func NewCfnBrowserCustom(scope constructs.Construct, id *string, props *CfnBrowserCustomProps) CfnBrowserCustom
Create a new `AWS::BedrockAgentCore::BrowserCustom`.
type CfnBrowserCustomProps ¶
type CfnBrowserCustomProps struct {
// The name of the custom browser.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The network configuration for a code interpreter.
//
// This structure defines how the code interpreter connects to the network.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-networkconfiguration
//
NetworkConfiguration interface{} `field:"required" json:"networkConfiguration" yaml:"networkConfiguration"`
// Browser signing configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-browsersigning
//
BrowserSigning interface{} `field:"optional" json:"browserSigning" yaml:"browserSigning"`
// The custom browser.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The Amazon Resource Name (ARN) of the execution role.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-executionrolearn
//
ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"`
// THe custom browser configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-recordingconfig
//
RecordingConfig interface{} `field:"optional" json:"recordingConfig" yaml:"recordingConfig"`
// The tags for the custom browser.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browsercustom.html#cfn-bedrockagentcore-browsercustom-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnBrowserCustom`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnBrowserCustomProps := &CfnBrowserCustomProps{
Name: jsii.String("name"),
NetworkConfiguration: &BrowserNetworkConfigurationProperty{
NetworkMode: jsii.String("networkMode"),
// the properties below are optional
VpcConfig: &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
},
},
// the properties below are optional
BrowserSigning: &BrowserSigningProperty{
Enabled: jsii.Boolean(false),
},
Description: jsii.String("description"),
ExecutionRoleArn: jsii.String("executionRoleArn"),
RecordingConfig: &RecordingConfigProperty{
Enabled: jsii.Boolean(false),
S3Location: &S3LocationProperty{
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnBrowserCustom_BrowserNetworkConfigurationProperty ¶
type CfnBrowserCustom_BrowserNetworkConfigurationProperty struct {
// The network mode.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration.html#cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-networkmode
//
NetworkMode *string `field:"required" json:"networkMode" yaml:"networkMode"`
// Network mode configuration for VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsernetworkconfiguration.html#cfn-bedrockagentcore-browsercustom-browsernetworkconfiguration-vpcconfig
//
VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"vpcConfig"`
}
The network configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
browserNetworkConfigurationProperty := &BrowserNetworkConfigurationProperty{
NetworkMode: jsii.String("networkMode"),
// the properties below are optional
VpcConfig: &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
},
}
type CfnBrowserCustom_BrowserSigningProperty ¶ added in v2.224.0
type CfnBrowserCustom_BrowserSigningProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-browsersigning.html#cfn-bedrockagentcore-browsercustom-browsersigning-enabled
//
// Default: - false.
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
}
Browser signing configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
browserSigningProperty := &BrowserSigningProperty{
Enabled: jsii.Boolean(false),
}
type CfnBrowserCustom_RecordingConfigProperty ¶
type CfnBrowserCustom_RecordingConfigProperty struct {
// The recording configuration for a browser.
//
// This structure defines how browser sessions are recorded.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-recordingconfig.html#cfn-bedrockagentcore-browsercustom-recordingconfig-enabled
//
// Default: - false.
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
// The S3 location.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-recordingconfig.html#cfn-bedrockagentcore-browsercustom-recordingconfig-s3location
//
S3Location interface{} `field:"optional" json:"s3Location" yaml:"s3Location"`
}
The recording configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
recordingConfigProperty := &RecordingConfigProperty{
Enabled: jsii.Boolean(false),
S3Location: &S3LocationProperty{
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
},
}
type CfnBrowserCustom_S3LocationProperty ¶
type CfnBrowserCustom_S3LocationProperty struct {
// The S3 location bucket name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-s3location.html#cfn-bedrockagentcore-browsercustom-s3location-bucket
//
Bucket *string `field:"required" json:"bucket" yaml:"bucket"`
// The S3 location object prefix.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-s3location.html#cfn-bedrockagentcore-browsercustom-s3location-prefix
//
Prefix *string `field:"required" json:"prefix" yaml:"prefix"`
}
The S3 location.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
s3LocationProperty := &S3LocationProperty{
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
}
type CfnBrowserCustom_VpcConfigProperty ¶ added in v2.220.0
type CfnBrowserCustom_VpcConfigProperty struct {
// Security groups for VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-vpcconfig.html#cfn-bedrockagentcore-browsercustom-vpcconfig-securitygroups
//
SecurityGroups *[]*string `field:"required" json:"securityGroups" yaml:"securityGroups"`
// Subnets for VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-browsercustom-vpcconfig.html#cfn-bedrockagentcore-browsercustom-vpcconfig-subnets
//
Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"`
}
Network mode configuration for VPC.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vpcConfigProperty := &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
}
type CfnBrowserProfile ¶ added in v2.242.0
type CfnBrowserProfile interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IBrowserProfileRef
awscdk.ITaggableV2
// Timestamp when the browser profile was created.
AttrCreatedAt() *string
// Timestamp when the browser profile was last saved.
AttrLastSavedAt() *string
// ID of the last saved browser.
AttrLastSavedBrowserId() *string
// ID of the last saved browser session.
AttrLastSavedBrowserSessionId() *string
// Timestamp when the browser profile was last updated.
AttrLastUpdatedAt() *string
// The ARN of a BrowserProfile resource.
AttrProfileArn() *string
// The id of the browser profile.
AttrProfileId() *string
// Status of browser profile.
AttrStatus() *string
// A reference to a BrowserProfile resource.
BrowserProfileRef() *interfacesawsbedrockagentcore.BrowserProfileReference
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the browser profile.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the browser profile.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// A map of tag keys and values.
Tags() *map[string]*string
SetTags(val *map[string]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource definition for AWS::BedrockAgentCore::BrowserProfile.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnBrowserProfile := awscdk.Aws_bedrockagentcore.NewCfnBrowserProfile(this, jsii.String("MyCfnBrowserProfile"), &CfnBrowserProfileProps{
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnBrowserProfile ¶ added in v2.242.0
func NewCfnBrowserProfile(scope constructs.Construct, id *string, props *CfnBrowserProfileProps) CfnBrowserProfile
Create a new `AWS::BedrockAgentCore::BrowserProfile`.
type CfnBrowserProfileProps ¶ added in v2.242.0
type CfnBrowserProfileProps struct {
// The name of the browser profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browserprofile.html#cfn-bedrockagentcore-browserprofile-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The description of the browser profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browserprofile.html#cfn-bedrockagentcore-browserprofile-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// A map of tag keys and values.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-browserprofile.html#cfn-bedrockagentcore-browserprofile-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnBrowserProfile`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnBrowserProfileProps := &CfnBrowserProfileProps{
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnCodeInterpreterCustom ¶
type CfnCodeInterpreterCustom interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.ICodeInterpreterCustomRef
awscdk.ITaggableV2
// The code interpreter Amazon Resource Name (ARN).
AttrCodeInterpreterArn() *string
// The ID of the code interpreter.
AttrCodeInterpreterId() *string
// The time at which the code interpreter was created.
AttrCreatedAt() *string
// The reason for failure if the code interpreter creation or operation failed.
AttrFailureReason() *string
// The time at which the code interpreter was last updated.
AttrLastUpdatedAt() *string
// The status of the custom code interpreter.
AttrStatus() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// A reference to a CodeInterpreterCustom resource.
CodeInterpreterCustomRef() *interfacesawsbedrockagentcore.CodeInterpreterCustomReference
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The code interpreter description.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The Amazon Resource Name (ARN) of the execution role.
ExecutionRoleArn() *string
SetExecutionRoleArn(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the code interpreter.
Name() *string
SetName(val *string)
// The network configuration for a code interpreter.
NetworkConfiguration() interface{}
SetNetworkConfiguration(val interface{})
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags for the code interpreter.
Tags() *map[string]*string
SetTags(val *map[string]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
The AgentCore Code Interpreter tool enables agents to securely execute code in isolated sandbox environments.
It offers advanced configuration support and seamless integration with popular frameworks.
For more information about using the custom code interpreter, see [Execute code and analyze data using Amazon Bedrock AgentCore Code Interpreter](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/code-interpreter-tool.html) .
See the *Properties* section below for descriptions of both the required and optional properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCodeInterpreterCustom := awscdk.Aws_bedrockagentcore.NewCfnCodeInterpreterCustom(this, jsii.String("MyCfnCodeInterpreterCustom"), &CfnCodeInterpreterCustomProps{
Name: jsii.String("name"),
NetworkConfiguration: &CodeInterpreterNetworkConfigurationProperty{
NetworkMode: jsii.String("networkMode"),
// the properties below are optional
VpcConfig: &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
},
},
// the properties below are optional
Description: jsii.String("description"),
ExecutionRoleArn: jsii.String("executionRoleArn"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnCodeInterpreterCustom ¶
func NewCfnCodeInterpreterCustom(scope constructs.Construct, id *string, props *CfnCodeInterpreterCustomProps) CfnCodeInterpreterCustom
Create a new `AWS::BedrockAgentCore::CodeInterpreterCustom`.
type CfnCodeInterpreterCustomProps ¶
type CfnCodeInterpreterCustomProps struct {
// The name of the code interpreter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The network configuration for a code interpreter.
//
// This structure defines how the code interpreter connects to the network.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-networkconfiguration
//
NetworkConfiguration interface{} `field:"required" json:"networkConfiguration" yaml:"networkConfiguration"`
// The code interpreter description.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The Amazon Resource Name (ARN) of the execution role.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-executionrolearn
//
ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"`
// The tags for the code interpreter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-codeinterpretercustom.html#cfn-bedrockagentcore-codeinterpretercustom-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnCodeInterpreterCustom`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCodeInterpreterCustomProps := &CfnCodeInterpreterCustomProps{
Name: jsii.String("name"),
NetworkConfiguration: &CodeInterpreterNetworkConfigurationProperty{
NetworkMode: jsii.String("networkMode"),
// the properties below are optional
VpcConfig: &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
},
},
// the properties below are optional
Description: jsii.String("description"),
ExecutionRoleArn: jsii.String("executionRoleArn"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnCodeInterpreterCustom_CodeInterpreterNetworkConfigurationProperty ¶
type CfnCodeInterpreterCustom_CodeInterpreterNetworkConfigurationProperty struct {
// The network mode.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration.html#cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-networkmode
//
NetworkMode *string `field:"required" json:"networkMode" yaml:"networkMode"`
// Network mode configuration for VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration.html#cfn-bedrockagentcore-codeinterpretercustom-codeinterpreternetworkconfiguration-vpcconfig
//
VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"vpcConfig"`
}
The network configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
codeInterpreterNetworkConfigurationProperty := &CodeInterpreterNetworkConfigurationProperty{
NetworkMode: jsii.String("networkMode"),
// the properties below are optional
VpcConfig: &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
},
}
type CfnCodeInterpreterCustom_VpcConfigProperty ¶ added in v2.220.0
type CfnCodeInterpreterCustom_VpcConfigProperty struct {
// Security groups for VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig.html#cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-securitygroups
//
SecurityGroups *[]*string `field:"required" json:"securityGroups" yaml:"securityGroups"`
// Subnets for VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-codeinterpretercustom-vpcconfig.html#cfn-bedrockagentcore-codeinterpretercustom-vpcconfig-subnets
//
Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"`
}
Network mode configuration for VPC.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vpcConfigProperty := &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
}
type CfnEvaluator ¶ added in v2.242.0
type CfnEvaluator interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IEvaluatorRef
awscdk.ITaggableV2
// The timestamp when the evaluator was created.
AttrCreatedAt() *string
// The Amazon Resource Name (ARN) of the evaluator.
AttrEvaluatorArn() *string
// The unique identifier of the evaluator.
AttrEvaluatorId() *string
AttrStatus() *string
// The timestamp when the evaluator was last updated.
AttrUpdatedAt() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the evaluator.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The configuration that defines how an evaluator assesses agent performance.
EvaluatorConfig() interface{}
SetEvaluatorConfig(val interface{})
// The name of the evaluator.
EvaluatorName() *string
SetEvaluatorName(val *string)
// A reference to a Evaluator resource.
EvaluatorRef() *interfacesawsbedrockagentcore.EvaluatorReference
Level() *string
SetLevel(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// A list of tags to assign to the evaluator.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource Type definition for AWS::BedrockAgentCore::Evaluator - Creates a custom evaluator for agent quality assessment using LLM-as-a-Judge configurations.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var additionalModelRequestFields interface{}
cfnEvaluator := awscdk.Aws_bedrockagentcore.NewCfnEvaluator(this, jsii.String("MyCfnEvaluator"), &CfnEvaluatorProps{
EvaluatorConfig: &EvaluatorConfigProperty{
CodeBased: &CodeBasedEvaluatorConfigProperty{
LambdaConfig: &LambdaEvaluatorConfigProperty{
LambdaArn: jsii.String("lambdaArn"),
// the properties below are optional
LambdaTimeoutInSeconds: jsii.Number(123),
},
},
LlmAsAJudge: &LlmAsAJudgeEvaluatorConfigProperty{
Instructions: jsii.String("instructions"),
ModelConfig: &EvaluatorModelConfigProperty{
BedrockEvaluatorModelConfig: &BedrockEvaluatorModelConfigProperty{
ModelId: jsii.String("modelId"),
// the properties below are optional
AdditionalModelRequestFields: additionalModelRequestFields,
InferenceConfig: &InferenceConfigurationProperty{
MaxTokens: jsii.Number(123),
Temperature: jsii.Number(123),
TopP: jsii.Number(123),
},
},
},
RatingScale: &RatingScaleProperty{
Categorical: []interface{}{
&CategoricalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
},
},
Numerical: []interface{}{
&NumericalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
Value: jsii.Number(123),
},
},
},
},
},
EvaluatorName: jsii.String("evaluatorName"),
Level: jsii.String("level"),
// the properties below are optional
Description: jsii.String("description"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnEvaluator ¶ added in v2.242.0
func NewCfnEvaluator(scope constructs.Construct, id *string, props *CfnEvaluatorProps) CfnEvaluator
Create a new `AWS::BedrockAgentCore::Evaluator`.
type CfnEvaluatorProps ¶ added in v2.242.0
type CfnEvaluatorProps struct {
// The configuration that defines how an evaluator assesses agent performance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html#cfn-bedrockagentcore-evaluator-evaluatorconfig
//
EvaluatorConfig interface{} `field:"required" json:"evaluatorConfig" yaml:"evaluatorConfig"`
// The name of the evaluator.
//
// Must be unique within your account.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html#cfn-bedrockagentcore-evaluator-evaluatorname
//
EvaluatorName *string `field:"required" json:"evaluatorName" yaml:"evaluatorName"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html#cfn-bedrockagentcore-evaluator-level
//
Level *string `field:"required" json:"level" yaml:"level"`
// The description of the evaluator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html#cfn-bedrockagentcore-evaluator-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// A list of tags to assign to the evaluator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html#cfn-bedrockagentcore-evaluator-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnEvaluator`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var additionalModelRequestFields interface{}
cfnEvaluatorProps := &CfnEvaluatorProps{
EvaluatorConfig: &EvaluatorConfigProperty{
CodeBased: &CodeBasedEvaluatorConfigProperty{
LambdaConfig: &LambdaEvaluatorConfigProperty{
LambdaArn: jsii.String("lambdaArn"),
// the properties below are optional
LambdaTimeoutInSeconds: jsii.Number(123),
},
},
LlmAsAJudge: &LlmAsAJudgeEvaluatorConfigProperty{
Instructions: jsii.String("instructions"),
ModelConfig: &EvaluatorModelConfigProperty{
BedrockEvaluatorModelConfig: &BedrockEvaluatorModelConfigProperty{
ModelId: jsii.String("modelId"),
// the properties below are optional
AdditionalModelRequestFields: additionalModelRequestFields,
InferenceConfig: &InferenceConfigurationProperty{
MaxTokens: jsii.Number(123),
Temperature: jsii.Number(123),
TopP: jsii.Number(123),
},
},
},
RatingScale: &RatingScaleProperty{
Categorical: []interface{}{
&CategoricalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
},
},
Numerical: []interface{}{
&NumericalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
Value: jsii.Number(123),
},
},
},
},
},
EvaluatorName: jsii.String("evaluatorName"),
Level: jsii.String("level"),
// the properties below are optional
Description: jsii.String("description"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnEvaluator_BedrockEvaluatorModelConfigProperty ¶ added in v2.242.0
type CfnEvaluator_BedrockEvaluatorModelConfigProperty struct {
// The identifier of the Amazon Bedrock model to use for evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig.html#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-modelid
//
ModelId *string `field:"required" json:"modelId" yaml:"modelId"`
// Additional model-specific request fields.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig.html#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-additionalmodelrequestfields
//
AdditionalModelRequestFields interface{} `field:"optional" json:"additionalModelRequestFields" yaml:"additionalModelRequestFields"`
// The inference configuration parameters that control model behavior during evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-bedrockevaluatormodelconfig.html#cfn-bedrockagentcore-evaluator-bedrockevaluatormodelconfig-inferenceconfig
//
InferenceConfig interface{} `field:"optional" json:"inferenceConfig" yaml:"inferenceConfig"`
}
The configuration for using Amazon Bedrock models in evaluator assessments.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var additionalModelRequestFields interface{}
bedrockEvaluatorModelConfigProperty := &BedrockEvaluatorModelConfigProperty{
ModelId: jsii.String("modelId"),
// the properties below are optional
AdditionalModelRequestFields: additionalModelRequestFields,
InferenceConfig: &InferenceConfigurationProperty{
MaxTokens: jsii.Number(123),
Temperature: jsii.Number(123),
TopP: jsii.Number(123),
},
}
type CfnEvaluator_CategoricalScaleDefinitionProperty ¶ added in v2.242.0
type CfnEvaluator_CategoricalScaleDefinitionProperty struct {
// The description that explains what this categorical rating represents.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-categoricalscaledefinition.html#cfn-bedrockagentcore-evaluator-categoricalscaledefinition-definition
//
Definition *string `field:"required" json:"definition" yaml:"definition"`
// The label of this categorical rating option.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-categoricalscaledefinition.html#cfn-bedrockagentcore-evaluator-categoricalscaledefinition-label
//
Label *string `field:"required" json:"label" yaml:"label"`
}
A categorical rating scale option.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
categoricalScaleDefinitionProperty := &CategoricalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
}
type CfnEvaluator_CodeBasedEvaluatorConfigProperty ¶ added in v2.249.0
type CfnEvaluator_CodeBasedEvaluatorConfigProperty struct {
// The Lambda function configuration for code-based evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-codebasedevaluatorconfig.html#cfn-bedrockagentcore-evaluator-codebasedevaluatorconfig-lambdaconfig
//
LambdaConfig interface{} `field:"required" json:"lambdaConfig" yaml:"lambdaConfig"`
}
The configuration for code-based evaluation using a Lambda function.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
codeBasedEvaluatorConfigProperty := &CodeBasedEvaluatorConfigProperty{
LambdaConfig: &LambdaEvaluatorConfigProperty{
LambdaArn: jsii.String("lambdaArn"),
// the properties below are optional
LambdaTimeoutInSeconds: jsii.Number(123),
},
}
type CfnEvaluator_EvaluatorConfigProperty ¶ added in v2.242.0
type CfnEvaluator_EvaluatorConfigProperty struct {
// The configuration for code-based evaluation using a Lambda function.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-evaluatorconfig.html#cfn-bedrockagentcore-evaluator-evaluatorconfig-codebased
//
CodeBased interface{} `field:"optional" json:"codeBased" yaml:"codeBased"`
// The configuration for LLM-as-a-Judge evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-evaluatorconfig.html#cfn-bedrockagentcore-evaluator-evaluatorconfig-llmasajudge
//
LlmAsAJudge interface{} `field:"optional" json:"llmAsAJudge" yaml:"llmAsAJudge"`
}
The configuration that defines how an evaluator assesses agent performance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var additionalModelRequestFields interface{}
evaluatorConfigProperty := &EvaluatorConfigProperty{
CodeBased: &CodeBasedEvaluatorConfigProperty{
LambdaConfig: &LambdaEvaluatorConfigProperty{
LambdaArn: jsii.String("lambdaArn"),
// the properties below are optional
LambdaTimeoutInSeconds: jsii.Number(123),
},
},
LlmAsAJudge: &LlmAsAJudgeEvaluatorConfigProperty{
Instructions: jsii.String("instructions"),
ModelConfig: &EvaluatorModelConfigProperty{
BedrockEvaluatorModelConfig: &BedrockEvaluatorModelConfigProperty{
ModelId: jsii.String("modelId"),
// the properties below are optional
AdditionalModelRequestFields: additionalModelRequestFields,
InferenceConfig: &InferenceConfigurationProperty{
MaxTokens: jsii.Number(123),
Temperature: jsii.Number(123),
TopP: jsii.Number(123),
},
},
},
RatingScale: &RatingScaleProperty{
Categorical: []interface{}{
&CategoricalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
},
},
Numerical: []interface{}{
&NumericalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
Value: jsii.Number(123),
},
},
},
},
}
type CfnEvaluator_EvaluatorModelConfigProperty ¶ added in v2.242.0
type CfnEvaluator_EvaluatorModelConfigProperty struct {
// The configuration for using Amazon Bedrock models in evaluator assessments.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-evaluatormodelconfig.html#cfn-bedrockagentcore-evaluator-evaluatormodelconfig-bedrockevaluatormodelconfig
//
BedrockEvaluatorModelConfig interface{} `field:"required" json:"bedrockEvaluatorModelConfig" yaml:"bedrockEvaluatorModelConfig"`
}
The model configuration that specifies which foundation model to use for evaluation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var additionalModelRequestFields interface{}
evaluatorModelConfigProperty := &EvaluatorModelConfigProperty{
BedrockEvaluatorModelConfig: &BedrockEvaluatorModelConfigProperty{
ModelId: jsii.String("modelId"),
// the properties below are optional
AdditionalModelRequestFields: additionalModelRequestFields,
InferenceConfig: &InferenceConfigurationProperty{
MaxTokens: jsii.Number(123),
Temperature: jsii.Number(123),
TopP: jsii.Number(123),
},
},
}
type CfnEvaluator_InferenceConfigurationProperty ¶ added in v2.242.0
type CfnEvaluator_InferenceConfigurationProperty struct {
// The maximum number of tokens to generate in the model response.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-inferenceconfiguration.html#cfn-bedrockagentcore-evaluator-inferenceconfiguration-maxtokens
//
MaxTokens *float64 `field:"optional" json:"maxTokens" yaml:"maxTokens"`
// The temperature value that controls randomness in the model's responses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-inferenceconfiguration.html#cfn-bedrockagentcore-evaluator-inferenceconfiguration-temperature
//
Temperature *float64 `field:"optional" json:"temperature" yaml:"temperature"`
// The top-p sampling parameter that controls the diversity of the model's responses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-inferenceconfiguration.html#cfn-bedrockagentcore-evaluator-inferenceconfiguration-topp
//
TopP *float64 `field:"optional" json:"topP" yaml:"topP"`
}
The inference configuration parameters that control model behavior during evaluation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
inferenceConfigurationProperty := &InferenceConfigurationProperty{
MaxTokens: jsii.Number(123),
Temperature: jsii.Number(123),
TopP: jsii.Number(123),
}
type CfnEvaluator_LambdaEvaluatorConfigProperty ¶ added in v2.249.0
type CfnEvaluator_LambdaEvaluatorConfigProperty struct {
// The ARN of the Lambda function used for evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-lambdaevaluatorconfig.html#cfn-bedrockagentcore-evaluator-lambdaevaluatorconfig-lambdaarn
//
LambdaArn *string `field:"required" json:"lambdaArn" yaml:"lambdaArn"`
// The timeout in seconds for the Lambda function invocation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-lambdaevaluatorconfig.html#cfn-bedrockagentcore-evaluator-lambdaevaluatorconfig-lambdatimeoutinseconds
//
LambdaTimeoutInSeconds *float64 `field:"optional" json:"lambdaTimeoutInSeconds" yaml:"lambdaTimeoutInSeconds"`
}
The Lambda function configuration for code-based evaluation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
lambdaEvaluatorConfigProperty := &LambdaEvaluatorConfigProperty{
LambdaArn: jsii.String("lambdaArn"),
// the properties below are optional
LambdaTimeoutInSeconds: jsii.Number(123),
}
type CfnEvaluator_LlmAsAJudgeEvaluatorConfigProperty ¶ added in v2.242.0
type CfnEvaluator_LlmAsAJudgeEvaluatorConfigProperty struct {
// The evaluation instructions that guide the language model in assessing agent performance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig.html#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-instructions
//
Instructions *string `field:"required" json:"instructions" yaml:"instructions"`
// The model configuration that specifies which foundation model to use for evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig.html#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-modelconfig
//
ModelConfig interface{} `field:"required" json:"modelConfig" yaml:"modelConfig"`
// The rating scale that defines how evaluators should score agent performance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig.html#cfn-bedrockagentcore-evaluator-llmasajudgeevaluatorconfig-ratingscale
//
RatingScale interface{} `field:"required" json:"ratingScale" yaml:"ratingScale"`
}
The configuration for LLM-as-a-Judge evaluation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var additionalModelRequestFields interface{}
llmAsAJudgeEvaluatorConfigProperty := &LlmAsAJudgeEvaluatorConfigProperty{
Instructions: jsii.String("instructions"),
ModelConfig: &EvaluatorModelConfigProperty{
BedrockEvaluatorModelConfig: &BedrockEvaluatorModelConfigProperty{
ModelId: jsii.String("modelId"),
// the properties below are optional
AdditionalModelRequestFields: additionalModelRequestFields,
InferenceConfig: &InferenceConfigurationProperty{
MaxTokens: jsii.Number(123),
Temperature: jsii.Number(123),
TopP: jsii.Number(123),
},
},
},
RatingScale: &RatingScaleProperty{
Categorical: []interface{}{
&CategoricalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
},
},
Numerical: []interface{}{
&NumericalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
Value: jsii.Number(123),
},
},
},
}
type CfnEvaluator_NumericalScaleDefinitionProperty ¶ added in v2.242.0
type CfnEvaluator_NumericalScaleDefinitionProperty struct {
// The description that explains what this numerical rating represents.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-numericalscaledefinition.html#cfn-bedrockagentcore-evaluator-numericalscaledefinition-definition
//
Definition *string `field:"required" json:"definition" yaml:"definition"`
// The label that describes this numerical rating option.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-numericalscaledefinition.html#cfn-bedrockagentcore-evaluator-numericalscaledefinition-label
//
Label *string `field:"required" json:"label" yaml:"label"`
// The numerical value for this rating scale option.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-numericalscaledefinition.html#cfn-bedrockagentcore-evaluator-numericalscaledefinition-value
//
Value *float64 `field:"required" json:"value" yaml:"value"`
}
A numerical rating scale option.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
numericalScaleDefinitionProperty := &NumericalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
Value: jsii.Number(123),
}
type CfnEvaluator_RatingScaleProperty ¶ added in v2.242.0
type CfnEvaluator_RatingScaleProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-ratingscale.html#cfn-bedrockagentcore-evaluator-ratingscale-categorical
//
Categorical interface{} `field:"optional" json:"categorical" yaml:"categorical"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-evaluator-ratingscale.html#cfn-bedrockagentcore-evaluator-ratingscale-numerical
//
Numerical interface{} `field:"optional" json:"numerical" yaml:"numerical"`
}
The rating scale that defines how evaluators should score agent performance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
ratingScaleProperty := &RatingScaleProperty{
Categorical: []interface{}{
&CategoricalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
},
},
Numerical: []interface{}{
&NumericalScaleDefinitionProperty{
Definition: jsii.String("definition"),
Label: jsii.String("label"),
Value: jsii.Number(123),
},
},
}
type CfnGateway ¶ added in v2.220.0
type CfnGateway interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IGatewayRef
awscdk.ITaggableV2
// The date and time at which the gateway was created.
AttrCreatedAt() *string
// The ARN for the gateway.
AttrGatewayArn() *string
AttrGatewayIdentifier() *string
// The gateway URL for the gateway.
AttrGatewayUrl() *string
// The status for the gateway.
AttrStatus() *string
// The status reasons for the gateway.
AttrStatusReasons() *[]*string
AttrUpdatedAt() *string
AttrWorkloadIdentityDetails() awscdk.IResolvable
AuthorizerConfiguration() interface{}
SetAuthorizerConfiguration(val interface{})
// The authorizer type for the gateway.
AuthorizerType() *string
SetAuthorizerType(val *string)
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description for the gateway.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The exception level for the gateway.
ExceptionLevel() *string
SetExceptionLevel(val *string)
// A reference to a Gateway resource.
GatewayRef() *interfacesawsbedrockagentcore.GatewayReference
InterceptorConfigurations() interface{}
SetInterceptorConfigurations(val interface{})
// The KMS key ARN for the gateway.
KmsKeyArn() *string
SetKmsKeyArn(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name for the gateway.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The configuration for a policy engine associated with a gateway.
PolicyEngineConfiguration() interface{}
SetPolicyEngineConfiguration(val interface{})
// The protocol configuration for the gateway target.
ProtocolConfiguration() interface{}
SetProtocolConfiguration(val interface{})
// The protocol type for the gateway target.
ProtocolType() *string
SetProtocolType(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
RoleArn() *string
SetRoleArn(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags for the gateway.
Tags() *map[string]*string
SetTags(val *map[string]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Amazon Bedrock AgentCore Gateway provides a unified connectivity layer between agents and the tools and resources they need to interact with.
For more information about creating a gateway, see [Set up an Amazon Bedrock AgentCore gateway](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-building.html) .
See the *Properties* section below for descriptions of both the required and optional properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnGateway := awscdk.Aws_bedrockagentcore.NewCfnGateway(this, jsii.String("MyCfnGateway"), &CfnGatewayProps{
AuthorizerType: jsii.String("authorizerType"),
Name: jsii.String("name"),
ProtocolType: jsii.String("protocolType"),
RoleArn: jsii.String("roleArn"),
// the properties below are optional
AuthorizerConfiguration: &AuthorizerConfigurationProperty{
CustomJwtAuthorizer: &CustomJWTAuthorizerConfigurationProperty{
DiscoveryUrl: jsii.String("discoveryUrl"),
// the properties below are optional
AllowedAudience: []*string{
jsii.String("allowedAudience"),
},
AllowedClients: []*string{
jsii.String("allowedClients"),
},
AllowedScopes: []*string{
jsii.String("allowedScopes"),
},
CustomClaims: []interface{}{
&CustomClaimValidationTypeProperty{
AuthorizingClaimMatchValue: &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
},
InboundTokenClaimName: jsii.String("inboundTokenClaimName"),
InboundTokenClaimValueType: jsii.String("inboundTokenClaimValueType"),
},
},
},
},
Description: jsii.String("description"),
ExceptionLevel: jsii.String("exceptionLevel"),
InterceptorConfigurations: []interface{}{
&GatewayInterceptorConfigurationProperty{
InterceptionPoints: []*string{
jsii.String("interceptionPoints"),
},
Interceptor: &InterceptorConfigurationProperty{
Lambda: &LambdaInterceptorConfigurationProperty{
Arn: jsii.String("arn"),
},
},
// the properties below are optional
InputConfiguration: &InterceptorInputConfigurationProperty{
PassRequestHeaders: jsii.Boolean(false),
},
},
},
KmsKeyArn: jsii.String("kmsKeyArn"),
PolicyEngineConfiguration: &GatewayPolicyEngineConfigurationProperty{
Arn: jsii.String("arn"),
Mode: jsii.String("mode"),
},
ProtocolConfiguration: &GatewayProtocolConfigurationProperty{
Mcp: &MCPGatewayConfigurationProperty{
Instructions: jsii.String("instructions"),
SearchType: jsii.String("searchType"),
SupportedVersions: []*string{
jsii.String("supportedVersions"),
},
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnGateway ¶ added in v2.220.0
func NewCfnGateway(scope constructs.Construct, id *string, props *CfnGatewayProps) CfnGateway
Create a new `AWS::BedrockAgentCore::Gateway`.
type CfnGatewayProps ¶ added in v2.220.0
type CfnGatewayProps struct {
// The authorizer type for the gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-authorizertype
//
AuthorizerType *string `field:"required" json:"authorizerType" yaml:"authorizerType"`
// The name for the gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The protocol type for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-protocoltype
//
ProtocolType *string `field:"required" json:"protocolType" yaml:"protocolType"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-rolearn
//
RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-authorizerconfiguration
//
AuthorizerConfiguration interface{} `field:"optional" json:"authorizerConfiguration" yaml:"authorizerConfiguration"`
// The description for the gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The exception level for the gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-exceptionlevel
//
ExceptionLevel *string `field:"optional" json:"exceptionLevel" yaml:"exceptionLevel"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-interceptorconfigurations
//
InterceptorConfigurations interface{} `field:"optional" json:"interceptorConfigurations" yaml:"interceptorConfigurations"`
// The KMS key ARN for the gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-kmskeyarn
//
KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
// The configuration for a policy engine associated with a gateway.
//
// A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-policyengineconfiguration
//
PolicyEngineConfiguration interface{} `field:"optional" json:"policyEngineConfiguration" yaml:"policyEngineConfiguration"`
// The protocol configuration for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-protocolconfiguration
//
ProtocolConfiguration interface{} `field:"optional" json:"protocolConfiguration" yaml:"protocolConfiguration"`
// The tags for the gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html#cfn-bedrockagentcore-gateway-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnGateway`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnGatewayProps := &CfnGatewayProps{
AuthorizerType: jsii.String("authorizerType"),
Name: jsii.String("name"),
ProtocolType: jsii.String("protocolType"),
RoleArn: jsii.String("roleArn"),
// the properties below are optional
AuthorizerConfiguration: &AuthorizerConfigurationProperty{
CustomJwtAuthorizer: &CustomJWTAuthorizerConfigurationProperty{
DiscoveryUrl: jsii.String("discoveryUrl"),
// the properties below are optional
AllowedAudience: []*string{
jsii.String("allowedAudience"),
},
AllowedClients: []*string{
jsii.String("allowedClients"),
},
AllowedScopes: []*string{
jsii.String("allowedScopes"),
},
CustomClaims: []interface{}{
&CustomClaimValidationTypeProperty{
AuthorizingClaimMatchValue: &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
},
InboundTokenClaimName: jsii.String("inboundTokenClaimName"),
InboundTokenClaimValueType: jsii.String("inboundTokenClaimValueType"),
},
},
},
},
Description: jsii.String("description"),
ExceptionLevel: jsii.String("exceptionLevel"),
InterceptorConfigurations: []interface{}{
&GatewayInterceptorConfigurationProperty{
InterceptionPoints: []*string{
jsii.String("interceptionPoints"),
},
Interceptor: &InterceptorConfigurationProperty{
Lambda: &LambdaInterceptorConfigurationProperty{
Arn: jsii.String("arn"),
},
},
// the properties below are optional
InputConfiguration: &InterceptorInputConfigurationProperty{
PassRequestHeaders: jsii.Boolean(false),
},
},
},
KmsKeyArn: jsii.String("kmsKeyArn"),
PolicyEngineConfiguration: &GatewayPolicyEngineConfigurationProperty{
Arn: jsii.String("arn"),
Mode: jsii.String("mode"),
},
ProtocolConfiguration: &GatewayProtocolConfigurationProperty{
Mcp: &MCPGatewayConfigurationProperty{
Instructions: jsii.String("instructions"),
SearchType: jsii.String("searchType"),
SupportedVersions: []*string{
jsii.String("supportedVersions"),
},
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnGatewayTarget ¶ added in v2.220.0
type CfnGatewayTarget interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IGatewayTargetRef
// The date and time at which the gateway target was created.
AttrCreatedAt() *string
AttrGatewayArn() *string
AttrLastSynchronizedAt() *string
// The status for the gateway target.
AttrStatus() *string
// The status reasons for the gateway target.
AttrStatusReasons() *[]*string
// The target ID for the gateway target.
AttrTargetId() *string
// The time at which the resource was updated.
AttrUpdatedAt() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The OAuth credential provider configuration.
CredentialProviderConfigurations() interface{}
SetCredentialProviderConfigurations(val interface{})
// The description for the gateway target.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The gateway ID for the gateway target.
GatewayIdentifier() *string
SetGatewayIdentifier(val *string)
// A reference to a GatewayTarget resource.
GatewayTargetRef() *interfacesawsbedrockagentcore.GatewayTargetReference
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
MetadataConfiguration() interface{}
SetMetadataConfiguration(val interface{})
// The name for the gateway target.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The target configuration for the Smithy model target.
TargetConfiguration() interface{}
SetTargetConfiguration(val interface{})
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
After creating a gateway, you can add targets, which define the tools that your gateway will host.
For more information about adding gateway targets, see [Add targets to an existing gateway](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/gateway-building-adding-targets.html) .
See the *Properties* section below for descriptions of both the required and optional properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var schemaDefinitionProperty_ SchemaDefinitionProperty
cfnGatewayTarget := awscdk.Aws_bedrockagentcore.NewCfnGatewayTarget(this, jsii.String("MyCfnGatewayTarget"), &CfnGatewayTargetProps{
Name: jsii.String("name"),
TargetConfiguration: &TargetConfigurationProperty{
Mcp: &McpTargetConfigurationProperty{
ApiGateway: &ApiGatewayTargetConfigurationProperty{
ApiGatewayToolConfiguration: &ApiGatewayToolConfigurationProperty{
ToolFilters: []interface{}{
&ApiGatewayToolFilterProperty{
FilterPath: jsii.String("filterPath"),
Methods: []*string{
jsii.String("methods"),
},
},
},
// the properties below are optional
ToolOverrides: []interface{}{
&ApiGatewayToolOverrideProperty{
Method: jsii.String("method"),
Name: jsii.String("name"),
Path: jsii.String("path"),
// the properties below are optional
Description: jsii.String("description"),
},
},
},
RestApiId: jsii.String("restApiId"),
Stage: jsii.String("stage"),
},
Lambda: &McpLambdaTargetConfigurationProperty{
LambdaArn: jsii.String("lambdaArn"),
ToolSchema: &ToolSchemaProperty{
InlinePayload: []interface{}{
&ToolDefinitionProperty{
Description: jsii.String("description"),
InputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
Name: jsii.String("name"),
// the properties below are optional
OutputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
},
},
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
},
McpServer: &McpServerTargetConfigurationProperty{
Endpoint: jsii.String("endpoint"),
},
OpenApiSchema: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
SmithyModel: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
},
},
// the properties below are optional
CredentialProviderConfigurations: []interface{}{
&CredentialProviderConfigurationProperty{
CredentialProviderType: jsii.String("credentialProviderType"),
// the properties below are optional
CredentialProvider: &CredentialProviderProperty{
ApiKeyCredentialProvider: &ApiKeyCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
// the properties below are optional
CredentialLocation: jsii.String("credentialLocation"),
CredentialParameterName: jsii.String("credentialParameterName"),
CredentialPrefix: jsii.String("credentialPrefix"),
},
IamCredentialProvider: &IamCredentialProviderProperty{
Service: jsii.String("service"),
// the properties below are optional
Region: jsii.String("region"),
},
OauthCredentialProvider: &OAuthCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
Scopes: []*string{
jsii.String("scopes"),
},
// the properties below are optional
CustomParameters: map[string]*string{
"customParametersKey": jsii.String("customParameters"),
},
DefaultReturnUrl: jsii.String("defaultReturnUrl"),
GrantType: jsii.String("grantType"),
},
},
},
},
Description: jsii.String("description"),
GatewayIdentifier: jsii.String("gatewayIdentifier"),
MetadataConfiguration: &MetadataConfigurationProperty{
AllowedQueryParameters: []*string{
jsii.String("allowedQueryParameters"),
},
AllowedRequestHeaders: []*string{
jsii.String("allowedRequestHeaders"),
},
AllowedResponseHeaders: []*string{
jsii.String("allowedResponseHeaders"),
},
},
})
func NewCfnGatewayTarget ¶ added in v2.220.0
func NewCfnGatewayTarget(scope constructs.Construct, id *string, props *CfnGatewayTargetProps) CfnGatewayTarget
Create a new `AWS::BedrockAgentCore::GatewayTarget`.
type CfnGatewayTargetProps ¶ added in v2.220.0
type CfnGatewayTargetProps struct {
// The name for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The target configuration for the Smithy model target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-targetconfiguration
//
TargetConfiguration interface{} `field:"required" json:"targetConfiguration" yaml:"targetConfiguration"`
// The OAuth credential provider configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfigurations
//
CredentialProviderConfigurations interface{} `field:"optional" json:"credentialProviderConfigurations" yaml:"credentialProviderConfigurations"`
// The description for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The gateway ID for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-gatewayidentifier
//
GatewayIdentifier *string `field:"optional" json:"gatewayIdentifier" yaml:"gatewayIdentifier"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration
//
MetadataConfiguration interface{} `field:"optional" json:"metadataConfiguration" yaml:"metadataConfiguration"`
}
Properties for defining a `CfnGatewayTarget`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var schemaDefinitionProperty_ SchemaDefinitionProperty
cfnGatewayTargetProps := &CfnGatewayTargetProps{
Name: jsii.String("name"),
TargetConfiguration: &TargetConfigurationProperty{
Mcp: &McpTargetConfigurationProperty{
ApiGateway: &ApiGatewayTargetConfigurationProperty{
ApiGatewayToolConfiguration: &ApiGatewayToolConfigurationProperty{
ToolFilters: []interface{}{
&ApiGatewayToolFilterProperty{
FilterPath: jsii.String("filterPath"),
Methods: []*string{
jsii.String("methods"),
},
},
},
// the properties below are optional
ToolOverrides: []interface{}{
&ApiGatewayToolOverrideProperty{
Method: jsii.String("method"),
Name: jsii.String("name"),
Path: jsii.String("path"),
// the properties below are optional
Description: jsii.String("description"),
},
},
},
RestApiId: jsii.String("restApiId"),
Stage: jsii.String("stage"),
},
Lambda: &McpLambdaTargetConfigurationProperty{
LambdaArn: jsii.String("lambdaArn"),
ToolSchema: &ToolSchemaProperty{
InlinePayload: []interface{}{
&ToolDefinitionProperty{
Description: jsii.String("description"),
InputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
Name: jsii.String("name"),
// the properties below are optional
OutputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
},
},
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
},
McpServer: &McpServerTargetConfigurationProperty{
Endpoint: jsii.String("endpoint"),
},
OpenApiSchema: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
SmithyModel: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
},
},
// the properties below are optional
CredentialProviderConfigurations: []interface{}{
&CredentialProviderConfigurationProperty{
CredentialProviderType: jsii.String("credentialProviderType"),
// the properties below are optional
CredentialProvider: &CredentialProviderProperty{
ApiKeyCredentialProvider: &ApiKeyCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
// the properties below are optional
CredentialLocation: jsii.String("credentialLocation"),
CredentialParameterName: jsii.String("credentialParameterName"),
CredentialPrefix: jsii.String("credentialPrefix"),
},
IamCredentialProvider: &IamCredentialProviderProperty{
Service: jsii.String("service"),
// the properties below are optional
Region: jsii.String("region"),
},
OauthCredentialProvider: &OAuthCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
Scopes: []*string{
jsii.String("scopes"),
},
// the properties below are optional
CustomParameters: map[string]*string{
"customParametersKey": jsii.String("customParameters"),
},
DefaultReturnUrl: jsii.String("defaultReturnUrl"),
GrantType: jsii.String("grantType"),
},
},
},
},
Description: jsii.String("description"),
GatewayIdentifier: jsii.String("gatewayIdentifier"),
MetadataConfiguration: &MetadataConfigurationProperty{
AllowedQueryParameters: []*string{
jsii.String("allowedQueryParameters"),
},
AllowedRequestHeaders: []*string{
jsii.String("allowedRequestHeaders"),
},
AllowedResponseHeaders: []*string{
jsii.String("allowedResponseHeaders"),
},
},
}
type CfnGatewayTarget_ApiGatewayTargetConfigurationProperty ¶ added in v2.235.0
type CfnGatewayTarget_ApiGatewayTargetConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-apigatewaytoolconfiguration
//
ApiGatewayToolConfiguration interface{} `field:"required" json:"apiGatewayToolConfiguration" yaml:"apiGatewayToolConfiguration"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-restapiid
//
RestApiId *string `field:"required" json:"restApiId" yaml:"restApiId"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-stage
//
Stage *string `field:"required" json:"stage" yaml:"stage"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
apiGatewayTargetConfigurationProperty := &ApiGatewayTargetConfigurationProperty{
ApiGatewayToolConfiguration: &ApiGatewayToolConfigurationProperty{
ToolFilters: []interface{}{
&ApiGatewayToolFilterProperty{
FilterPath: jsii.String("filterPath"),
Methods: []*string{
jsii.String("methods"),
},
},
},
// the properties below are optional
ToolOverrides: []interface{}{
&ApiGatewayToolOverrideProperty{
Method: jsii.String("method"),
Name: jsii.String("name"),
Path: jsii.String("path"),
// the properties below are optional
Description: jsii.String("description"),
},
},
},
RestApiId: jsii.String("restApiId"),
Stage: jsii.String("stage"),
}
type CfnGatewayTarget_ApiGatewayToolConfigurationProperty ¶ added in v2.235.0
type CfnGatewayTarget_ApiGatewayToolConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-toolfilters
//
ToolFilters interface{} `field:"required" json:"toolFilters" yaml:"toolFilters"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-tooloverrides
//
ToolOverrides interface{} `field:"optional" json:"toolOverrides" yaml:"toolOverrides"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
apiGatewayToolConfigurationProperty := &ApiGatewayToolConfigurationProperty{
ToolFilters: []interface{}{
&ApiGatewayToolFilterProperty{
FilterPath: jsii.String("filterPath"),
Methods: []*string{
jsii.String("methods"),
},
},
},
// the properties below are optional
ToolOverrides: []interface{}{
&ApiGatewayToolOverrideProperty{
Method: jsii.String("method"),
Name: jsii.String("name"),
Path: jsii.String("path"),
// the properties below are optional
Description: jsii.String("description"),
},
},
}
type CfnGatewayTarget_ApiGatewayToolFilterProperty ¶ added in v2.235.0
type CfnGatewayTarget_ApiGatewayToolFilterProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolfilter.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-filterpath
//
FilterPath *string `field:"required" json:"filterPath" yaml:"filterPath"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolfilter.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-methods
//
Methods *[]*string `field:"required" json:"methods" yaml:"methods"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
apiGatewayToolFilterProperty := &ApiGatewayToolFilterProperty{
FilterPath: jsii.String("filterPath"),
Methods: []*string{
jsii.String("methods"),
},
}
type CfnGatewayTarget_ApiGatewayToolOverrideProperty ¶ added in v2.235.0
type CfnGatewayTarget_ApiGatewayToolOverrideProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-method
//
Method *string `field:"required" json:"method" yaml:"method"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-path
//
Path *string `field:"required" json:"path" yaml:"path"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
apiGatewayToolOverrideProperty := &ApiGatewayToolOverrideProperty{
Method: jsii.String("method"),
Name: jsii.String("name"),
Path: jsii.String("path"),
// the properties below are optional
Description: jsii.String("description"),
}
type CfnGatewayTarget_ApiKeyCredentialProviderProperty ¶ added in v2.220.0
type CfnGatewayTarget_ApiKeyCredentialProviderProperty struct {
// The provider ARN for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-providerarn
//
ProviderArn *string `field:"required" json:"providerArn" yaml:"providerArn"`
// The credential location for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentiallocation
//
CredentialLocation *string `field:"optional" json:"credentialLocation" yaml:"credentialLocation"`
// The credential parameter name for the provider for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialparametername
//
CredentialParameterName *string `field:"optional" json:"credentialParameterName" yaml:"credentialParameterName"`
// The API key credential provider for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialprefix
//
CredentialPrefix *string `field:"optional" json:"credentialPrefix" yaml:"credentialPrefix"`
}
The API key credential provider for the gateway target.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
apiKeyCredentialProviderProperty := &ApiKeyCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
// the properties below are optional
CredentialLocation: jsii.String("credentialLocation"),
CredentialParameterName: jsii.String("credentialParameterName"),
CredentialPrefix: jsii.String("credentialPrefix"),
}
type CfnGatewayTarget_ApiSchemaConfigurationProperty ¶ added in v2.220.0
type CfnGatewayTarget_ApiSchemaConfigurationProperty struct {
// The inline payload for the gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-inlinepayload
//
InlinePayload *string `field:"optional" json:"inlinePayload" yaml:"inlinePayload"`
// The API schema configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-s3
//
S3 interface{} `field:"optional" json:"s3" yaml:"s3"`
}
The API schema configuration for the gateway target.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
apiSchemaConfigurationProperty := &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
}
type CfnGatewayTarget_CredentialProviderConfigurationProperty ¶ added in v2.220.0
type CfnGatewayTarget_CredentialProviderConfigurationProperty struct {
// The credential provider type for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovidertype
//
CredentialProviderType *string `field:"required" json:"credentialProviderType" yaml:"credentialProviderType"`
// The credential provider for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovider
//
CredentialProvider interface{} `field:"optional" json:"credentialProvider" yaml:"credentialProvider"`
}
The credential provider configuration for the gateway target.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
credentialProviderConfigurationProperty := &CredentialProviderConfigurationProperty{
CredentialProviderType: jsii.String("credentialProviderType"),
// the properties below are optional
CredentialProvider: &CredentialProviderProperty{
ApiKeyCredentialProvider: &ApiKeyCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
// the properties below are optional
CredentialLocation: jsii.String("credentialLocation"),
CredentialParameterName: jsii.String("credentialParameterName"),
CredentialPrefix: jsii.String("credentialPrefix"),
},
IamCredentialProvider: &IamCredentialProviderProperty{
Service: jsii.String("service"),
// the properties below are optional
Region: jsii.String("region"),
},
OauthCredentialProvider: &OAuthCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
Scopes: []*string{
jsii.String("scopes"),
},
// the properties below are optional
CustomParameters: map[string]*string{
"customParametersKey": jsii.String("customParameters"),
},
DefaultReturnUrl: jsii.String("defaultReturnUrl"),
GrantType: jsii.String("grantType"),
},
},
}
type CfnGatewayTarget_CredentialProviderProperty ¶ added in v2.220.0
type CfnGatewayTarget_CredentialProviderProperty struct {
// The API key credential provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-apikeycredentialprovider
//
ApiKeyCredentialProvider interface{} `field:"optional" json:"apiKeyCredentialProvider" yaml:"apiKeyCredentialProvider"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-iamcredentialprovider
//
IamCredentialProvider interface{} `field:"optional" json:"iamCredentialProvider" yaml:"iamCredentialProvider"`
// The OAuth credential provider for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-oauthcredentialprovider
//
OauthCredentialProvider interface{} `field:"optional" json:"oauthCredentialProvider" yaml:"oauthCredentialProvider"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
credentialProviderProperty := &CredentialProviderProperty{
ApiKeyCredentialProvider: &ApiKeyCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
// the properties below are optional
CredentialLocation: jsii.String("credentialLocation"),
CredentialParameterName: jsii.String("credentialParameterName"),
CredentialPrefix: jsii.String("credentialPrefix"),
},
IamCredentialProvider: &IamCredentialProviderProperty{
Service: jsii.String("service"),
// the properties below are optional
Region: jsii.String("region"),
},
OauthCredentialProvider: &OAuthCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
Scopes: []*string{
jsii.String("scopes"),
},
// the properties below are optional
CustomParameters: map[string]*string{
"customParametersKey": jsii.String("customParameters"),
},
DefaultReturnUrl: jsii.String("defaultReturnUrl"),
GrantType: jsii.String("grantType"),
},
}
type CfnGatewayTarget_IamCredentialProviderProperty ¶ added in v2.251.0
type CfnGatewayTarget_IamCredentialProviderProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-iamcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-iamcredentialprovider-service
//
Service *string `field:"required" json:"service" yaml:"service"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-iamcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-iamcredentialprovider-region
//
Region *string `field:"optional" json:"region" yaml:"region"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
iamCredentialProviderProperty := &IamCredentialProviderProperty{
Service: jsii.String("service"),
// the properties below are optional
Region: jsii.String("region"),
}
type CfnGatewayTarget_McpLambdaTargetConfigurationProperty ¶ added in v2.220.0
type CfnGatewayTarget_McpLambdaTargetConfigurationProperty struct {
// The ARN of the Lambda target configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-lambdaarn
//
LambdaArn *string `field:"required" json:"lambdaArn" yaml:"lambdaArn"`
// The tool schema configuration for the gateway target MCP configuration for Lambda.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-toolschema
//
ToolSchema interface{} `field:"required" json:"toolSchema" yaml:"toolSchema"`
}
The Lambda target configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var schemaDefinitionProperty_ SchemaDefinitionProperty
mcpLambdaTargetConfigurationProperty := &McpLambdaTargetConfigurationProperty{
LambdaArn: jsii.String("lambdaArn"),
ToolSchema: &ToolSchemaProperty{
InlinePayload: []interface{}{
&ToolDefinitionProperty{
Description: jsii.String("description"),
InputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
Name: jsii.String("name"),
// the properties below are optional
OutputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
},
},
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
}
type CfnGatewayTarget_McpServerTargetConfigurationProperty ¶ added in v2.225.0
type CfnGatewayTarget_McpServerTargetConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-endpoint
//
Endpoint *string `field:"required" json:"endpoint" yaml:"endpoint"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
mcpServerTargetConfigurationProperty := &McpServerTargetConfigurationProperty{
Endpoint: jsii.String("endpoint"),
}
type CfnGatewayTarget_McpTargetConfigurationProperty ¶ added in v2.220.0
type CfnGatewayTarget_McpTargetConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-apigateway
//
ApiGateway interface{} `field:"optional" json:"apiGateway" yaml:"apiGateway"`
// The Lambda MCP configuration for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-lambda
//
Lambda interface{} `field:"optional" json:"lambda" yaml:"lambda"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-mcpserver
//
McpServer interface{} `field:"optional" json:"mcpServer" yaml:"mcpServer"`
// The OpenApi schema for the gateway target MCP configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-openapischema
//
OpenApiSchema interface{} `field:"optional" json:"openApiSchema" yaml:"openApiSchema"`
// The target configuration for the Smithy model target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-smithymodel
//
SmithyModel interface{} `field:"optional" json:"smithyModel" yaml:"smithyModel"`
}
The MCP target configuration for the gateway target.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var schemaDefinitionProperty_ SchemaDefinitionProperty
mcpTargetConfigurationProperty := &McpTargetConfigurationProperty{
ApiGateway: &ApiGatewayTargetConfigurationProperty{
ApiGatewayToolConfiguration: &ApiGatewayToolConfigurationProperty{
ToolFilters: []interface{}{
&ApiGatewayToolFilterProperty{
FilterPath: jsii.String("filterPath"),
Methods: []*string{
jsii.String("methods"),
},
},
},
// the properties below are optional
ToolOverrides: []interface{}{
&ApiGatewayToolOverrideProperty{
Method: jsii.String("method"),
Name: jsii.String("name"),
Path: jsii.String("path"),
// the properties below are optional
Description: jsii.String("description"),
},
},
},
RestApiId: jsii.String("restApiId"),
Stage: jsii.String("stage"),
},
Lambda: &McpLambdaTargetConfigurationProperty{
LambdaArn: jsii.String("lambdaArn"),
ToolSchema: &ToolSchemaProperty{
InlinePayload: []interface{}{
&ToolDefinitionProperty{
Description: jsii.String("description"),
InputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
Name: jsii.String("name"),
// the properties below are optional
OutputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
},
},
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
},
McpServer: &McpServerTargetConfigurationProperty{
Endpoint: jsii.String("endpoint"),
},
OpenApiSchema: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
SmithyModel: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
}
type CfnGatewayTarget_MetadataConfigurationProperty ¶ added in v2.234.0
type CfnGatewayTarget_MetadataConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration.html#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedqueryparameters
//
AllowedQueryParameters *[]*string `field:"optional" json:"allowedQueryParameters" yaml:"allowedQueryParameters"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration.html#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedrequestheaders
//
AllowedRequestHeaders *[]*string `field:"optional" json:"allowedRequestHeaders" yaml:"allowedRequestHeaders"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration.html#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedresponseheaders
//
AllowedResponseHeaders *[]*string `field:"optional" json:"allowedResponseHeaders" yaml:"allowedResponseHeaders"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
metadataConfigurationProperty := &MetadataConfigurationProperty{
AllowedQueryParameters: []*string{
jsii.String("allowedQueryParameters"),
},
AllowedRequestHeaders: []*string{
jsii.String("allowedRequestHeaders"),
},
AllowedResponseHeaders: []*string{
jsii.String("allowedResponseHeaders"),
},
}
type CfnGatewayTarget_OAuthCredentialProviderProperty ¶ added in v2.220.0
type CfnGatewayTarget_OAuthCredentialProviderProperty struct {
// The provider ARN for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-providerarn
//
ProviderArn *string `field:"required" json:"providerArn" yaml:"providerArn"`
// The OAuth credential provider scopes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-scopes
//
Scopes *[]*string `field:"required" json:"scopes" yaml:"scopes"`
// The OAuth credential provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-customparameters
//
CustomParameters interface{} `field:"optional" json:"customParameters" yaml:"customParameters"`
// Return URL for OAuth callback.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-defaultreturnurl
//
DefaultReturnUrl *string `field:"optional" json:"defaultReturnUrl" yaml:"defaultReturnUrl"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-granttype
//
GrantType *string `field:"optional" json:"grantType" yaml:"grantType"`
}
The OAuth credential provider for the gateway target.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
oAuthCredentialProviderProperty := &OAuthCredentialProviderProperty{
ProviderArn: jsii.String("providerArn"),
Scopes: []*string{
jsii.String("scopes"),
},
// the properties below are optional
CustomParameters: map[string]*string{
"customParametersKey": jsii.String("customParameters"),
},
DefaultReturnUrl: jsii.String("defaultReturnUrl"),
GrantType: jsii.String("grantType"),
}
type CfnGatewayTarget_S3ConfigurationProperty ¶ added in v2.220.0
type CfnGatewayTarget_S3ConfigurationProperty struct {
// The S3 configuration bucket owner account ID for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html#cfn-bedrockagentcore-gatewaytarget-s3configuration-bucketowneraccountid
//
BucketOwnerAccountId *string `field:"optional" json:"bucketOwnerAccountId" yaml:"bucketOwnerAccountId"`
// The configuration URI for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html#cfn-bedrockagentcore-gatewaytarget-s3configuration-uri
//
Uri *string `field:"optional" json:"uri" yaml:"uri"`
}
The S3 configuration for the gateway target.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
s3ConfigurationProperty := &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
}
type CfnGatewayTarget_SchemaDefinitionProperty ¶ added in v2.220.0
type CfnGatewayTarget_SchemaDefinitionProperty struct {
// The scheme definition type for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// The workload identity details for the gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-items
//
Items interface{} `field:"optional" json:"items" yaml:"items"`
// The schema definition properties for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-properties
//
Properties interface{} `field:"optional" json:"properties" yaml:"properties"`
// The schema definition.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-required
//
Required *[]*string `field:"optional" json:"required" yaml:"required"`
}
The schema definition for the gateway target.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var schemaDefinitionProperty_ SchemaDefinitionProperty
schemaDefinitionProperty := &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
}
type CfnGatewayTarget_TargetConfigurationProperty ¶ added in v2.220.0
type CfnGatewayTarget_TargetConfigurationProperty struct {
// The target configuration definition for MCP.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-targetconfiguration-mcp
//
Mcp interface{} `field:"required" json:"mcp" yaml:"mcp"`
}
The target configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var schemaDefinitionProperty_ SchemaDefinitionProperty
targetConfigurationProperty := &TargetConfigurationProperty{
Mcp: &McpTargetConfigurationProperty{
ApiGateway: &ApiGatewayTargetConfigurationProperty{
ApiGatewayToolConfiguration: &ApiGatewayToolConfigurationProperty{
ToolFilters: []interface{}{
&ApiGatewayToolFilterProperty{
FilterPath: jsii.String("filterPath"),
Methods: []*string{
jsii.String("methods"),
},
},
},
// the properties below are optional
ToolOverrides: []interface{}{
&ApiGatewayToolOverrideProperty{
Method: jsii.String("method"),
Name: jsii.String("name"),
Path: jsii.String("path"),
// the properties below are optional
Description: jsii.String("description"),
},
},
},
RestApiId: jsii.String("restApiId"),
Stage: jsii.String("stage"),
},
Lambda: &McpLambdaTargetConfigurationProperty{
LambdaArn: jsii.String("lambdaArn"),
ToolSchema: &ToolSchemaProperty{
InlinePayload: []interface{}{
&ToolDefinitionProperty{
Description: jsii.String("description"),
InputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
Name: jsii.String("name"),
// the properties below are optional
OutputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
},
},
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
},
McpServer: &McpServerTargetConfigurationProperty{
Endpoint: jsii.String("endpoint"),
},
OpenApiSchema: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
SmithyModel: &ApiSchemaConfigurationProperty{
InlinePayload: jsii.String("inlinePayload"),
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
},
},
}
type CfnGatewayTarget_ToolDefinitionProperty ¶ added in v2.220.0
type CfnGatewayTarget_ToolDefinitionProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-description
//
Description *string `field:"required" json:"description" yaml:"description"`
// The input schema for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-inputschema
//
InputSchema interface{} `field:"required" json:"inputSchema" yaml:"inputSchema"`
// The tool name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The tool definition output schema for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-outputschema
//
OutputSchema interface{} `field:"optional" json:"outputSchema" yaml:"outputSchema"`
}
The tool definition for the gateway.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var schemaDefinitionProperty_ SchemaDefinitionProperty
toolDefinitionProperty := &ToolDefinitionProperty{
Description: jsii.String("description"),
InputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
Name: jsii.String("name"),
// the properties below are optional
OutputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
}
type CfnGatewayTarget_ToolSchemaProperty ¶ added in v2.220.0
type CfnGatewayTarget_ToolSchemaProperty struct {
// The inline payload for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html#cfn-bedrockagentcore-gatewaytarget-toolschema-inlinepayload
//
InlinePayload interface{} `field:"optional" json:"inlinePayload" yaml:"inlinePayload"`
// The S3 tool schema for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html#cfn-bedrockagentcore-gatewaytarget-toolschema-s3
//
S3 interface{} `field:"optional" json:"s3" yaml:"s3"`
}
The tool schema for the gateway target.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var schemaDefinitionProperty_ SchemaDefinitionProperty
toolSchemaProperty := &ToolSchemaProperty{
InlinePayload: []interface{}{
&ToolDefinitionProperty{
Description: jsii.String("description"),
InputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
Name: jsii.String("name"),
// the properties below are optional
OutputSchema: &SchemaDefinitionProperty{
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
Items: schemaDefinitionProperty_,
Properties: map[string]interface{}{
"propertiesKey": schemaDefinitionProperty_,
},
Required: []*string{
jsii.String("required"),
},
},
},
},
S3: &S3ConfigurationProperty{
BucketOwnerAccountId: jsii.String("bucketOwnerAccountId"),
Uri: jsii.String("uri"),
},
}
type CfnGateway_AuthorizerConfigurationProperty ¶ added in v2.220.0
type CfnGateway_AuthorizerConfigurationProperty struct {
// The authorizer configuration for the gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-authorizerconfiguration.html#cfn-bedrockagentcore-gateway-authorizerconfiguration-customjwtauthorizer
//
CustomJwtAuthorizer interface{} `field:"required" json:"customJwtAuthorizer" yaml:"customJwtAuthorizer"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
authorizerConfigurationProperty := &AuthorizerConfigurationProperty{
CustomJwtAuthorizer: &CustomJWTAuthorizerConfigurationProperty{
DiscoveryUrl: jsii.String("discoveryUrl"),
// the properties below are optional
AllowedAudience: []*string{
jsii.String("allowedAudience"),
},
AllowedClients: []*string{
jsii.String("allowedClients"),
},
AllowedScopes: []*string{
jsii.String("allowedScopes"),
},
CustomClaims: []interface{}{
&CustomClaimValidationTypeProperty{
AuthorizingClaimMatchValue: &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
},
InboundTokenClaimName: jsii.String("inboundTokenClaimName"),
InboundTokenClaimValueType: jsii.String("inboundTokenClaimValueType"),
},
},
},
}
type CfnGateway_AuthorizingClaimMatchValueTypeProperty ¶ added in v2.234.0
type CfnGateway_AuthorizingClaimMatchValueTypeProperty struct {
// The relationship between the claim field value and the value or values being matched.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-authorizingclaimmatchvaluetype.html#cfn-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-claimmatchoperator
//
ClaimMatchOperator *string `field:"required" json:"claimMatchOperator" yaml:"claimMatchOperator"`
// The value or values in the custom claim to match for.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-authorizingclaimmatchvaluetype.html#cfn-bedrockagentcore-gateway-authorizingclaimmatchvaluetype-claimmatchvalue
//
ClaimMatchValue interface{} `field:"required" json:"claimMatchValue" yaml:"claimMatchValue"`
}
The value or values in the custom claim to match and relationship of match.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
authorizingClaimMatchValueTypeProperty := &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
}
type CfnGateway_ClaimMatchValueTypeProperty ¶ added in v2.234.0
type CfnGateway_ClaimMatchValueTypeProperty struct {
// The string value to match for.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-claimmatchvaluetype.html#cfn-bedrockagentcore-gateway-claimmatchvaluetype-matchvaluestring
//
MatchValueString *string `field:"optional" json:"matchValueString" yaml:"matchValueString"`
// The list of strings to check for a match.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-claimmatchvaluetype.html#cfn-bedrockagentcore-gateway-claimmatchvaluetype-matchvaluestringlist
//
MatchValueStringList *[]*string `field:"optional" json:"matchValueStringList" yaml:"matchValueStringList"`
}
The value or values in the custom claim to match for.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
claimMatchValueTypeProperty := &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
}
type CfnGateway_CustomClaimValidationTypeProperty ¶ added in v2.234.0
type CfnGateway_CustomClaimValidationTypeProperty struct {
// The value or values in the custom claim to match and relationship of match.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customclaimvalidationtype.html#cfn-bedrockagentcore-gateway-customclaimvalidationtype-authorizingclaimmatchvalue
//
AuthorizingClaimMatchValue interface{} `field:"required" json:"authorizingClaimMatchValue" yaml:"authorizingClaimMatchValue"`
// The name of the custom claim to validate.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customclaimvalidationtype.html#cfn-bedrockagentcore-gateway-customclaimvalidationtype-inboundtokenclaimname
//
InboundTokenClaimName *string `field:"required" json:"inboundTokenClaimName" yaml:"inboundTokenClaimName"`
// Token claim data type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customclaimvalidationtype.html#cfn-bedrockagentcore-gateway-customclaimvalidationtype-inboundtokenclaimvaluetype
//
InboundTokenClaimValueType *string `field:"required" json:"inboundTokenClaimValueType" yaml:"inboundTokenClaimValueType"`
}
Required custom claim.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
customClaimValidationTypeProperty := &CustomClaimValidationTypeProperty{
AuthorizingClaimMatchValue: &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
},
InboundTokenClaimName: jsii.String("inboundTokenClaimName"),
InboundTokenClaimValueType: jsii.String("inboundTokenClaimValueType"),
}
type CfnGateway_CustomJWTAuthorizerConfigurationProperty ¶ added in v2.220.0
type CfnGateway_CustomJWTAuthorizerConfigurationProperty struct {
// The discovery URL for the authorizer configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-discoveryurl
//
DiscoveryUrl *string `field:"required" json:"discoveryUrl" yaml:"discoveryUrl"`
// The allowed audience authorized for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedaudience
//
AllowedAudience *[]*string `field:"optional" json:"allowedAudience" yaml:"allowedAudience"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedclients
//
AllowedClients *[]*string `field:"optional" json:"allowedClients" yaml:"allowedClients"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedscopes
//
AllowedScopes *[]*string `field:"optional" json:"allowedScopes" yaml:"allowedScopes"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-customclaims
//
CustomClaims interface{} `field:"optional" json:"customClaims" yaml:"customClaims"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
customJWTAuthorizerConfigurationProperty := &CustomJWTAuthorizerConfigurationProperty{
DiscoveryUrl: jsii.String("discoveryUrl"),
// the properties below are optional
AllowedAudience: []*string{
jsii.String("allowedAudience"),
},
AllowedClients: []*string{
jsii.String("allowedClients"),
},
AllowedScopes: []*string{
jsii.String("allowedScopes"),
},
CustomClaims: []interface{}{
&CustomClaimValidationTypeProperty{
AuthorizingClaimMatchValue: &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
},
InboundTokenClaimName: jsii.String("inboundTokenClaimName"),
InboundTokenClaimValueType: jsii.String("inboundTokenClaimValueType"),
},
},
}
type CfnGateway_GatewayInterceptorConfigurationProperty ¶ added in v2.233.0
type CfnGateway_GatewayInterceptorConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptionpoints
//
InterceptionPoints *[]*string `field:"required" json:"interceptionPoints" yaml:"interceptionPoints"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-interceptor
//
Interceptor interface{} `field:"required" json:"interceptor" yaml:"interceptor"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayinterceptorconfiguration.html#cfn-bedrockagentcore-gateway-gatewayinterceptorconfiguration-inputconfiguration
//
InputConfiguration interface{} `field:"optional" json:"inputConfiguration" yaml:"inputConfiguration"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
gatewayInterceptorConfigurationProperty := &GatewayInterceptorConfigurationProperty{
InterceptionPoints: []*string{
jsii.String("interceptionPoints"),
},
Interceptor: &InterceptorConfigurationProperty{
Lambda: &LambdaInterceptorConfigurationProperty{
Arn: jsii.String("arn"),
},
},
// the properties below are optional
InputConfiguration: &InterceptorInputConfigurationProperty{
PassRequestHeaders: jsii.Boolean(false),
},
}
type CfnGateway_GatewayPolicyEngineConfigurationProperty ¶ added in v2.245.0
type CfnGateway_GatewayPolicyEngineConfigurationProperty struct {
// The ARN of the policy engine.
//
// The policy engine contains Cedar policies that define fine-grained authorization rules specifying who can perform what actions on which resources as agents interact through the gateway.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewaypolicyengineconfiguration.html#cfn-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-arn
//
Arn *string `field:"required" json:"arn" yaml:"arn"`
// The enforcement mode for the policy engine.
//
// LOG_ONLY - The policy engine evaluates each action against your policies and adds traces on whether tool calls would be allowed or denied, but does not enforce the decision. Use this mode to test and validate policies before enabling enforcement. ENFORCE - The policy engine evaluates actions against your policies and enforces decisions by allowing or denying agent operations. Test and validate policies in LOG_ONLY mode before enabling enforcement to avoid unintended denials or adversely affecting production traffic.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewaypolicyengineconfiguration.html#cfn-bedrockagentcore-gateway-gatewaypolicyengineconfiguration-mode
//
Mode *string `field:"required" json:"mode" yaml:"mode"`
}
The configuration for a policy engine associated with a gateway.
A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
gatewayPolicyEngineConfigurationProperty := &GatewayPolicyEngineConfigurationProperty{
Arn: jsii.String("arn"),
Mode: jsii.String("mode"),
}
type CfnGateway_GatewayProtocolConfigurationProperty ¶ added in v2.220.0
type CfnGateway_GatewayProtocolConfigurationProperty struct {
// The gateway protocol configuration for MCP.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration.html#cfn-bedrockagentcore-gateway-gatewayprotocolconfiguration-mcp
//
Mcp interface{} `field:"required" json:"mcp" yaml:"mcp"`
}
The protocol configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
gatewayProtocolConfigurationProperty := &GatewayProtocolConfigurationProperty{
Mcp: &MCPGatewayConfigurationProperty{
Instructions: jsii.String("instructions"),
SearchType: jsii.String("searchType"),
SupportedVersions: []*string{
jsii.String("supportedVersions"),
},
},
}
type CfnGateway_InterceptorConfigurationProperty ¶ added in v2.233.0
type CfnGateway_InterceptorConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-interceptorconfiguration.html#cfn-bedrockagentcore-gateway-interceptorconfiguration-lambda
//
Lambda interface{} `field:"required" json:"lambda" yaml:"lambda"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
interceptorConfigurationProperty := &InterceptorConfigurationProperty{
Lambda: &LambdaInterceptorConfigurationProperty{
Arn: jsii.String("arn"),
},
}
type CfnGateway_InterceptorInputConfigurationProperty ¶ added in v2.233.0
type CfnGateway_InterceptorInputConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-interceptorinputconfiguration.html#cfn-bedrockagentcore-gateway-interceptorinputconfiguration-passrequestheaders
//
PassRequestHeaders interface{} `field:"required" json:"passRequestHeaders" yaml:"passRequestHeaders"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
interceptorInputConfigurationProperty := &InterceptorInputConfigurationProperty{
PassRequestHeaders: jsii.Boolean(false),
}
type CfnGateway_LambdaInterceptorConfigurationProperty ¶ added in v2.233.0
type CfnGateway_LambdaInterceptorConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-lambdainterceptorconfiguration.html#cfn-bedrockagentcore-gateway-lambdainterceptorconfiguration-arn
//
Arn *string `field:"required" json:"arn" yaml:"arn"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
lambdaInterceptorConfigurationProperty := &LambdaInterceptorConfigurationProperty{
Arn: jsii.String("arn"),
}
type CfnGateway_MCPGatewayConfigurationProperty ¶ added in v2.220.0
type CfnGateway_MCPGatewayConfigurationProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-instructions
//
Instructions *string `field:"optional" json:"instructions" yaml:"instructions"`
// The MCP gateway configuration search type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-searchtype
//
SearchType *string `field:"optional" json:"searchType" yaml:"searchType"`
// The supported versions for the MCP configuration for the gateway target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-supportedversions
//
SupportedVersions *[]*string `field:"optional" json:"supportedVersions" yaml:"supportedVersions"`
}
The gateway configuration for MCP.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
mCPGatewayConfigurationProperty := &MCPGatewayConfigurationProperty{
Instructions: jsii.String("instructions"),
SearchType: jsii.String("searchType"),
SupportedVersions: []*string{
jsii.String("supportedVersions"),
},
}
type CfnGateway_WorkloadIdentityDetailsProperty ¶ added in v2.220.0
type CfnGateway_WorkloadIdentityDetailsProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-workloadidentitydetails.html#cfn-bedrockagentcore-gateway-workloadidentitydetails-workloadidentityarn
//
WorkloadIdentityArn *string `field:"required" json:"workloadIdentityArn" yaml:"workloadIdentityArn"`
}
The workload identity details for the gateway.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
workloadIdentityDetailsProperty := &WorkloadIdentityDetailsProperty{
WorkloadIdentityArn: jsii.String("workloadIdentityArn"),
}
type CfnMemory ¶ added in v2.220.0
type CfnMemory interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IMemoryRef
awscdk.ITaggableV2
// The timestamp when the memory record was created.
AttrCreatedAt() *string
AttrFailureReason() *string
// ARN of the Memory resource.
AttrMemoryArn() *string
// The memory ID.
AttrMemoryId() *string
// The memory status.
AttrStatus() *string
AttrUpdatedAt() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// Description of the Memory resource.
Description() *string
SetDescription(val *string)
// The memory encryption key Amazon Resource Name (ARN).
EncryptionKeyArn() *string
SetEncryptionKeyArn(val *string)
Env() *interfaces.ResourceEnvironment
// The event expiry configuration.
EventExpiryDuration() *float64
SetEventExpiryDuration(val *float64)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The memory role ARN.
MemoryExecutionRoleArn() *string
SetMemoryExecutionRoleArn(val *string)
// A reference to a Memory resource.
MemoryRef() *interfacesawsbedrockagentcore.MemoryReference
// The memory strategies.
MemoryStrategies() interface{}
SetMemoryStrategies(val interface{})
// The memory name.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
StreamDeliveryResources() interface{}
SetStreamDeliveryResources(val interface{})
// The tags for the resources.
Tags() *map[string]*string
SetTags(val *map[string]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Memory allows AI agents to maintain both immediate and long-term knowledge, enabling context-aware and personalized interactions.
For more information about using Memory in Amazon Bedrock AgentCore, see [Host agent or tools with Amazon Bedrock AgentCore Memory](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/memory-getting-started.html) .
See the *Properties* section below for descriptions of both the required and optional properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnMemory := awscdk.Aws_bedrockagentcore.NewCfnMemory(this, jsii.String("MyCfnMemory"), &CfnMemoryProps{
EventExpiryDuration: jsii.Number(123),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
EncryptionKeyArn: jsii.String("encryptionKeyArn"),
MemoryExecutionRoleArn: jsii.String("memoryExecutionRoleArn"),
MemoryStrategies: []interface{}{
&MemoryStrategyProperty{
CustomMemoryStrategy: &CustomMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
Configuration: &CustomConfigurationInputProperty{
EpisodicOverride: &EpisodicOverrideProperty{
Consolidation: &EpisodicOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &EpisodicOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Reflection: &EpisodicOverrideReflectionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
// the properties below are optional
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
},
},
SelfManagedConfiguration: &SelfManagedConfigurationProperty{
HistoricalContextWindowSize: jsii.Number(123),
InvocationConfiguration: &InvocationConfigurationInputProperty{
PayloadDeliveryBucketName: jsii.String("payloadDeliveryBucketName"),
TopicArn: jsii.String("topicArn"),
},
TriggerConditions: []interface{}{
&TriggerConditionInputProperty{
MessageBasedTrigger: &MessageBasedTriggerInputProperty{
MessageCount: jsii.Number(123),
},
TimeBasedTrigger: &TimeBasedTriggerInputProperty{
IdleSessionTimeout: jsii.Number(123),
},
TokenBasedTrigger: &TokenBasedTriggerInputProperty{
TokenCount: jsii.Number(123),
},
},
},
},
SemanticOverride: &SemanticOverrideProperty{
Consolidation: &SemanticOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &SemanticOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
SummaryOverride: &SummaryOverrideProperty{
Consolidation: &SummaryOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
UserPreferenceOverride: &UserPreferenceOverrideProperty{
Consolidation: &UserPreferenceOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &UserPreferenceOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
},
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
EpisodicMemoryStrategy: &EpisodicMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
ReflectionConfiguration: &EpisodicReflectionConfigurationInputProperty{
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
SemanticMemoryStrategy: &SemanticMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
SummaryMemoryStrategy: &SummaryMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
UserPreferenceMemoryStrategy: &UserPreferenceMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
},
},
StreamDeliveryResources: &StreamDeliveryResourcesProperty{
Resources: []interface{}{
&StreamDeliveryResourceProperty{
Kinesis: &KinesisResourceProperty{
ContentConfigurations: []interface{}{
&ContentConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
Level: jsii.String("level"),
},
},
DataStreamArn: jsii.String("dataStreamArn"),
},
},
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnMemory ¶ added in v2.220.0
func NewCfnMemory(scope constructs.Construct, id *string, props *CfnMemoryProps) CfnMemory
Create a new `AWS::BedrockAgentCore::Memory`.
type CfnMemoryProps ¶ added in v2.220.0
type CfnMemoryProps struct {
// The event expiry configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-eventexpiryduration
//
EventExpiryDuration *float64 `field:"required" json:"eventExpiryDuration" yaml:"eventExpiryDuration"`
// The memory name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// Description of the Memory resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The memory encryption key Amazon Resource Name (ARN).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-encryptionkeyarn
//
EncryptionKeyArn *string `field:"optional" json:"encryptionKeyArn" yaml:"encryptionKeyArn"`
// The memory role ARN.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-memoryexecutionrolearn
//
MemoryExecutionRoleArn *string `field:"optional" json:"memoryExecutionRoleArn" yaml:"memoryExecutionRoleArn"`
// The memory strategies.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-memorystrategies
//
MemoryStrategies interface{} `field:"optional" json:"memoryStrategies" yaml:"memoryStrategies"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-streamdeliveryresources
//
StreamDeliveryResources interface{} `field:"optional" json:"streamDeliveryResources" yaml:"streamDeliveryResources"`
// The tags for the resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html#cfn-bedrockagentcore-memory-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnMemory`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnMemoryProps := &CfnMemoryProps{
EventExpiryDuration: jsii.Number(123),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
EncryptionKeyArn: jsii.String("encryptionKeyArn"),
MemoryExecutionRoleArn: jsii.String("memoryExecutionRoleArn"),
MemoryStrategies: []interface{}{
&MemoryStrategyProperty{
CustomMemoryStrategy: &CustomMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
Configuration: &CustomConfigurationInputProperty{
EpisodicOverride: &EpisodicOverrideProperty{
Consolidation: &EpisodicOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &EpisodicOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Reflection: &EpisodicOverrideReflectionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
// the properties below are optional
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
},
},
SelfManagedConfiguration: &SelfManagedConfigurationProperty{
HistoricalContextWindowSize: jsii.Number(123),
InvocationConfiguration: &InvocationConfigurationInputProperty{
PayloadDeliveryBucketName: jsii.String("payloadDeliveryBucketName"),
TopicArn: jsii.String("topicArn"),
},
TriggerConditions: []interface{}{
&TriggerConditionInputProperty{
MessageBasedTrigger: &MessageBasedTriggerInputProperty{
MessageCount: jsii.Number(123),
},
TimeBasedTrigger: &TimeBasedTriggerInputProperty{
IdleSessionTimeout: jsii.Number(123),
},
TokenBasedTrigger: &TokenBasedTriggerInputProperty{
TokenCount: jsii.Number(123),
},
},
},
},
SemanticOverride: &SemanticOverrideProperty{
Consolidation: &SemanticOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &SemanticOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
SummaryOverride: &SummaryOverrideProperty{
Consolidation: &SummaryOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
UserPreferenceOverride: &UserPreferenceOverrideProperty{
Consolidation: &UserPreferenceOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &UserPreferenceOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
},
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
EpisodicMemoryStrategy: &EpisodicMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
ReflectionConfiguration: &EpisodicReflectionConfigurationInputProperty{
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
SemanticMemoryStrategy: &SemanticMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
SummaryMemoryStrategy: &SummaryMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
UserPreferenceMemoryStrategy: &UserPreferenceMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
},
},
StreamDeliveryResources: &StreamDeliveryResourcesProperty{
Resources: []interface{}{
&StreamDeliveryResourceProperty{
Kinesis: &KinesisResourceProperty{
ContentConfigurations: []interface{}{
&ContentConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
Level: jsii.String("level"),
},
},
DataStreamArn: jsii.String("dataStreamArn"),
},
},
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnMemory_ContentConfigurationProperty ¶ added in v2.245.0
type CfnMemory_ContentConfigurationProperty struct {
// The type of content to deliver.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-contentconfiguration.html#cfn-bedrockagentcore-memory-contentconfiguration-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// The level of content detail to deliver.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-contentconfiguration.html#cfn-bedrockagentcore-memory-contentconfiguration-level
//
Level *string `field:"optional" json:"level" yaml:"level"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
contentConfigurationProperty := &ContentConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
Level: jsii.String("level"),
}
type CfnMemory_CustomConfigurationInputProperty ¶ added in v2.220.0
type CfnMemory_CustomConfigurationInputProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-episodicoverride
//
EpisodicOverride interface{} `field:"optional" json:"episodicOverride" yaml:"episodicOverride"`
// The custom configuration input.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-selfmanagedconfiguration
//
SelfManagedConfiguration interface{} `field:"optional" json:"selfManagedConfiguration" yaml:"selfManagedConfiguration"`
// The memory override configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-semanticoverride
//
SemanticOverride interface{} `field:"optional" json:"semanticOverride" yaml:"semanticOverride"`
// The memory configuration override.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-summaryoverride
//
SummaryOverride interface{} `field:"optional" json:"summaryOverride" yaml:"summaryOverride"`
// The memory user preference override.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-userpreferenceoverride
//
UserPreferenceOverride interface{} `field:"optional" json:"userPreferenceOverride" yaml:"userPreferenceOverride"`
}
The memory configuration input.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
customConfigurationInputProperty := &CustomConfigurationInputProperty{
EpisodicOverride: &EpisodicOverrideProperty{
Consolidation: &EpisodicOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &EpisodicOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Reflection: &EpisodicOverrideReflectionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
// the properties below are optional
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
},
},
SelfManagedConfiguration: &SelfManagedConfigurationProperty{
HistoricalContextWindowSize: jsii.Number(123),
InvocationConfiguration: &InvocationConfigurationInputProperty{
PayloadDeliveryBucketName: jsii.String("payloadDeliveryBucketName"),
TopicArn: jsii.String("topicArn"),
},
TriggerConditions: []interface{}{
&TriggerConditionInputProperty{
MessageBasedTrigger: &MessageBasedTriggerInputProperty{
MessageCount: jsii.Number(123),
},
TimeBasedTrigger: &TimeBasedTriggerInputProperty{
IdleSessionTimeout: jsii.Number(123),
},
TokenBasedTrigger: &TokenBasedTriggerInputProperty{
TokenCount: jsii.Number(123),
},
},
},
},
SemanticOverride: &SemanticOverrideProperty{
Consolidation: &SemanticOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &SemanticOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
SummaryOverride: &SummaryOverrideProperty{
Consolidation: &SummaryOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
UserPreferenceOverride: &UserPreferenceOverrideProperty{
Consolidation: &UserPreferenceOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &UserPreferenceOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
}
type CfnMemory_CustomMemoryStrategyProperty ¶ added in v2.220.0
type CfnMemory_CustomMemoryStrategyProperty struct {
// The memory strategy name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The memory strategy configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-configuration
//
Configuration interface{} `field:"optional" json:"configuration" yaml:"configuration"`
// Creation timestamp of the memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-createdat
//
CreatedAt *string `field:"optional" json:"createdAt" yaml:"createdAt"`
// The memory strategy description.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The memory strategy namespaces.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-namespaces
//
Namespaces *[]*string `field:"optional" json:"namespaces" yaml:"namespaces"`
// List of namespaces for memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-namespacetemplates
//
NamespaceTemplates *[]*string `field:"optional" json:"namespaceTemplates" yaml:"namespaceTemplates"`
// The memory strategy status.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
// The memory strategy ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-strategyid
//
StrategyId *string `field:"optional" json:"strategyId" yaml:"strategyId"`
// The memory strategy type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// The memory strategy update date and time.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-updatedat
//
UpdatedAt *string `field:"optional" json:"updatedAt" yaml:"updatedAt"`
}
The memory strategy.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
customMemoryStrategyProperty := &CustomMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
Configuration: &CustomConfigurationInputProperty{
EpisodicOverride: &EpisodicOverrideProperty{
Consolidation: &EpisodicOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &EpisodicOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Reflection: &EpisodicOverrideReflectionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
// the properties below are optional
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
},
},
SelfManagedConfiguration: &SelfManagedConfigurationProperty{
HistoricalContextWindowSize: jsii.Number(123),
InvocationConfiguration: &InvocationConfigurationInputProperty{
PayloadDeliveryBucketName: jsii.String("payloadDeliveryBucketName"),
TopicArn: jsii.String("topicArn"),
},
TriggerConditions: []interface{}{
&TriggerConditionInputProperty{
MessageBasedTrigger: &MessageBasedTriggerInputProperty{
MessageCount: jsii.Number(123),
},
TimeBasedTrigger: &TimeBasedTriggerInputProperty{
IdleSessionTimeout: jsii.Number(123),
},
TokenBasedTrigger: &TokenBasedTriggerInputProperty{
TokenCount: jsii.Number(123),
},
},
},
},
SemanticOverride: &SemanticOverrideProperty{
Consolidation: &SemanticOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &SemanticOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
SummaryOverride: &SummaryOverrideProperty{
Consolidation: &SummaryOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
UserPreferenceOverride: &UserPreferenceOverrideProperty{
Consolidation: &UserPreferenceOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &UserPreferenceOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
},
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
}
type CfnMemory_EpisodicMemoryStrategyProperty ¶ added in v2.234.0
type CfnMemory_EpisodicMemoryStrategyProperty struct {
// Name of the Memory resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// Creation timestamp of the memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-createdat
//
CreatedAt *string `field:"optional" json:"createdAt" yaml:"createdAt"`
// Description of the Memory resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// List of namespaces for memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-namespaces
//
Namespaces *[]*string `field:"optional" json:"namespaces" yaml:"namespaces"`
// List of namespaces for memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-namespacetemplates
//
NamespaceTemplates *[]*string `field:"optional" json:"namespaceTemplates" yaml:"namespaceTemplates"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-reflectionconfiguration
//
ReflectionConfiguration interface{} `field:"optional" json:"reflectionConfiguration" yaml:"reflectionConfiguration"`
// Status of the memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
// Unique identifier for the memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-strategyid
//
StrategyId *string `field:"optional" json:"strategyId" yaml:"strategyId"`
// Type of memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// Last update timestamp of the memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicmemorystrategy.html#cfn-bedrockagentcore-memory-episodicmemorystrategy-updatedat
//
UpdatedAt *string `field:"optional" json:"updatedAt" yaml:"updatedAt"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
episodicMemoryStrategyProperty := &EpisodicMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
ReflectionConfiguration: &EpisodicReflectionConfigurationInputProperty{
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
}
type CfnMemory_EpisodicOverrideConsolidationConfigurationInputProperty ¶ added in v2.234.0
type CfnMemory_EpisodicOverrideConsolidationConfigurationInputProperty struct {
// Text prompt for model instructions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-appendtoprompt
//
AppendToPrompt *string `field:"required" json:"appendToPrompt" yaml:"appendToPrompt"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverrideconsolidationconfigurationinput-modelid
//
ModelId *string `field:"required" json:"modelId" yaml:"modelId"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
episodicOverrideConsolidationConfigurationInputProperty := &EpisodicOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
}
type CfnMemory_EpisodicOverrideExtractionConfigurationInputProperty ¶ added in v2.234.0
type CfnMemory_EpisodicOverrideExtractionConfigurationInputProperty struct {
// Text prompt for model instructions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-appendtoprompt
//
AppendToPrompt *string `field:"required" json:"appendToPrompt" yaml:"appendToPrompt"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverrideextractionconfigurationinput-modelid
//
ModelId *string `field:"required" json:"modelId" yaml:"modelId"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
episodicOverrideExtractionConfigurationInputProperty := &EpisodicOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
}
type CfnMemory_EpisodicOverrideProperty ¶ added in v2.234.0
type CfnMemory_EpisodicOverrideProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverride.html#cfn-bedrockagentcore-memory-episodicoverride-consolidation
//
Consolidation interface{} `field:"optional" json:"consolidation" yaml:"consolidation"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverride.html#cfn-bedrockagentcore-memory-episodicoverride-extraction
//
Extraction interface{} `field:"optional" json:"extraction" yaml:"extraction"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverride.html#cfn-bedrockagentcore-memory-episodicoverride-reflection
//
Reflection interface{} `field:"optional" json:"reflection" yaml:"reflection"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
episodicOverrideProperty := &EpisodicOverrideProperty{
Consolidation: &EpisodicOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &EpisodicOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Reflection: &EpisodicOverrideReflectionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
// the properties below are optional
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
},
}
type CfnMemory_EpisodicOverrideReflectionConfigurationInputProperty ¶ added in v2.234.0
type CfnMemory_EpisodicOverrideReflectionConfigurationInputProperty struct {
// Text prompt for model instructions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-appendtoprompt
//
AppendToPrompt *string `field:"required" json:"appendToPrompt" yaml:"appendToPrompt"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-modelid
//
ModelId *string `field:"required" json:"modelId" yaml:"modelId"`
// List of namespaces for memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-namespaces
//
Namespaces *[]*string `field:"optional" json:"namespaces" yaml:"namespaces"`
// List of namespaces for memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicoverridereflectionconfigurationinput-namespacetemplates
//
NamespaceTemplates *[]*string `field:"optional" json:"namespaceTemplates" yaml:"namespaceTemplates"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
episodicOverrideReflectionConfigurationInputProperty := &EpisodicOverrideReflectionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
// the properties below are optional
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
}
type CfnMemory_EpisodicReflectionConfigurationInputProperty ¶ added in v2.234.0
type CfnMemory_EpisodicReflectionConfigurationInputProperty struct {
// List of namespaces for memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicreflectionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicreflectionconfigurationinput-namespaces
//
Namespaces *[]*string `field:"optional" json:"namespaces" yaml:"namespaces"`
// List of namespaces for memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-episodicreflectionconfigurationinput.html#cfn-bedrockagentcore-memory-episodicreflectionconfigurationinput-namespacetemplates
//
NamespaceTemplates *[]*string `field:"optional" json:"namespaceTemplates" yaml:"namespaceTemplates"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
episodicReflectionConfigurationInputProperty := &EpisodicReflectionConfigurationInputProperty{
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
}
type CfnMemory_InvocationConfigurationInputProperty ¶ added in v2.221.0
type CfnMemory_InvocationConfigurationInputProperty struct {
// The message invocation configuration information for the bucket name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-invocationconfigurationinput.html#cfn-bedrockagentcore-memory-invocationconfigurationinput-payloaddeliverybucketname
//
PayloadDeliveryBucketName *string `field:"optional" json:"payloadDeliveryBucketName" yaml:"payloadDeliveryBucketName"`
// The memory trigger condition topic Amazon Resource Name (ARN).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-invocationconfigurationinput.html#cfn-bedrockagentcore-memory-invocationconfigurationinput-topicarn
//
TopicArn *string `field:"optional" json:"topicArn" yaml:"topicArn"`
}
The memory invocation configuration input.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
invocationConfigurationInputProperty := &InvocationConfigurationInputProperty{
PayloadDeliveryBucketName: jsii.String("payloadDeliveryBucketName"),
TopicArn: jsii.String("topicArn"),
}
type CfnMemory_KinesisResourceProperty ¶ added in v2.245.0
type CfnMemory_KinesisResourceProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-kinesisresource.html#cfn-bedrockagentcore-memory-kinesisresource-contentconfigurations
//
ContentConfigurations interface{} `field:"required" json:"contentConfigurations" yaml:"contentConfigurations"`
// ARN format.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-kinesisresource.html#cfn-bedrockagentcore-memory-kinesisresource-datastreamarn
//
DataStreamArn *string `field:"required" json:"dataStreamArn" yaml:"dataStreamArn"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
kinesisResourceProperty := &KinesisResourceProperty{
ContentConfigurations: []interface{}{
&ContentConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
Level: jsii.String("level"),
},
},
DataStreamArn: jsii.String("dataStreamArn"),
}
type CfnMemory_MemoryStrategyProperty ¶ added in v2.220.0
type CfnMemory_MemoryStrategyProperty struct {
// The memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-custommemorystrategy
//
CustomMemoryStrategy interface{} `field:"optional" json:"customMemoryStrategy" yaml:"customMemoryStrategy"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-episodicmemorystrategy
//
EpisodicMemoryStrategy interface{} `field:"optional" json:"episodicMemoryStrategy" yaml:"episodicMemoryStrategy"`
// The memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-semanticmemorystrategy
//
SemanticMemoryStrategy interface{} `field:"optional" json:"semanticMemoryStrategy" yaml:"semanticMemoryStrategy"`
// The memory strategy summary.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-summarymemorystrategy
//
SummaryMemoryStrategy interface{} `field:"optional" json:"summaryMemoryStrategy" yaml:"summaryMemoryStrategy"`
// The memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-userpreferencememorystrategy
//
UserPreferenceMemoryStrategy interface{} `field:"optional" json:"userPreferenceMemoryStrategy" yaml:"userPreferenceMemoryStrategy"`
}
The memory strategy.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
memoryStrategyProperty := &MemoryStrategyProperty{
CustomMemoryStrategy: &CustomMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
Configuration: &CustomConfigurationInputProperty{
EpisodicOverride: &EpisodicOverrideProperty{
Consolidation: &EpisodicOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &EpisodicOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Reflection: &EpisodicOverrideReflectionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
// the properties below are optional
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
},
},
SelfManagedConfiguration: &SelfManagedConfigurationProperty{
HistoricalContextWindowSize: jsii.Number(123),
InvocationConfiguration: &InvocationConfigurationInputProperty{
PayloadDeliveryBucketName: jsii.String("payloadDeliveryBucketName"),
TopicArn: jsii.String("topicArn"),
},
TriggerConditions: []interface{}{
&TriggerConditionInputProperty{
MessageBasedTrigger: &MessageBasedTriggerInputProperty{
MessageCount: jsii.Number(123),
},
TimeBasedTrigger: &TimeBasedTriggerInputProperty{
IdleSessionTimeout: jsii.Number(123),
},
TokenBasedTrigger: &TokenBasedTriggerInputProperty{
TokenCount: jsii.Number(123),
},
},
},
},
SemanticOverride: &SemanticOverrideProperty{
Consolidation: &SemanticOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &SemanticOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
SummaryOverride: &SummaryOverrideProperty{
Consolidation: &SummaryOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
UserPreferenceOverride: &UserPreferenceOverrideProperty{
Consolidation: &UserPreferenceOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &UserPreferenceOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
},
},
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
EpisodicMemoryStrategy: &EpisodicMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
ReflectionConfiguration: &EpisodicReflectionConfigurationInputProperty{
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
SemanticMemoryStrategy: &SemanticMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
SummaryMemoryStrategy: &SummaryMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
UserPreferenceMemoryStrategy: &UserPreferenceMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
},
}
type CfnMemory_MessageBasedTriggerInputProperty ¶ added in v2.221.0
type CfnMemory_MessageBasedTriggerInputProperty struct {
// The memory trigger condition input for the message based trigger message count.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-messagebasedtriggerinput.html#cfn-bedrockagentcore-memory-messagebasedtriggerinput-messagecount
//
MessageCount *float64 `field:"optional" json:"messageCount" yaml:"messageCount"`
}
The message based trigger input.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
messageBasedTriggerInputProperty := &MessageBasedTriggerInputProperty{
MessageCount: jsii.Number(123),
}
type CfnMemory_SelfManagedConfigurationProperty ¶ added in v2.221.0
type CfnMemory_SelfManagedConfigurationProperty struct {
// The memory configuration for self managed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html#cfn-bedrockagentcore-memory-selfmanagedconfiguration-historicalcontextwindowsize
//
HistoricalContextWindowSize *float64 `field:"optional" json:"historicalContextWindowSize" yaml:"historicalContextWindowSize"`
// The self managed configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html#cfn-bedrockagentcore-memory-selfmanagedconfiguration-invocationconfiguration
//
InvocationConfiguration interface{} `field:"optional" json:"invocationConfiguration" yaml:"invocationConfiguration"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html#cfn-bedrockagentcore-memory-selfmanagedconfiguration-triggerconditions
//
TriggerConditions interface{} `field:"optional" json:"triggerConditions" yaml:"triggerConditions"`
}
The self managed configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
selfManagedConfigurationProperty := &SelfManagedConfigurationProperty{
HistoricalContextWindowSize: jsii.Number(123),
InvocationConfiguration: &InvocationConfigurationInputProperty{
PayloadDeliveryBucketName: jsii.String("payloadDeliveryBucketName"),
TopicArn: jsii.String("topicArn"),
},
TriggerConditions: []interface{}{
&TriggerConditionInputProperty{
MessageBasedTrigger: &MessageBasedTriggerInputProperty{
MessageCount: jsii.Number(123),
},
TimeBasedTrigger: &TimeBasedTriggerInputProperty{
IdleSessionTimeout: jsii.Number(123),
},
TokenBasedTrigger: &TokenBasedTriggerInputProperty{
TokenCount: jsii.Number(123),
},
},
},
}
type CfnMemory_SemanticMemoryStrategyProperty ¶ added in v2.220.0
type CfnMemory_SemanticMemoryStrategyProperty struct {
// The memory strategy name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// Creation timestamp of the memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-createdat
//
CreatedAt *string `field:"optional" json:"createdAt" yaml:"createdAt"`
// The memory strategy description.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The memory strategy namespaces.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-namespaces
//
Namespaces *[]*string `field:"optional" json:"namespaces" yaml:"namespaces"`
// List of namespaces for memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-namespacetemplates
//
NamespaceTemplates *[]*string `field:"optional" json:"namespaceTemplates" yaml:"namespaceTemplates"`
// Status of the memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
// The memory strategy ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-strategyid
//
StrategyId *string `field:"optional" json:"strategyId" yaml:"strategyId"`
// The memory strategy type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// Last update timestamp of the memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-updatedat
//
UpdatedAt *string `field:"optional" json:"updatedAt" yaml:"updatedAt"`
}
The memory strategy.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
semanticMemoryStrategyProperty := &SemanticMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
}
type CfnMemory_SemanticOverrideConsolidationConfigurationInputProperty ¶ added in v2.220.0
type CfnMemory_SemanticOverrideConsolidationConfigurationInputProperty struct {
// The override configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-appendtoprompt
//
AppendToPrompt *string `field:"required" json:"appendToPrompt" yaml:"appendToPrompt"`
// The memory override model ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-modelid
//
ModelId *string `field:"required" json:"modelId" yaml:"modelId"`
}
The memory override configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
semanticOverrideConsolidationConfigurationInputProperty := &SemanticOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
}
type CfnMemory_SemanticOverrideExtractionConfigurationInputProperty ¶ added in v2.220.0
type CfnMemory_SemanticOverrideExtractionConfigurationInputProperty struct {
// The extraction configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-appendtoprompt
//
AppendToPrompt *string `field:"required" json:"appendToPrompt" yaml:"appendToPrompt"`
// The memory override configuration model ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-modelid
//
ModelId *string `field:"required" json:"modelId" yaml:"modelId"`
}
The memory override configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
semanticOverrideExtractionConfigurationInputProperty := &SemanticOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
}
type CfnMemory_SemanticOverrideProperty ¶ added in v2.220.0
type CfnMemory_SemanticOverrideProperty struct {
// The memory override consolidation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverride.html#cfn-bedrockagentcore-memory-semanticoverride-consolidation
//
Consolidation interface{} `field:"optional" json:"consolidation" yaml:"consolidation"`
// The memory override extraction.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverride.html#cfn-bedrockagentcore-memory-semanticoverride-extraction
//
Extraction interface{} `field:"optional" json:"extraction" yaml:"extraction"`
}
The memory override.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
semanticOverrideProperty := &SemanticOverrideProperty{
Consolidation: &SemanticOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &SemanticOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
}
type CfnMemory_StreamDeliveryResourceProperty ¶ added in v2.245.0
type CfnMemory_StreamDeliveryResourceProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-streamdeliveryresource.html#cfn-bedrockagentcore-memory-streamdeliveryresource-kinesis
//
Kinesis interface{} `field:"optional" json:"kinesis" yaml:"kinesis"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
streamDeliveryResourceProperty := &StreamDeliveryResourceProperty{
Kinesis: &KinesisResourceProperty{
ContentConfigurations: []interface{}{
&ContentConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
Level: jsii.String("level"),
},
},
DataStreamArn: jsii.String("dataStreamArn"),
},
}
type CfnMemory_StreamDeliveryResourcesProperty ¶ added in v2.245.0
type CfnMemory_StreamDeliveryResourcesProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-streamdeliveryresources.html#cfn-bedrockagentcore-memory-streamdeliveryresources-resources
//
Resources interface{} `field:"required" json:"resources" yaml:"resources"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
streamDeliveryResourcesProperty := &StreamDeliveryResourcesProperty{
Resources: []interface{}{
&StreamDeliveryResourceProperty{
Kinesis: &KinesisResourceProperty{
ContentConfigurations: []interface{}{
&ContentConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
Level: jsii.String("level"),
},
},
DataStreamArn: jsii.String("dataStreamArn"),
},
},
},
}
type CfnMemory_SummaryMemoryStrategyProperty ¶ added in v2.220.0
type CfnMemory_SummaryMemoryStrategyProperty struct {
// The memory strategy name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// Creation timestamp of the memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-createdat
//
CreatedAt *string `field:"optional" json:"createdAt" yaml:"createdAt"`
// The memory strategy description.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The summary memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-namespaces
//
Namespaces *[]*string `field:"optional" json:"namespaces" yaml:"namespaces"`
// List of namespaces for memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-namespacetemplates
//
NamespaceTemplates *[]*string `field:"optional" json:"namespaceTemplates" yaml:"namespaceTemplates"`
// The memory strategy status.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
// The memory strategy ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-strategyid
//
StrategyId *string `field:"optional" json:"strategyId" yaml:"strategyId"`
// The memory strategy type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// The memory strategy update date and time.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-updatedat
//
UpdatedAt *string `field:"optional" json:"updatedAt" yaml:"updatedAt"`
}
The memory strategy.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
summaryMemoryStrategyProperty := &SummaryMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
}
type CfnMemory_SummaryOverrideConsolidationConfigurationInputProperty ¶ added in v2.220.0
type CfnMemory_SummaryOverrideConsolidationConfigurationInputProperty struct {
// The memory override configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-appendtoprompt
//
AppendToPrompt *string `field:"required" json:"appendToPrompt" yaml:"appendToPrompt"`
// The memory override configuration model ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-modelid
//
ModelId *string `field:"required" json:"modelId" yaml:"modelId"`
}
The consolidation configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
summaryOverrideConsolidationConfigurationInputProperty := &SummaryOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
}
type CfnMemory_SummaryOverrideProperty ¶ added in v2.220.0
type CfnMemory_SummaryOverrideProperty struct {
// The memory override consolidation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverride.html#cfn-bedrockagentcore-memory-summaryoverride-consolidation
//
Consolidation interface{} `field:"optional" json:"consolidation" yaml:"consolidation"`
}
The memory summary override.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
summaryOverrideProperty := &SummaryOverrideProperty{
Consolidation: &SummaryOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
}
type CfnMemory_TimeBasedTriggerInputProperty ¶ added in v2.221.0
type CfnMemory_TimeBasedTriggerInputProperty struct {
// The memory trigger condition input for the session timeout.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-timebasedtriggerinput.html#cfn-bedrockagentcore-memory-timebasedtriggerinput-idlesessiontimeout
//
IdleSessionTimeout *float64 `field:"optional" json:"idleSessionTimeout" yaml:"idleSessionTimeout"`
}
The memory trigger condition input for the time based trigger.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
timeBasedTriggerInputProperty := &TimeBasedTriggerInputProperty{
IdleSessionTimeout: jsii.Number(123),
}
type CfnMemory_TokenBasedTriggerInputProperty ¶ added in v2.221.0
type CfnMemory_TokenBasedTriggerInputProperty struct {
// The token based trigger token count.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput.html#cfn-bedrockagentcore-memory-tokenbasedtriggerinput-tokencount
//
TokenCount *float64 `field:"optional" json:"tokenCount" yaml:"tokenCount"`
}
The token based trigger input.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
tokenBasedTriggerInputProperty := &TokenBasedTriggerInputProperty{
TokenCount: jsii.Number(123),
}
type CfnMemory_TriggerConditionInputProperty ¶ added in v2.221.0
type CfnMemory_TriggerConditionInputProperty struct {
// The memory trigger condition input for the message based trigger.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-triggerconditioninput.html#cfn-bedrockagentcore-memory-triggerconditioninput-messagebasedtrigger
//
MessageBasedTrigger interface{} `field:"optional" json:"messageBasedTrigger" yaml:"messageBasedTrigger"`
// The memory trigger condition input.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-triggerconditioninput.html#cfn-bedrockagentcore-memory-triggerconditioninput-timebasedtrigger
//
TimeBasedTrigger interface{} `field:"optional" json:"timeBasedTrigger" yaml:"timeBasedTrigger"`
// The trigger condition information for a token based trigger.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-triggerconditioninput.html#cfn-bedrockagentcore-memory-triggerconditioninput-tokenbasedtrigger
//
TokenBasedTrigger interface{} `field:"optional" json:"tokenBasedTrigger" yaml:"tokenBasedTrigger"`
}
The memory trigger condition input.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
triggerConditionInputProperty := &TriggerConditionInputProperty{
MessageBasedTrigger: &MessageBasedTriggerInputProperty{
MessageCount: jsii.Number(123),
},
TimeBasedTrigger: &TimeBasedTriggerInputProperty{
IdleSessionTimeout: jsii.Number(123),
},
TokenBasedTrigger: &TokenBasedTriggerInputProperty{
TokenCount: jsii.Number(123),
},
}
type CfnMemory_UserPreferenceMemoryStrategyProperty ¶ added in v2.220.0
type CfnMemory_UserPreferenceMemoryStrategyProperty struct {
// The memory strategy name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// Creation timestamp of the memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-createdat
//
CreatedAt *string `field:"optional" json:"createdAt" yaml:"createdAt"`
// The memory strategy description.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The memory namespaces.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-namespaces
//
Namespaces *[]*string `field:"optional" json:"namespaces" yaml:"namespaces"`
// List of namespaces for memory strategy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-namespacetemplates
//
NamespaceTemplates *[]*string `field:"optional" json:"namespaceTemplates" yaml:"namespaceTemplates"`
// The memory strategy status.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
// The memory strategy ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-strategyid
//
StrategyId *string `field:"optional" json:"strategyId" yaml:"strategyId"`
// The memory strategy type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// The memory strategy update date and time.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-updatedat
//
UpdatedAt *string `field:"optional" json:"updatedAt" yaml:"updatedAt"`
}
The memory strategy.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
userPreferenceMemoryStrategyProperty := &UserPreferenceMemoryStrategyProperty{
Name: jsii.String("name"),
// the properties below are optional
CreatedAt: jsii.String("createdAt"),
Description: jsii.String("description"),
Namespaces: []*string{
jsii.String("namespaces"),
},
NamespaceTemplates: []*string{
jsii.String("namespaceTemplates"),
},
Status: jsii.String("status"),
StrategyId: jsii.String("strategyId"),
Type: jsii.String("type"),
UpdatedAt: jsii.String("updatedAt"),
}
type CfnMemory_UserPreferenceOverrideConsolidationConfigurationInputProperty ¶ added in v2.220.0
type CfnMemory_UserPreferenceOverrideConsolidationConfigurationInputProperty struct {
// The memory configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-appendtoprompt
//
AppendToPrompt *string `field:"required" json:"appendToPrompt" yaml:"appendToPrompt"`
// The memory override configuration model ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-modelid
//
ModelId *string `field:"required" json:"modelId" yaml:"modelId"`
}
The configuration input.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
userPreferenceOverrideConsolidationConfigurationInputProperty := &UserPreferenceOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
}
type CfnMemory_UserPreferenceOverrideExtractionConfigurationInputProperty ¶ added in v2.220.0
type CfnMemory_UserPreferenceOverrideExtractionConfigurationInputProperty struct {
// The extraction configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-appendtoprompt
//
AppendToPrompt *string `field:"required" json:"appendToPrompt" yaml:"appendToPrompt"`
// The memory override for the model ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-modelid
//
ModelId *string `field:"required" json:"modelId" yaml:"modelId"`
}
The memory override configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
userPreferenceOverrideExtractionConfigurationInputProperty := &UserPreferenceOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
}
type CfnMemory_UserPreferenceOverrideProperty ¶ added in v2.220.0
type CfnMemory_UserPreferenceOverrideProperty struct {
// The memory override consolidation information.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverride.html#cfn-bedrockagentcore-memory-userpreferenceoverride-consolidation
//
Consolidation interface{} `field:"optional" json:"consolidation" yaml:"consolidation"`
// The memory user preferences for extraction.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverride.html#cfn-bedrockagentcore-memory-userpreferenceoverride-extraction
//
Extraction interface{} `field:"optional" json:"extraction" yaml:"extraction"`
}
The memory user preference override.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
userPreferenceOverrideProperty := &UserPreferenceOverrideProperty{
Consolidation: &UserPreferenceOverrideConsolidationConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
Extraction: &UserPreferenceOverrideExtractionConfigurationInputProperty{
AppendToPrompt: jsii.String("appendToPrompt"),
ModelId: jsii.String("modelId"),
},
}
type CfnOAuth2CredentialProvider ¶ added in v2.250.0
type CfnOAuth2CredentialProvider interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IOAuth2CredentialProviderRef
awscdk.ITaggableV2
// The callback URL for the OAuth2 authorization flow.
AttrCallbackUrl() *string
// Contains information about a secret in AWS Secrets Manager.
AttrClientSecretArn() awscdk.IResolvable
// The timestamp when the credential provider was created.
AttrCreatedTime() *string
// The Amazon Resource Name (ARN) of the OAuth2 credential provider.
AttrCredentialProviderArn() *string
// The timestamp when the credential provider was last updated.
AttrLastUpdatedTime() *string
// Output configuration for an OAuth2 provider.
AttrOauth2ProviderConfigOutput() awscdk.IResolvable
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The vendor of the OAuth2 credential provider.
CredentialProviderVendor() *string
SetCredentialProviderVendor(val *string)
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the OAuth2 credential provider.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// A reference to a OAuth2CredentialProvider resource.
OAuth2CredentialProviderRef() *interfacesawsbedrockagentcore.OAuth2CredentialProviderReference
// Input configuration for an OAuth2 provider.
Oauth2ProviderConfigInput() interface{}
SetOauth2ProviderConfigInput(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tags to assign to the OAuth2 credential provider.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource Type definition for AWS::BedrockAgentCore::OAuth2CredentialProvider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnOAuth2CredentialProvider := awscdk.Aws_bedrockagentcore.NewCfnOAuth2CredentialProvider(this, jsii.String("MyCfnOAuth2CredentialProvider"), &CfnOAuth2CredentialProviderProps{
CredentialProviderVendor: jsii.String("credentialProviderVendor"),
Name: jsii.String("name"),
// the properties below are optional
Oauth2ProviderConfigInput: &Oauth2ProviderConfigInputProperty{
AtlassianOauth2ProviderConfig: &AtlassianOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
CustomOauth2ProviderConfig: &CustomOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
OauthDiscovery: &Oauth2DiscoveryProperty{
AuthorizationServerMetadata: &Oauth2AuthorizationServerMetadataProperty{
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
Issuer: jsii.String("issuer"),
TokenEndpoint: jsii.String("tokenEndpoint"),
// the properties below are optional
ResponseTypes: []*string{
jsii.String("responseTypes"),
},
},
DiscoveryUrl: jsii.String("discoveryUrl"),
},
},
GithubOauth2ProviderConfig: &GithubOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
GoogleOauth2ProviderConfig: &GoogleOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
IncludedOauth2ProviderConfig: &IncludedOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
// the properties below are optional
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
Issuer: jsii.String("issuer"),
TokenEndpoint: jsii.String("tokenEndpoint"),
},
LinkedinOauth2ProviderConfig: &LinkedinOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
MicrosoftOauth2ProviderConfig: &MicrosoftOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
// the properties below are optional
TenantId: jsii.String("tenantId"),
},
SalesforceOauth2ProviderConfig: &SalesforceOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
SlackOauth2ProviderConfig: &SlackOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnOAuth2CredentialProvider ¶ added in v2.250.0
func NewCfnOAuth2CredentialProvider(scope constructs.Construct, id *string, props *CfnOAuth2CredentialProviderProps) CfnOAuth2CredentialProvider
Create a new `AWS::BedrockAgentCore::OAuth2CredentialProvider`.
type CfnOAuth2CredentialProviderProps ¶ added in v2.250.0
type CfnOAuth2CredentialProviderProps struct {
// The vendor of the OAuth2 credential provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-oauth2credentialprovider.html#cfn-bedrockagentcore-oauth2credentialprovider-credentialprovidervendor
//
CredentialProviderVendor *string `field:"required" json:"credentialProviderVendor" yaml:"credentialProviderVendor"`
// The name of the OAuth2 credential provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-oauth2credentialprovider.html#cfn-bedrockagentcore-oauth2credentialprovider-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// Input configuration for an OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-oauth2credentialprovider.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput
//
Oauth2ProviderConfigInput interface{} `field:"optional" json:"oauth2ProviderConfigInput" yaml:"oauth2ProviderConfigInput"`
// Tags to assign to the OAuth2 credential provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-oauth2credentialprovider.html#cfn-bedrockagentcore-oauth2credentialprovider-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnOAuth2CredentialProvider`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnOAuth2CredentialProviderProps := &CfnOAuth2CredentialProviderProps{
CredentialProviderVendor: jsii.String("credentialProviderVendor"),
Name: jsii.String("name"),
// the properties below are optional
Oauth2ProviderConfigInput: &Oauth2ProviderConfigInputProperty{
AtlassianOauth2ProviderConfig: &AtlassianOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
CustomOauth2ProviderConfig: &CustomOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
OauthDiscovery: &Oauth2DiscoveryProperty{
AuthorizationServerMetadata: &Oauth2AuthorizationServerMetadataProperty{
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
Issuer: jsii.String("issuer"),
TokenEndpoint: jsii.String("tokenEndpoint"),
// the properties below are optional
ResponseTypes: []*string{
jsii.String("responseTypes"),
},
},
DiscoveryUrl: jsii.String("discoveryUrl"),
},
},
GithubOauth2ProviderConfig: &GithubOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
GoogleOauth2ProviderConfig: &GoogleOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
IncludedOauth2ProviderConfig: &IncludedOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
// the properties below are optional
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
Issuer: jsii.String("issuer"),
TokenEndpoint: jsii.String("tokenEndpoint"),
},
LinkedinOauth2ProviderConfig: &LinkedinOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
MicrosoftOauth2ProviderConfig: &MicrosoftOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
// the properties below are optional
TenantId: jsii.String("tenantId"),
},
SalesforceOauth2ProviderConfig: &SalesforceOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
SlackOauth2ProviderConfig: &SlackOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnOAuth2CredentialProvider_AtlassianOauth2ProviderConfigInputProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_AtlassianOauth2ProviderConfigInputProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-clientid
//
ClientId *string `field:"required" json:"clientId" yaml:"clientId"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-atlassianoauth2providerconfiginput-clientsecret
//
ClientSecret *string `field:"required" json:"clientSecret" yaml:"clientSecret"`
}
Input configuration for an Atlassian OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
atlassianOauth2ProviderConfigInputProperty := &AtlassianOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
}
type CfnOAuth2CredentialProvider_ClientSecretArnProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_ClientSecretArnProperty struct {
// The ARN of the secret in AWS Secrets Manager.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-clientsecretarn.html#cfn-bedrockagentcore-oauth2credentialprovider-clientsecretarn-secretarn
//
SecretArn *string `field:"required" json:"secretArn" yaml:"secretArn"`
}
Contains information about a secret in AWS Secrets Manager.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
clientSecretArnProperty := &ClientSecretArnProperty{
SecretArn: jsii.String("secretArn"),
}
type CfnOAuth2CredentialProvider_CustomOauth2ProviderConfigInputProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_CustomOauth2ProviderConfigInputProperty struct {
// The client ID for the custom OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientid
//
ClientId *string `field:"required" json:"clientId" yaml:"clientId"`
// The client secret for the custom OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-clientsecret
//
ClientSecret *string `field:"required" json:"clientSecret" yaml:"clientSecret"`
// Discovery information for an OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-customoauth2providerconfiginput-oauthdiscovery
//
OauthDiscovery interface{} `field:"required" json:"oauthDiscovery" yaml:"oauthDiscovery"`
}
Input configuration for a custom OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
customOauth2ProviderConfigInputProperty := &CustomOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
OauthDiscovery: &Oauth2DiscoveryProperty{
AuthorizationServerMetadata: &Oauth2AuthorizationServerMetadataProperty{
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
Issuer: jsii.String("issuer"),
TokenEndpoint: jsii.String("tokenEndpoint"),
// the properties below are optional
ResponseTypes: []*string{
jsii.String("responseTypes"),
},
},
DiscoveryUrl: jsii.String("discoveryUrl"),
},
}
type CfnOAuth2CredentialProvider_GithubOauth2ProviderConfigInputProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_GithubOauth2ProviderConfigInputProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-clientid
//
ClientId *string `field:"required" json:"clientId" yaml:"clientId"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-githuboauth2providerconfiginput-clientsecret
//
ClientSecret *string `field:"required" json:"clientSecret" yaml:"clientSecret"`
}
Input configuration for a GitHub OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
githubOauth2ProviderConfigInputProperty := &GithubOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
}
type CfnOAuth2CredentialProvider_GoogleOauth2ProviderConfigInputProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_GoogleOauth2ProviderConfigInputProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-clientid
//
ClientId *string `field:"required" json:"clientId" yaml:"clientId"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-googleoauth2providerconfiginput-clientsecret
//
ClientSecret *string `field:"required" json:"clientSecret" yaml:"clientSecret"`
}
Input configuration for a Google OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
googleOauth2ProviderConfigInputProperty := &GoogleOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
}
type CfnOAuth2CredentialProvider_IncludedOauth2ProviderConfigInputProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_IncludedOauth2ProviderConfigInputProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-clientid
//
ClientId *string `field:"required" json:"clientId" yaml:"clientId"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-clientsecret
//
ClientSecret *string `field:"required" json:"clientSecret" yaml:"clientSecret"`
// OAuth2 authorization endpoint for your isolated OAuth2 application tenant.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-authorizationendpoint
//
AuthorizationEndpoint *string `field:"optional" json:"authorizationEndpoint" yaml:"authorizationEndpoint"`
// Token issuer of your isolated OAuth2 application tenant.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-issuer
//
Issuer *string `field:"optional" json:"issuer" yaml:"issuer"`
// OAuth2 token endpoint for your isolated OAuth2 application tenant.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-includedoauth2providerconfiginput-tokenendpoint
//
TokenEndpoint *string `field:"optional" json:"tokenEndpoint" yaml:"tokenEndpoint"`
}
Input configuration for a supported non-custom OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
includedOauth2ProviderConfigInputProperty := &IncludedOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
// the properties below are optional
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
Issuer: jsii.String("issuer"),
TokenEndpoint: jsii.String("tokenEndpoint"),
}
type CfnOAuth2CredentialProvider_LinkedinOauth2ProviderConfigInputProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_LinkedinOauth2ProviderConfigInputProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-clientid
//
ClientId *string `field:"required" json:"clientId" yaml:"clientId"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-linkedinoauth2providerconfiginput-clientsecret
//
ClientSecret *string `field:"required" json:"clientSecret" yaml:"clientSecret"`
}
Input configuration for a LinkedIn OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
linkedinOauth2ProviderConfigInputProperty := &LinkedinOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
}
type CfnOAuth2CredentialProvider_MicrosoftOauth2ProviderConfigInputProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_MicrosoftOauth2ProviderConfigInputProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-clientid
//
ClientId *string `field:"required" json:"clientId" yaml:"clientId"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-clientsecret
//
ClientSecret *string `field:"required" json:"clientSecret" yaml:"clientSecret"`
// The Microsoft Entra ID tenant ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-microsoftoauth2providerconfiginput-tenantid
//
TenantId *string `field:"optional" json:"tenantId" yaml:"tenantId"`
}
Input configuration for a Microsoft OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
microsoftOauth2ProviderConfigInputProperty := &MicrosoftOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
// the properties below are optional
TenantId: jsii.String("tenantId"),
}
type CfnOAuth2CredentialProvider_Oauth2AuthorizationServerMetadataProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_Oauth2AuthorizationServerMetadataProperty struct {
// The authorization endpoint URL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-authorizationendpoint
//
AuthorizationEndpoint *string `field:"required" json:"authorizationEndpoint" yaml:"authorizationEndpoint"`
// The issuer URL for the OAuth2 authorization server.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-issuer
//
Issuer *string `field:"required" json:"issuer" yaml:"issuer"`
// The token endpoint URL.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-tokenendpoint
//
TokenEndpoint *string `field:"required" json:"tokenEndpoint" yaml:"tokenEndpoint"`
// The supported response types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2authorizationservermetadata-responsetypes
//
ResponseTypes *[]*string `field:"optional" json:"responseTypes" yaml:"responseTypes"`
}
Authorization server metadata for the OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
oauth2AuthorizationServerMetadataProperty := &Oauth2AuthorizationServerMetadataProperty{
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
Issuer: jsii.String("issuer"),
TokenEndpoint: jsii.String("tokenEndpoint"),
// the properties below are optional
ResponseTypes: []*string{
jsii.String("responseTypes"),
},
}
type CfnOAuth2CredentialProvider_Oauth2DiscoveryProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_Oauth2DiscoveryProperty struct {
// Authorization server metadata for the OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2discovery-authorizationservermetadata
//
AuthorizationServerMetadata interface{} `field:"optional" json:"authorizationServerMetadata" yaml:"authorizationServerMetadata"`
// The discovery URL for the OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2discovery.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2discovery-discoveryurl
//
DiscoveryUrl *string `field:"optional" json:"discoveryUrl" yaml:"discoveryUrl"`
}
Discovery information for an OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
oauth2DiscoveryProperty := &Oauth2DiscoveryProperty{
AuthorizationServerMetadata: &Oauth2AuthorizationServerMetadataProperty{
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
Issuer: jsii.String("issuer"),
TokenEndpoint: jsii.String("tokenEndpoint"),
// the properties below are optional
ResponseTypes: []*string{
jsii.String("responseTypes"),
},
},
DiscoveryUrl: jsii.String("discoveryUrl"),
}
type CfnOAuth2CredentialProvider_Oauth2ProviderConfigInputProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_Oauth2ProviderConfigInputProperty struct {
// Input configuration for an Atlassian OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-atlassianoauth2providerconfig
//
AtlassianOauth2ProviderConfig interface{} `field:"optional" json:"atlassianOauth2ProviderConfig" yaml:"atlassianOauth2ProviderConfig"`
// Input configuration for a custom OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-customoauth2providerconfig
//
CustomOauth2ProviderConfig interface{} `field:"optional" json:"customOauth2ProviderConfig" yaml:"customOauth2ProviderConfig"`
// Input configuration for a GitHub OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-githuboauth2providerconfig
//
GithubOauth2ProviderConfig interface{} `field:"optional" json:"githubOauth2ProviderConfig" yaml:"githubOauth2ProviderConfig"`
// Input configuration for a Google OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-googleoauth2providerconfig
//
GoogleOauth2ProviderConfig interface{} `field:"optional" json:"googleOauth2ProviderConfig" yaml:"googleOauth2ProviderConfig"`
// Input configuration for a supported non-custom OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-includedoauth2providerconfig
//
IncludedOauth2ProviderConfig interface{} `field:"optional" json:"includedOauth2ProviderConfig" yaml:"includedOauth2ProviderConfig"`
// Input configuration for a LinkedIn OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-linkedinoauth2providerconfig
//
LinkedinOauth2ProviderConfig interface{} `field:"optional" json:"linkedinOauth2ProviderConfig" yaml:"linkedinOauth2ProviderConfig"`
// Input configuration for a Microsoft OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-microsoftoauth2providerconfig
//
MicrosoftOauth2ProviderConfig interface{} `field:"optional" json:"microsoftOauth2ProviderConfig" yaml:"microsoftOauth2ProviderConfig"`
// Input configuration for a Salesforce OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-salesforceoauth2providerconfig
//
SalesforceOauth2ProviderConfig interface{} `field:"optional" json:"salesforceOauth2ProviderConfig" yaml:"salesforceOauth2ProviderConfig"`
// Input configuration for a Slack OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfiginput-slackoauth2providerconfig
//
SlackOauth2ProviderConfig interface{} `field:"optional" json:"slackOauth2ProviderConfig" yaml:"slackOauth2ProviderConfig"`
}
Input configuration for an OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
oauth2ProviderConfigInputProperty := &Oauth2ProviderConfigInputProperty{
AtlassianOauth2ProviderConfig: &AtlassianOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
CustomOauth2ProviderConfig: &CustomOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
OauthDiscovery: &Oauth2DiscoveryProperty{
AuthorizationServerMetadata: &Oauth2AuthorizationServerMetadataProperty{
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
Issuer: jsii.String("issuer"),
TokenEndpoint: jsii.String("tokenEndpoint"),
// the properties below are optional
ResponseTypes: []*string{
jsii.String("responseTypes"),
},
},
DiscoveryUrl: jsii.String("discoveryUrl"),
},
},
GithubOauth2ProviderConfig: &GithubOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
GoogleOauth2ProviderConfig: &GoogleOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
IncludedOauth2ProviderConfig: &IncludedOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
// the properties below are optional
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
Issuer: jsii.String("issuer"),
TokenEndpoint: jsii.String("tokenEndpoint"),
},
LinkedinOauth2ProviderConfig: &LinkedinOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
MicrosoftOauth2ProviderConfig: &MicrosoftOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
// the properties below are optional
TenantId: jsii.String("tenantId"),
},
SalesforceOauth2ProviderConfig: &SalesforceOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
SlackOauth2ProviderConfig: &SlackOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
},
}
type CfnOAuth2CredentialProvider_Oauth2ProviderConfigOutputProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_Oauth2ProviderConfigOutputProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-clientid
//
ClientId *string `field:"optional" json:"clientId" yaml:"clientId"`
// Discovery information for an OAuth2 provider.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput.html#cfn-bedrockagentcore-oauth2credentialprovider-oauth2providerconfigoutput-oauthdiscovery
//
OauthDiscovery interface{} `field:"optional" json:"oauthDiscovery" yaml:"oauthDiscovery"`
}
Output configuration for an OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
oauth2ProviderConfigOutputProperty := &Oauth2ProviderConfigOutputProperty{
ClientId: jsii.String("clientId"),
OauthDiscovery: &Oauth2DiscoveryProperty{
AuthorizationServerMetadata: &Oauth2AuthorizationServerMetadataProperty{
AuthorizationEndpoint: jsii.String("authorizationEndpoint"),
Issuer: jsii.String("issuer"),
TokenEndpoint: jsii.String("tokenEndpoint"),
// the properties below are optional
ResponseTypes: []*string{
jsii.String("responseTypes"),
},
},
DiscoveryUrl: jsii.String("discoveryUrl"),
},
}
type CfnOAuth2CredentialProvider_SalesforceOauth2ProviderConfigInputProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_SalesforceOauth2ProviderConfigInputProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-clientid
//
ClientId *string `field:"required" json:"clientId" yaml:"clientId"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-salesforceoauth2providerconfiginput-clientsecret
//
ClientSecret *string `field:"required" json:"clientSecret" yaml:"clientSecret"`
}
Input configuration for a Salesforce OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
salesforceOauth2ProviderConfigInputProperty := &SalesforceOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
}
type CfnOAuth2CredentialProvider_SlackOauth2ProviderConfigInputProperty ¶ added in v2.250.0
type CfnOAuth2CredentialProvider_SlackOauth2ProviderConfigInputProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-clientid
//
ClientId *string `field:"required" json:"clientId" yaml:"clientId"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput.html#cfn-bedrockagentcore-oauth2credentialprovider-slackoauth2providerconfiginput-clientsecret
//
ClientSecret *string `field:"required" json:"clientSecret" yaml:"clientSecret"`
}
Input configuration for a Slack OAuth2 provider.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
slackOauth2ProviderConfigInputProperty := &SlackOauth2ProviderConfigInputProperty{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
}
type CfnOnlineEvaluationConfig ¶ added in v2.242.0
type CfnOnlineEvaluationConfig interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IOnlineEvaluationConfigRef
awscdk.ITaggableV2
// The timestamp when the online evaluation configuration was created.
AttrCreatedAt() *string
// The Amazon Resource Name (ARN) of the online evaluation configuration.
AttrOnlineEvaluationConfigArn() *string
// The unique identifier of the online evaluation configuration.
AttrOnlineEvaluationConfigId() *string
// The configuration that specifies where evaluation results should be written.
AttrOutputConfig() awscdk.IResolvable
AttrStatus() *string
// The timestamp when the online evaluation configuration was last updated.
AttrUpdatedAt() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The configuration that specifies where to read agent traces for online evaluation.
DataSourceConfig() interface{}
SetDataSourceConfig(val interface{})
// The description of the online evaluation configuration.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The Amazon Resource Name (ARN) of the IAM role that grants permissions for evaluation.
EvaluationExecutionRoleArn() *string
SetEvaluationExecutionRoleArn(val *string)
// The list of evaluators to apply during online evaluation.
Evaluators() interface{}
SetEvaluators(val interface{})
ExecutionStatus() *string
SetExecutionStatus(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The name of the online evaluation configuration.
OnlineEvaluationConfigName() *string
SetOnlineEvaluationConfigName(val *string)
// A reference to a OnlineEvaluationConfig resource.
OnlineEvaluationConfigRef() *interfacesawsbedrockagentcore.OnlineEvaluationConfigReference
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The evaluation rule that defines sampling configuration, filtering criteria, and session detection settings.
Rule() interface{}
SetRule(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// A list of tags to assign to the online evaluation configuration.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource Type definition for AWS::BedrockAgentCore::OnlineEvaluationConfig - Creates an online evaluation configuration for continuous monitoring of agent performance.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnOnlineEvaluationConfig := awscdk.Aws_bedrockagentcore.NewCfnOnlineEvaluationConfig(this, jsii.String("MyCfnOnlineEvaluationConfig"), &CfnOnlineEvaluationConfigProps{
DataSourceConfig: &DataSourceConfigProperty{
CloudWatchLogs: &CloudWatchLogsInputConfigProperty{
LogGroupNames: []*string{
jsii.String("logGroupNames"),
},
ServiceNames: []*string{
jsii.String("serviceNames"),
},
},
},
EvaluationExecutionRoleArn: jsii.String("evaluationExecutionRoleArn"),
Evaluators: []interface{}{
&EvaluatorReferenceProperty{
EvaluatorId: jsii.String("evaluatorId"),
},
},
OnlineEvaluationConfigName: jsii.String("onlineEvaluationConfigName"),
Rule: &RuleProperty{
SamplingConfig: &SamplingConfigProperty{
SamplingPercentage: jsii.Number(123),
},
// the properties below are optional
Filters: []interface{}{
&FilterProperty{
Key: jsii.String("key"),
Operator: jsii.String("operator"),
Value: &FilterValueProperty{
BooleanValue: jsii.Boolean(false),
DoubleValue: jsii.Number(123),
StringValue: jsii.String("stringValue"),
},
},
},
SessionConfig: &SessionConfigProperty{
SessionTimeoutMinutes: jsii.Number(123),
},
},
// the properties below are optional
Description: jsii.String("description"),
ExecutionStatus: jsii.String("executionStatus"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnOnlineEvaluationConfig ¶ added in v2.242.0
func NewCfnOnlineEvaluationConfig(scope constructs.Construct, id *string, props *CfnOnlineEvaluationConfigProps) CfnOnlineEvaluationConfig
Create a new `AWS::BedrockAgentCore::OnlineEvaluationConfig`.
type CfnOnlineEvaluationConfigProps ¶ added in v2.242.0
type CfnOnlineEvaluationConfigProps struct {
// The configuration that specifies where to read agent traces for online evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-datasourceconfig
//
DataSourceConfig interface{} `field:"required" json:"dataSourceConfig" yaml:"dataSourceConfig"`
// The Amazon Resource Name (ARN) of the IAM role that grants permissions for evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-evaluationexecutionrolearn
//
EvaluationExecutionRoleArn *string `field:"required" json:"evaluationExecutionRoleArn" yaml:"evaluationExecutionRoleArn"`
// The list of evaluators to apply during online evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-evaluators
//
Evaluators interface{} `field:"required" json:"evaluators" yaml:"evaluators"`
// The name of the online evaluation configuration.
//
// Must be unique within your account.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-onlineevaluationconfigname
//
OnlineEvaluationConfigName *string `field:"required" json:"onlineEvaluationConfigName" yaml:"onlineEvaluationConfigName"`
// The evaluation rule that defines sampling configuration, filtering criteria, and session detection settings.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-rule
//
Rule interface{} `field:"required" json:"rule" yaml:"rule"`
// The description of the online evaluation configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-executionstatus
//
ExecutionStatus *string `field:"optional" json:"executionStatus" yaml:"executionStatus"`
// A list of tags to assign to the online evaluation configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-onlineevaluationconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnOnlineEvaluationConfig`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnOnlineEvaluationConfigProps := &CfnOnlineEvaluationConfigProps{
DataSourceConfig: &DataSourceConfigProperty{
CloudWatchLogs: &CloudWatchLogsInputConfigProperty{
LogGroupNames: []*string{
jsii.String("logGroupNames"),
},
ServiceNames: []*string{
jsii.String("serviceNames"),
},
},
},
EvaluationExecutionRoleArn: jsii.String("evaluationExecutionRoleArn"),
Evaluators: []interface{}{
&EvaluatorReferenceProperty{
EvaluatorId: jsii.String("evaluatorId"),
},
},
OnlineEvaluationConfigName: jsii.String("onlineEvaluationConfigName"),
Rule: &RuleProperty{
SamplingConfig: &SamplingConfigProperty{
SamplingPercentage: jsii.Number(123),
},
// the properties below are optional
Filters: []interface{}{
&FilterProperty{
Key: jsii.String("key"),
Operator: jsii.String("operator"),
Value: &FilterValueProperty{
BooleanValue: jsii.Boolean(false),
DoubleValue: jsii.Number(123),
StringValue: jsii.String("stringValue"),
},
},
},
SessionConfig: &SessionConfigProperty{
SessionTimeoutMinutes: jsii.Number(123),
},
},
// the properties below are optional
Description: jsii.String("description"),
ExecutionStatus: jsii.String("executionStatus"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnOnlineEvaluationConfig_CloudWatchLogsInputConfigProperty ¶ added in v2.242.0
type CfnOnlineEvaluationConfig_CloudWatchLogsInputConfigProperty struct {
// The list of CloudWatch log group names to monitor for agent traces.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-loggroupnames
//
LogGroupNames *[]*string `field:"required" json:"logGroupNames" yaml:"logGroupNames"`
// The list of service names to filter traces within the specified log groups.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchlogsinputconfig-servicenames
//
ServiceNames *[]*string `field:"required" json:"serviceNames" yaml:"serviceNames"`
}
The configuration for reading agent traces from CloudWatch logs.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cloudWatchLogsInputConfigProperty := &CloudWatchLogsInputConfigProperty{
LogGroupNames: []*string{
jsii.String("logGroupNames"),
},
ServiceNames: []*string{
jsii.String("serviceNames"),
},
}
type CfnOnlineEvaluationConfig_CloudWatchOutputConfigProperty ¶ added in v2.242.0
type CfnOnlineEvaluationConfig_CloudWatchOutputConfigProperty struct {
// The CloudWatch log group name for evaluation results.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-cloudwatchoutputconfig-loggroupname
//
LogGroupName *string `field:"optional" json:"logGroupName" yaml:"logGroupName"`
}
The CloudWatch configuration for writing evaluation results.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cloudWatchOutputConfigProperty := &CloudWatchOutputConfigProperty{
LogGroupName: jsii.String("logGroupName"),
}
type CfnOnlineEvaluationConfig_DataSourceConfigProperty ¶ added in v2.242.0
type CfnOnlineEvaluationConfig_DataSourceConfigProperty struct {
// The configuration for reading agent traces from CloudWatch logs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-datasourceconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-datasourceconfig-cloudwatchlogs
//
CloudWatchLogs interface{} `field:"required" json:"cloudWatchLogs" yaml:"cloudWatchLogs"`
}
The configuration that specifies where to read agent traces for online evaluation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
dataSourceConfigProperty := &DataSourceConfigProperty{
CloudWatchLogs: &CloudWatchLogsInputConfigProperty{
LogGroupNames: []*string{
jsii.String("logGroupNames"),
},
ServiceNames: []*string{
jsii.String("serviceNames"),
},
},
}
type CfnOnlineEvaluationConfig_EvaluatorReferenceProperty ¶ added in v2.242.0
type CfnOnlineEvaluationConfig_EvaluatorReferenceProperty struct {
// The unique identifier of the evaluator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-evaluatorreference.html#cfn-bedrockagentcore-onlineevaluationconfig-evaluatorreference-evaluatorid
//
EvaluatorId *string `field:"required" json:"evaluatorId" yaml:"evaluatorId"`
}
The reference to an evaluator used in online evaluation configurations.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
evaluatorReferenceProperty := &EvaluatorReferenceProperty{
EvaluatorId: jsii.String("evaluatorId"),
}
type CfnOnlineEvaluationConfig_FilterProperty ¶ added in v2.242.0
type CfnOnlineEvaluationConfig_FilterProperty struct {
// The key or field name to filter on within the agent trace data.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filter.html#cfn-bedrockagentcore-onlineevaluationconfig-filter-key
//
Key *string `field:"required" json:"key" yaml:"key"`
// The comparison operator to use for filtering.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filter.html#cfn-bedrockagentcore-onlineevaluationconfig-filter-operator
//
Operator *string `field:"required" json:"operator" yaml:"operator"`
// The value used in filter comparisons.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filter.html#cfn-bedrockagentcore-onlineevaluationconfig-filter-value
//
Value interface{} `field:"required" json:"value" yaml:"value"`
}
The filter that applies conditions to agent traces during online evaluation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
filterProperty := &FilterProperty{
Key: jsii.String("key"),
Operator: jsii.String("operator"),
Value: &FilterValueProperty{
BooleanValue: jsii.Boolean(false),
DoubleValue: jsii.Number(123),
StringValue: jsii.String("stringValue"),
},
}
type CfnOnlineEvaluationConfig_FilterValueProperty ¶ added in v2.242.0
type CfnOnlineEvaluationConfig_FilterValueProperty struct {
// The boolean value for true/false filtering conditions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue.html#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-booleanvalue
//
BooleanValue interface{} `field:"optional" json:"booleanValue" yaml:"booleanValue"`
// The numeric value for numerical filtering.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue.html#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-doublevalue
//
DoubleValue *float64 `field:"optional" json:"doubleValue" yaml:"doubleValue"`
// The string value for text-based filtering.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-filtervalue.html#cfn-bedrockagentcore-onlineevaluationconfig-filtervalue-stringvalue
//
StringValue *string `field:"optional" json:"stringValue" yaml:"stringValue"`
}
The value used in filter comparisons.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
filterValueProperty := &FilterValueProperty{
BooleanValue: jsii.Boolean(false),
DoubleValue: jsii.Number(123),
StringValue: jsii.String("stringValue"),
}
type CfnOnlineEvaluationConfig_OutputConfigProperty ¶ added in v2.242.0
type CfnOnlineEvaluationConfig_OutputConfigProperty struct {
// The CloudWatch configuration for writing evaluation results.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-outputconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-outputconfig-cloudwatchconfig
//
CloudWatchConfig interface{} `field:"optional" json:"cloudWatchConfig" yaml:"cloudWatchConfig"`
}
The configuration that specifies where evaluation results should be written.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
outputConfigProperty := &OutputConfigProperty{
CloudWatchConfig: &CloudWatchOutputConfigProperty{
LogGroupName: jsii.String("logGroupName"),
},
}
type CfnOnlineEvaluationConfig_RuleProperty ¶ added in v2.242.0
type CfnOnlineEvaluationConfig_RuleProperty struct {
// The configuration that controls what percentage of agent traces are sampled for evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-rule.html#cfn-bedrockagentcore-onlineevaluationconfig-rule-samplingconfig
//
SamplingConfig interface{} `field:"required" json:"samplingConfig" yaml:"samplingConfig"`
// The list of filters that determine which agent traces should be included in the evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-rule.html#cfn-bedrockagentcore-onlineevaluationconfig-rule-filters
//
Filters interface{} `field:"optional" json:"filters" yaml:"filters"`
// The configuration that defines how agent sessions are detected.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-rule.html#cfn-bedrockagentcore-onlineevaluationconfig-rule-sessionconfig
//
SessionConfig interface{} `field:"optional" json:"sessionConfig" yaml:"sessionConfig"`
}
The evaluation rule that defines sampling configuration, filtering criteria, and session detection settings.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
ruleProperty := &RuleProperty{
SamplingConfig: &SamplingConfigProperty{
SamplingPercentage: jsii.Number(123),
},
// the properties below are optional
Filters: []interface{}{
&FilterProperty{
Key: jsii.String("key"),
Operator: jsii.String("operator"),
Value: &FilterValueProperty{
BooleanValue: jsii.Boolean(false),
DoubleValue: jsii.Number(123),
StringValue: jsii.String("stringValue"),
},
},
},
SessionConfig: &SessionConfigProperty{
SessionTimeoutMinutes: jsii.Number(123),
},
}
type CfnOnlineEvaluationConfig_SamplingConfigProperty ¶ added in v2.242.0
type CfnOnlineEvaluationConfig_SamplingConfigProperty struct {
// The percentage of agent traces to sample for evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-samplingconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-samplingconfig-samplingpercentage
//
SamplingPercentage *float64 `field:"required" json:"samplingPercentage" yaml:"samplingPercentage"`
}
The configuration that controls what percentage of agent traces are sampled for evaluation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
samplingConfigProperty := &SamplingConfigProperty{
SamplingPercentage: jsii.Number(123),
}
type CfnOnlineEvaluationConfig_SessionConfigProperty ¶ added in v2.242.0
type CfnOnlineEvaluationConfig_SessionConfigProperty struct {
// The number of minutes of inactivity after which an agent session is considered complete.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-onlineevaluationconfig-sessionconfig.html#cfn-bedrockagentcore-onlineevaluationconfig-sessionconfig-sessiontimeoutminutes
//
SessionTimeoutMinutes *float64 `field:"required" json:"sessionTimeoutMinutes" yaml:"sessionTimeoutMinutes"`
}
The configuration that defines how agent sessions are detected.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sessionConfigProperty := &SessionConfigProperty{
SessionTimeoutMinutes: jsii.Number(123),
}
type CfnPolicy ¶ added in v2.242.0
type CfnPolicy interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IPolicyRef
// The timestamp when the policy was created.
AttrCreatedAt() *string
// The Amazon Resource Name (ARN) of the policy.
AttrPolicyArn() *string
// The unique identifier for the policy.
AttrPolicyId() *string
AttrStatus() *string
// Additional information about the policy status.
AttrStatusReasons() *[]*string
// The timestamp when the policy was last updated.
AttrUpdatedAt() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The definition structure for policies.
Definition() interface{}
SetDefinition(val interface{})
// A human-readable description of the policy's purpose and functionality.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The customer-assigned immutable name for the policy.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The identifier of the policy engine which contains this policy.
PolicyEngineId() *string
SetPolicyEngineId(val *string)
// A reference to a Policy resource.
PolicyRef() *interfacesawsbedrockagentcore.PolicyReference
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The validation mode for the policy.
ValidationMode() *string
SetValidationMode(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource Type definition for AWS::BedrockAgentCore::Policy.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnPolicy := awscdk.Aws_bedrockagentcore.NewCfnPolicy(this, jsii.String("MyCfnPolicy"), &CfnPolicyProps{
Definition: &PolicyDefinitionProperty{
Cedar: &CedarPolicyProperty{
Statement: jsii.String("statement"),
},
},
Name: jsii.String("name"),
PolicyEngineId: jsii.String("policyEngineId"),
// the properties below are optional
Description: jsii.String("description"),
ValidationMode: jsii.String("validationMode"),
})
func NewCfnPolicy ¶ added in v2.242.0
func NewCfnPolicy(scope constructs.Construct, id *string, props *CfnPolicyProps) CfnPolicy
Create a new `AWS::BedrockAgentCore::Policy`.
type CfnPolicyEngine ¶ added in v2.242.0
type CfnPolicyEngine interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IPolicyEngineRef
awscdk.ITaggableV2
// The timestamp when the policy engine was created.
AttrCreatedAt() *string
// The Amazon Resource Name (ARN) of the policy engine.
AttrPolicyEngineArn() *string
// The unique identifier for the policy engine.
AttrPolicyEngineId() *string
AttrStatus() *string
// Additional information about the policy engine status.
AttrStatusReasons() *[]*string
// The timestamp when the policy engine was last updated.
AttrUpdatedAt() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// A human-readable description of the policy engine's purpose and scope.
Description() *string
SetDescription(val *string)
// The ARN of the KMS key used to encrypt the policy engine data.
EncryptionKeyArn() *string
SetEncryptionKeyArn(val *string)
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The customer-assigned immutable name for the policy engine.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// A reference to a PolicyEngine resource.
PolicyEngineRef() *interfacesawsbedrockagentcore.PolicyEngineReference
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// A list of tags to assign to the policy engine.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource Type definition for AWS::BedrockAgentCore::PolicyEngine.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnPolicyEngine := awscdk.Aws_bedrockagentcore.NewCfnPolicyEngine(this, jsii.String("MyCfnPolicyEngine"), &CfnPolicyEngineProps{
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
EncryptionKeyArn: jsii.String("encryptionKeyArn"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnPolicyEngine ¶ added in v2.242.0
func NewCfnPolicyEngine(scope constructs.Construct, id *string, props *CfnPolicyEngineProps) CfnPolicyEngine
Create a new `AWS::BedrockAgentCore::PolicyEngine`.
type CfnPolicyEngineProps ¶ added in v2.242.0
type CfnPolicyEngineProps struct {
// The customer-assigned immutable name for the policy engine.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-policyengine.html#cfn-bedrockagentcore-policyengine-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// A human-readable description of the policy engine's purpose and scope.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-policyengine.html#cfn-bedrockagentcore-policyengine-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The ARN of the KMS key used to encrypt the policy engine data.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-policyengine.html#cfn-bedrockagentcore-policyengine-encryptionkeyarn
//
EncryptionKeyArn *string `field:"optional" json:"encryptionKeyArn" yaml:"encryptionKeyArn"`
// A list of tags to assign to the policy engine.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-policyengine.html#cfn-bedrockagentcore-policyengine-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnPolicyEngine`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnPolicyEngineProps := &CfnPolicyEngineProps{
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
EncryptionKeyArn: jsii.String("encryptionKeyArn"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnPolicyProps ¶ added in v2.242.0
type CfnPolicyProps struct {
// The definition structure for policies.
//
// Encapsulates different policy formats.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-policy.html#cfn-bedrockagentcore-policy-definition
//
Definition interface{} `field:"required" json:"definition" yaml:"definition"`
// The customer-assigned immutable name for the policy.
//
// Must be unique within the policy engine.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-policy.html#cfn-bedrockagentcore-policy-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The identifier of the policy engine which contains this policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-policy.html#cfn-bedrockagentcore-policy-policyengineid
//
PolicyEngineId *string `field:"required" json:"policyEngineId" yaml:"policyEngineId"`
// A human-readable description of the policy's purpose and functionality.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-policy.html#cfn-bedrockagentcore-policy-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The validation mode for the policy.
//
// Determines how Cedar analyzer validation results are handled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-policy.html#cfn-bedrockagentcore-policy-validationmode
//
ValidationMode *string `field:"optional" json:"validationMode" yaml:"validationMode"`
}
Properties for defining a `CfnPolicy`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnPolicyProps := &CfnPolicyProps{
Definition: &PolicyDefinitionProperty{
Cedar: &CedarPolicyProperty{
Statement: jsii.String("statement"),
},
},
Name: jsii.String("name"),
PolicyEngineId: jsii.String("policyEngineId"),
// the properties below are optional
Description: jsii.String("description"),
ValidationMode: jsii.String("validationMode"),
}
type CfnPolicy_CedarPolicyProperty ¶ added in v2.242.0
type CfnPolicy_CedarPolicyProperty struct {
// The Cedar policy statement that defines the authorization logic.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-policy-cedarpolicy.html#cfn-bedrockagentcore-policy-cedarpolicy-statement
//
Statement *string `field:"required" json:"statement" yaml:"statement"`
}
A Cedar policy statement within the AgentCore Policy system.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cedarPolicyProperty := &CedarPolicyProperty{
Statement: jsii.String("statement"),
}
type CfnPolicy_PolicyDefinitionProperty ¶ added in v2.242.0
type CfnPolicy_PolicyDefinitionProperty struct {
// A Cedar policy statement within the AgentCore Policy system.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-policy-policydefinition.html#cfn-bedrockagentcore-policy-policydefinition-cedar
//
Cedar interface{} `field:"required" json:"cedar" yaml:"cedar"`
}
The definition structure for policies.
Encapsulates different policy formats.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
policyDefinitionProperty := &PolicyDefinitionProperty{
Cedar: &CedarPolicyProperty{
Statement: jsii.String("statement"),
},
}
type CfnRuntime ¶
type CfnRuntime interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IRuntimeRef
awscdk.ITaggableV2
// The artifact of the agent.
AgentRuntimeArtifact() interface{}
SetAgentRuntimeArtifact(val interface{})
// The name of the AgentCore Runtime endpoint.
AgentRuntimeName() *string
SetAgentRuntimeName(val *string)
// The agent runtime ARN.
AttrAgentRuntimeArn() *string
// The ID for the agent runtime.
AttrAgentRuntimeId() *string
// The version for the agent runtime.
AttrAgentRuntimeVersion() *string
// The time at which the runtime was created.
AttrCreatedAt() *string
// The reason for failure if the agent is in a failed state.
AttrFailureReason() *string
// The time at which the runtime was last updated.
AttrLastUpdatedAt() *string
// The status for the agent runtime.
AttrStatus() *string
// Configuration for workload identity.
AttrWorkloadIdentityDetails() awscdk.IResolvable
// Represents inbound authorization configuration options used to authenticate incoming requests.
AuthorizerConfiguration() interface{}
SetAuthorizerConfiguration(val interface{})
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The agent runtime description.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The environment variables for the agent.
EnvironmentVariables() interface{}
SetEnvironmentVariables(val interface{})
// List of filesystem configurations.
FilesystemConfigurations() interface{}
SetFilesystemConfigurations(val interface{})
// Configuration for managing the lifecycle of runtime sessions and resources.
LifecycleConfiguration() interface{}
SetLifecycleConfiguration(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The network configuration.
NetworkConfiguration() interface{}
SetNetworkConfiguration(val interface{})
// The tree node.
Node() constructs.Node
// The protocol configuration for an agent runtime.
ProtocolConfiguration() *string
SetProtocolConfiguration(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// Configuration for HTTP request headers.
RequestHeaderConfiguration() interface{}
SetRequestHeaderConfiguration(val interface{})
// The Amazon Resource Name (ARN) for for the role.
RoleArn() *string
SetRoleArn(val *string)
// A reference to a Runtime resource.
RuntimeRef() *interfacesawsbedrockagentcore.RuntimeReference
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags for the agent.
Tags() *map[string]*string
SetTags(val *map[string]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock Agent.
AgentCore Runtime is a secure, serverless runtime purpose-built for deploying and scaling dynamic AI agents and tools using any open-source framework including LangGraph, CrewAI, and Strands Agents, any protocol, and any model.
For more information about using agent runtime in Amazon Bedrock AgentCore, see [Host agent or tools with Amazon Bedrock AgentCore Runtime](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/agents-tools-runtime.html) .
See the *Properties* section below for descriptions of both the required and optional properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnRuntime := awscdk.Aws_bedrockagentcore.NewCfnRuntime(this, jsii.String("MyCfnRuntime"), &CfnRuntimeProps{
AgentRuntimeArtifact: &AgentRuntimeArtifactProperty{
CodeConfiguration: &CodeConfigurationProperty{
Code: &CodeProperty{
S3: &S3LocationProperty{
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
},
EntryPoint: []*string{
jsii.String("entryPoint"),
},
Runtime: jsii.String("runtime"),
},
ContainerConfiguration: &ContainerConfigurationProperty{
ContainerUri: jsii.String("containerUri"),
},
},
AgentRuntimeName: jsii.String("agentRuntimeName"),
NetworkConfiguration: &NetworkConfigurationProperty{
NetworkMode: jsii.String("networkMode"),
// the properties below are optional
NetworkModeConfig: &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
},
},
RoleArn: jsii.String("roleArn"),
// the properties below are optional
AuthorizerConfiguration: &AuthorizerConfigurationProperty{
CustomJwtAuthorizer: &CustomJWTAuthorizerConfigurationProperty{
DiscoveryUrl: jsii.String("discoveryUrl"),
// the properties below are optional
AllowedAudience: []*string{
jsii.String("allowedAudience"),
},
AllowedClients: []*string{
jsii.String("allowedClients"),
},
AllowedScopes: []*string{
jsii.String("allowedScopes"),
},
CustomClaims: []interface{}{
&CustomClaimValidationTypeProperty{
AuthorizingClaimMatchValue: &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
},
InboundTokenClaimName: jsii.String("inboundTokenClaimName"),
InboundTokenClaimValueType: jsii.String("inboundTokenClaimValueType"),
},
},
},
},
Description: jsii.String("description"),
EnvironmentVariables: map[string]*string{
"environmentVariablesKey": jsii.String("environmentVariables"),
},
FilesystemConfigurations: []interface{}{
&FilesystemConfigurationProperty{
SessionStorage: &SessionStorageConfigurationProperty{
MountPath: jsii.String("mountPath"),
},
},
},
LifecycleConfiguration: &LifecycleConfigurationProperty{
IdleRuntimeSessionTimeout: jsii.Number(123),
MaxLifetime: jsii.Number(123),
},
ProtocolConfiguration: jsii.String("protocolConfiguration"),
RequestHeaderConfiguration: &RequestHeaderConfigurationProperty{
RequestHeaderAllowlist: []*string{
jsii.String("requestHeaderAllowlist"),
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnRuntime ¶
func NewCfnRuntime(scope constructs.Construct, id *string, props *CfnRuntimeProps) CfnRuntime
Create a new `AWS::BedrockAgentCore::Runtime`.
type CfnRuntimeEndpoint ¶
type CfnRuntimeEndpoint interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IRuntimeEndpointRef
awscdk.ITaggableV2
// The agent runtime ID.
AgentRuntimeId() *string
SetAgentRuntimeId(val *string)
// The version of the agent.
AgentRuntimeVersion() *string
SetAgentRuntimeVersion(val *string)
// The Amazon Resource Name (ARN) of the runtime agent.
AttrAgentRuntimeArn() *string
// The endpoint Amazon Resource Name (ARN).
AttrAgentRuntimeEndpointArn() *string
// The time at which the endpoint was created.
AttrCreatedAt() *string
// The reason for failure if the memory is in a failed state.
AttrFailureReason() *string
// The ID of the runtime endpoint.
AttrId() *string
// The time at which the endpoint was last updated.
AttrLastUpdatedAt() *string
// The live version for the runtime endpoint.
AttrLiveVersion() *string
// The status of the runtime endpoint.
AttrStatus() *string
// The target version.
AttrTargetVersion() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// Contains information about an agent runtime endpoint.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the AgentCore Runtime endpoint.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// A reference to a RuntimeEndpoint resource.
RuntimeEndpointRef() *interfacesawsbedrockagentcore.RuntimeEndpointReference
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags for the AgentCore Runtime endpoint.
Tags() *map[string]*string
SetTags(val *map[string]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
AgentCore Runtime is a secure, serverless runtime purpose-built for deploying and scaling dynamic AI agents and tools using any open-source framework including LangGraph, CrewAI, and Strands Agents, any protocol, and any model.
For more information about using agent runtime endpoints in Amazon Bedrock AgentCore, see [AgentCore Runtime versioning and endpoints](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/agent-runtime-versioning.html) .
See the *Properties* section below for descriptions of both the required and optional properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnRuntimeEndpoint := awscdk.Aws_bedrockagentcore.NewCfnRuntimeEndpoint(this, jsii.String("MyCfnRuntimeEndpoint"), &CfnRuntimeEndpointProps{
AgentRuntimeId: jsii.String("agentRuntimeId"),
Name: jsii.String("name"),
// the properties below are optional
AgentRuntimeVersion: jsii.String("agentRuntimeVersion"),
Description: jsii.String("description"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnRuntimeEndpoint ¶
func NewCfnRuntimeEndpoint(scope constructs.Construct, id *string, props *CfnRuntimeEndpointProps) CfnRuntimeEndpoint
Create a new `AWS::BedrockAgentCore::RuntimeEndpoint`.
type CfnRuntimeEndpointProps ¶
type CfnRuntimeEndpointProps struct {
// The agent runtime ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#cfn-bedrockagentcore-runtimeendpoint-agentruntimeid
//
AgentRuntimeId *string `field:"required" json:"agentRuntimeId" yaml:"agentRuntimeId"`
// The name of the AgentCore Runtime endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#cfn-bedrockagentcore-runtimeendpoint-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The version of the agent.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#cfn-bedrockagentcore-runtimeendpoint-agentruntimeversion
//
AgentRuntimeVersion *string `field:"optional" json:"agentRuntimeVersion" yaml:"agentRuntimeVersion"`
// Contains information about an agent runtime endpoint.
//
// An agent runtime is the execution environment for a Amazon Bedrock Agent.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#cfn-bedrockagentcore-runtimeendpoint-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The tags for the AgentCore Runtime endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtimeendpoint.html#cfn-bedrockagentcore-runtimeendpoint-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnRuntimeEndpoint`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnRuntimeEndpointProps := &CfnRuntimeEndpointProps{
AgentRuntimeId: jsii.String("agentRuntimeId"),
Name: jsii.String("name"),
// the properties below are optional
AgentRuntimeVersion: jsii.String("agentRuntimeVersion"),
Description: jsii.String("description"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnRuntimeProps ¶
type CfnRuntimeProps struct {
// The artifact of the agent.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-agentruntimeartifact
//
AgentRuntimeArtifact interface{} `field:"required" json:"agentRuntimeArtifact" yaml:"agentRuntimeArtifact"`
// The name of the AgentCore Runtime endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-agentruntimename
//
AgentRuntimeName *string `field:"required" json:"agentRuntimeName" yaml:"agentRuntimeName"`
// The network configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-networkconfiguration
//
NetworkConfiguration interface{} `field:"required" json:"networkConfiguration" yaml:"networkConfiguration"`
// The Amazon Resource Name (ARN) for for the role.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-rolearn
//
RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
// Represents inbound authorization configuration options used to authenticate incoming requests.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-authorizerconfiguration
//
AuthorizerConfiguration interface{} `field:"optional" json:"authorizerConfiguration" yaml:"authorizerConfiguration"`
// The agent runtime description.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The environment variables for the agent.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-environmentvariables
//
EnvironmentVariables interface{} `field:"optional" json:"environmentVariables" yaml:"environmentVariables"`
// List of filesystem configurations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-filesystemconfigurations
//
FilesystemConfigurations interface{} `field:"optional" json:"filesystemConfigurations" yaml:"filesystemConfigurations"`
// Configuration for managing the lifecycle of runtime sessions and resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-lifecycleconfiguration
//
LifecycleConfiguration interface{} `field:"optional" json:"lifecycleConfiguration" yaml:"lifecycleConfiguration"`
// The protocol configuration for an agent runtime.
//
// This structure defines how the agent runtime communicates with clients.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-protocolconfiguration
//
ProtocolConfiguration *string `field:"optional" json:"protocolConfiguration" yaml:"protocolConfiguration"`
// Configuration for HTTP request headers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-requestheaderconfiguration
//
RequestHeaderConfiguration interface{} `field:"optional" json:"requestHeaderConfiguration" yaml:"requestHeaderConfiguration"`
// The tags for the agent.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnRuntime`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnRuntimeProps := &CfnRuntimeProps{
AgentRuntimeArtifact: &AgentRuntimeArtifactProperty{
CodeConfiguration: &CodeConfigurationProperty{
Code: &CodeProperty{
S3: &S3LocationProperty{
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
},
EntryPoint: []*string{
jsii.String("entryPoint"),
},
Runtime: jsii.String("runtime"),
},
ContainerConfiguration: &ContainerConfigurationProperty{
ContainerUri: jsii.String("containerUri"),
},
},
AgentRuntimeName: jsii.String("agentRuntimeName"),
NetworkConfiguration: &NetworkConfigurationProperty{
NetworkMode: jsii.String("networkMode"),
// the properties below are optional
NetworkModeConfig: &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
},
},
RoleArn: jsii.String("roleArn"),
// the properties below are optional
AuthorizerConfiguration: &AuthorizerConfigurationProperty{
CustomJwtAuthorizer: &CustomJWTAuthorizerConfigurationProperty{
DiscoveryUrl: jsii.String("discoveryUrl"),
// the properties below are optional
AllowedAudience: []*string{
jsii.String("allowedAudience"),
},
AllowedClients: []*string{
jsii.String("allowedClients"),
},
AllowedScopes: []*string{
jsii.String("allowedScopes"),
},
CustomClaims: []interface{}{
&CustomClaimValidationTypeProperty{
AuthorizingClaimMatchValue: &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
},
InboundTokenClaimName: jsii.String("inboundTokenClaimName"),
InboundTokenClaimValueType: jsii.String("inboundTokenClaimValueType"),
},
},
},
},
Description: jsii.String("description"),
EnvironmentVariables: map[string]*string{
"environmentVariablesKey": jsii.String("environmentVariables"),
},
FilesystemConfigurations: []interface{}{
&FilesystemConfigurationProperty{
SessionStorage: &SessionStorageConfigurationProperty{
MountPath: jsii.String("mountPath"),
},
},
},
LifecycleConfiguration: &LifecycleConfigurationProperty{
IdleRuntimeSessionTimeout: jsii.Number(123),
MaxLifetime: jsii.Number(123),
},
ProtocolConfiguration: jsii.String("protocolConfiguration"),
RequestHeaderConfiguration: &RequestHeaderConfigurationProperty{
RequestHeaderAllowlist: []*string{
jsii.String("requestHeaderAllowlist"),
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnRuntime_AgentRuntimeArtifactProperty ¶
type CfnRuntime_AgentRuntimeArtifactProperty struct {
// Representation of a code configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-agentruntimeartifact.html#cfn-bedrockagentcore-runtime-agentruntimeartifact-codeconfiguration
//
CodeConfiguration interface{} `field:"optional" json:"codeConfiguration" yaml:"codeConfiguration"`
// Representation of a container configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-agentruntimeartifact.html#cfn-bedrockagentcore-runtime-agentruntimeartifact-containerconfiguration
//
ContainerConfiguration interface{} `field:"optional" json:"containerConfiguration" yaml:"containerConfiguration"`
}
The artifact of the agent.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
agentRuntimeArtifactProperty := &AgentRuntimeArtifactProperty{
CodeConfiguration: &CodeConfigurationProperty{
Code: &CodeProperty{
S3: &S3LocationProperty{
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
},
EntryPoint: []*string{
jsii.String("entryPoint"),
},
Runtime: jsii.String("runtime"),
},
ContainerConfiguration: &ContainerConfigurationProperty{
ContainerUri: jsii.String("containerUri"),
},
}
type CfnRuntime_AuthorizerConfigurationProperty ¶
type CfnRuntime_AuthorizerConfigurationProperty struct {
// Represents inbound authorization configuration options used to authenticate incoming requests.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-authorizerconfiguration.html#cfn-bedrockagentcore-runtime-authorizerconfiguration-customjwtauthorizer
//
CustomJwtAuthorizer interface{} `field:"optional" json:"customJwtAuthorizer" yaml:"customJwtAuthorizer"`
}
The authorizer configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
authorizerConfigurationProperty := &AuthorizerConfigurationProperty{
CustomJwtAuthorizer: &CustomJWTAuthorizerConfigurationProperty{
DiscoveryUrl: jsii.String("discoveryUrl"),
// the properties below are optional
AllowedAudience: []*string{
jsii.String("allowedAudience"),
},
AllowedClients: []*string{
jsii.String("allowedClients"),
},
AllowedScopes: []*string{
jsii.String("allowedScopes"),
},
CustomClaims: []interface{}{
&CustomClaimValidationTypeProperty{
AuthorizingClaimMatchValue: &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
},
InboundTokenClaimName: jsii.String("inboundTokenClaimName"),
InboundTokenClaimValueType: jsii.String("inboundTokenClaimValueType"),
},
},
},
}
type CfnRuntime_AuthorizingClaimMatchValueTypeProperty ¶ added in v2.237.0
type CfnRuntime_AuthorizingClaimMatchValueTypeProperty struct {
// The relationship between the claim field value and the value or values being matched.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-authorizingclaimmatchvaluetype.html#cfn-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-claimmatchoperator
//
ClaimMatchOperator *string `field:"required" json:"claimMatchOperator" yaml:"claimMatchOperator"`
// The value or values in the custom claim to match for.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-authorizingclaimmatchvaluetype.html#cfn-bedrockagentcore-runtime-authorizingclaimmatchvaluetype-claimmatchvalue
//
ClaimMatchValue interface{} `field:"required" json:"claimMatchValue" yaml:"claimMatchValue"`
}
The value or values in the custom claim to match and relationship of match.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
authorizingClaimMatchValueTypeProperty := &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
}
type CfnRuntime_ClaimMatchValueTypeProperty ¶ added in v2.237.0
type CfnRuntime_ClaimMatchValueTypeProperty struct {
// The string value to match for.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-claimmatchvaluetype.html#cfn-bedrockagentcore-runtime-claimmatchvaluetype-matchvaluestring
//
MatchValueString *string `field:"optional" json:"matchValueString" yaml:"matchValueString"`
// The list of strings to check for a match.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-claimmatchvaluetype.html#cfn-bedrockagentcore-runtime-claimmatchvaluetype-matchvaluestringlist
//
MatchValueStringList *[]*string `field:"optional" json:"matchValueStringList" yaml:"matchValueStringList"`
}
The value or values in the custom claim to match for.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
claimMatchValueTypeProperty := &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
}
type CfnRuntime_CodeConfigurationProperty ¶ added in v2.224.0
type CfnRuntime_CodeConfigurationProperty struct {
// Object represents source code from zip file.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-codeconfiguration.html#cfn-bedrockagentcore-runtime-codeconfiguration-code
//
Code interface{} `field:"required" json:"code" yaml:"code"`
// List of entry points.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-codeconfiguration.html#cfn-bedrockagentcore-runtime-codeconfiguration-entrypoint
//
EntryPoint *[]*string `field:"required" json:"entryPoint" yaml:"entryPoint"`
// Managed runtime types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-codeconfiguration.html#cfn-bedrockagentcore-runtime-codeconfiguration-runtime
//
Runtime *string `field:"required" json:"runtime" yaml:"runtime"`
}
Representation of a code configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
codeConfigurationProperty := &CodeConfigurationProperty{
Code: &CodeProperty{
S3: &S3LocationProperty{
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
},
EntryPoint: []*string{
jsii.String("entryPoint"),
},
Runtime: jsii.String("runtime"),
}
type CfnRuntime_CodeProperty ¶ added in v2.224.0
type CfnRuntime_CodeProperty struct {
// S3 Location Configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-code.html#cfn-bedrockagentcore-runtime-code-s3
//
S3 interface{} `field:"optional" json:"s3" yaml:"s3"`
}
Object represents source code from zip file.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
codeProperty := &CodeProperty{
S3: &S3LocationProperty{
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
}
type CfnRuntime_ContainerConfigurationProperty ¶
type CfnRuntime_ContainerConfigurationProperty struct {
// The container Uri.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-containerconfiguration.html#cfn-bedrockagentcore-runtime-containerconfiguration-containeruri
//
ContainerUri *string `field:"required" json:"containerUri" yaml:"containerUri"`
}
The container configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
containerConfigurationProperty := &ContainerConfigurationProperty{
ContainerUri: jsii.String("containerUri"),
}
type CfnRuntime_CustomClaimValidationTypeProperty ¶ added in v2.237.0
type CfnRuntime_CustomClaimValidationTypeProperty struct {
// The value or values in the custom claim to match and relationship of match.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customclaimvalidationtype.html#cfn-bedrockagentcore-runtime-customclaimvalidationtype-authorizingclaimmatchvalue
//
AuthorizingClaimMatchValue interface{} `field:"required" json:"authorizingClaimMatchValue" yaml:"authorizingClaimMatchValue"`
// The name of the custom claim to validate.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customclaimvalidationtype.html#cfn-bedrockagentcore-runtime-customclaimvalidationtype-inboundtokenclaimname
//
InboundTokenClaimName *string `field:"required" json:"inboundTokenClaimName" yaml:"inboundTokenClaimName"`
// Token claim data type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customclaimvalidationtype.html#cfn-bedrockagentcore-runtime-customclaimvalidationtype-inboundtokenclaimvaluetype
//
InboundTokenClaimValueType *string `field:"required" json:"inboundTokenClaimValueType" yaml:"inboundTokenClaimValueType"`
}
Required custom claim.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
customClaimValidationTypeProperty := &CustomClaimValidationTypeProperty{
AuthorizingClaimMatchValue: &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
},
InboundTokenClaimName: jsii.String("inboundTokenClaimName"),
InboundTokenClaimValueType: jsii.String("inboundTokenClaimValueType"),
}
type CfnRuntime_CustomJWTAuthorizerConfigurationProperty ¶
type CfnRuntime_CustomJWTAuthorizerConfigurationProperty struct {
// The configuration authorization.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-discoveryurl
//
DiscoveryUrl *string `field:"required" json:"discoveryUrl" yaml:"discoveryUrl"`
// Represents inbound authorization configuration options used to authenticate incoming requests.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedaudience
//
AllowedAudience *[]*string `field:"optional" json:"allowedAudience" yaml:"allowedAudience"`
// Represents individual client IDs that are validated in the incoming JWT token validation process.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedclients
//
AllowedClients *[]*string `field:"optional" json:"allowedClients" yaml:"allowedClients"`
// List of allowed scopes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedscopes
//
AllowedScopes *[]*string `field:"optional" json:"allowedScopes" yaml:"allowedScopes"`
// List of required custom claims.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-customclaims
//
CustomClaims interface{} `field:"optional" json:"customClaims" yaml:"customClaims"`
}
Configuration for custom JWT authorizer.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
customJWTAuthorizerConfigurationProperty := &CustomJWTAuthorizerConfigurationProperty{
DiscoveryUrl: jsii.String("discoveryUrl"),
// the properties below are optional
AllowedAudience: []*string{
jsii.String("allowedAudience"),
},
AllowedClients: []*string{
jsii.String("allowedClients"),
},
AllowedScopes: []*string{
jsii.String("allowedScopes"),
},
CustomClaims: []interface{}{
&CustomClaimValidationTypeProperty{
AuthorizingClaimMatchValue: &AuthorizingClaimMatchValueTypeProperty{
ClaimMatchOperator: jsii.String("claimMatchOperator"),
ClaimMatchValue: &ClaimMatchValueTypeProperty{
MatchValueString: jsii.String("matchValueString"),
MatchValueStringList: []*string{
jsii.String("matchValueStringList"),
},
},
},
InboundTokenClaimName: jsii.String("inboundTokenClaimName"),
InboundTokenClaimValueType: jsii.String("inboundTokenClaimValueType"),
},
},
}
type CfnRuntime_FilesystemConfigurationProperty ¶ added in v2.250.0
type CfnRuntime_FilesystemConfigurationProperty struct {
// Configuration for session storage.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-filesystemconfiguration.html#cfn-bedrockagentcore-runtime-filesystemconfiguration-sessionstorage
//
SessionStorage interface{} `field:"optional" json:"sessionStorage" yaml:"sessionStorage"`
}
Filesystem configuration for the runtime.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
filesystemConfigurationProperty := &FilesystemConfigurationProperty{
SessionStorage: &SessionStorageConfigurationProperty{
MountPath: jsii.String("mountPath"),
},
}
type CfnRuntime_LifecycleConfigurationProperty ¶ added in v2.224.0
type CfnRuntime_LifecycleConfigurationProperty struct {
// Timeout in seconds for idle runtime sessions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-lifecycleconfiguration.html#cfn-bedrockagentcore-runtime-lifecycleconfiguration-idleruntimesessiontimeout
//
IdleRuntimeSessionTimeout *float64 `field:"optional" json:"idleRuntimeSessionTimeout" yaml:"idleRuntimeSessionTimeout"`
// Maximum lifetime in seconds for runtime sessions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-lifecycleconfiguration.html#cfn-bedrockagentcore-runtime-lifecycleconfiguration-maxlifetime
//
MaxLifetime *float64 `field:"optional" json:"maxLifetime" yaml:"maxLifetime"`
}
Configuration for managing the lifecycle of runtime sessions and resources.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
lifecycleConfigurationProperty := &LifecycleConfigurationProperty{
IdleRuntimeSessionTimeout: jsii.Number(123),
MaxLifetime: jsii.Number(123),
}
type CfnRuntime_NetworkConfigurationProperty ¶
type CfnRuntime_NetworkConfigurationProperty struct {
// The network mode.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-networkconfiguration.html#cfn-bedrockagentcore-runtime-networkconfiguration-networkmode
//
NetworkMode *string `field:"required" json:"networkMode" yaml:"networkMode"`
// Network mode configuration for VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-networkconfiguration.html#cfn-bedrockagentcore-runtime-networkconfiguration-networkmodeconfig
//
NetworkModeConfig interface{} `field:"optional" json:"networkModeConfig" yaml:"networkModeConfig"`
}
The network configuration for the agent.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
networkConfigurationProperty := &NetworkConfigurationProperty{
NetworkMode: jsii.String("networkMode"),
// the properties below are optional
NetworkModeConfig: &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
},
}
type CfnRuntime_RequestHeaderConfigurationProperty ¶ added in v2.224.0
type CfnRuntime_RequestHeaderConfigurationProperty struct {
// List of allowed HTTP headers for agent runtime requests.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-requestheaderconfiguration.html#cfn-bedrockagentcore-runtime-requestheaderconfiguration-requestheaderallowlist
//
RequestHeaderAllowlist *[]*string `field:"optional" json:"requestHeaderAllowlist" yaml:"requestHeaderAllowlist"`
}
Configuration for HTTP request headers.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
requestHeaderConfigurationProperty := &RequestHeaderConfigurationProperty{
RequestHeaderAllowlist: []*string{
jsii.String("requestHeaderAllowlist"),
},
}
type CfnRuntime_S3LocationProperty ¶ added in v2.224.0
type CfnRuntime_S3LocationProperty struct {
// S3 bucket name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-s3location.html#cfn-bedrockagentcore-runtime-s3location-bucket
//
Bucket *string `field:"required" json:"bucket" yaml:"bucket"`
// S3 object key prefix.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-s3location.html#cfn-bedrockagentcore-runtime-s3location-prefix
//
Prefix *string `field:"required" json:"prefix" yaml:"prefix"`
// S3 object version ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-s3location.html#cfn-bedrockagentcore-runtime-s3location-versionid
//
VersionId *string `field:"optional" json:"versionId" yaml:"versionId"`
}
S3 Location Configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
s3LocationProperty := &S3LocationProperty{
Bucket: jsii.String("bucket"),
Prefix: jsii.String("prefix"),
// the properties below are optional
VersionId: jsii.String("versionId"),
}
type CfnRuntime_SessionStorageConfigurationProperty ¶ added in v2.250.0
type CfnRuntime_SessionStorageConfigurationProperty struct {
// Mount path for session storage.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-sessionstorageconfiguration.html#cfn-bedrockagentcore-runtime-sessionstorageconfiguration-mountpath
//
MountPath *string `field:"required" json:"mountPath" yaml:"mountPath"`
}
Configuration for session storage.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sessionStorageConfigurationProperty := &SessionStorageConfigurationProperty{
MountPath: jsii.String("mountPath"),
}
type CfnRuntime_VpcConfigProperty ¶ added in v2.220.0
type CfnRuntime_VpcConfigProperty struct {
// Security groups for VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-vpcconfig.html#cfn-bedrockagentcore-runtime-vpcconfig-securitygroups
//
SecurityGroups *[]*string `field:"required" json:"securityGroups" yaml:"securityGroups"`
// Subnets for VPC.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-vpcconfig.html#cfn-bedrockagentcore-runtime-vpcconfig-subnets
//
Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"`
}
Network mode configuration for VPC.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vpcConfigProperty := &VpcConfigProperty{
SecurityGroups: []*string{
jsii.String("securityGroups"),
},
Subnets: []*string{
jsii.String("subnets"),
},
}
type CfnRuntime_WorkloadIdentityDetailsProperty ¶
type CfnRuntime_WorkloadIdentityDetailsProperty struct {
// The Amazon Resource Name (ARN) for the workload identity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-workloadidentitydetails.html#cfn-bedrockagentcore-runtime-workloadidentitydetails-workloadidentityarn
//
WorkloadIdentityArn *string `field:"required" json:"workloadIdentityArn" yaml:"workloadIdentityArn"`
}
The workload identity details for the agent.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
workloadIdentityDetailsProperty := &WorkloadIdentityDetailsProperty{
WorkloadIdentityArn: jsii.String("workloadIdentityArn"),
}
type CfnWorkloadIdentity ¶ added in v2.224.0
type CfnWorkloadIdentity interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsbedrockagentcore.IWorkloadIdentityRef
awscdk.ITaggableV2
// The list of allowed OAuth2 return URLs for resources associated with this workload identity.
AllowedResourceOauth2ReturnUrls() *[]*string
SetAllowedResourceOauth2ReturnUrls(val *[]*string)
// The timestamp when the workload identity was created.
AttrCreatedTime() awscdk.IResolvable
// The timestamp when the workload identity was last updated.
AttrLastUpdatedTime() awscdk.IResolvable
// The Amazon Resource Name (ARN) of the workload identity.
AttrWorkloadIdentityArn() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the workload identity.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags for the workload identity.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// A reference to a WorkloadIdentity resource.
WorkloadIdentityRef() *interfacesawsbedrockagentcore.WorkloadIdentityReference
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Creates a workload identity for Amazon Bedrock AgentCore.
A workload identity provides OAuth2-based authentication for resources associated with agent runtimes.
For more information about using workload identities in Amazon Bedrock AgentCore, see [Managing workload identities](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/workload-identity.html) .
See the *Properties* section below for descriptions of both the required and optional properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnWorkloadIdentity := awscdk.Aws_bedrockagentcore.NewCfnWorkloadIdentity(this, jsii.String("MyCfnWorkloadIdentity"), &CfnWorkloadIdentityProps{
Name: jsii.String("name"),
// the properties below are optional
AllowedResourceOauth2ReturnUrls: []*string{
jsii.String("allowedResourceOauth2ReturnUrls"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnWorkloadIdentity ¶ added in v2.224.0
func NewCfnWorkloadIdentity(scope constructs.Construct, id *string, props *CfnWorkloadIdentityProps) CfnWorkloadIdentity
Create a new `AWS::BedrockAgentCore::WorkloadIdentity`.
type CfnWorkloadIdentityProps ¶ added in v2.224.0
type CfnWorkloadIdentityProps struct {
// The name of the workload identity.
//
// The name must be unique within your account.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-workloadidentity.html#cfn-bedrockagentcore-workloadidentity-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The list of allowed OAuth2 return URLs for resources associated with this workload identity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-workloadidentity.html#cfn-bedrockagentcore-workloadidentity-allowedresourceoauth2returnurls
//
AllowedResourceOauth2ReturnUrls *[]*string `field:"optional" json:"allowedResourceOauth2ReturnUrls" yaml:"allowedResourceOauth2ReturnUrls"`
// The tags for the workload identity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-workloadidentity.html#cfn-bedrockagentcore-workloadidentity-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnWorkloadIdentity`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnWorkloadIdentityProps := &CfnWorkloadIdentityProps{
Name: jsii.String("name"),
// the properties below are optional
AllowedResourceOauth2ReturnUrls: []*string{
jsii.String("allowedResourceOauth2ReturnUrls"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Source Files
¶
- CfnApiKeyCredentialProvider.go
- CfnApiKeyCredentialProviderProps.go
- CfnApiKeyCredentialProvider_ApiKeySecretArnProperty.go
- CfnApiKeyCredentialProvider__checks.go
- CfnBrowserCustom.go
- CfnBrowserCustomProps.go
- CfnBrowserCustom_BrowserNetworkConfigurationProperty.go
- CfnBrowserCustom_BrowserSigningProperty.go
- CfnBrowserCustom_RecordingConfigProperty.go
- CfnBrowserCustom_S3LocationProperty.go
- CfnBrowserCustom_VpcConfigProperty.go
- CfnBrowserCustom__checks.go
- CfnBrowserProfile.go
- CfnBrowserProfileProps.go
- CfnBrowserProfile__checks.go
- CfnCodeInterpreterCustom.go
- CfnCodeInterpreterCustomProps.go
- CfnCodeInterpreterCustom_CodeInterpreterNetworkConfigurationProperty.go
- CfnCodeInterpreterCustom_VpcConfigProperty.go
- CfnCodeInterpreterCustom__checks.go
- CfnEvaluator.go
- CfnEvaluatorProps.go
- CfnEvaluator_BedrockEvaluatorModelConfigProperty.go
- CfnEvaluator_CategoricalScaleDefinitionProperty.go
- CfnEvaluator_CodeBasedEvaluatorConfigProperty.go
- CfnEvaluator_EvaluatorConfigProperty.go
- CfnEvaluator_EvaluatorModelConfigProperty.go
- CfnEvaluator_InferenceConfigurationProperty.go
- CfnEvaluator_LambdaEvaluatorConfigProperty.go
- CfnEvaluator_LlmAsAJudgeEvaluatorConfigProperty.go
- CfnEvaluator_NumericalScaleDefinitionProperty.go
- CfnEvaluator_RatingScaleProperty.go
- CfnEvaluator__checks.go
- CfnGateway.go
- CfnGatewayProps.go
- CfnGatewayTarget.go
- CfnGatewayTargetProps.go
- CfnGatewayTarget_ApiGatewayTargetConfigurationProperty.go
- CfnGatewayTarget_ApiGatewayToolConfigurationProperty.go
- CfnGatewayTarget_ApiGatewayToolFilterProperty.go
- CfnGatewayTarget_ApiGatewayToolOverrideProperty.go
- CfnGatewayTarget_ApiKeyCredentialProviderProperty.go
- CfnGatewayTarget_ApiSchemaConfigurationProperty.go
- CfnGatewayTarget_CredentialProviderConfigurationProperty.go
- CfnGatewayTarget_CredentialProviderProperty.go
- CfnGatewayTarget_IamCredentialProviderProperty.go
- CfnGatewayTarget_McpLambdaTargetConfigurationProperty.go
- CfnGatewayTarget_McpServerTargetConfigurationProperty.go
- CfnGatewayTarget_McpTargetConfigurationProperty.go
- CfnGatewayTarget_MetadataConfigurationProperty.go
- CfnGatewayTarget_OAuthCredentialProviderProperty.go
- CfnGatewayTarget_S3ConfigurationProperty.go
- CfnGatewayTarget_SchemaDefinitionProperty.go
- CfnGatewayTarget_TargetConfigurationProperty.go
- CfnGatewayTarget_ToolDefinitionProperty.go
- CfnGatewayTarget_ToolSchemaProperty.go
- CfnGatewayTarget__checks.go
- CfnGateway_AuthorizerConfigurationProperty.go
- CfnGateway_AuthorizingClaimMatchValueTypeProperty.go
- CfnGateway_ClaimMatchValueTypeProperty.go
- CfnGateway_CustomClaimValidationTypeProperty.go
- CfnGateway_CustomJWTAuthorizerConfigurationProperty.go
- CfnGateway_GatewayInterceptorConfigurationProperty.go
- CfnGateway_GatewayPolicyEngineConfigurationProperty.go
- CfnGateway_GatewayProtocolConfigurationProperty.go
- CfnGateway_InterceptorConfigurationProperty.go
- CfnGateway_InterceptorInputConfigurationProperty.go
- CfnGateway_LambdaInterceptorConfigurationProperty.go
- CfnGateway_MCPGatewayConfigurationProperty.go
- CfnGateway_WorkloadIdentityDetailsProperty.go
- CfnGateway__checks.go
- CfnMemory.go
- CfnMemoryProps.go
- CfnMemory_ContentConfigurationProperty.go
- CfnMemory_CustomConfigurationInputProperty.go
- CfnMemory_CustomMemoryStrategyProperty.go
- CfnMemory_EpisodicMemoryStrategyProperty.go
- CfnMemory_EpisodicOverrideConsolidationConfigurationInputProperty.go
- CfnMemory_EpisodicOverrideExtractionConfigurationInputProperty.go
- CfnMemory_EpisodicOverrideProperty.go
- CfnMemory_EpisodicOverrideReflectionConfigurationInputProperty.go
- CfnMemory_EpisodicReflectionConfigurationInputProperty.go
- CfnMemory_InvocationConfigurationInputProperty.go
- CfnMemory_KinesisResourceProperty.go
- CfnMemory_MemoryStrategyProperty.go
- CfnMemory_MessageBasedTriggerInputProperty.go
- CfnMemory_SelfManagedConfigurationProperty.go
- CfnMemory_SemanticMemoryStrategyProperty.go
- CfnMemory_SemanticOverrideConsolidationConfigurationInputProperty.go
- CfnMemory_SemanticOverrideExtractionConfigurationInputProperty.go
- CfnMemory_SemanticOverrideProperty.go
- CfnMemory_StreamDeliveryResourceProperty.go
- CfnMemory_StreamDeliveryResourcesProperty.go
- CfnMemory_SummaryMemoryStrategyProperty.go
- CfnMemory_SummaryOverrideConsolidationConfigurationInputProperty.go
- CfnMemory_SummaryOverrideProperty.go
- CfnMemory_TimeBasedTriggerInputProperty.go
- CfnMemory_TokenBasedTriggerInputProperty.go
- CfnMemory_TriggerConditionInputProperty.go
- CfnMemory_UserPreferenceMemoryStrategyProperty.go
- CfnMemory_UserPreferenceOverrideConsolidationConfigurationInputProperty.go
- CfnMemory_UserPreferenceOverrideExtractionConfigurationInputProperty.go
- CfnMemory_UserPreferenceOverrideProperty.go
- CfnMemory__checks.go
- CfnOAuth2CredentialProvider.go
- CfnOAuth2CredentialProviderProps.go
- CfnOAuth2CredentialProvider_AtlassianOauth2ProviderConfigInputProperty.go
- CfnOAuth2CredentialProvider_ClientSecretArnProperty.go
- CfnOAuth2CredentialProvider_CustomOauth2ProviderConfigInputProperty.go
- CfnOAuth2CredentialProvider_GithubOauth2ProviderConfigInputProperty.go
- CfnOAuth2CredentialProvider_GoogleOauth2ProviderConfigInputProperty.go
- CfnOAuth2CredentialProvider_IncludedOauth2ProviderConfigInputProperty.go
- CfnOAuth2CredentialProvider_LinkedinOauth2ProviderConfigInputProperty.go
- CfnOAuth2CredentialProvider_MicrosoftOauth2ProviderConfigInputProperty.go
- CfnOAuth2CredentialProvider_Oauth2AuthorizationServerMetadataProperty.go
- CfnOAuth2CredentialProvider_Oauth2DiscoveryProperty.go
- CfnOAuth2CredentialProvider_Oauth2ProviderConfigInputProperty.go
- CfnOAuth2CredentialProvider_Oauth2ProviderConfigOutputProperty.go
- CfnOAuth2CredentialProvider_SalesforceOauth2ProviderConfigInputProperty.go
- CfnOAuth2CredentialProvider_SlackOauth2ProviderConfigInputProperty.go
- CfnOAuth2CredentialProvider__checks.go
- CfnOnlineEvaluationConfig.go
- CfnOnlineEvaluationConfigProps.go
- CfnOnlineEvaluationConfig_CloudWatchLogsInputConfigProperty.go
- CfnOnlineEvaluationConfig_CloudWatchOutputConfigProperty.go
- CfnOnlineEvaluationConfig_DataSourceConfigProperty.go
- CfnOnlineEvaluationConfig_EvaluatorReferenceProperty.go
- CfnOnlineEvaluationConfig_FilterProperty.go
- CfnOnlineEvaluationConfig_FilterValueProperty.go
- CfnOnlineEvaluationConfig_OutputConfigProperty.go
- CfnOnlineEvaluationConfig_RuleProperty.go
- CfnOnlineEvaluationConfig_SamplingConfigProperty.go
- CfnOnlineEvaluationConfig_SessionConfigProperty.go
- CfnOnlineEvaluationConfig__checks.go
- CfnPolicy.go
- CfnPolicyEngine.go
- CfnPolicyEngineProps.go
- CfnPolicyEngine__checks.go
- CfnPolicyProps.go
- CfnPolicy_CedarPolicyProperty.go
- CfnPolicy_PolicyDefinitionProperty.go
- CfnPolicy__checks.go
- CfnRuntime.go
- CfnRuntimeEndpoint.go
- CfnRuntimeEndpointProps.go
- CfnRuntimeEndpoint__checks.go
- CfnRuntimeProps.go
- CfnRuntime_AgentRuntimeArtifactProperty.go
- CfnRuntime_AuthorizerConfigurationProperty.go
- CfnRuntime_AuthorizingClaimMatchValueTypeProperty.go
- CfnRuntime_ClaimMatchValueTypeProperty.go
- CfnRuntime_CodeConfigurationProperty.go
- CfnRuntime_CodeProperty.go
- CfnRuntime_ContainerConfigurationProperty.go
- CfnRuntime_CustomClaimValidationTypeProperty.go
- CfnRuntime_CustomJWTAuthorizerConfigurationProperty.go
- CfnRuntime_FilesystemConfigurationProperty.go
- CfnRuntime_LifecycleConfigurationProperty.go
- CfnRuntime_NetworkConfigurationProperty.go
- CfnRuntime_RequestHeaderConfigurationProperty.go
- CfnRuntime_S3LocationProperty.go
- CfnRuntime_SessionStorageConfigurationProperty.go
- CfnRuntime_VpcConfigProperty.go
- CfnRuntime_WorkloadIdentityDetailsProperty.go
- CfnRuntime__checks.go
- CfnWorkloadIdentity.go
- CfnWorkloadIdentityProps.go
- CfnWorkloadIdentity__checks.go
- main.go