Documentation ¶
Index ¶
- func CfnAIAgentVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAIAgentVersion_IsCfnElement(x interface{}) *bool
- func CfnAIAgentVersion_IsCfnResource(x interface{}) *bool
- func CfnAIAgentVersion_IsConstruct(x interface{}) *bool
- func CfnAIAgent_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAIAgent_IsCfnElement(x interface{}) *bool
- func CfnAIAgent_IsCfnResource(x interface{}) *bool
- func CfnAIAgent_IsConstruct(x interface{}) *bool
- func CfnAIGuardrailVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAIGuardrailVersion_IsCfnElement(x interface{}) *bool
- func CfnAIGuardrailVersion_IsCfnResource(x interface{}) *bool
- func CfnAIGuardrailVersion_IsConstruct(x interface{}) *bool
- func CfnAIGuardrail_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAIGuardrail_IsCfnElement(x interface{}) *bool
- func CfnAIGuardrail_IsCfnResource(x interface{}) *bool
- func CfnAIGuardrail_IsConstruct(x interface{}) *bool
- func CfnAIPromptVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAIPromptVersion_IsCfnElement(x interface{}) *bool
- func CfnAIPromptVersion_IsCfnResource(x interface{}) *bool
- func CfnAIPromptVersion_IsConstruct(x interface{}) *bool
- func CfnAIPrompt_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAIPrompt_IsCfnElement(x interface{}) *bool
- func CfnAIPrompt_IsCfnResource(x interface{}) *bool
- func CfnAIPrompt_IsConstruct(x interface{}) *bool
- func CfnAssistantAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAssistantAssociation_IsCfnElement(x interface{}) *bool
- func CfnAssistantAssociation_IsCfnResource(x interface{}) *bool
- func CfnAssistantAssociation_IsConstruct(x interface{}) *bool
- func CfnAssistant_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAssistant_IsCfnElement(x interface{}) *bool
- func CfnAssistant_IsCfnResource(x interface{}) *bool
- func CfnAssistant_IsConstruct(x interface{}) *bool
- func CfnKnowledgeBase_CFN_RESOURCE_TYPE_NAME() *string
- func CfnKnowledgeBase_IsCfnElement(x interface{}) *bool
- func CfnKnowledgeBase_IsCfnResource(x interface{}) *bool
- func CfnKnowledgeBase_IsConstruct(x interface{}) *bool
- func CfnMessageTemplateVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMessageTemplateVersion_IsCfnElement(x interface{}) *bool
- func CfnMessageTemplateVersion_IsCfnResource(x interface{}) *bool
- func CfnMessageTemplateVersion_IsConstruct(x interface{}) *bool
- func CfnMessageTemplate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMessageTemplate_IsCfnElement(x interface{}) *bool
- func CfnMessageTemplate_IsCfnResource(x interface{}) *bool
- func CfnMessageTemplate_IsConstruct(x interface{}) *bool
- func NewCfnAIAgentVersion_Override(c CfnAIAgentVersion, scope constructs.Construct, id *string, ...)
- func NewCfnAIAgent_Override(c CfnAIAgent, scope constructs.Construct, id *string, props *CfnAIAgentProps)
- func NewCfnAIGuardrailVersion_Override(c CfnAIGuardrailVersion, scope constructs.Construct, id *string, ...)
- func NewCfnAIGuardrail_Override(c CfnAIGuardrail, scope constructs.Construct, id *string, ...)
- func NewCfnAIPromptVersion_Override(c CfnAIPromptVersion, scope constructs.Construct, id *string, ...)
- func NewCfnAIPrompt_Override(c CfnAIPrompt, scope constructs.Construct, id *string, props *CfnAIPromptProps)
- func NewCfnAssistantAssociation_Override(c CfnAssistantAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnAssistant_Override(c CfnAssistant, scope constructs.Construct, id *string, ...)
- func NewCfnKnowledgeBase_Override(c CfnKnowledgeBase, scope constructs.Construct, id *string, ...)
- func NewCfnMessageTemplateVersion_Override(c CfnMessageTemplateVersion, scope constructs.Construct, id *string, ...)
- func NewCfnMessageTemplate_Override(c CfnMessageTemplate, scope constructs.Construct, id *string, ...)
- type CfnAIAgent
- type CfnAIAgentProps
- type CfnAIAgentVersion
- type CfnAIAgentVersionProps
- type CfnAIAgent_AIAgentConfigurationProperty
- type CfnAIAgent_AnswerRecommendationAIAgentConfigurationProperty
- type CfnAIAgent_AssociationConfigurationDataProperty
- type CfnAIAgent_AssociationConfigurationProperty
- type CfnAIAgent_KnowledgeBaseAssociationConfigurationDataProperty
- type CfnAIAgent_ManualSearchAIAgentConfigurationProperty
- type CfnAIAgent_OrConditionProperty
- type CfnAIAgent_SelfServiceAIAgentConfigurationProperty
- type CfnAIAgent_TagConditionProperty
- type CfnAIAgent_TagFilterProperty
- type CfnAIGuardrail
- type CfnAIGuardrailProps
- type CfnAIGuardrailVersion
- type CfnAIGuardrailVersionProps
- type CfnAIGuardrail_AIGuardrailContentPolicyConfigProperty
- type CfnAIGuardrail_AIGuardrailContextualGroundingPolicyConfigProperty
- type CfnAIGuardrail_AIGuardrailSensitiveInformationPolicyConfigProperty
- type CfnAIGuardrail_AIGuardrailTopicPolicyConfigProperty
- type CfnAIGuardrail_AIGuardrailWordPolicyConfigProperty
- type CfnAIGuardrail_GuardrailContentFilterConfigProperty
- type CfnAIGuardrail_GuardrailContextualGroundingFilterConfigProperty
- type CfnAIGuardrail_GuardrailManagedWordsConfigProperty
- type CfnAIGuardrail_GuardrailPiiEntityConfigProperty
- type CfnAIGuardrail_GuardrailRegexConfigProperty
- type CfnAIGuardrail_GuardrailTopicConfigProperty
- type CfnAIGuardrail_GuardrailWordConfigProperty
- type CfnAIPrompt
- type CfnAIPromptProps
- type CfnAIPromptVersion
- type CfnAIPromptVersionProps
- type CfnAIPrompt_AIPromptTemplateConfigurationProperty
- type CfnAIPrompt_TextFullAIPromptEditTemplateConfigurationProperty
- type CfnAssistant
- type CfnAssistantAssociation
- type CfnAssistantAssociationProps
- type CfnAssistantAssociation_AssociationDataProperty
- type CfnAssistantProps
- type CfnAssistant_ServerSideEncryptionConfigurationProperty
- type CfnKnowledgeBase
- type CfnKnowledgeBaseProps
- type CfnKnowledgeBase_AppIntegrationsConfigurationProperty
- type CfnKnowledgeBase_BedrockFoundationModelConfigurationProperty
- type CfnKnowledgeBase_ChunkingConfigurationProperty
- type CfnKnowledgeBase_CrawlerLimitsProperty
- type CfnKnowledgeBase_FixedSizeChunkingConfigurationProperty
- type CfnKnowledgeBase_HierarchicalChunkingConfigurationProperty
- type CfnKnowledgeBase_HierarchicalChunkingLevelConfigurationProperty
- type CfnKnowledgeBase_ManagedSourceConfigurationProperty
- type CfnKnowledgeBase_ParsingConfigurationProperty
- type CfnKnowledgeBase_ParsingPromptProperty
- type CfnKnowledgeBase_RenderingConfigurationProperty
- type CfnKnowledgeBase_SeedUrlProperty
- type CfnKnowledgeBase_SemanticChunkingConfigurationProperty
- type CfnKnowledgeBase_ServerSideEncryptionConfigurationProperty
- type CfnKnowledgeBase_SourceConfigurationProperty
- type CfnKnowledgeBase_UrlConfigurationProperty
- type CfnKnowledgeBase_VectorIngestionConfigurationProperty
- type CfnKnowledgeBase_WebCrawlerConfigurationProperty
- type CfnMessageTemplate
- type CfnMessageTemplateProps
- type CfnMessageTemplateVersion
- type CfnMessageTemplateVersionProps
- type CfnMessageTemplate_AgentAttributesProperty
- type CfnMessageTemplate_ContentProperty
- type CfnMessageTemplate_CustomerProfileAttributesProperty
- type CfnMessageTemplate_EmailMessageTemplateContentBodyProperty
- type CfnMessageTemplate_EmailMessageTemplateContentProperty
- type CfnMessageTemplate_EmailMessageTemplateHeaderProperty
- type CfnMessageTemplate_GroupingConfigurationProperty
- type CfnMessageTemplate_MessageTemplateAttributesProperty
- type CfnMessageTemplate_MessageTemplateBodyContentProviderProperty
- type CfnMessageTemplate_SmsMessageTemplateContentBodyProperty
- type CfnMessageTemplate_SmsMessageTemplateContentProperty
- type CfnMessageTemplate_SystemAttributesProperty
- type CfnMessageTemplate_SystemEndpointAttributesProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnAIAgentVersion_CFN_RESOURCE_TYPE_NAME ¶ added in v2.167.0
func CfnAIAgentVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnAIAgentVersion_IsCfnElement ¶ added in v2.167.0
func CfnAIAgentVersion_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 CfnAIAgentVersion_IsCfnResource ¶ added in v2.167.0
func CfnAIAgentVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAIAgentVersion_IsConstruct ¶ added in v2.167.0
func CfnAIAgentVersion_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 CfnAIAgent_CFN_RESOURCE_TYPE_NAME ¶ added in v2.166.0
func CfnAIAgent_CFN_RESOURCE_TYPE_NAME() *string
func CfnAIAgent_IsCfnElement ¶ added in v2.166.0
func CfnAIAgent_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 CfnAIAgent_IsCfnResource ¶ added in v2.166.0
func CfnAIAgent_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAIAgent_IsConstruct ¶ added in v2.166.0
func CfnAIAgent_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 CfnAIGuardrailVersion_CFN_RESOURCE_TYPE_NAME ¶ added in v2.173.0
func CfnAIGuardrailVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnAIGuardrailVersion_IsCfnElement ¶ added in v2.173.0
func CfnAIGuardrailVersion_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 CfnAIGuardrailVersion_IsCfnResource ¶ added in v2.173.0
func CfnAIGuardrailVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAIGuardrailVersion_IsConstruct ¶ added in v2.173.0
func CfnAIGuardrailVersion_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 CfnAIGuardrail_CFN_RESOURCE_TYPE_NAME ¶ added in v2.173.0
func CfnAIGuardrail_CFN_RESOURCE_TYPE_NAME() *string
func CfnAIGuardrail_IsCfnElement ¶ added in v2.173.0
func CfnAIGuardrail_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 CfnAIGuardrail_IsCfnResource ¶ added in v2.173.0
func CfnAIGuardrail_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAIGuardrail_IsConstruct ¶ added in v2.173.0
func CfnAIGuardrail_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 CfnAIPromptVersion_CFN_RESOURCE_TYPE_NAME ¶ added in v2.166.0
func CfnAIPromptVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnAIPromptVersion_IsCfnElement ¶ added in v2.166.0
func CfnAIPromptVersion_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 CfnAIPromptVersion_IsCfnResource ¶ added in v2.166.0
func CfnAIPromptVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAIPromptVersion_IsConstruct ¶ added in v2.166.0
func CfnAIPromptVersion_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 CfnAIPrompt_CFN_RESOURCE_TYPE_NAME ¶ added in v2.163.0
func CfnAIPrompt_CFN_RESOURCE_TYPE_NAME() *string
func CfnAIPrompt_IsCfnElement ¶ added in v2.163.0
func CfnAIPrompt_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 CfnAIPrompt_IsCfnResource ¶ added in v2.163.0
func CfnAIPrompt_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAIPrompt_IsConstruct ¶ added in v2.163.0
func CfnAIPrompt_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 CfnAssistantAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnAssistantAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnAssistantAssociation_IsCfnElement ¶
func CfnAssistantAssociation_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 CfnAssistantAssociation_IsCfnResource ¶
func CfnAssistantAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAssistantAssociation_IsConstruct ¶
func CfnAssistantAssociation_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 CfnAssistant_CFN_RESOURCE_TYPE_NAME ¶
func CfnAssistant_CFN_RESOURCE_TYPE_NAME() *string
func CfnAssistant_IsCfnElement ¶
func CfnAssistant_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 CfnAssistant_IsCfnResource ¶
func CfnAssistant_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAssistant_IsConstruct ¶
func CfnAssistant_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 CfnKnowledgeBase_CFN_RESOURCE_TYPE_NAME ¶
func CfnKnowledgeBase_CFN_RESOURCE_TYPE_NAME() *string
func CfnKnowledgeBase_IsCfnElement ¶
func CfnKnowledgeBase_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 CfnKnowledgeBase_IsCfnResource ¶
func CfnKnowledgeBase_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnKnowledgeBase_IsConstruct ¶
func CfnKnowledgeBase_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 CfnMessageTemplateVersion_CFN_RESOURCE_TYPE_NAME ¶ added in v2.172.0
func CfnMessageTemplateVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnMessageTemplateVersion_IsCfnElement ¶ added in v2.172.0
func CfnMessageTemplateVersion_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 CfnMessageTemplateVersion_IsCfnResource ¶ added in v2.172.0
func CfnMessageTemplateVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMessageTemplateVersion_IsConstruct ¶ added in v2.172.0
func CfnMessageTemplateVersion_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 CfnMessageTemplate_CFN_RESOURCE_TYPE_NAME ¶ added in v2.172.0
func CfnMessageTemplate_CFN_RESOURCE_TYPE_NAME() *string
func CfnMessageTemplate_IsCfnElement ¶ added in v2.172.0
func CfnMessageTemplate_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 CfnMessageTemplate_IsCfnResource ¶ added in v2.172.0
func CfnMessageTemplate_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMessageTemplate_IsConstruct ¶ added in v2.172.0
func CfnMessageTemplate_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 NewCfnAIAgentVersion_Override ¶ added in v2.167.0
func NewCfnAIAgentVersion_Override(c CfnAIAgentVersion, scope constructs.Construct, id *string, props *CfnAIAgentVersionProps)
func NewCfnAIAgent_Override ¶ added in v2.166.0
func NewCfnAIAgent_Override(c CfnAIAgent, scope constructs.Construct, id *string, props *CfnAIAgentProps)
func NewCfnAIGuardrailVersion_Override ¶ added in v2.173.0
func NewCfnAIGuardrailVersion_Override(c CfnAIGuardrailVersion, scope constructs.Construct, id *string, props *CfnAIGuardrailVersionProps)
func NewCfnAIGuardrail_Override ¶ added in v2.173.0
func NewCfnAIGuardrail_Override(c CfnAIGuardrail, scope constructs.Construct, id *string, props *CfnAIGuardrailProps)
func NewCfnAIPromptVersion_Override ¶ added in v2.166.0
func NewCfnAIPromptVersion_Override(c CfnAIPromptVersion, scope constructs.Construct, id *string, props *CfnAIPromptVersionProps)
func NewCfnAIPrompt_Override ¶ added in v2.163.0
func NewCfnAIPrompt_Override(c CfnAIPrompt, scope constructs.Construct, id *string, props *CfnAIPromptProps)
func NewCfnAssistantAssociation_Override ¶
func NewCfnAssistantAssociation_Override(c CfnAssistantAssociation, scope constructs.Construct, id *string, props *CfnAssistantAssociationProps)
func NewCfnAssistant_Override ¶
func NewCfnAssistant_Override(c CfnAssistant, scope constructs.Construct, id *string, props *CfnAssistantProps)
func NewCfnKnowledgeBase_Override ¶
func NewCfnKnowledgeBase_Override(c CfnKnowledgeBase, scope constructs.Construct, id *string, props *CfnKnowledgeBaseProps)
func NewCfnMessageTemplateVersion_Override ¶ added in v2.172.0
func NewCfnMessageTemplateVersion_Override(c CfnMessageTemplateVersion, scope constructs.Construct, id *string, props *CfnMessageTemplateVersionProps)
func NewCfnMessageTemplate_Override ¶ added in v2.172.0
func NewCfnMessageTemplate_Override(c CfnMessageTemplate, scope constructs.Construct, id *string, props *CfnMessageTemplateProps)
Types ¶
type CfnAIAgent ¶ added in v2.166.0
type CfnAIAgent interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The identifier of the Amazon Q in Connect assistant. AssistantId() *string SetAssistantId(val *string) // The Amazon Resource Name (ARN) of the AI agent. AttrAiAgentArn() *string // The identifier of the AI Agent. AttrAiAgentId() *string // The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. AttrAssistantArn() *string AttrModifiedTimeSeconds() 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{} // AWS resource type. CfnResourceType() *string // Configuration for the AI Agent. Configuration() interface{} SetConfiguration(val interface{}) // 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 AI Agent. Description() *string SetDescription(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 AI Agent. 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 used to organize, track, or control access for this resource. Tags() *map[string]*string SetTags(val *map[string]*string) // The type of the AI Agent. Type() *string SetType(val *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) // 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{}) }
Creates an Amazon Q in Connect AI 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" cfnAIAgent := awscdk.Aws_wisdom.NewCfnAIAgent(this, jsii.String("MyCfnAIAgent"), &CfnAIAgentProps{ AssistantId: jsii.String("assistantId"), Configuration: &AIAgentConfigurationProperty{ AnswerRecommendationAiAgentConfiguration: &AnswerRecommendationAIAgentConfigurationProperty{ AnswerGenerationAiGuardrailId: jsii.String("answerGenerationAiGuardrailId"), AnswerGenerationAiPromptId: jsii.String("answerGenerationAiPromptId"), AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, IntentLabelingGenerationAiPromptId: jsii.String("intentLabelingGenerationAiPromptId"), QueryReformulationAiPromptId: jsii.String("queryReformulationAiPromptId"), }, ManualSearchAiAgentConfiguration: &ManualSearchAIAgentConfigurationProperty{ AnswerGenerationAiGuardrailId: jsii.String("answerGenerationAiGuardrailId"), AnswerGenerationAiPromptId: jsii.String("answerGenerationAiPromptId"), AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, }, SelfServiceAiAgentConfiguration: &SelfServiceAIAgentConfigurationProperty{ AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, SelfServiceAiGuardrailId: jsii.String("selfServiceAiGuardrailId"), SelfServiceAnswerGenerationAiPromptId: jsii.String("selfServiceAnswerGenerationAiPromptId"), SelfServicePreProcessingAiPromptId: jsii.String("selfServicePreProcessingAiPromptId"), }, }, Type: jsii.String("type"), // the properties below are optional Description: jsii.String("description"), Name: jsii.String("name"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html
func NewCfnAIAgent ¶ added in v2.166.0
func NewCfnAIAgent(scope constructs.Construct, id *string, props *CfnAIAgentProps) CfnAIAgent
type CfnAIAgentProps ¶ added in v2.166.0
type CfnAIAgentProps struct { // The identifier of the Amazon Q in Connect assistant. // // Can be either the ID or the ARN. URLs cannot contain the ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html#cfn-wisdom-aiagent-assistantid // AssistantId *string `field:"required" json:"assistantId" yaml:"assistantId"` // Configuration for the AI Agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html#cfn-wisdom-aiagent-configuration // Configuration interface{} `field:"required" json:"configuration" yaml:"configuration"` // The type of the AI Agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html#cfn-wisdom-aiagent-type // Type *string `field:"required" json:"type" yaml:"type"` // The description of the AI Agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html#cfn-wisdom-aiagent-description // Description *string `field:"optional" json:"description" yaml:"description"` // The name of the AI Agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html#cfn-wisdom-aiagent-name // Name *string `field:"optional" json:"name" yaml:"name"` // The tags used to organize, track, or control access for this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html#cfn-wisdom-aiagent-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnAIAgent`.
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" cfnAIAgentProps := &CfnAIAgentProps{ AssistantId: jsii.String("assistantId"), Configuration: &AIAgentConfigurationProperty{ AnswerRecommendationAiAgentConfiguration: &AnswerRecommendationAIAgentConfigurationProperty{ AnswerGenerationAiGuardrailId: jsii.String("answerGenerationAiGuardrailId"), AnswerGenerationAiPromptId: jsii.String("answerGenerationAiPromptId"), AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, IntentLabelingGenerationAiPromptId: jsii.String("intentLabelingGenerationAiPromptId"), QueryReformulationAiPromptId: jsii.String("queryReformulationAiPromptId"), }, ManualSearchAiAgentConfiguration: &ManualSearchAIAgentConfigurationProperty{ AnswerGenerationAiGuardrailId: jsii.String("answerGenerationAiGuardrailId"), AnswerGenerationAiPromptId: jsii.String("answerGenerationAiPromptId"), AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, }, SelfServiceAiAgentConfiguration: &SelfServiceAIAgentConfigurationProperty{ AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, SelfServiceAiGuardrailId: jsii.String("selfServiceAiGuardrailId"), SelfServiceAnswerGenerationAiPromptId: jsii.String("selfServiceAnswerGenerationAiPromptId"), SelfServicePreProcessingAiPromptId: jsii.String("selfServicePreProcessingAiPromptId"), }, }, Type: jsii.String("type"), // the properties below are optional Description: jsii.String("description"), Name: jsii.String("name"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html
type CfnAIAgentVersion ¶ added in v2.167.0
type CfnAIAgentVersion interface { awscdk.CfnResource awscdk.IInspectable // The identifier of the AI Agent. AiAgentId() *string SetAiAgentId(val *string) AssistantId() *string SetAssistantId(val *string) AttrAiAgentArn() *string AttrAiAgentVersionId() *string AttrAssistantArn() *string // The version number for this AI Agent version. AttrVersionNumber() awscdk.IResolvable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // 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 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 time the AI Agent version was last modified in seconds. ModifiedTimeSeconds() *float64 SetModifiedTimeSeconds(val *float64) // 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 // 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) // 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{}) }
Creates and Amazon Q in Connect AI Agent version.
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" cfnAIAgentVersion := awscdk.Aws_wisdom.NewCfnAIAgentVersion(this, jsii.String("MyCfnAIAgentVersion"), &CfnAIAgentVersionProps{ AiAgentId: jsii.String("aiAgentId"), AssistantId: jsii.String("assistantId"), // the properties below are optional ModifiedTimeSeconds: jsii.Number(123), })
func NewCfnAIAgentVersion ¶ added in v2.167.0
func NewCfnAIAgentVersion(scope constructs.Construct, id *string, props *CfnAIAgentVersionProps) CfnAIAgentVersion
type CfnAIAgentVersionProps ¶ added in v2.167.0
type CfnAIAgentVersionProps struct { // The identifier of the AI Agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagentversion.html#cfn-wisdom-aiagentversion-aiagentid // AiAgentId *string `field:"required" json:"aiAgentId" yaml:"aiAgentId"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagentversion.html#cfn-wisdom-aiagentversion-assistantid // AssistantId *string `field:"required" json:"assistantId" yaml:"assistantId"` // The time the AI Agent version was last modified in seconds. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagentversion.html#cfn-wisdom-aiagentversion-modifiedtimeseconds // ModifiedTimeSeconds *float64 `field:"optional" json:"modifiedTimeSeconds" yaml:"modifiedTimeSeconds"` }
Properties for defining a `CfnAIAgentVersion`.
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" cfnAIAgentVersionProps := &CfnAIAgentVersionProps{ AiAgentId: jsii.String("aiAgentId"), AssistantId: jsii.String("assistantId"), // the properties below are optional ModifiedTimeSeconds: jsii.Number(123), }
type CfnAIAgent_AIAgentConfigurationProperty ¶ added in v2.166.0
type CfnAIAgent_AIAgentConfigurationProperty struct { // The configuration for AI Agents of type `ANSWER_RECOMMENDATION` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-answerrecommendationaiagentconfiguration // AnswerRecommendationAiAgentConfiguration interface{} `field:"optional" json:"answerRecommendationAiAgentConfiguration" yaml:"answerRecommendationAiAgentConfiguration"` // The configuration for AI Agents of type `MANUAL_SEARCH` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-manualsearchaiagentconfiguration // ManualSearchAiAgentConfiguration interface{} `field:"optional" json:"manualSearchAiAgentConfiguration" yaml:"manualSearchAiAgentConfiguration"` // The self-service AI agent configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-selfserviceaiagentconfiguration // SelfServiceAiAgentConfiguration interface{} `field:"optional" json:"selfServiceAiAgentConfiguration" yaml:"selfServiceAiAgentConfiguration"` }
A typed union that specifies the configuration based on the type of AI 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" aIAgentConfigurationProperty := &AIAgentConfigurationProperty{ AnswerRecommendationAiAgentConfiguration: &AnswerRecommendationAIAgentConfigurationProperty{ AnswerGenerationAiGuardrailId: jsii.String("answerGenerationAiGuardrailId"), AnswerGenerationAiPromptId: jsii.String("answerGenerationAiPromptId"), AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, IntentLabelingGenerationAiPromptId: jsii.String("intentLabelingGenerationAiPromptId"), QueryReformulationAiPromptId: jsii.String("queryReformulationAiPromptId"), }, ManualSearchAiAgentConfiguration: &ManualSearchAIAgentConfigurationProperty{ AnswerGenerationAiGuardrailId: jsii.String("answerGenerationAiGuardrailId"), AnswerGenerationAiPromptId: jsii.String("answerGenerationAiPromptId"), AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, }, SelfServiceAiAgentConfiguration: &SelfServiceAIAgentConfigurationProperty{ AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, SelfServiceAiGuardrailId: jsii.String("selfServiceAiGuardrailId"), SelfServiceAnswerGenerationAiPromptId: jsii.String("selfServiceAnswerGenerationAiPromptId"), SelfServicePreProcessingAiPromptId: jsii.String("selfServicePreProcessingAiPromptId"), }, }
type CfnAIAgent_AnswerRecommendationAIAgentConfigurationProperty ¶ added in v2.166.0
type CfnAIAgent_AnswerRecommendationAIAgentConfigurationProperty struct { // The ID of the answer generation AI guardrail. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.html#cfn-wisdom-aiagent-answerrecommendationaiagentconfiguration-answergenerationaiguardrailid // AnswerGenerationAiGuardrailId *string `field:"optional" json:"answerGenerationAiGuardrailId" yaml:"answerGenerationAiGuardrailId"` // The AI Prompt identifier for the Answer Generation prompt used by the `ANSWER_RECOMMENDATION` AI Agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.html#cfn-wisdom-aiagent-answerrecommendationaiagentconfiguration-answergenerationaipromptid // AnswerGenerationAiPromptId *string `field:"optional" json:"answerGenerationAiPromptId" yaml:"answerGenerationAiPromptId"` // The association configurations for overriding behavior on this AI Agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.html#cfn-wisdom-aiagent-answerrecommendationaiagentconfiguration-associationconfigurations // AssociationConfigurations interface{} `field:"optional" json:"associationConfigurations" yaml:"associationConfigurations"` // The AI Prompt identifier for the Intent Labeling prompt used by the `ANSWER_RECOMMENDATION` AI Agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.html#cfn-wisdom-aiagent-answerrecommendationaiagentconfiguration-intentlabelinggenerationaipromptid // IntentLabelingGenerationAiPromptId *string `field:"optional" json:"intentLabelingGenerationAiPromptId" yaml:"intentLabelingGenerationAiPromptId"` // The AI Prompt identifier for the Query Reformulation prompt used by the `ANSWER_RECOMMENDATION` AI Agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.html#cfn-wisdom-aiagent-answerrecommendationaiagentconfiguration-queryreformulationaipromptid // QueryReformulationAiPromptId *string `field:"optional" json:"queryReformulationAiPromptId" yaml:"queryReformulationAiPromptId"` }
The configuration for AI Agents of type `ANSWER_RECOMMENDATION` .
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" answerRecommendationAIAgentConfigurationProperty := &AnswerRecommendationAIAgentConfigurationProperty{ AnswerGenerationAiGuardrailId: jsii.String("answerGenerationAiGuardrailId"), AnswerGenerationAiPromptId: jsii.String("answerGenerationAiPromptId"), AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, IntentLabelingGenerationAiPromptId: jsii.String("intentLabelingGenerationAiPromptId"), QueryReformulationAiPromptId: jsii.String("queryReformulationAiPromptId"), }
type CfnAIAgent_AssociationConfigurationDataProperty ¶ added in v2.166.0
type CfnAIAgent_AssociationConfigurationDataProperty struct { // The data of the configuration for a `KNOWLEDGE_BASE` type Amazon Q in Connect Assistant Association. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-associationconfigurationdata.html#cfn-wisdom-aiagent-associationconfigurationdata-knowledgebaseassociationconfigurationdata // KnowledgeBaseAssociationConfigurationData interface{} `field:"required" json:"knowledgeBaseAssociationConfigurationData" yaml:"knowledgeBaseAssociationConfigurationData"` }
A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.
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" associationConfigurationDataProperty := &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }
type CfnAIAgent_AssociationConfigurationProperty ¶ added in v2.166.0
type CfnAIAgent_AssociationConfigurationProperty struct { // A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-associationconfiguration.html#cfn-wisdom-aiagent-associationconfiguration-associationconfigurationdata // AssociationConfigurationData interface{} `field:"optional" json:"associationConfigurationData" yaml:"associationConfigurationData"` // The identifier of the association for this Association Configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-associationconfiguration.html#cfn-wisdom-aiagent-associationconfiguration-associationid // AssociationId *string `field:"optional" json:"associationId" yaml:"associationId"` // The type of the association for this Association Configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-associationconfiguration.html#cfn-wisdom-aiagent-associationconfiguration-associationtype // AssociationType *string `field:"optional" json:"associationType" yaml:"associationType"` }
The configuration for an Amazon Q in Connect Assistant Association.
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" associationConfigurationProperty := &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }
type CfnAIAgent_KnowledgeBaseAssociationConfigurationDataProperty ¶ added in v2.166.0
type CfnAIAgent_KnowledgeBaseAssociationConfigurationDataProperty struct { // An object that can be used to specify Tag conditions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-knowledgebaseassociationconfigurationdata.html#cfn-wisdom-aiagent-knowledgebaseassociationconfigurationdata-contenttagfilter // ContentTagFilter interface{} `field:"optional" json:"contentTagFilter" yaml:"contentTagFilter"` // The maximum number of results to return per page. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-knowledgebaseassociationconfigurationdata.html#cfn-wisdom-aiagent-knowledgebaseassociationconfigurationdata-maxresults // MaxResults *float64 `field:"optional" json:"maxResults" yaml:"maxResults"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-knowledgebaseassociationconfigurationdata.html#cfn-wisdom-aiagent-knowledgebaseassociationconfigurationdata-overrideknowledgebasesearchtype // OverrideKnowledgeBaseSearchType *string `field:"optional" json:"overrideKnowledgeBaseSearchType" yaml:"overrideKnowledgeBaseSearchType"` }
The data of the configuration for a `KNOWLEDGE_BASE` type Amazon Q in Connect Assistant Association.
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" knowledgeBaseAssociationConfigurationDataProperty := &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }
type CfnAIAgent_ManualSearchAIAgentConfigurationProperty ¶ added in v2.166.0
type CfnAIAgent_ManualSearchAIAgentConfigurationProperty struct { // The ID of the answer generation AI guardrail. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-manualsearchaiagentconfiguration.html#cfn-wisdom-aiagent-manualsearchaiagentconfiguration-answergenerationaiguardrailid // AnswerGenerationAiGuardrailId *string `field:"optional" json:"answerGenerationAiGuardrailId" yaml:"answerGenerationAiGuardrailId"` // The AI Prompt identifier for the Answer Generation prompt used by the `ANSWER_RECOMMENDATION` AI Agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-manualsearchaiagentconfiguration.html#cfn-wisdom-aiagent-manualsearchaiagentconfiguration-answergenerationaipromptid // AnswerGenerationAiPromptId *string `field:"optional" json:"answerGenerationAiPromptId" yaml:"answerGenerationAiPromptId"` // The association configurations for overriding behavior on this AI Agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-manualsearchaiagentconfiguration.html#cfn-wisdom-aiagent-manualsearchaiagentconfiguration-associationconfigurations // AssociationConfigurations interface{} `field:"optional" json:"associationConfigurations" yaml:"associationConfigurations"` }
The configuration for AI Agents of type `MANUAL_SEARCH` .
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" manualSearchAIAgentConfigurationProperty := &ManualSearchAIAgentConfigurationProperty{ AnswerGenerationAiGuardrailId: jsii.String("answerGenerationAiGuardrailId"), AnswerGenerationAiPromptId: jsii.String("answerGenerationAiPromptId"), AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, }
type CfnAIAgent_OrConditionProperty ¶ added in v2.166.0
type CfnAIAgent_OrConditionProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orcondition.html#cfn-wisdom-aiagent-orcondition-andconditions // AndConditions interface{} `field:"optional" json:"andConditions" yaml:"andConditions"` // A leaf node condition which can be used to specify a tag condition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orcondition.html#cfn-wisdom-aiagent-orcondition-tagcondition // TagCondition interface{} `field:"optional" json:"tagCondition" yaml:"tagCondition"` }
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" orConditionProperty := &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }
type CfnAIAgent_SelfServiceAIAgentConfigurationProperty ¶ added in v2.173.0
type CfnAIAgent_SelfServiceAIAgentConfigurationProperty struct { // The association configuration of the self-service AI agent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-selfserviceaiagentconfiguration.html#cfn-wisdom-aiagent-selfserviceaiagentconfiguration-associationconfigurations // AssociationConfigurations interface{} `field:"optional" json:"associationConfigurations" yaml:"associationConfigurations"` // The ID of the self-service AI guardrail. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-selfserviceaiagentconfiguration.html#cfn-wisdom-aiagent-selfserviceaiagentconfiguration-selfserviceaiguardrailid // SelfServiceAiGuardrailId *string `field:"optional" json:"selfServiceAiGuardrailId" yaml:"selfServiceAiGuardrailId"` // The ID of the self-service answer generation AI prompt. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-selfserviceaiagentconfiguration.html#cfn-wisdom-aiagent-selfserviceaiagentconfiguration-selfserviceanswergenerationaipromptid // SelfServiceAnswerGenerationAiPromptId *string `field:"optional" json:"selfServiceAnswerGenerationAiPromptId" yaml:"selfServiceAnswerGenerationAiPromptId"` // The ID of the self-service preprocessing AI prompt. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-selfserviceaiagentconfiguration.html#cfn-wisdom-aiagent-selfserviceaiagentconfiguration-selfservicepreprocessingaipromptid // SelfServicePreProcessingAiPromptId *string `field:"optional" json:"selfServicePreProcessingAiPromptId" yaml:"selfServicePreProcessingAiPromptId"` }
The configuration of the self-service AI 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" selfServiceAIAgentConfigurationProperty := &SelfServiceAIAgentConfigurationProperty{ AssociationConfigurations: []interface{}{ &AssociationConfigurationProperty{ AssociationConfigurationData: &AssociationConfigurationDataProperty{ KnowledgeBaseAssociationConfigurationData: &KnowledgeBaseAssociationConfigurationDataProperty{ ContentTagFilter: &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, MaxResults: jsii.Number(123), OverrideKnowledgeBaseSearchType: jsii.String("overrideKnowledgeBaseSearchType"), }, }, AssociationId: jsii.String("associationId"), AssociationType: jsii.String("associationType"), }, }, SelfServiceAiGuardrailId: jsii.String("selfServiceAiGuardrailId"), SelfServiceAnswerGenerationAiPromptId: jsii.String("selfServiceAnswerGenerationAiPromptId"), SelfServicePreProcessingAiPromptId: jsii.String("selfServicePreProcessingAiPromptId"), }
type CfnAIAgent_TagConditionProperty ¶ added in v2.166.0
type CfnAIAgent_TagConditionProperty struct { // The tag key in the tag condition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagcondition.html#cfn-wisdom-aiagent-tagcondition-key // Key *string `field:"required" json:"key" yaml:"key"` // The tag value in the tag condition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagcondition.html#cfn-wisdom-aiagent-tagcondition-value // Value *string `field:"optional" json:"value" yaml:"value"` }
An object that can be used to specify tag conditions.
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" tagConditionProperty := &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }
type CfnAIAgent_TagFilterProperty ¶ added in v2.166.0
type CfnAIAgent_TagFilterProperty struct { // A list of conditions which would be applied together with an `AND` condition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagfilter.html#cfn-wisdom-aiagent-tagfilter-andconditions // AndConditions interface{} `field:"optional" json:"andConditions" yaml:"andConditions"` // A list of conditions which would be applied together with an `OR` condition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagfilter.html#cfn-wisdom-aiagent-tagfilter-orconditions // OrConditions interface{} `field:"optional" json:"orConditions" yaml:"orConditions"` // A leaf node condition which can be used to specify a tag condition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagfilter.html#cfn-wisdom-aiagent-tagfilter-tagcondition // TagCondition interface{} `field:"optional" json:"tagCondition" yaml:"tagCondition"` }
An object that can be used to specify tag conditions.
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" tagFilterProperty := &TagFilterProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, OrConditions: []interface{}{ &OrConditionProperty{ AndConditions: []interface{}{ &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }, }, TagCondition: &TagConditionProperty{ Key: jsii.String("key"), // the properties below are optional Value: jsii.String("value"), }, }
type CfnAIGuardrail ¶ added in v2.173.0
type CfnAIGuardrail interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The identifier of the Amazon Q in Connect assistant. AssistantId() *string SetAssistantId(val *string) // The Amazon Resource Name (ARN) of the AI Guardrail. AttrAiGuardrailArn() *string // The identifier of the Amazon Q in Connect AI Guardrail. AttrAiGuardrailId() *string // The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. AttrAssistantArn() *string // The message to return when the AI Guardrail blocks a prompt. BlockedInputMessaging() *string SetBlockedInputMessaging(val *string) // The message to return when the AI Guardrail blocks a model response. BlockedOutputsMessaging() *string SetBlockedOutputsMessaging(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{} // AWS resource type. CfnResourceType() *string // Contains details about how to handle harmful content. ContentPolicyConfig() interface{} SetContentPolicyConfig(val interface{}) // The policy configuration details for the AI Guardrail's contextual grounding policy. ContextualGroundingPolicyConfig() interface{} SetContextualGroundingPolicyConfig(val interface{}) // 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 description of the AI Guardrail. Description() *string SetDescription(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 AI Guardrail. 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 // Contains details about PII entities and regular expressions to configure for the AI Guardrail. SensitiveInformationPolicyConfig() interface{} SetSensitiveInformationPolicyConfig(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags used to organize, track, or control access for this resource. Tags() *map[string]*string SetTags(val *map[string]*string) // Contains details about topics that the AI Guardrail should identify and deny. TopicPolicyConfig() interface{} SetTopicPolicyConfig(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{} // Contains details about the word policy to configured for the AI Guardrail. WordPolicyConfig() interface{} SetWordPolicyConfig(val 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) // 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{}) }
Creates an Amazon Q in Connect AI Guardrail.
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" cfnAIGuardrail := awscdk.Aws_wisdom.NewCfnAIGuardrail(this, jsii.String("MyCfnAIGuardrail"), &CfnAIGuardrailProps{ AssistantId: jsii.String("assistantId"), BlockedInputMessaging: jsii.String("blockedInputMessaging"), BlockedOutputsMessaging: jsii.String("blockedOutputsMessaging"), // the properties below are optional ContentPolicyConfig: &AIGuardrailContentPolicyConfigProperty{ FiltersConfig: []interface{}{ &GuardrailContentFilterConfigProperty{ InputStrength: jsii.String("inputStrength"), OutputStrength: jsii.String("outputStrength"), Type: jsii.String("type"), }, }, }, ContextualGroundingPolicyConfig: &AIGuardrailContextualGroundingPolicyConfigProperty{ FiltersConfig: []interface{}{ &GuardrailContextualGroundingFilterConfigProperty{ Threshold: jsii.Number(123), Type: jsii.String("type"), }, }, }, Description: jsii.String("description"), Name: jsii.String("name"), SensitiveInformationPolicyConfig: &AIGuardrailSensitiveInformationPolicyConfigProperty{ PiiEntitiesConfig: []interface{}{ &GuardrailPiiEntityConfigProperty{ Action: jsii.String("action"), Type: jsii.String("type"), }, }, RegexesConfig: []interface{}{ &GuardrailRegexConfigProperty{ Action: jsii.String("action"), Name: jsii.String("name"), Pattern: jsii.String("pattern"), // the properties below are optional Description: jsii.String("description"), }, }, }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, TopicPolicyConfig: &AIGuardrailTopicPolicyConfigProperty{ TopicsConfig: []interface{}{ &GuardrailTopicConfigProperty{ Definition: jsii.String("definition"), Name: jsii.String("name"), Type: jsii.String("type"), // the properties below are optional Examples: []*string{ jsii.String("examples"), }, }, }, }, WordPolicyConfig: &AIGuardrailWordPolicyConfigProperty{ ManagedWordListsConfig: []interface{}{ &GuardrailManagedWordsConfigProperty{ Type: jsii.String("type"), }, }, WordsConfig: []interface{}{ &GuardrailWordConfigProperty{ Text: jsii.String("text"), }, }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html
func NewCfnAIGuardrail ¶ added in v2.173.0
func NewCfnAIGuardrail(scope constructs.Construct, id *string, props *CfnAIGuardrailProps) CfnAIGuardrail
type CfnAIGuardrailProps ¶ added in v2.173.0
type CfnAIGuardrailProps struct { // The identifier of the Amazon Q in Connect assistant. // // Can be either the ID or the ARN. URLs cannot contain the ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-assistantid // AssistantId *string `field:"required" json:"assistantId" yaml:"assistantId"` // The message to return when the AI Guardrail blocks a prompt. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-blockedinputmessaging // BlockedInputMessaging *string `field:"required" json:"blockedInputMessaging" yaml:"blockedInputMessaging"` // The message to return when the AI Guardrail blocks a model response. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-blockedoutputsmessaging // BlockedOutputsMessaging *string `field:"required" json:"blockedOutputsMessaging" yaml:"blockedOutputsMessaging"` // Contains details about how to handle harmful content. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-contentpolicyconfig // ContentPolicyConfig interface{} `field:"optional" json:"contentPolicyConfig" yaml:"contentPolicyConfig"` // The policy configuration details for the AI Guardrail's contextual grounding policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-contextualgroundingpolicyconfig // ContextualGroundingPolicyConfig interface{} `field:"optional" json:"contextualGroundingPolicyConfig" yaml:"contextualGroundingPolicyConfig"` // A description of the AI Guardrail. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-description // Description *string `field:"optional" json:"description" yaml:"description"` // The name of the AI Guardrail. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-name // Name *string `field:"optional" json:"name" yaml:"name"` // Contains details about PII entities and regular expressions to configure for the AI Guardrail. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-sensitiveinformationpolicyconfig // SensitiveInformationPolicyConfig interface{} `field:"optional" json:"sensitiveInformationPolicyConfig" yaml:"sensitiveInformationPolicyConfig"` // The tags used to organize, track, or control access for this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` // Contains details about topics that the AI Guardrail should identify and deny. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-topicpolicyconfig // TopicPolicyConfig interface{} `field:"optional" json:"topicPolicyConfig" yaml:"topicPolicyConfig"` // Contains details about the word policy to configured for the AI Guardrail. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-wordpolicyconfig // WordPolicyConfig interface{} `field:"optional" json:"wordPolicyConfig" yaml:"wordPolicyConfig"` }
Properties for defining a `CfnAIGuardrail`.
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" cfnAIGuardrailProps := &CfnAIGuardrailProps{ AssistantId: jsii.String("assistantId"), BlockedInputMessaging: jsii.String("blockedInputMessaging"), BlockedOutputsMessaging: jsii.String("blockedOutputsMessaging"), // the properties below are optional ContentPolicyConfig: &AIGuardrailContentPolicyConfigProperty{ FiltersConfig: []interface{}{ &GuardrailContentFilterConfigProperty{ InputStrength: jsii.String("inputStrength"), OutputStrength: jsii.String("outputStrength"), Type: jsii.String("type"), }, }, }, ContextualGroundingPolicyConfig: &AIGuardrailContextualGroundingPolicyConfigProperty{ FiltersConfig: []interface{}{ &GuardrailContextualGroundingFilterConfigProperty{ Threshold: jsii.Number(123), Type: jsii.String("type"), }, }, }, Description: jsii.String("description"), Name: jsii.String("name"), SensitiveInformationPolicyConfig: &AIGuardrailSensitiveInformationPolicyConfigProperty{ PiiEntitiesConfig: []interface{}{ &GuardrailPiiEntityConfigProperty{ Action: jsii.String("action"), Type: jsii.String("type"), }, }, RegexesConfig: []interface{}{ &GuardrailRegexConfigProperty{ Action: jsii.String("action"), Name: jsii.String("name"), Pattern: jsii.String("pattern"), // the properties below are optional Description: jsii.String("description"), }, }, }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, TopicPolicyConfig: &AIGuardrailTopicPolicyConfigProperty{ TopicsConfig: []interface{}{ &GuardrailTopicConfigProperty{ Definition: jsii.String("definition"), Name: jsii.String("name"), Type: jsii.String("type"), // the properties below are optional Examples: []*string{ jsii.String("examples"), }, }, }, }, WordPolicyConfig: &AIGuardrailWordPolicyConfigProperty{ ManagedWordListsConfig: []interface{}{ &GuardrailManagedWordsConfigProperty{ Type: jsii.String("type"), }, }, WordsConfig: []interface{}{ &GuardrailWordConfigProperty{ Text: jsii.String("text"), }, }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html
type CfnAIGuardrailVersion ¶ added in v2.173.0
type CfnAIGuardrailVersion interface { awscdk.CfnResource awscdk.IInspectable // The ID of the AI guardrail version. AiGuardrailId() *string SetAiGuardrailId(val *string) // The ID of the AI guardrail version assistant. AssistantId() *string SetAssistantId(val *string) // The ARN of the AI guardrail version. AttrAiGuardrailArn() *string // The ID of the AI guardrail version. AttrAiGuardrailVersionId() *string // The ARN of the AI guardrail version assistant. AttrAssistantArn() *string // The version number for this AI Guardrail version. AttrVersionNumber() awscdk.IResolvable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // 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 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 modified time of the AI guardrail version in seconds. ModifiedTimeSeconds() *float64 SetModifiedTimeSeconds(val *float64) // 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 // 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) // 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{}) }
Creates an Amazon Q in Connect AI Guardrail version.
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" cfnAIGuardrailVersion := awscdk.Aws_wisdom.NewCfnAIGuardrailVersion(this, jsii.String("MyCfnAIGuardrailVersion"), &CfnAIGuardrailVersionProps{ AiGuardrailId: jsii.String("aiGuardrailId"), AssistantId: jsii.String("assistantId"), // the properties below are optional ModifiedTimeSeconds: jsii.Number(123), })
func NewCfnAIGuardrailVersion ¶ added in v2.173.0
func NewCfnAIGuardrailVersion(scope constructs.Construct, id *string, props *CfnAIGuardrailVersionProps) CfnAIGuardrailVersion
type CfnAIGuardrailVersionProps ¶ added in v2.173.0
type CfnAIGuardrailVersionProps struct { // The ID of the AI guardrail version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrailversion.html#cfn-wisdom-aiguardrailversion-aiguardrailid // AiGuardrailId *string `field:"required" json:"aiGuardrailId" yaml:"aiGuardrailId"` // The ID of the AI guardrail version assistant. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrailversion.html#cfn-wisdom-aiguardrailversion-assistantid // AssistantId *string `field:"required" json:"assistantId" yaml:"assistantId"` // The modified time of the AI guardrail version in seconds. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrailversion.html#cfn-wisdom-aiguardrailversion-modifiedtimeseconds // ModifiedTimeSeconds *float64 `field:"optional" json:"modifiedTimeSeconds" yaml:"modifiedTimeSeconds"` }
Properties for defining a `CfnAIGuardrailVersion`.
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" cfnAIGuardrailVersionProps := &CfnAIGuardrailVersionProps{ AiGuardrailId: jsii.String("aiGuardrailId"), AssistantId: jsii.String("assistantId"), // the properties below are optional ModifiedTimeSeconds: jsii.Number(123), }
type CfnAIGuardrail_AIGuardrailContentPolicyConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_AIGuardrailContentPolicyConfigProperty struct { // List of content filter configurations in a content policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailcontentpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailcontentpolicyconfig-filtersconfig // FiltersConfig interface{} `field:"required" json:"filtersConfig" yaml:"filtersConfig"` }
Content policy config for a guardrail.
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" aIGuardrailContentPolicyConfigProperty := &AIGuardrailContentPolicyConfigProperty{ FiltersConfig: []interface{}{ &GuardrailContentFilterConfigProperty{ InputStrength: jsii.String("inputStrength"), OutputStrength: jsii.String("outputStrength"), Type: jsii.String("type"), }, }, }
type CfnAIGuardrail_AIGuardrailContextualGroundingPolicyConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_AIGuardrailContextualGroundingPolicyConfigProperty struct { // List of contextual grounding filter configs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailcontextualgroundingpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailcontextualgroundingpolicyconfig-filtersconfig // FiltersConfig interface{} `field:"required" json:"filtersConfig" yaml:"filtersConfig"` }
Contextual grounding policy config for a guardrail.
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" aIGuardrailContextualGroundingPolicyConfigProperty := &AIGuardrailContextualGroundingPolicyConfigProperty{ FiltersConfig: []interface{}{ &GuardrailContextualGroundingFilterConfigProperty{ Threshold: jsii.Number(123), Type: jsii.String("type"), }, }, }
type CfnAIGuardrail_AIGuardrailSensitiveInformationPolicyConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_AIGuardrailSensitiveInformationPolicyConfigProperty struct { // List of entities. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig-piientitiesconfig // PiiEntitiesConfig interface{} `field:"optional" json:"piiEntitiesConfig" yaml:"piiEntitiesConfig"` // List of regex. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig-regexesconfig // RegexesConfig interface{} `field:"optional" json:"regexesConfig" yaml:"regexesConfig"` }
Sensitive information policy configuration for a guardrail.
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" aIGuardrailSensitiveInformationPolicyConfigProperty := &AIGuardrailSensitiveInformationPolicyConfigProperty{ PiiEntitiesConfig: []interface{}{ &GuardrailPiiEntityConfigProperty{ Action: jsii.String("action"), Type: jsii.String("type"), }, }, RegexesConfig: []interface{}{ &GuardrailRegexConfigProperty{ Action: jsii.String("action"), Name: jsii.String("name"), Pattern: jsii.String("pattern"), // the properties below are optional Description: jsii.String("description"), }, }, }
type CfnAIGuardrail_AIGuardrailTopicPolicyConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_AIGuardrailTopicPolicyConfigProperty struct { // List of topic configs in topic policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailtopicpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailtopicpolicyconfig-topicsconfig // TopicsConfig interface{} `field:"required" json:"topicsConfig" yaml:"topicsConfig"` }
Topic policy configuration for a guardrail.
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" aIGuardrailTopicPolicyConfigProperty := &AIGuardrailTopicPolicyConfigProperty{ TopicsConfig: []interface{}{ &GuardrailTopicConfigProperty{ Definition: jsii.String("definition"), Name: jsii.String("name"), Type: jsii.String("type"), // the properties below are optional Examples: []*string{ jsii.String("examples"), }, }, }, }
type CfnAIGuardrail_AIGuardrailWordPolicyConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_AIGuardrailWordPolicyConfigProperty struct { // A config for the list of managed words. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailwordpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailwordpolicyconfig-managedwordlistsconfig // ManagedWordListsConfig interface{} `field:"optional" json:"managedWordListsConfig" yaml:"managedWordListsConfig"` // List of custom word configurations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailwordpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailwordpolicyconfig-wordsconfig // WordsConfig interface{} `field:"optional" json:"wordsConfig" yaml:"wordsConfig"` }
Word policy config for a guardrail.
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" aIGuardrailWordPolicyConfigProperty := &AIGuardrailWordPolicyConfigProperty{ ManagedWordListsConfig: []interface{}{ &GuardrailManagedWordsConfigProperty{ Type: jsii.String("type"), }, }, WordsConfig: []interface{}{ &GuardrailWordConfigProperty{ Text: jsii.String("text"), }, }, }
type CfnAIGuardrail_GuardrailContentFilterConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_GuardrailContentFilterConfigProperty struct { // The strength of the input for the guardrail content filter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontentfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontentfilterconfig-inputstrength // InputStrength *string `field:"required" json:"inputStrength" yaml:"inputStrength"` // The output strength of the guardrail content filter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontentfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontentfilterconfig-outputstrength // OutputStrength *string `field:"required" json:"outputStrength" yaml:"outputStrength"` // The type of the guardrail content filter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontentfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontentfilterconfig-type // Type *string `field:"required" json:"type" yaml:"type"` }
Content filter configuration in content 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" guardrailContentFilterConfigProperty := &GuardrailContentFilterConfigProperty{ InputStrength: jsii.String("inputStrength"), OutputStrength: jsii.String("outputStrength"), Type: jsii.String("type"), }
type CfnAIGuardrail_GuardrailContextualGroundingFilterConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_GuardrailContextualGroundingFilterConfigProperty struct { // The threshold for this filter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig-threshold // // Default: - 0. // Threshold *float64 `field:"required" json:"threshold" yaml:"threshold"` // The type of this filter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig-type // Type *string `field:"required" json:"type" yaml:"type"` }
A configuration for grounding filter.
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" guardrailContextualGroundingFilterConfigProperty := &GuardrailContextualGroundingFilterConfigProperty{ Threshold: jsii.Number(123), Type: jsii.String("type"), }
type CfnAIGuardrail_GuardrailManagedWordsConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_GuardrailManagedWordsConfigProperty struct { // The type of guardrail managed words. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailmanagedwordsconfig.html#cfn-wisdom-aiguardrail-guardrailmanagedwordsconfig-type // Type *string `field:"required" json:"type" yaml:"type"` }
A managed words config.
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" guardrailManagedWordsConfigProperty := &GuardrailManagedWordsConfigProperty{ Type: jsii.String("type"), }
type CfnAIGuardrail_GuardrailPiiEntityConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_GuardrailPiiEntityConfigProperty struct { // The action of guardrail PII entity configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailpiientityconfig.html#cfn-wisdom-aiguardrail-guardrailpiientityconfig-action // Action *string `field:"required" json:"action" yaml:"action"` // The currently supported PII entities. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailpiientityconfig.html#cfn-wisdom-aiguardrail-guardrailpiientityconfig-type // Type *string `field:"required" json:"type" yaml:"type"` }
PII entity 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" guardrailPiiEntityConfigProperty := &GuardrailPiiEntityConfigProperty{ Action: jsii.String("action"), Type: jsii.String("type"), }
type CfnAIGuardrail_GuardrailRegexConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_GuardrailRegexConfigProperty struct { // The action of the guardrail regex configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-action // Action *string `field:"required" json:"action" yaml:"action"` // A regex configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-name // Name *string `field:"required" json:"name" yaml:"name"` // The regex pattern. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-pattern // Pattern *string `field:"required" json:"pattern" yaml:"pattern"` // The regex description. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-description // Description *string `field:"optional" json:"description" yaml:"description"` }
A regex 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" guardrailRegexConfigProperty := &GuardrailRegexConfigProperty{ Action: jsii.String("action"), Name: jsii.String("name"), Pattern: jsii.String("pattern"), // the properties below are optional Description: jsii.String("description"), }
type CfnAIGuardrail_GuardrailTopicConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_GuardrailTopicConfigProperty struct { // Definition of topic in topic policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-definition // Definition *string `field:"required" json:"definition" yaml:"definition"` // Name of topic in topic policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-name // Name *string `field:"required" json:"name" yaml:"name"` // Type of topic in a policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-type // Type *string `field:"required" json:"type" yaml:"type"` // Text example in topic policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-examples // Examples *[]*string `field:"optional" json:"examples" yaml:"examples"` }
Topic configuration in topic 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" guardrailTopicConfigProperty := &GuardrailTopicConfigProperty{ Definition: jsii.String("definition"), Name: jsii.String("name"), Type: jsii.String("type"), // the properties below are optional Examples: []*string{ jsii.String("examples"), }, }
type CfnAIGuardrail_GuardrailWordConfigProperty ¶ added in v2.173.0
type CfnAIGuardrail_GuardrailWordConfigProperty struct { // The custom word text. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailwordconfig.html#cfn-wisdom-aiguardrail-guardrailwordconfig-text // Text *string `field:"required" json:"text" yaml:"text"` }
A custom word config.
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" guardrailWordConfigProperty := &GuardrailWordConfigProperty{ Text: jsii.String("text"), }
type CfnAIPrompt ¶ added in v2.163.0
type CfnAIPrompt interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The API format used for this AI Prompt. ApiFormat() *string SetApiFormat(val *string) // The identifier of the Amazon Q in Connect assistant. AssistantId() *string SetAssistantId(val *string) // The Amazon Resource Name (ARN) of the AI Prompt. AttrAiPromptArn() *string // The identifier of the Amazon Q in Connect AI prompt. AttrAiPromptId() *string // The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. AttrAssistantArn() *string AttrModifiedTimeSeconds() 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{} // 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 AI Prompt. Description() *string SetDescription(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 identifier of the model used for this AI Prompt. ModelId() *string SetModelId(val *string) // The name of the AI Prompt. 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 used to organize, track, or control access for this resource. Tags() *map[string]*string SetTags(val *map[string]*string) // The configuration of the prompt template for this AI Prompt. TemplateConfiguration() interface{} SetTemplateConfiguration(val interface{}) // The type of the prompt template for this AI Prompt. TemplateType() *string SetTemplateType(val *string) // The type of this AI Prompt. Type() *string SetType(val *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) // 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{}) }
Creates an Amazon Q in Connect AI Prompt.
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" cfnAIPrompt := awscdk.Aws_wisdom.NewCfnAIPrompt(this, jsii.String("MyCfnAIPrompt"), &CfnAIPromptProps{ ApiFormat: jsii.String("apiFormat"), ModelId: jsii.String("modelId"), TemplateConfiguration: &AIPromptTemplateConfigurationProperty{ TextFullAiPromptEditTemplateConfiguration: &TextFullAIPromptEditTemplateConfigurationProperty{ Text: jsii.String("text"), }, }, TemplateType: jsii.String("templateType"), Type: jsii.String("type"), // the properties below are optional AssistantId: jsii.String("assistantId"), Description: jsii.String("description"), Name: jsii.String("name"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html
func NewCfnAIPrompt ¶ added in v2.163.0
func NewCfnAIPrompt(scope constructs.Construct, id *string, props *CfnAIPromptProps) CfnAIPrompt
type CfnAIPromptProps ¶ added in v2.163.0
type CfnAIPromptProps struct { // The API format used for this AI Prompt. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html#cfn-wisdom-aiprompt-apiformat // ApiFormat *string `field:"required" json:"apiFormat" yaml:"apiFormat"` // The identifier of the model used for this AI Prompt. // // Model Ids supported are: `CLAUDE_3_HAIKU_20240307_V1` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html#cfn-wisdom-aiprompt-modelid // ModelId *string `field:"required" json:"modelId" yaml:"modelId"` // The configuration of the prompt template for this AI Prompt. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html#cfn-wisdom-aiprompt-templateconfiguration // TemplateConfiguration interface{} `field:"required" json:"templateConfiguration" yaml:"templateConfiguration"` // The type of the prompt template for this AI Prompt. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html#cfn-wisdom-aiprompt-templatetype // TemplateType *string `field:"required" json:"templateType" yaml:"templateType"` // The type of this AI Prompt. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html#cfn-wisdom-aiprompt-type // Type *string `field:"required" json:"type" yaml:"type"` // The identifier of the Amazon Q in Connect assistant. // // Can be either the ID or the ARN. URLs cannot contain the ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html#cfn-wisdom-aiprompt-assistantid // AssistantId *string `field:"optional" json:"assistantId" yaml:"assistantId"` // The description of the AI Prompt. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html#cfn-wisdom-aiprompt-description // Description *string `field:"optional" json:"description" yaml:"description"` // The name of the AI Prompt. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html#cfn-wisdom-aiprompt-name // Name *string `field:"optional" json:"name" yaml:"name"` // The tags used to organize, track, or control access for this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html#cfn-wisdom-aiprompt-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnAIPrompt`.
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" cfnAIPromptProps := &CfnAIPromptProps{ ApiFormat: jsii.String("apiFormat"), ModelId: jsii.String("modelId"), TemplateConfiguration: &AIPromptTemplateConfigurationProperty{ TextFullAiPromptEditTemplateConfiguration: &TextFullAIPromptEditTemplateConfigurationProperty{ Text: jsii.String("text"), }, }, TemplateType: jsii.String("templateType"), Type: jsii.String("type"), // the properties below are optional AssistantId: jsii.String("assistantId"), Description: jsii.String("description"), Name: jsii.String("name"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html
type CfnAIPromptVersion ¶ added in v2.166.0
type CfnAIPromptVersion interface { awscdk.CfnResource awscdk.IInspectable // The identifier of the Amazon Q in Connect AI prompt. AiPromptId() *string SetAiPromptId(val *string) // The identifier of the Amazon Q in Connect assistant. AssistantId() *string SetAssistantId(val *string) // The ARN of the AI prompt. AttrAiPromptArn() *string AttrAiPromptVersionId() *string AttrAssistantArn() *string // The version number for this AI Prompt version. AttrVersionNumber() awscdk.IResolvable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // 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 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 time the AI Prompt version was last modified in seconds. ModifiedTimeSeconds() *float64 SetModifiedTimeSeconds(val *float64) // 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 // 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) // 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{}) }
Creates an Amazon Q in Connect AI Prompt version.
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" cfnAIPromptVersion := awscdk.Aws_wisdom.NewCfnAIPromptVersion(this, jsii.String("MyCfnAIPromptVersion"), &CfnAIPromptVersionProps{ AiPromptId: jsii.String("aiPromptId"), AssistantId: jsii.String("assistantId"), // the properties below are optional ModifiedTimeSeconds: jsii.Number(123), })
func NewCfnAIPromptVersion ¶ added in v2.166.0
func NewCfnAIPromptVersion(scope constructs.Construct, id *string, props *CfnAIPromptVersionProps) CfnAIPromptVersion
type CfnAIPromptVersionProps ¶ added in v2.166.0
type CfnAIPromptVersionProps struct { // The identifier of the Amazon Q in Connect AI prompt. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aipromptversion.html#cfn-wisdom-aipromptversion-aipromptid // AiPromptId *string `field:"required" json:"aiPromptId" yaml:"aiPromptId"` // The identifier of the Amazon Q in Connect assistant. // // Can be either the ID or the ARN. URLs cannot contain the ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aipromptversion.html#cfn-wisdom-aipromptversion-assistantid // AssistantId *string `field:"required" json:"assistantId" yaml:"assistantId"` // The time the AI Prompt version was last modified in seconds. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aipromptversion.html#cfn-wisdom-aipromptversion-modifiedtimeseconds // ModifiedTimeSeconds *float64 `field:"optional" json:"modifiedTimeSeconds" yaml:"modifiedTimeSeconds"` }
Properties for defining a `CfnAIPromptVersion`.
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" cfnAIPromptVersionProps := &CfnAIPromptVersionProps{ AiPromptId: jsii.String("aiPromptId"), AssistantId: jsii.String("assistantId"), // the properties below are optional ModifiedTimeSeconds: jsii.Number(123), }
type CfnAIPrompt_AIPromptTemplateConfigurationProperty ¶ added in v2.163.0
type CfnAIPrompt_AIPromptTemplateConfigurationProperty struct { // The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiprompt-aiprompttemplateconfiguration.html#cfn-wisdom-aiprompt-aiprompttemplateconfiguration-textfullaipromptedittemplateconfiguration // TextFullAiPromptEditTemplateConfiguration interface{} `field:"required" json:"textFullAiPromptEditTemplateConfiguration" yaml:"textFullAiPromptEditTemplateConfiguration"` }
A typed union that specifies the configuration for a prompt template based on its type.
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" aIPromptTemplateConfigurationProperty := &AIPromptTemplateConfigurationProperty{ TextFullAiPromptEditTemplateConfiguration: &TextFullAIPromptEditTemplateConfigurationProperty{ Text: jsii.String("text"), }, }
type CfnAIPrompt_TextFullAIPromptEditTemplateConfigurationProperty ¶ added in v2.163.0
type CfnAIPrompt_TextFullAIPromptEditTemplateConfigurationProperty struct { // The YAML text for the AI Prompt template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiprompt-textfullaipromptedittemplateconfiguration.html#cfn-wisdom-aiprompt-textfullaipromptedittemplateconfiguration-text // Text *string `field:"required" json:"text" yaml:"text"` }
The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
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" textFullAIPromptEditTemplateConfigurationProperty := &TextFullAIPromptEditTemplateConfigurationProperty{ Text: jsii.String("text"), }
type CfnAssistant ¶
type CfnAssistant interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the assistant. AttrAssistantArn() *string // The ID of the Wisdom assistant. AttrAssistantId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // 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 assistant. Description() *string SetDescription(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 assistant. 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 configuration information for the customer managed key used for encryption. ServerSideEncryptionConfiguration() interface{} SetServerSideEncryptionConfiguration(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags used to organize, track, or control access for this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // The type of assistant. Type() *string SetType(val *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) // 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{}) }
Specifies an Amazon Connect Wisdom assistant.
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" cfnAssistant := awscdk.Aws_wisdom.NewCfnAssistant(this, jsii.String("MyCfnAssistant"), &CfnAssistantProps{ Name: jsii.String("name"), Type: jsii.String("type"), // the properties below are optional Description: jsii.String("description"), ServerSideEncryptionConfiguration: &ServerSideEncryptionConfigurationProperty{ KmsKeyId: jsii.String("kmsKeyId"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html
func NewCfnAssistant ¶
func NewCfnAssistant(scope constructs.Construct, id *string, props *CfnAssistantProps) CfnAssistant
type CfnAssistantAssociation ¶
type CfnAssistantAssociation interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The identifier of the Wisdom assistant. AssistantId() *string SetAssistantId(val *string) // The identifier of the associated resource. Association() interface{} SetAssociation(val interface{}) // The type of association. AssociationType() *string SetAssociationType(val *string) // The Amazon Resource Name (ARN) of the Wisdom assistant. AttrAssistantArn() *string // The Amazon Resource Name (ARN) of the assistant association. AttrAssistantAssociationArn() *string // The ID of the association. AttrAssistantAssociationId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // 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 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 // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags used to organize, track, or control access for this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(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) // 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{}) }
Specifies an association between an Amazon Connect Wisdom assistant and another resource.
Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
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" cfnAssistantAssociation := awscdk.Aws_wisdom.NewCfnAssistantAssociation(this, jsii.String("MyCfnAssistantAssociation"), &CfnAssistantAssociationProps{ AssistantId: jsii.String("assistantId"), Association: &AssociationDataProperty{ KnowledgeBaseId: jsii.String("knowledgeBaseId"), }, AssociationType: jsii.String("associationType"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnAssistantAssociation ¶
func NewCfnAssistantAssociation(scope constructs.Construct, id *string, props *CfnAssistantAssociationProps) CfnAssistantAssociation
type CfnAssistantAssociationProps ¶
type CfnAssistantAssociationProps struct { // The identifier of the Wisdom assistant. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistantassociation.html#cfn-wisdom-assistantassociation-assistantid // AssistantId *string `field:"required" json:"assistantId" yaml:"assistantId"` // The identifier of the associated resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistantassociation.html#cfn-wisdom-assistantassociation-association // Association interface{} `field:"required" json:"association" yaml:"association"` // The type of association. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistantassociation.html#cfn-wisdom-assistantassociation-associationtype // AssociationType *string `field:"required" json:"associationType" yaml:"associationType"` // The tags used to organize, track, or control access for this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistantassociation.html#cfn-wisdom-assistantassociation-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnAssistantAssociation`.
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" cfnAssistantAssociationProps := &CfnAssistantAssociationProps{ AssistantId: jsii.String("assistantId"), Association: &AssociationDataProperty{ KnowledgeBaseId: jsii.String("knowledgeBaseId"), }, AssociationType: jsii.String("associationType"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnAssistantAssociation_AssociationDataProperty ¶
type CfnAssistantAssociation_AssociationDataProperty struct { // The identifier of the knowledge base. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-assistantassociation-associationdata.html#cfn-wisdom-assistantassociation-associationdata-knowledgebaseid // KnowledgeBaseId *string `field:"required" json:"knowledgeBaseId" yaml:"knowledgeBaseId"` }
A union type that currently has a single argument, which is the knowledge base ID.
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" associationDataProperty := &AssociationDataProperty{ KnowledgeBaseId: jsii.String("knowledgeBaseId"), }
type CfnAssistantProps ¶
type CfnAssistantProps struct { // The name of the assistant. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html#cfn-wisdom-assistant-name // Name *string `field:"required" json:"name" yaml:"name"` // The type of assistant. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html#cfn-wisdom-assistant-type // Type *string `field:"required" json:"type" yaml:"type"` // The description of the assistant. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html#cfn-wisdom-assistant-description // Description *string `field:"optional" json:"description" yaml:"description"` // The configuration information for the customer managed key used for encryption. // // The customer managed key must have a policy that allows `kms:CreateGrant` and `kms:DescribeKey` permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow `kms:Decrypt` , `kms:GenerateDataKey*` , and `kms:DescribeKey` permissions to the `connect.amazonaws.com` service principal. For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html#cfn-wisdom-assistant-serversideencryptionconfiguration // ServerSideEncryptionConfiguration interface{} `field:"optional" json:"serverSideEncryptionConfiguration" yaml:"serverSideEncryptionConfiguration"` // The tags used to organize, track, or control access for this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html#cfn-wisdom-assistant-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnAssistant`.
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" cfnAssistantProps := &CfnAssistantProps{ Name: jsii.String("name"), Type: jsii.String("type"), // the properties below are optional Description: jsii.String("description"), ServerSideEncryptionConfiguration: &ServerSideEncryptionConfigurationProperty{ KmsKeyId: jsii.String("kmsKeyId"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html
type CfnAssistant_ServerSideEncryptionConfigurationProperty ¶
type CfnAssistant_ServerSideEncryptionConfigurationProperty struct { // The customer managed key used for encryption. // // The customer managed key must have a policy that allows `kms:CreateGrant` and `kms:DescribeKey` permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow `kms:Decrypt` , `kms:GenerateDataKey*` , and `kms:DescribeKey` permissions to the `connect.amazonaws.com` service principal. For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) . For information about valid ID values, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) in the *AWS Key Management Service Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-assistant-serversideencryptionconfiguration.html#cfn-wisdom-assistant-serversideencryptionconfiguration-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The configuration information for the customer managed key used for encryption.
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" serverSideEncryptionConfigurationProperty := &ServerSideEncryptionConfigurationProperty{ KmsKeyId: jsii.String("kmsKeyId"), }
type CfnKnowledgeBase ¶
type CfnKnowledgeBase interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the knowledge base. AttrKnowledgeBaseArn() *string // The ID of the knowledge base. AttrKnowledgeBaseId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // 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. Description() *string SetDescription(val *string) // The type of knowledge base. KnowledgeBaseType() *string SetKnowledgeBaseType(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 knowledge base. 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 // Information about how to render the content. RenderingConfiguration() interface{} SetRenderingConfiguration(val interface{}) // This customer managed key must have a policy that allows `kms:CreateGrant` and `kms:DescribeKey` permissions to the IAM identity using the key to invoke Wisdom. ServerSideEncryptionConfiguration() interface{} SetServerSideEncryptionConfiguration(val interface{}) // The source of the knowledge base content. SourceConfiguration() interface{} SetSourceConfiguration(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags used to organize, track, or control access for this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(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{} // Contains details about how to ingest the documents in a data source. VectorIngestionConfiguration() interface{} SetVectorIngestionConfiguration(val 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) // 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{}) }
Specifies a knowledge base.
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" cfnKnowledgeBase := awscdk.Aws_wisdom.NewCfnKnowledgeBase(this, jsii.String("MyCfnKnowledgeBase"), &CfnKnowledgeBaseProps{ KnowledgeBaseType: jsii.String("knowledgeBaseType"), Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), RenderingConfiguration: &RenderingConfigurationProperty{ TemplateUri: jsii.String("templateUri"), }, ServerSideEncryptionConfiguration: &ServerSideEncryptionConfigurationProperty{ KmsKeyId: jsii.String("kmsKeyId"), }, SourceConfiguration: &SourceConfigurationProperty{ AppIntegrations: &AppIntegrationsConfigurationProperty{ AppIntegrationArn: jsii.String("appIntegrationArn"), // the properties below are optional ObjectFields: []*string{ jsii.String("objectFields"), }, }, ManagedSourceConfiguration: &ManagedSourceConfigurationProperty{ WebCrawlerConfiguration: &WebCrawlerConfigurationProperty{ UrlConfiguration: &UrlConfigurationProperty{ SeedUrls: []interface{}{ &SeedUrlProperty{ Url: jsii.String("url"), }, }, }, // the properties below are optional CrawlerLimits: &CrawlerLimitsProperty{ RateLimit: jsii.Number(123), }, ExclusionFilters: []*string{ jsii.String("exclusionFilters"), }, InclusionFilters: []*string{ jsii.String("inclusionFilters"), }, Scope: jsii.String("scope"), }, }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VectorIngestionConfiguration: &VectorIngestionConfigurationProperty{ ChunkingConfiguration: &ChunkingConfigurationProperty{ ChunkingStrategy: jsii.String("chunkingStrategy"), // the properties below are optional FixedSizeChunkingConfiguration: &FixedSizeChunkingConfigurationProperty{ MaxTokens: jsii.Number(123), OverlapPercentage: jsii.Number(123), }, HierarchicalChunkingConfiguration: &HierarchicalChunkingConfigurationProperty{ LevelConfigurations: []interface{}{ &HierarchicalChunkingLevelConfigurationProperty{ MaxTokens: jsii.Number(123), }, }, OverlapTokens: jsii.Number(123), }, SemanticChunkingConfiguration: &SemanticChunkingConfigurationProperty{ BreakpointPercentileThreshold: jsii.Number(123), BufferSize: jsii.Number(123), MaxTokens: jsii.Number(123), }, }, ParsingConfiguration: &ParsingConfigurationProperty{ ParsingStrategy: jsii.String("parsingStrategy"), // the properties below are optional BedrockFoundationModelConfiguration: &BedrockFoundationModelConfigurationProperty{ ModelArn: jsii.String("modelArn"), // the properties below are optional ParsingPrompt: &ParsingPromptProperty{ ParsingPromptText: jsii.String("parsingPromptText"), }, }, }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html
func NewCfnKnowledgeBase ¶
func NewCfnKnowledgeBase(scope constructs.Construct, id *string, props *CfnKnowledgeBaseProps) CfnKnowledgeBase
type CfnKnowledgeBaseProps ¶
type CfnKnowledgeBaseProps struct { // The type of knowledge base. // // Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-knowledgebasetype // KnowledgeBaseType *string `field:"required" json:"knowledgeBaseType" yaml:"knowledgeBaseType"` // The name of the knowledge base. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-name // Name *string `field:"required" json:"name" yaml:"name"` // The description. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-description // Description *string `field:"optional" json:"description" yaml:"description"` // Information about how to render the content. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-renderingconfiguration // RenderingConfiguration interface{} `field:"optional" json:"renderingConfiguration" yaml:"renderingConfiguration"` // This customer managed key must have a policy that allows `kms:CreateGrant` and `kms:DescribeKey` permissions to the IAM identity using the key to invoke Wisdom. // // For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) . For information about valid ID values, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) in the *AWS Key Management Service Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-serversideencryptionconfiguration // ServerSideEncryptionConfiguration interface{} `field:"optional" json:"serverSideEncryptionConfiguration" yaml:"serverSideEncryptionConfiguration"` // The source of the knowledge base content. // // Only set this argument for EXTERNAL or Managed knowledge bases. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-sourceconfiguration // SourceConfiguration interface{} `field:"optional" json:"sourceConfiguration" yaml:"sourceConfiguration"` // The tags used to organize, track, or control access for this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // Contains details about how to ingest the documents in a data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-vectoringestionconfiguration // VectorIngestionConfiguration interface{} `field:"optional" json:"vectorIngestionConfiguration" yaml:"vectorIngestionConfiguration"` }
Properties for defining a `CfnKnowledgeBase`.
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" cfnKnowledgeBaseProps := &CfnKnowledgeBaseProps{ KnowledgeBaseType: jsii.String("knowledgeBaseType"), Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), RenderingConfiguration: &RenderingConfigurationProperty{ TemplateUri: jsii.String("templateUri"), }, ServerSideEncryptionConfiguration: &ServerSideEncryptionConfigurationProperty{ KmsKeyId: jsii.String("kmsKeyId"), }, SourceConfiguration: &SourceConfigurationProperty{ AppIntegrations: &AppIntegrationsConfigurationProperty{ AppIntegrationArn: jsii.String("appIntegrationArn"), // the properties below are optional ObjectFields: []*string{ jsii.String("objectFields"), }, }, ManagedSourceConfiguration: &ManagedSourceConfigurationProperty{ WebCrawlerConfiguration: &WebCrawlerConfigurationProperty{ UrlConfiguration: &UrlConfigurationProperty{ SeedUrls: []interface{}{ &SeedUrlProperty{ Url: jsii.String("url"), }, }, }, // the properties below are optional CrawlerLimits: &CrawlerLimitsProperty{ RateLimit: jsii.Number(123), }, ExclusionFilters: []*string{ jsii.String("exclusionFilters"), }, InclusionFilters: []*string{ jsii.String("inclusionFilters"), }, Scope: jsii.String("scope"), }, }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, VectorIngestionConfiguration: &VectorIngestionConfigurationProperty{ ChunkingConfiguration: &ChunkingConfigurationProperty{ ChunkingStrategy: jsii.String("chunkingStrategy"), // the properties below are optional FixedSizeChunkingConfiguration: &FixedSizeChunkingConfigurationProperty{ MaxTokens: jsii.Number(123), OverlapPercentage: jsii.Number(123), }, HierarchicalChunkingConfiguration: &HierarchicalChunkingConfigurationProperty{ LevelConfigurations: []interface{}{ &HierarchicalChunkingLevelConfigurationProperty{ MaxTokens: jsii.Number(123), }, }, OverlapTokens: jsii.Number(123), }, SemanticChunkingConfiguration: &SemanticChunkingConfigurationProperty{ BreakpointPercentileThreshold: jsii.Number(123), BufferSize: jsii.Number(123), MaxTokens: jsii.Number(123), }, }, ParsingConfiguration: &ParsingConfigurationProperty{ ParsingStrategy: jsii.String("parsingStrategy"), // the properties below are optional BedrockFoundationModelConfiguration: &BedrockFoundationModelConfigurationProperty{ ModelArn: jsii.String("modelArn"), // the properties below are optional ParsingPrompt: &ParsingPromptProperty{ ParsingPromptText: jsii.String("parsingPromptText"), }, }, }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html
type CfnKnowledgeBase_AppIntegrationsConfigurationProperty ¶
type CfnKnowledgeBase_AppIntegrationsConfigurationProperty struct { // The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content. // // - For [Salesforce](https://docs.aws.amazon.com/https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm) , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least `Id` , `ArticleNumber` , `VersionNumber` , `Title` , `PublishStatus` , and `IsDeleted` as source fields. // - For [ServiceNow](https://docs.aws.amazon.com/https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api) , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least `number` , `short_description` , `sys_mod_count` , `workflow_state` , and `active` as source fields. // - For [Zendesk](https://docs.aws.amazon.com/https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/) , your AppIntegrations DataIntegration must have an ObjectConfiguration if `objectFields` is not provided, including at least `id` , `title` , `updated_at` , and `draft` as source fields. // - For [SharePoint](https://docs.aws.amazon.com/https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index) , your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among `docx` , `pdf` , `html` , `htm` , and `txt` . // - For [Amazon S3](https://docs.aws.amazon.com/s3/) , the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The `SourceURI` of your DataIntegration must use the following format: `s3://your_s3_bucket_name` . // // > The bucket policy of the corresponding S3 bucket must allow the AWS principal `app-integrations.amazonaws.com` to perform `s3:ListBucket` , `s3:GetObject` , and `s3:GetBucketLocation` against the bucket. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-appintegrationsconfiguration.html#cfn-wisdom-knowledgebase-appintegrationsconfiguration-appintegrationarn // AppIntegrationArn *string `field:"required" json:"appIntegrationArn" yaml:"appIntegrationArn"` // The fields from the source that are made available to your agents in Amazon Q in Connect. // // Optional if ObjectConfiguration is included in the provided DataIntegration. // // - For [Salesforce](https://docs.aws.amazon.com/https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm) , you must include at least `Id` , `ArticleNumber` , `VersionNumber` , `Title` , `PublishStatus` , and `IsDeleted` . // - For [ServiceNow](https://docs.aws.amazon.com/https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api) , you must include at least `number` , `short_description` , `sys_mod_count` , `workflow_state` , and `active` . // - For [Zendesk](https://docs.aws.amazon.com/https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/) , you must include at least `id` , `title` , `updated_at` , and `draft` . // // Make sure to include additional fields. These fields are indexed and used to source recommendations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-appintegrationsconfiguration.html#cfn-wisdom-knowledgebase-appintegrationsconfiguration-objectfields // ObjectFields *[]*string `field:"optional" json:"objectFields" yaml:"objectFields"` }
Configuration information for Amazon AppIntegrations to automatically ingest content.
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" appIntegrationsConfigurationProperty := &AppIntegrationsConfigurationProperty{ AppIntegrationArn: jsii.String("appIntegrationArn"), // the properties below are optional ObjectFields: []*string{ jsii.String("objectFields"), }, }
type CfnKnowledgeBase_BedrockFoundationModelConfigurationProperty ¶ added in v2.172.0
type CfnKnowledgeBase_BedrockFoundationModelConfigurationProperty struct { // The model ARN of the Bedrock foundation model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-bedrockfoundationmodelconfiguration.html#cfn-wisdom-knowledgebase-bedrockfoundationmodelconfiguration-modelarn // ModelArn *string `field:"required" json:"modelArn" yaml:"modelArn"` // The parsing prompt of the Bedrock foundation model configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-bedrockfoundationmodelconfiguration.html#cfn-wisdom-knowledgebase-bedrockfoundationmodelconfiguration-parsingprompt // ParsingPrompt interface{} `field:"optional" json:"parsingPrompt" yaml:"parsingPrompt"` }
The configuration of the Bedrock foundation model.
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" bedrockFoundationModelConfigurationProperty := &BedrockFoundationModelConfigurationProperty{ ModelArn: jsii.String("modelArn"), // the properties below are optional ParsingPrompt: &ParsingPromptProperty{ ParsingPromptText: jsii.String("parsingPromptText"), }, }
type CfnKnowledgeBase_ChunkingConfigurationProperty ¶ added in v2.172.0
type CfnKnowledgeBase_ChunkingConfigurationProperty struct { // Knowledge base can split your source data into chunks. // // A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for `NONE` , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-chunkingconfiguration.html#cfn-wisdom-knowledgebase-chunkingconfiguration-chunkingstrategy // ChunkingStrategy *string `field:"required" json:"chunkingStrategy" yaml:"chunkingStrategy"` // Configurations for when you choose fixed-size chunking. // // If you set the `chunkingStrategy` as `NONE` , exclude this field. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-chunkingconfiguration.html#cfn-wisdom-knowledgebase-chunkingconfiguration-fixedsizechunkingconfiguration // FixedSizeChunkingConfiguration interface{} `field:"optional" json:"fixedSizeChunkingConfiguration" yaml:"fixedSizeChunkingConfiguration"` // Settings for hierarchical document chunking for a data source. // // Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-chunkingconfiguration.html#cfn-wisdom-knowledgebase-chunkingconfiguration-hierarchicalchunkingconfiguration // HierarchicalChunkingConfiguration interface{} `field:"optional" json:"hierarchicalChunkingConfiguration" yaml:"hierarchicalChunkingConfiguration"` // Settings for semantic document chunking for a data source. // // Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-chunkingconfiguration.html#cfn-wisdom-knowledgebase-chunkingconfiguration-semanticchunkingconfiguration // SemanticChunkingConfiguration interface{} `field:"optional" json:"semanticChunkingConfiguration" yaml:"semanticChunkingConfiguration"` }
Details about how to chunk the documents in the data source.
A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
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" chunkingConfigurationProperty := &ChunkingConfigurationProperty{ ChunkingStrategy: jsii.String("chunkingStrategy"), // the properties below are optional FixedSizeChunkingConfiguration: &FixedSizeChunkingConfigurationProperty{ MaxTokens: jsii.Number(123), OverlapPercentage: jsii.Number(123), }, HierarchicalChunkingConfiguration: &HierarchicalChunkingConfigurationProperty{ LevelConfigurations: []interface{}{ &HierarchicalChunkingLevelConfigurationProperty{ MaxTokens: jsii.Number(123), }, }, OverlapTokens: jsii.Number(123), }, SemanticChunkingConfiguration: &SemanticChunkingConfigurationProperty{ BreakpointPercentileThreshold: jsii.Number(123), BufferSize: jsii.Number(123), MaxTokens: jsii.Number(123), }, }
type CfnKnowledgeBase_CrawlerLimitsProperty ¶ added in v2.172.0
type CfnKnowledgeBase_CrawlerLimitsProperty struct { // The limit rate at which the crawler is configured. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-crawlerlimits.html#cfn-wisdom-knowledgebase-crawlerlimits-ratelimit // RateLimit *float64 `field:"optional" json:"rateLimit" yaml:"rateLimit"` }
The limits of the crawler.
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" crawlerLimitsProperty := &CrawlerLimitsProperty{ RateLimit: jsii.Number(123), }
type CfnKnowledgeBase_FixedSizeChunkingConfigurationProperty ¶ added in v2.172.0
type CfnKnowledgeBase_FixedSizeChunkingConfigurationProperty struct { // The maximum number of tokens to include in a chunk. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-fixedsizechunkingconfiguration.html#cfn-wisdom-knowledgebase-fixedsizechunkingconfiguration-maxtokens // MaxTokens *float64 `field:"required" json:"maxTokens" yaml:"maxTokens"` // The percentage of overlap between adjacent chunks of a data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-fixedsizechunkingconfiguration.html#cfn-wisdom-knowledgebase-fixedsizechunkingconfiguration-overlappercentage // OverlapPercentage *float64 `field:"required" json:"overlapPercentage" yaml:"overlapPercentage"` }
Configurations for when you choose fixed-size chunking.
If you set the `chunkingStrategy` as `NONE` , exclude this field.
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" fixedSizeChunkingConfigurationProperty := &FixedSizeChunkingConfigurationProperty{ MaxTokens: jsii.Number(123), OverlapPercentage: jsii.Number(123), }
type CfnKnowledgeBase_HierarchicalChunkingConfigurationProperty ¶ added in v2.172.0
type CfnKnowledgeBase_HierarchicalChunkingConfigurationProperty struct { // Token settings for each layer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-hierarchicalchunkingconfiguration.html#cfn-wisdom-knowledgebase-hierarchicalchunkingconfiguration-levelconfigurations // LevelConfigurations interface{} `field:"required" json:"levelConfigurations" yaml:"levelConfigurations"` // The number of tokens to repeat across chunks in the same layer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-hierarchicalchunkingconfiguration.html#cfn-wisdom-knowledgebase-hierarchicalchunkingconfiguration-overlaptokens // OverlapTokens *float64 `field:"required" json:"overlapTokens" yaml:"overlapTokens"` }
Settings for hierarchical document chunking for a data source.
Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
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" hierarchicalChunkingConfigurationProperty := &HierarchicalChunkingConfigurationProperty{ LevelConfigurations: []interface{}{ &HierarchicalChunkingLevelConfigurationProperty{ MaxTokens: jsii.Number(123), }, }, OverlapTokens: jsii.Number(123), }
type CfnKnowledgeBase_HierarchicalChunkingLevelConfigurationProperty ¶ added in v2.172.0
type CfnKnowledgeBase_HierarchicalChunkingLevelConfigurationProperty struct { // The maximum number of tokens that a chunk can contain in this layer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-hierarchicalchunkinglevelconfiguration.html#cfn-wisdom-knowledgebase-hierarchicalchunkinglevelconfiguration-maxtokens // MaxTokens *float64 `field:"required" json:"maxTokens" yaml:"maxTokens"` }
Token settings for each layer.
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" hierarchicalChunkingLevelConfigurationProperty := &HierarchicalChunkingLevelConfigurationProperty{ MaxTokens: jsii.Number(123), }
type CfnKnowledgeBase_ManagedSourceConfigurationProperty ¶ added in v2.172.0
type CfnKnowledgeBase_ManagedSourceConfigurationProperty struct { // Configuration data for web crawler data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-managedsourceconfiguration.html#cfn-wisdom-knowledgebase-managedsourceconfiguration-webcrawlerconfiguration // WebCrawlerConfiguration interface{} `field:"required" json:"webCrawlerConfiguration" yaml:"webCrawlerConfiguration"` }
Source configuration for managed 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" managedSourceConfigurationProperty := &ManagedSourceConfigurationProperty{ WebCrawlerConfiguration: &WebCrawlerConfigurationProperty{ UrlConfiguration: &UrlConfigurationProperty{ SeedUrls: []interface{}{ &SeedUrlProperty{ Url: jsii.String("url"), }, }, }, // the properties below are optional CrawlerLimits: &CrawlerLimitsProperty{ RateLimit: jsii.Number(123), }, ExclusionFilters: []*string{ jsii.String("exclusionFilters"), }, InclusionFilters: []*string{ jsii.String("inclusionFilters"), }, Scope: jsii.String("scope"), }, }
type CfnKnowledgeBase_ParsingConfigurationProperty ¶ added in v2.172.0
type CfnKnowledgeBase_ParsingConfigurationProperty struct { // The parsing strategy for the data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-parsingconfiguration.html#cfn-wisdom-knowledgebase-parsingconfiguration-parsingstrategy // ParsingStrategy *string `field:"required" json:"parsingStrategy" yaml:"parsingStrategy"` // Settings for a foundation model used to parse documents for a data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-parsingconfiguration.html#cfn-wisdom-knowledgebase-parsingconfiguration-bedrockfoundationmodelconfiguration // BedrockFoundationModelConfiguration interface{} `field:"optional" json:"bedrockFoundationModelConfiguration" yaml:"bedrockFoundationModelConfiguration"` }
Settings for parsing document contents.
By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.
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" parsingConfigurationProperty := &ParsingConfigurationProperty{ ParsingStrategy: jsii.String("parsingStrategy"), // the properties below are optional BedrockFoundationModelConfiguration: &BedrockFoundationModelConfigurationProperty{ ModelArn: jsii.String("modelArn"), // the properties below are optional ParsingPrompt: &ParsingPromptProperty{ ParsingPromptText: jsii.String("parsingPromptText"), }, }, }
type CfnKnowledgeBase_ParsingPromptProperty ¶ added in v2.172.0
type CfnKnowledgeBase_ParsingPromptProperty struct { // Instructions for interpreting the contents of a document. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-parsingprompt.html#cfn-wisdom-knowledgebase-parsingprompt-parsingprompttext // ParsingPromptText *string `field:"required" json:"parsingPromptText" yaml:"parsingPromptText"` }
Instructions for interpreting the contents of a document.
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" parsingPromptProperty := &ParsingPromptProperty{ ParsingPromptText: jsii.String("parsingPromptText"), }
type CfnKnowledgeBase_RenderingConfigurationProperty ¶
type CfnKnowledgeBase_RenderingConfigurationProperty struct { // A URI template containing exactly one variable in `${variableName}` format. // // This can only be set for `EXTERNAL` knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following: // // - Salesforce: `Id` , `ArticleNumber` , `VersionNumber` , `Title` , `PublishStatus` , or `IsDeleted` // - ServiceNow: `number` , `short_description` , `sys_mod_count` , `workflow_state` , or `active` // - Zendesk: `id` , `title` , `updated_at` , or `draft` // // The variable is replaced with the actual value for a piece of content when calling [GetContent](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-renderingconfiguration.html#cfn-wisdom-knowledgebase-renderingconfiguration-templateuri // TemplateUri *string `field:"optional" json:"templateUri" yaml:"templateUri"` }
Information about how to render the content.
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" renderingConfigurationProperty := &RenderingConfigurationProperty{ TemplateUri: jsii.String("templateUri"), }
type CfnKnowledgeBase_SeedUrlProperty ¶ added in v2.172.0
type CfnKnowledgeBase_SeedUrlProperty struct { // URL for crawling. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-seedurl.html#cfn-wisdom-knowledgebase-seedurl-url // Url *string `field:"optional" json:"url" yaml:"url"` }
A URL for crawling.
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" seedUrlProperty := &SeedUrlProperty{ Url: jsii.String("url"), }
type CfnKnowledgeBase_SemanticChunkingConfigurationProperty ¶ added in v2.172.0
type CfnKnowledgeBase_SemanticChunkingConfigurationProperty struct { // The dissimilarity threshold for splitting chunks. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-semanticchunkingconfiguration.html#cfn-wisdom-knowledgebase-semanticchunkingconfiguration-breakpointpercentilethreshold // BreakpointPercentileThreshold *float64 `field:"required" json:"breakpointPercentileThreshold" yaml:"breakpointPercentileThreshold"` // The buffer size. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-semanticchunkingconfiguration.html#cfn-wisdom-knowledgebase-semanticchunkingconfiguration-buffersize // BufferSize *float64 `field:"required" json:"bufferSize" yaml:"bufferSize"` // The maximum number of tokens that a chunk can contain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-semanticchunkingconfiguration.html#cfn-wisdom-knowledgebase-semanticchunkingconfiguration-maxtokens // MaxTokens *float64 `field:"required" json:"maxTokens" yaml:"maxTokens"` }
Settings for semantic document chunking for a data source.
Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.
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" semanticChunkingConfigurationProperty := &SemanticChunkingConfigurationProperty{ BreakpointPercentileThreshold: jsii.Number(123), BufferSize: jsii.Number(123), MaxTokens: jsii.Number(123), }
type CfnKnowledgeBase_ServerSideEncryptionConfigurationProperty ¶
type CfnKnowledgeBase_ServerSideEncryptionConfigurationProperty struct { // The customer managed key used for encryption. // // This customer managed key must have a policy that allows `kms:CreateGrant` and `kms:DescribeKey` permissions to the IAM identity using the key to invoke Wisdom. // // For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) . For information about valid ID values, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-serversideencryptionconfiguration.html#cfn-wisdom-knowledgebase-serversideencryptionconfiguration-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The configuration information for the customer managed key used for encryption.
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" serverSideEncryptionConfigurationProperty := &ServerSideEncryptionConfigurationProperty{ KmsKeyId: jsii.String("kmsKeyId"), }
type CfnKnowledgeBase_SourceConfigurationProperty ¶
type CfnKnowledgeBase_SourceConfigurationProperty struct { // Configuration information for Amazon AppIntegrations to automatically ingest content. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-sourceconfiguration.html#cfn-wisdom-knowledgebase-sourceconfiguration-appintegrations // AppIntegrations interface{} `field:"optional" json:"appIntegrations" yaml:"appIntegrations"` // Source configuration for managed resources. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-sourceconfiguration.html#cfn-wisdom-knowledgebase-sourceconfiguration-managedsourceconfiguration // ManagedSourceConfiguration interface{} `field:"optional" json:"managedSourceConfiguration" yaml:"managedSourceConfiguration"` }
Configuration information about the external data source.
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" sourceConfigurationProperty := &SourceConfigurationProperty{ AppIntegrations: &AppIntegrationsConfigurationProperty{ AppIntegrationArn: jsii.String("appIntegrationArn"), // the properties below are optional ObjectFields: []*string{ jsii.String("objectFields"), }, }, ManagedSourceConfiguration: &ManagedSourceConfigurationProperty{ WebCrawlerConfiguration: &WebCrawlerConfigurationProperty{ UrlConfiguration: &UrlConfigurationProperty{ SeedUrls: []interface{}{ &SeedUrlProperty{ Url: jsii.String("url"), }, }, }, // the properties below are optional CrawlerLimits: &CrawlerLimitsProperty{ RateLimit: jsii.Number(123), }, ExclusionFilters: []*string{ jsii.String("exclusionFilters"), }, InclusionFilters: []*string{ jsii.String("inclusionFilters"), }, Scope: jsii.String("scope"), }, }, }
type CfnKnowledgeBase_UrlConfigurationProperty ¶ added in v2.172.0
type CfnKnowledgeBase_UrlConfigurationProperty struct { // List of URLs for crawling. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-urlconfiguration.html#cfn-wisdom-knowledgebase-urlconfiguration-seedurls // SeedUrls interface{} `field:"optional" json:"seedUrls" yaml:"seedUrls"` }
The configuration of the URL/URLs for the web content that you want to crawl.
You should be authorized to crawl the URLs.
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" urlConfigurationProperty := &UrlConfigurationProperty{ SeedUrls: []interface{}{ &SeedUrlProperty{ Url: jsii.String("url"), }, }, }
type CfnKnowledgeBase_VectorIngestionConfigurationProperty ¶ added in v2.172.0
type CfnKnowledgeBase_VectorIngestionConfigurationProperty struct { // Details about how to chunk the documents in the data source. // // A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-vectoringestionconfiguration.html#cfn-wisdom-knowledgebase-vectoringestionconfiguration-chunkingconfiguration // ChunkingConfiguration interface{} `field:"optional" json:"chunkingConfiguration" yaml:"chunkingConfiguration"` // A custom parser for data source documents. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-vectoringestionconfiguration.html#cfn-wisdom-knowledgebase-vectoringestionconfiguration-parsingconfiguration // ParsingConfiguration interface{} `field:"optional" json:"parsingConfiguration" yaml:"parsingConfiguration"` }
Contains details about how to ingest the documents in a data source.
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" vectorIngestionConfigurationProperty := &VectorIngestionConfigurationProperty{ ChunkingConfiguration: &ChunkingConfigurationProperty{ ChunkingStrategy: jsii.String("chunkingStrategy"), // the properties below are optional FixedSizeChunkingConfiguration: &FixedSizeChunkingConfigurationProperty{ MaxTokens: jsii.Number(123), OverlapPercentage: jsii.Number(123), }, HierarchicalChunkingConfiguration: &HierarchicalChunkingConfigurationProperty{ LevelConfigurations: []interface{}{ &HierarchicalChunkingLevelConfigurationProperty{ MaxTokens: jsii.Number(123), }, }, OverlapTokens: jsii.Number(123), }, SemanticChunkingConfiguration: &SemanticChunkingConfigurationProperty{ BreakpointPercentileThreshold: jsii.Number(123), BufferSize: jsii.Number(123), MaxTokens: jsii.Number(123), }, }, ParsingConfiguration: &ParsingConfigurationProperty{ ParsingStrategy: jsii.String("parsingStrategy"), // the properties below are optional BedrockFoundationModelConfiguration: &BedrockFoundationModelConfigurationProperty{ ModelArn: jsii.String("modelArn"), // the properties below are optional ParsingPrompt: &ParsingPromptProperty{ ParsingPromptText: jsii.String("parsingPromptText"), }, }, }, }
type CfnKnowledgeBase_WebCrawlerConfigurationProperty ¶ added in v2.172.0
type CfnKnowledgeBase_WebCrawlerConfigurationProperty struct { // The configuration of the URL/URLs for the web content that you want to crawl. // // You should be authorized to crawl the URLs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-webcrawlerconfiguration.html#cfn-wisdom-knowledgebase-webcrawlerconfiguration-urlconfiguration // UrlConfiguration interface{} `field:"required" json:"urlConfiguration" yaml:"urlConfiguration"` // The configuration of crawl limits for the web URLs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-webcrawlerconfiguration.html#cfn-wisdom-knowledgebase-webcrawlerconfiguration-crawlerlimits // CrawlerLimits interface{} `field:"optional" json:"crawlerLimits" yaml:"crawlerLimits"` // A list of one or more exclusion regular expression patterns to exclude certain URLs. // // If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-webcrawlerconfiguration.html#cfn-wisdom-knowledgebase-webcrawlerconfiguration-exclusionfilters // ExclusionFilters *[]*string `field:"optional" json:"exclusionFilters" yaml:"exclusionFilters"` // A list of one or more inclusion regular expression patterns to include certain URLs. // // If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-webcrawlerconfiguration.html#cfn-wisdom-knowledgebase-webcrawlerconfiguration-inclusionfilters // InclusionFilters *[]*string `field:"optional" json:"inclusionFilters" yaml:"inclusionFilters"` // The scope of what is crawled for your URLs. // // You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL `https://docs.aws.amazon.com/bedrock/latest/userguide/` and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain `aws.amazon.com` can also include sub domain `docs.aws.amazon.com` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-webcrawlerconfiguration.html#cfn-wisdom-knowledgebase-webcrawlerconfiguration-scope // Scope *string `field:"optional" json:"scope" yaml:"scope"` }
The configuration details for the web data source.
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" webCrawlerConfigurationProperty := &WebCrawlerConfigurationProperty{ UrlConfiguration: &UrlConfigurationProperty{ SeedUrls: []interface{}{ &SeedUrlProperty{ Url: jsii.String("url"), }, }, }, // the properties below are optional CrawlerLimits: &CrawlerLimitsProperty{ RateLimit: jsii.Number(123), }, ExclusionFilters: []*string{ jsii.String("exclusionFilters"), }, InclusionFilters: []*string{ jsii.String("inclusionFilters"), }, Scope: jsii.String("scope"), }
type CfnMessageTemplate ¶ added in v2.172.0
type CfnMessageTemplate interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name (ARN) of the message template. AttrMessageTemplateArn() *string // The checksum value of the message template content that is referenced by the `$LATEST` qualifier. // // It can be returned in `MessageTemplateData` or `ExtendedMessageTemplateData` . It’s calculated by content, language, `defaultAttributes` and `Attachments` of the message template. AttrMessageTemplateContentSha256() *string // The identifier of the message template. AttrMessageTemplateId() *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{} // AWS resource type. CfnResourceType() *string // The channel subtype this message template applies to. ChannelSubtype() *string SetChannelSubtype(val *string) // The content of the message template. Content() interface{} SetContent(val interface{}) // 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 // An object that specifies the default values to use for variables in the message template. DefaultAttributes() interface{} SetDefaultAttributes(val interface{}) // The description of the message template. Description() *string SetDescription(val *string) // The configuration information of the external data source. GroupingConfiguration() interface{} SetGroupingConfiguration(val interface{}) // The Amazon Resource Name (ARN) of the knowledge base. KnowledgeBaseArn() *string SetKnowledgeBaseArn(val *string) // The language code value for the language in which the quick response is written. Language() *string SetLanguage(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 message template. 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 used to organize, track, or control access for this resource. 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) // 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{}) }
Creates an Amazon Q in Connect message template.
The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the `$LATEST` qualifier to reference the created message template.
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" cfnMessageTemplate := awscdk.Aws_wisdom.NewCfnMessageTemplate(this, jsii.String("MyCfnMessageTemplate"), &CfnMessageTemplateProps{ ChannelSubtype: jsii.String("channelSubtype"), Content: &ContentProperty{ EmailMessageTemplateContent: &EmailMessageTemplateContentProperty{ Body: &EmailMessageTemplateContentBodyProperty{ Html: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, PlainText: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, }, Headers: []interface{}{ &EmailMessageTemplateHeaderProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, Subject: jsii.String("subject"), }, SmsMessageTemplateContent: &SmsMessageTemplateContentProperty{ Body: &SmsMessageTemplateContentBodyProperty{ PlainText: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, }, }, }, KnowledgeBaseArn: jsii.String("knowledgeBaseArn"), Name: jsii.String("name"), // the properties below are optional DefaultAttributes: &MessageTemplateAttributesProperty{ AgentAttributes: &AgentAttributesProperty{ FirstName: jsii.String("firstName"), LastName: jsii.String("lastName"), }, CustomAttributes: map[string]*string{ "customAttributesKey": jsii.String("customAttributes"), }, CustomerProfileAttributes: &CustomerProfileAttributesProperty{ AccountNumber: jsii.String("accountNumber"), AdditionalInformation: jsii.String("additionalInformation"), Address1: jsii.String("address1"), Address2: jsii.String("address2"), Address3: jsii.String("address3"), Address4: jsii.String("address4"), BillingAddress1: jsii.String("billingAddress1"), BillingAddress2: jsii.String("billingAddress2"), BillingAddress3: jsii.String("billingAddress3"), BillingAddress4: jsii.String("billingAddress4"), BillingCity: jsii.String("billingCity"), BillingCountry: jsii.String("billingCountry"), BillingCounty: jsii.String("billingCounty"), BillingPostalCode: jsii.String("billingPostalCode"), BillingProvince: jsii.String("billingProvince"), BillingState: jsii.String("billingState"), BirthDate: jsii.String("birthDate"), BusinessEmailAddress: jsii.String("businessEmailAddress"), BusinessName: jsii.String("businessName"), BusinessPhoneNumber: jsii.String("businessPhoneNumber"), City: jsii.String("city"), Country: jsii.String("country"), County: jsii.String("county"), Custom: map[string]*string{ "customKey": jsii.String("custom"), }, EmailAddress: jsii.String("emailAddress"), FirstName: jsii.String("firstName"), Gender: jsii.String("gender"), HomePhoneNumber: jsii.String("homePhoneNumber"), LastName: jsii.String("lastName"), MailingAddress1: jsii.String("mailingAddress1"), MailingAddress2: jsii.String("mailingAddress2"), MailingAddress3: jsii.String("mailingAddress3"), MailingAddress4: jsii.String("mailingAddress4"), MailingCity: jsii.String("mailingCity"), MailingCountry: jsii.String("mailingCountry"), MailingCounty: jsii.String("mailingCounty"), MailingPostalCode: jsii.String("mailingPostalCode"), MailingProvince: jsii.String("mailingProvince"), MailingState: jsii.String("mailingState"), MiddleName: jsii.String("middleName"), MobilePhoneNumber: jsii.String("mobilePhoneNumber"), PartyType: jsii.String("partyType"), PhoneNumber: jsii.String("phoneNumber"), PostalCode: jsii.String("postalCode"), ProfileArn: jsii.String("profileArn"), ProfileId: jsii.String("profileId"), Province: jsii.String("province"), ShippingAddress1: jsii.String("shippingAddress1"), ShippingAddress2: jsii.String("shippingAddress2"), ShippingAddress3: jsii.String("shippingAddress3"), ShippingAddress4: jsii.String("shippingAddress4"), ShippingCity: jsii.String("shippingCity"), ShippingCountry: jsii.String("shippingCountry"), ShippingCounty: jsii.String("shippingCounty"), ShippingPostalCode: jsii.String("shippingPostalCode"), ShippingProvince: jsii.String("shippingProvince"), ShippingState: jsii.String("shippingState"), State: jsii.String("state"), }, SystemAttributes: &SystemAttributesProperty{ CustomerEndpoint: &SystemEndpointAttributesProperty{ Address: jsii.String("address"), }, Name: jsii.String("name"), SystemEndpoint: &SystemEndpointAttributesProperty{ Address: jsii.String("address"), }, }, }, Description: jsii.String("description"), GroupingConfiguration: &GroupingConfigurationProperty{ Criteria: jsii.String("criteria"), Values: []*string{ jsii.String("values"), }, }, Language: jsii.String("language"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnMessageTemplate ¶ added in v2.172.0
func NewCfnMessageTemplate(scope constructs.Construct, id *string, props *CfnMessageTemplateProps) CfnMessageTemplate
type CfnMessageTemplateProps ¶ added in v2.172.0
type CfnMessageTemplateProps struct { // The channel subtype this message template applies to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplate.html#cfn-wisdom-messagetemplate-channelsubtype // ChannelSubtype *string `field:"required" json:"channelSubtype" yaml:"channelSubtype"` // The content of the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplate.html#cfn-wisdom-messagetemplate-content // Content interface{} `field:"required" json:"content" yaml:"content"` // The Amazon Resource Name (ARN) of the knowledge base. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplate.html#cfn-wisdom-messagetemplate-knowledgebasearn // KnowledgeBaseArn *string `field:"required" json:"knowledgeBaseArn" yaml:"knowledgeBaseArn"` // The name of the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplate.html#cfn-wisdom-messagetemplate-name // Name *string `field:"required" json:"name" yaml:"name"` // An object that specifies the default values to use for variables in the message template. // // This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplate.html#cfn-wisdom-messagetemplate-defaultattributes // DefaultAttributes interface{} `field:"optional" json:"defaultAttributes" yaml:"defaultAttributes"` // The description of the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplate.html#cfn-wisdom-messagetemplate-description // Description *string `field:"optional" json:"description" yaml:"description"` // The configuration information of the external data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplate.html#cfn-wisdom-messagetemplate-groupingconfiguration // GroupingConfiguration interface{} `field:"optional" json:"groupingConfiguration" yaml:"groupingConfiguration"` // The language code value for the language in which the quick response is written. // // The supported language codes include `de_DE` , `en_US` , `es_ES` , `fr_FR` , `id_ID` , `it_IT` , `ja_JP` , `ko_KR` , `pt_BR` , `zh_CN` , `zh_TW`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplate.html#cfn-wisdom-messagetemplate-language // Language *string `field:"optional" json:"language" yaml:"language"` // The tags used to organize, track, or control access for this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplate.html#cfn-wisdom-messagetemplate-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnMessageTemplate`.
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" cfnMessageTemplateProps := &CfnMessageTemplateProps{ ChannelSubtype: jsii.String("channelSubtype"), Content: &ContentProperty{ EmailMessageTemplateContent: &EmailMessageTemplateContentProperty{ Body: &EmailMessageTemplateContentBodyProperty{ Html: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, PlainText: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, }, Headers: []interface{}{ &EmailMessageTemplateHeaderProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, Subject: jsii.String("subject"), }, SmsMessageTemplateContent: &SmsMessageTemplateContentProperty{ Body: &SmsMessageTemplateContentBodyProperty{ PlainText: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, }, }, }, KnowledgeBaseArn: jsii.String("knowledgeBaseArn"), Name: jsii.String("name"), // the properties below are optional DefaultAttributes: &MessageTemplateAttributesProperty{ AgentAttributes: &AgentAttributesProperty{ FirstName: jsii.String("firstName"), LastName: jsii.String("lastName"), }, CustomAttributes: map[string]*string{ "customAttributesKey": jsii.String("customAttributes"), }, CustomerProfileAttributes: &CustomerProfileAttributesProperty{ AccountNumber: jsii.String("accountNumber"), AdditionalInformation: jsii.String("additionalInformation"), Address1: jsii.String("address1"), Address2: jsii.String("address2"), Address3: jsii.String("address3"), Address4: jsii.String("address4"), BillingAddress1: jsii.String("billingAddress1"), BillingAddress2: jsii.String("billingAddress2"), BillingAddress3: jsii.String("billingAddress3"), BillingAddress4: jsii.String("billingAddress4"), BillingCity: jsii.String("billingCity"), BillingCountry: jsii.String("billingCountry"), BillingCounty: jsii.String("billingCounty"), BillingPostalCode: jsii.String("billingPostalCode"), BillingProvince: jsii.String("billingProvince"), BillingState: jsii.String("billingState"), BirthDate: jsii.String("birthDate"), BusinessEmailAddress: jsii.String("businessEmailAddress"), BusinessName: jsii.String("businessName"), BusinessPhoneNumber: jsii.String("businessPhoneNumber"), City: jsii.String("city"), Country: jsii.String("country"), County: jsii.String("county"), Custom: map[string]*string{ "customKey": jsii.String("custom"), }, EmailAddress: jsii.String("emailAddress"), FirstName: jsii.String("firstName"), Gender: jsii.String("gender"), HomePhoneNumber: jsii.String("homePhoneNumber"), LastName: jsii.String("lastName"), MailingAddress1: jsii.String("mailingAddress1"), MailingAddress2: jsii.String("mailingAddress2"), MailingAddress3: jsii.String("mailingAddress3"), MailingAddress4: jsii.String("mailingAddress4"), MailingCity: jsii.String("mailingCity"), MailingCountry: jsii.String("mailingCountry"), MailingCounty: jsii.String("mailingCounty"), MailingPostalCode: jsii.String("mailingPostalCode"), MailingProvince: jsii.String("mailingProvince"), MailingState: jsii.String("mailingState"), MiddleName: jsii.String("middleName"), MobilePhoneNumber: jsii.String("mobilePhoneNumber"), PartyType: jsii.String("partyType"), PhoneNumber: jsii.String("phoneNumber"), PostalCode: jsii.String("postalCode"), ProfileArn: jsii.String("profileArn"), ProfileId: jsii.String("profileId"), Province: jsii.String("province"), ShippingAddress1: jsii.String("shippingAddress1"), ShippingAddress2: jsii.String("shippingAddress2"), ShippingAddress3: jsii.String("shippingAddress3"), ShippingAddress4: jsii.String("shippingAddress4"), ShippingCity: jsii.String("shippingCity"), ShippingCountry: jsii.String("shippingCountry"), ShippingCounty: jsii.String("shippingCounty"), ShippingPostalCode: jsii.String("shippingPostalCode"), ShippingProvince: jsii.String("shippingProvince"), ShippingState: jsii.String("shippingState"), State: jsii.String("state"), }, SystemAttributes: &SystemAttributesProperty{ CustomerEndpoint: &SystemEndpointAttributesProperty{ Address: jsii.String("address"), }, Name: jsii.String("name"), SystemEndpoint: &SystemEndpointAttributesProperty{ Address: jsii.String("address"), }, }, }, Description: jsii.String("description"), GroupingConfiguration: &GroupingConfigurationProperty{ Criteria: jsii.String("criteria"), Values: []*string{ jsii.String("values"), }, }, Language: jsii.String("language"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnMessageTemplateVersion ¶ added in v2.172.0
type CfnMessageTemplateVersion interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) of the Message Template Version. AttrMessageTemplateVersionArn() *string // The version number for this Message Template Version. AttrMessageTemplateVersionNumber() awscdk.IResolvable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // 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 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 Amazon Resource Name (ARN) of the message template. MessageTemplateArn() *string SetMessageTemplateArn(val *string) // The content SHA256 of the message template. MessageTemplateContentSha256() *string SetMessageTemplateContentSha256(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 // 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) // 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{}) }
Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template.
Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in `<messageTemplateArn>:<versionNumber>` as the message template identifier. An error is displayed if the supplied `messageTemplateContentSha256` is different from the `messageTemplateContentSha256` of the message template with `$LATEST` qualifier. If multiple `CreateMessageTemplateVersion` requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.
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" cfnMessageTemplateVersion := awscdk.Aws_wisdom.NewCfnMessageTemplateVersion(this, jsii.String("MyCfnMessageTemplateVersion"), &CfnMessageTemplateVersionProps{ MessageTemplateArn: jsii.String("messageTemplateArn"), // the properties below are optional MessageTemplateContentSha256: jsii.String("messageTemplateContentSha256"), })
func NewCfnMessageTemplateVersion ¶ added in v2.172.0
func NewCfnMessageTemplateVersion(scope constructs.Construct, id *string, props *CfnMessageTemplateVersionProps) CfnMessageTemplateVersion
type CfnMessageTemplateVersionProps ¶ added in v2.172.0
type CfnMessageTemplateVersionProps struct { // The Amazon Resource Name (ARN) of the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplateversion.html#cfn-wisdom-messagetemplateversion-messagetemplatearn // MessageTemplateArn *string `field:"required" json:"messageTemplateArn" yaml:"messageTemplateArn"` // The content SHA256 of the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplateversion.html#cfn-wisdom-messagetemplateversion-messagetemplatecontentsha256 // MessageTemplateContentSha256 *string `field:"optional" json:"messageTemplateContentSha256" yaml:"messageTemplateContentSha256"` }
Properties for defining a `CfnMessageTemplateVersion`.
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" cfnMessageTemplateVersionProps := &CfnMessageTemplateVersionProps{ MessageTemplateArn: jsii.String("messageTemplateArn"), // the properties below are optional MessageTemplateContentSha256: jsii.String("messageTemplateContentSha256"), }
type CfnMessageTemplate_AgentAttributesProperty ¶ added in v2.172.0
type CfnMessageTemplate_AgentAttributesProperty struct { // The agent’s first name as entered in their Amazon Connect user account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-agentattributes.html#cfn-wisdom-messagetemplate-agentattributes-firstname // FirstName *string `field:"optional" json:"firstName" yaml:"firstName"` // The agent’s last name as entered in their Amazon Connect user account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-agentattributes.html#cfn-wisdom-messagetemplate-agentattributes-lastname // LastName *string `field:"optional" json:"lastName" yaml:"lastName"` }
Information about an 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" agentAttributesProperty := &AgentAttributesProperty{ FirstName: jsii.String("firstName"), LastName: jsii.String("lastName"), }
type CfnMessageTemplate_ContentProperty ¶ added in v2.172.0
type CfnMessageTemplate_ContentProperty struct { // The content of the message template that applies to the email channel subtype. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-content.html#cfn-wisdom-messagetemplate-content-emailmessagetemplatecontent // EmailMessageTemplateContent interface{} `field:"optional" json:"emailMessageTemplateContent" yaml:"emailMessageTemplateContent"` // The content of message template that applies to SMS channel subtype. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-content.html#cfn-wisdom-messagetemplate-content-smsmessagetemplatecontent // SmsMessageTemplateContent interface{} `field:"optional" json:"smsMessageTemplateContent" yaml:"smsMessageTemplateContent"` }
The content of the message template.
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" contentProperty := &ContentProperty{ EmailMessageTemplateContent: &EmailMessageTemplateContentProperty{ Body: &EmailMessageTemplateContentBodyProperty{ Html: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, PlainText: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, }, Headers: []interface{}{ &EmailMessageTemplateHeaderProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, Subject: jsii.String("subject"), }, SmsMessageTemplateContent: &SmsMessageTemplateContentProperty{ Body: &SmsMessageTemplateContentBodyProperty{ PlainText: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, }, }, }
type CfnMessageTemplate_CustomerProfileAttributesProperty ¶ added in v2.172.0
type CfnMessageTemplate_CustomerProfileAttributesProperty struct { // A unique account number that you have given to the customer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-accountnumber // AccountNumber *string `field:"optional" json:"accountNumber" yaml:"accountNumber"` // Any additional information relevant to the customer's profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-additionalinformation // AdditionalInformation *string `field:"optional" json:"additionalInformation" yaml:"additionalInformation"` // The first line of a customer address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-address1 // Address1 *string `field:"optional" json:"address1" yaml:"address1"` // The second line of a customer address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-address2 // Address2 *string `field:"optional" json:"address2" yaml:"address2"` // The third line of a customer address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-address3 // Address3 *string `field:"optional" json:"address3" yaml:"address3"` // The fourth line of a customer address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-address4 // Address4 *string `field:"optional" json:"address4" yaml:"address4"` // The first line of a customer’s billing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingaddress1 // BillingAddress1 *string `field:"optional" json:"billingAddress1" yaml:"billingAddress1"` // The second line of a customer’s billing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingaddress2 // BillingAddress2 *string `field:"optional" json:"billingAddress2" yaml:"billingAddress2"` // The third line of a customer’s billing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingaddress3 // BillingAddress3 *string `field:"optional" json:"billingAddress3" yaml:"billingAddress3"` // The fourth line of a customer’s billing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingaddress4 // BillingAddress4 *string `field:"optional" json:"billingAddress4" yaml:"billingAddress4"` // The city of a customer’s billing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingcity // BillingCity *string `field:"optional" json:"billingCity" yaml:"billingCity"` // The country of a customer’s billing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingcountry // BillingCountry *string `field:"optional" json:"billingCountry" yaml:"billingCountry"` // The county of a customer’s billing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingcounty // BillingCounty *string `field:"optional" json:"billingCounty" yaml:"billingCounty"` // The postal code of a customer’s billing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingpostalcode // BillingPostalCode *string `field:"optional" json:"billingPostalCode" yaml:"billingPostalCode"` // The province of a customer’s billing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingprovince // BillingProvince *string `field:"optional" json:"billingProvince" yaml:"billingProvince"` // The state of a customer’s billing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingstate // BillingState *string `field:"optional" json:"billingState" yaml:"billingState"` // The customer's birth date. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-birthdate // BirthDate *string `field:"optional" json:"birthDate" yaml:"birthDate"` // The customer's business email address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-businessemailaddress // BusinessEmailAddress *string `field:"optional" json:"businessEmailAddress" yaml:"businessEmailAddress"` // The name of the customer's business. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-businessname // BusinessName *string `field:"optional" json:"businessName" yaml:"businessName"` // The customer's business phone number. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-businessphonenumber // BusinessPhoneNumber *string `field:"optional" json:"businessPhoneNumber" yaml:"businessPhoneNumber"` // The city in which a customer lives. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-city // City *string `field:"optional" json:"city" yaml:"city"` // The country in which a customer lives. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-country // Country *string `field:"optional" json:"country" yaml:"country"` // The county in which a customer lives. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-county // County *string `field:"optional" json:"county" yaml:"county"` // The custom attributes in customer profile attributes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-custom // Custom interface{} `field:"optional" json:"custom" yaml:"custom"` // The customer's email address, which has not been specified as a personal or business address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-emailaddress // EmailAddress *string `field:"optional" json:"emailAddress" yaml:"emailAddress"` // The customer's first name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-firstname // FirstName *string `field:"optional" json:"firstName" yaml:"firstName"` // The customer's gender. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-gender // Gender *string `field:"optional" json:"gender" yaml:"gender"` // The customer's mobile phone number. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-homephonenumber // HomePhoneNumber *string `field:"optional" json:"homePhoneNumber" yaml:"homePhoneNumber"` // The customer's last name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-lastname // LastName *string `field:"optional" json:"lastName" yaml:"lastName"` // The first line of a customer’s mailing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingaddress1 // MailingAddress1 *string `field:"optional" json:"mailingAddress1" yaml:"mailingAddress1"` // The second line of a customer’s mailing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingaddress2 // MailingAddress2 *string `field:"optional" json:"mailingAddress2" yaml:"mailingAddress2"` // The third line of a customer’s mailing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingaddress3 // MailingAddress3 *string `field:"optional" json:"mailingAddress3" yaml:"mailingAddress3"` // The fourth line of a customer’s mailing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingaddress4 // MailingAddress4 *string `field:"optional" json:"mailingAddress4" yaml:"mailingAddress4"` // The city of a customer’s mailing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingcity // MailingCity *string `field:"optional" json:"mailingCity" yaml:"mailingCity"` // The country of a customer’s mailing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingcountry // MailingCountry *string `field:"optional" json:"mailingCountry" yaml:"mailingCountry"` // The county of a customer’s mailing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingcounty // MailingCounty *string `field:"optional" json:"mailingCounty" yaml:"mailingCounty"` // The postal code of a customer’s mailing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingpostalcode // MailingPostalCode *string `field:"optional" json:"mailingPostalCode" yaml:"mailingPostalCode"` // The province of a customer’s mailing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingprovince // MailingProvince *string `field:"optional" json:"mailingProvince" yaml:"mailingProvince"` // The state of a customer’s mailing address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingstate // MailingState *string `field:"optional" json:"mailingState" yaml:"mailingState"` // The customer's middle name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-middlename // MiddleName *string `field:"optional" json:"middleName" yaml:"middleName"` // The customer's mobile phone number. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mobilephonenumber // MobilePhoneNumber *string `field:"optional" json:"mobilePhoneNumber" yaml:"mobilePhoneNumber"` // The customer's party type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-partytype // PartyType *string `field:"optional" json:"partyType" yaml:"partyType"` // The customer's phone number, which has not been specified as a mobile, home, or business number. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-phonenumber // PhoneNumber *string `field:"optional" json:"phoneNumber" yaml:"phoneNumber"` // The postal code of a customer address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-postalcode // PostalCode *string `field:"optional" json:"postalCode" yaml:"postalCode"` // The ARN of a customer profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-profilearn // ProfileArn *string `field:"optional" json:"profileArn" yaml:"profileArn"` // The unique identifier of a customer profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-profileid // ProfileId *string `field:"optional" json:"profileId" yaml:"profileId"` // The province in which a customer lives. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-province // Province *string `field:"optional" json:"province" yaml:"province"` // The first line of a customer’s shipping address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingaddress1 // ShippingAddress1 *string `field:"optional" json:"shippingAddress1" yaml:"shippingAddress1"` // The second line of a customer’s shipping address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingaddress2 // ShippingAddress2 *string `field:"optional" json:"shippingAddress2" yaml:"shippingAddress2"` // The third line of a customer’s shipping address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingaddress3 // ShippingAddress3 *string `field:"optional" json:"shippingAddress3" yaml:"shippingAddress3"` // The fourth line of a customer’s shipping address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingaddress4 // ShippingAddress4 *string `field:"optional" json:"shippingAddress4" yaml:"shippingAddress4"` // The city of a customer’s shipping address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingcity // ShippingCity *string `field:"optional" json:"shippingCity" yaml:"shippingCity"` // The country of a customer’s shipping address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingcountry // ShippingCountry *string `field:"optional" json:"shippingCountry" yaml:"shippingCountry"` // The county of a customer’s shipping address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingcounty // ShippingCounty *string `field:"optional" json:"shippingCounty" yaml:"shippingCounty"` // The postal code of a customer’s shipping address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingpostalcode // ShippingPostalCode *string `field:"optional" json:"shippingPostalCode" yaml:"shippingPostalCode"` // The province of a customer’s shipping address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingprovince // ShippingProvince *string `field:"optional" json:"shippingProvince" yaml:"shippingProvince"` // The state of a customer’s shipping address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingstate // ShippingState *string `field:"optional" json:"shippingState" yaml:"shippingState"` // The state in which a customer lives. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-state // State *string `field:"optional" json:"state" yaml:"state"` }
The customer profile attributes that are used with the message template.
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" customerProfileAttributesProperty := &CustomerProfileAttributesProperty{ AccountNumber: jsii.String("accountNumber"), AdditionalInformation: jsii.String("additionalInformation"), Address1: jsii.String("address1"), Address2: jsii.String("address2"), Address3: jsii.String("address3"), Address4: jsii.String("address4"), BillingAddress1: jsii.String("billingAddress1"), BillingAddress2: jsii.String("billingAddress2"), BillingAddress3: jsii.String("billingAddress3"), BillingAddress4: jsii.String("billingAddress4"), BillingCity: jsii.String("billingCity"), BillingCountry: jsii.String("billingCountry"), BillingCounty: jsii.String("billingCounty"), BillingPostalCode: jsii.String("billingPostalCode"), BillingProvince: jsii.String("billingProvince"), BillingState: jsii.String("billingState"), BirthDate: jsii.String("birthDate"), BusinessEmailAddress: jsii.String("businessEmailAddress"), BusinessName: jsii.String("businessName"), BusinessPhoneNumber: jsii.String("businessPhoneNumber"), City: jsii.String("city"), Country: jsii.String("country"), County: jsii.String("county"), Custom: map[string]*string{ "customKey": jsii.String("custom"), }, EmailAddress: jsii.String("emailAddress"), FirstName: jsii.String("firstName"), Gender: jsii.String("gender"), HomePhoneNumber: jsii.String("homePhoneNumber"), LastName: jsii.String("lastName"), MailingAddress1: jsii.String("mailingAddress1"), MailingAddress2: jsii.String("mailingAddress2"), MailingAddress3: jsii.String("mailingAddress3"), MailingAddress4: jsii.String("mailingAddress4"), MailingCity: jsii.String("mailingCity"), MailingCountry: jsii.String("mailingCountry"), MailingCounty: jsii.String("mailingCounty"), MailingPostalCode: jsii.String("mailingPostalCode"), MailingProvince: jsii.String("mailingProvince"), MailingState: jsii.String("mailingState"), MiddleName: jsii.String("middleName"), MobilePhoneNumber: jsii.String("mobilePhoneNumber"), PartyType: jsii.String("partyType"), PhoneNumber: jsii.String("phoneNumber"), PostalCode: jsii.String("postalCode"), ProfileArn: jsii.String("profileArn"), ProfileId: jsii.String("profileId"), Province: jsii.String("province"), ShippingAddress1: jsii.String("shippingAddress1"), ShippingAddress2: jsii.String("shippingAddress2"), ShippingAddress3: jsii.String("shippingAddress3"), ShippingAddress4: jsii.String("shippingAddress4"), ShippingCity: jsii.String("shippingCity"), ShippingCountry: jsii.String("shippingCountry"), ShippingCounty: jsii.String("shippingCounty"), ShippingPostalCode: jsii.String("shippingPostalCode"), ShippingProvince: jsii.String("shippingProvince"), ShippingState: jsii.String("shippingState"), State: jsii.String("state"), }
type CfnMessageTemplate_EmailMessageTemplateContentBodyProperty ¶ added in v2.172.0
type CfnMessageTemplate_EmailMessageTemplateContentBodyProperty struct { // The message body, in HTML format, to use in email messages that are based on the message template. // // We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontentbody.html#cfn-wisdom-messagetemplate-emailmessagetemplatecontentbody-html // Html interface{} `field:"optional" json:"html" yaml:"html"` // The message body, in plain text format, to use in email messages that are based on the message template. // // We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontentbody.html#cfn-wisdom-messagetemplate-emailmessagetemplatecontentbody-plaintext // PlainText interface{} `field:"optional" json:"plainText" yaml:"plainText"` }
The body to use in email messages.
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" emailMessageTemplateContentBodyProperty := &EmailMessageTemplateContentBodyProperty{ Html: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, PlainText: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, }
type CfnMessageTemplate_EmailMessageTemplateContentProperty ¶ added in v2.172.0
type CfnMessageTemplate_EmailMessageTemplateContentProperty struct { // The body to use in email messages. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontent.html#cfn-wisdom-messagetemplate-emailmessagetemplatecontent-body // Body interface{} `field:"required" json:"body" yaml:"body"` // The email headers to include in email messages. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontent.html#cfn-wisdom-messagetemplate-emailmessagetemplatecontent-headers // Headers interface{} `field:"required" json:"headers" yaml:"headers"` // The subject line, or title, to use in email messages. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontent.html#cfn-wisdom-messagetemplate-emailmessagetemplatecontent-subject // Subject *string `field:"required" json:"subject" yaml:"subject"` }
The content of the message template that applies to the email channel subtype.
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" emailMessageTemplateContentProperty := &EmailMessageTemplateContentProperty{ Body: &EmailMessageTemplateContentBodyProperty{ Html: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, PlainText: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, }, Headers: []interface{}{ &EmailMessageTemplateHeaderProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, Subject: jsii.String("subject"), }
type CfnMessageTemplate_EmailMessageTemplateHeaderProperty ¶ added in v2.172.0
type CfnMessageTemplate_EmailMessageTemplateHeaderProperty struct { // The name of the email header. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplateheader.html#cfn-wisdom-messagetemplate-emailmessagetemplateheader-name // Name *string `field:"optional" json:"name" yaml:"name"` // The value of the email header. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplateheader.html#cfn-wisdom-messagetemplate-emailmessagetemplateheader-value // Value *string `field:"optional" json:"value" yaml:"value"` }
The email headers to include in email messages.
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" emailMessageTemplateHeaderProperty := &EmailMessageTemplateHeaderProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }
type CfnMessageTemplate_GroupingConfigurationProperty ¶ added in v2.172.0
type CfnMessageTemplate_GroupingConfigurationProperty struct { // The criteria used for grouping Amazon Q in Connect users. // // The following is the list of supported criteria values. // // - `RoutingProfileArn` : Grouping the users by their [Amazon Connect routing profile ARN](https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html) . User should have [SearchRoutingProfile](https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html) and [DescribeRoutingProfile](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html) permissions when setting criteria to this value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-groupingconfiguration.html#cfn-wisdom-messagetemplate-groupingconfiguration-criteria // Criteria *string `field:"required" json:"criteria" yaml:"criteria"` // The list of values that define different groups of Amazon Q in Connect users. // // - When setting `criteria` to `RoutingProfileArn` , you need to provide a list of ARNs of [Amazon Connect routing profiles](https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html) as values of this parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-groupingconfiguration.html#cfn-wisdom-messagetemplate-groupingconfiguration-values // Values *[]*string `field:"required" json:"values" yaml:"values"` }
The configuration information of the grouping of Amazon Q in Connect users.
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" groupingConfigurationProperty := &GroupingConfigurationProperty{ Criteria: jsii.String("criteria"), Values: []*string{ jsii.String("values"), }, }
type CfnMessageTemplate_MessageTemplateAttributesProperty ¶ added in v2.172.0
type CfnMessageTemplate_MessageTemplateAttributesProperty struct { // The agent attributes that are used with the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattributes.html#cfn-wisdom-messagetemplate-messagetemplateattributes-agentattributes // AgentAttributes interface{} `field:"optional" json:"agentAttributes" yaml:"agentAttributes"` // The custom attributes that are used with the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattributes.html#cfn-wisdom-messagetemplate-messagetemplateattributes-customattributes // CustomAttributes interface{} `field:"optional" json:"customAttributes" yaml:"customAttributes"` // The customer profile attributes that are used with the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattributes.html#cfn-wisdom-messagetemplate-messagetemplateattributes-customerprofileattributes // CustomerProfileAttributes interface{} `field:"optional" json:"customerProfileAttributes" yaml:"customerProfileAttributes"` // The system attributes that are used with the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattributes.html#cfn-wisdom-messagetemplate-messagetemplateattributes-systemattributes // SystemAttributes interface{} `field:"optional" json:"systemAttributes" yaml:"systemAttributes"` }
The attributes that are used with the message template.
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" messageTemplateAttributesProperty := &MessageTemplateAttributesProperty{ AgentAttributes: &AgentAttributesProperty{ FirstName: jsii.String("firstName"), LastName: jsii.String("lastName"), }, CustomAttributes: map[string]*string{ "customAttributesKey": jsii.String("customAttributes"), }, CustomerProfileAttributes: &CustomerProfileAttributesProperty{ AccountNumber: jsii.String("accountNumber"), AdditionalInformation: jsii.String("additionalInformation"), Address1: jsii.String("address1"), Address2: jsii.String("address2"), Address3: jsii.String("address3"), Address4: jsii.String("address4"), BillingAddress1: jsii.String("billingAddress1"), BillingAddress2: jsii.String("billingAddress2"), BillingAddress3: jsii.String("billingAddress3"), BillingAddress4: jsii.String("billingAddress4"), BillingCity: jsii.String("billingCity"), BillingCountry: jsii.String("billingCountry"), BillingCounty: jsii.String("billingCounty"), BillingPostalCode: jsii.String("billingPostalCode"), BillingProvince: jsii.String("billingProvince"), BillingState: jsii.String("billingState"), BirthDate: jsii.String("birthDate"), BusinessEmailAddress: jsii.String("businessEmailAddress"), BusinessName: jsii.String("businessName"), BusinessPhoneNumber: jsii.String("businessPhoneNumber"), City: jsii.String("city"), Country: jsii.String("country"), County: jsii.String("county"), Custom: map[string]*string{ "customKey": jsii.String("custom"), }, EmailAddress: jsii.String("emailAddress"), FirstName: jsii.String("firstName"), Gender: jsii.String("gender"), HomePhoneNumber: jsii.String("homePhoneNumber"), LastName: jsii.String("lastName"), MailingAddress1: jsii.String("mailingAddress1"), MailingAddress2: jsii.String("mailingAddress2"), MailingAddress3: jsii.String("mailingAddress3"), MailingAddress4: jsii.String("mailingAddress4"), MailingCity: jsii.String("mailingCity"), MailingCountry: jsii.String("mailingCountry"), MailingCounty: jsii.String("mailingCounty"), MailingPostalCode: jsii.String("mailingPostalCode"), MailingProvince: jsii.String("mailingProvince"), MailingState: jsii.String("mailingState"), MiddleName: jsii.String("middleName"), MobilePhoneNumber: jsii.String("mobilePhoneNumber"), PartyType: jsii.String("partyType"), PhoneNumber: jsii.String("phoneNumber"), PostalCode: jsii.String("postalCode"), ProfileArn: jsii.String("profileArn"), ProfileId: jsii.String("profileId"), Province: jsii.String("province"), ShippingAddress1: jsii.String("shippingAddress1"), ShippingAddress2: jsii.String("shippingAddress2"), ShippingAddress3: jsii.String("shippingAddress3"), ShippingAddress4: jsii.String("shippingAddress4"), ShippingCity: jsii.String("shippingCity"), ShippingCountry: jsii.String("shippingCountry"), ShippingCounty: jsii.String("shippingCounty"), ShippingPostalCode: jsii.String("shippingPostalCode"), ShippingProvince: jsii.String("shippingProvince"), ShippingState: jsii.String("shippingState"), State: jsii.String("state"), }, SystemAttributes: &SystemAttributesProperty{ CustomerEndpoint: &SystemEndpointAttributesProperty{ Address: jsii.String("address"), }, Name: jsii.String("name"), SystemEndpoint: &SystemEndpointAttributesProperty{ Address: jsii.String("address"), }, }, }
type CfnMessageTemplate_MessageTemplateBodyContentProviderProperty ¶ added in v2.172.0
type CfnMessageTemplate_MessageTemplateBodyContentProviderProperty struct { // The content of the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplatebodycontentprovider.html#cfn-wisdom-messagetemplate-messagetemplatebodycontentprovider-content // Content *string `field:"optional" json:"content" yaml:"content"` }
The container of the message template body.
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" messageTemplateBodyContentProviderProperty := &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }
type CfnMessageTemplate_SmsMessageTemplateContentBodyProperty ¶ added in v2.172.0
type CfnMessageTemplate_SmsMessageTemplateContentBodyProperty struct { // The message body to use in SMS messages. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-smsmessagetemplatecontentbody.html#cfn-wisdom-messagetemplate-smsmessagetemplatecontentbody-plaintext // PlainText interface{} `field:"optional" json:"plainText" yaml:"plainText"` }
The body to use in SMS messages.
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" smsMessageTemplateContentBodyProperty := &SmsMessageTemplateContentBodyProperty{ PlainText: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, }
type CfnMessageTemplate_SmsMessageTemplateContentProperty ¶ added in v2.172.0
type CfnMessageTemplate_SmsMessageTemplateContentProperty struct { // The body to use in SMS messages. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-smsmessagetemplatecontent.html#cfn-wisdom-messagetemplate-smsmessagetemplatecontent-body // Body interface{} `field:"required" json:"body" yaml:"body"` }
The content of the message template that applies to the SMS channel subtype.
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" smsMessageTemplateContentProperty := &SmsMessageTemplateContentProperty{ Body: &SmsMessageTemplateContentBodyProperty{ PlainText: &MessageTemplateBodyContentProviderProperty{ Content: jsii.String("content"), }, }, }
type CfnMessageTemplate_SystemAttributesProperty ¶ added in v2.172.0
type CfnMessageTemplate_SystemAttributesProperty struct { // The CustomerEndpoint attribute. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-systemattributes.html#cfn-wisdom-messagetemplate-systemattributes-customerendpoint // CustomerEndpoint interface{} `field:"optional" json:"customerEndpoint" yaml:"customerEndpoint"` // The name of the task. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-systemattributes.html#cfn-wisdom-messagetemplate-systemattributes-name // Name *string `field:"optional" json:"name" yaml:"name"` // The SystemEndpoint attribute. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-systemattributes.html#cfn-wisdom-messagetemplate-systemattributes-systemendpoint // SystemEndpoint interface{} `field:"optional" json:"systemEndpoint" yaml:"systemEndpoint"` }
The system attributes that are used with the message template.
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" systemAttributesProperty := &SystemAttributesProperty{ CustomerEndpoint: &SystemEndpointAttributesProperty{ Address: jsii.String("address"), }, Name: jsii.String("name"), SystemEndpoint: &SystemEndpointAttributesProperty{ Address: jsii.String("address"), }, }
type CfnMessageTemplate_SystemEndpointAttributesProperty ¶ added in v2.172.0
type CfnMessageTemplate_SystemEndpointAttributesProperty struct { // The customer's phone number if used with `customerEndpoint` , or the number the customer dialed to call your contact center if used with `systemEndpoint` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-systemendpointattributes.html#cfn-wisdom-messagetemplate-systemendpointattributes-address // Address *string `field:"optional" json:"address" yaml:"address"` }
The system endpoint attributes that are used with the message template.
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" systemEndpointAttributesProperty := &SystemEndpointAttributesProperty{ Address: jsii.String("address"), }
Source Files ¶
- CfnAIAgent.go
- CfnAIAgentProps.go
- CfnAIAgentVersion.go
- CfnAIAgentVersionProps.go
- CfnAIAgentVersion__checks.go
- CfnAIAgent_AIAgentConfigurationProperty.go
- CfnAIAgent_AnswerRecommendationAIAgentConfigurationProperty.go
- CfnAIAgent_AssociationConfigurationDataProperty.go
- CfnAIAgent_AssociationConfigurationProperty.go
- CfnAIAgent_KnowledgeBaseAssociationConfigurationDataProperty.go
- CfnAIAgent_ManualSearchAIAgentConfigurationProperty.go
- CfnAIAgent_OrConditionProperty.go
- CfnAIAgent_SelfServiceAIAgentConfigurationProperty.go
- CfnAIAgent_TagConditionProperty.go
- CfnAIAgent_TagFilterProperty.go
- CfnAIAgent__checks.go
- CfnAIGuardrail.go
- CfnAIGuardrailProps.go
- CfnAIGuardrailVersion.go
- CfnAIGuardrailVersionProps.go
- CfnAIGuardrailVersion__checks.go
- CfnAIGuardrail_AIGuardrailContentPolicyConfigProperty.go
- CfnAIGuardrail_AIGuardrailContextualGroundingPolicyConfigProperty.go
- CfnAIGuardrail_AIGuardrailSensitiveInformationPolicyConfigProperty.go
- CfnAIGuardrail_AIGuardrailTopicPolicyConfigProperty.go
- CfnAIGuardrail_AIGuardrailWordPolicyConfigProperty.go
- CfnAIGuardrail_GuardrailContentFilterConfigProperty.go
- CfnAIGuardrail_GuardrailContextualGroundingFilterConfigProperty.go
- CfnAIGuardrail_GuardrailManagedWordsConfigProperty.go
- CfnAIGuardrail_GuardrailPiiEntityConfigProperty.go
- CfnAIGuardrail_GuardrailRegexConfigProperty.go
- CfnAIGuardrail_GuardrailTopicConfigProperty.go
- CfnAIGuardrail_GuardrailWordConfigProperty.go
- CfnAIGuardrail__checks.go
- CfnAIPrompt.go
- CfnAIPromptProps.go
- CfnAIPromptVersion.go
- CfnAIPromptVersionProps.go
- CfnAIPromptVersion__checks.go
- CfnAIPrompt_AIPromptTemplateConfigurationProperty.go
- CfnAIPrompt_TextFullAIPromptEditTemplateConfigurationProperty.go
- CfnAIPrompt__checks.go
- CfnAssistant.go
- CfnAssistantAssociation.go
- CfnAssistantAssociationProps.go
- CfnAssistantAssociation_AssociationDataProperty.go
- CfnAssistantAssociation__checks.go
- CfnAssistantProps.go
- CfnAssistant_ServerSideEncryptionConfigurationProperty.go
- CfnAssistant__checks.go
- CfnKnowledgeBase.go
- CfnKnowledgeBaseProps.go
- CfnKnowledgeBase_AppIntegrationsConfigurationProperty.go
- CfnKnowledgeBase_BedrockFoundationModelConfigurationProperty.go
- CfnKnowledgeBase_ChunkingConfigurationProperty.go
- CfnKnowledgeBase_CrawlerLimitsProperty.go
- CfnKnowledgeBase_FixedSizeChunkingConfigurationProperty.go
- CfnKnowledgeBase_HierarchicalChunkingConfigurationProperty.go
- CfnKnowledgeBase_HierarchicalChunkingLevelConfigurationProperty.go
- CfnKnowledgeBase_ManagedSourceConfigurationProperty.go
- CfnKnowledgeBase_ParsingConfigurationProperty.go
- CfnKnowledgeBase_ParsingPromptProperty.go
- CfnKnowledgeBase_RenderingConfigurationProperty.go
- CfnKnowledgeBase_SeedUrlProperty.go
- CfnKnowledgeBase_SemanticChunkingConfigurationProperty.go
- CfnKnowledgeBase_ServerSideEncryptionConfigurationProperty.go
- CfnKnowledgeBase_SourceConfigurationProperty.go
- CfnKnowledgeBase_UrlConfigurationProperty.go
- CfnKnowledgeBase_VectorIngestionConfigurationProperty.go
- CfnKnowledgeBase_WebCrawlerConfigurationProperty.go
- CfnKnowledgeBase__checks.go
- CfnMessageTemplate.go
- CfnMessageTemplateProps.go
- CfnMessageTemplateVersion.go
- CfnMessageTemplateVersionProps.go
- CfnMessageTemplateVersion__checks.go
- CfnMessageTemplate_AgentAttributesProperty.go
- CfnMessageTemplate_ContentProperty.go
- CfnMessageTemplate_CustomerProfileAttributesProperty.go
- CfnMessageTemplate_EmailMessageTemplateContentBodyProperty.go
- CfnMessageTemplate_EmailMessageTemplateContentProperty.go
- CfnMessageTemplate_EmailMessageTemplateHeaderProperty.go
- CfnMessageTemplate_GroupingConfigurationProperty.go
- CfnMessageTemplate_MessageTemplateAttributesProperty.go
- CfnMessageTemplate_MessageTemplateBodyContentProviderProperty.go
- CfnMessageTemplate_SmsMessageTemplateContentBodyProperty.go
- CfnMessageTemplate_SmsMessageTemplateContentProperty.go
- CfnMessageTemplate_SystemAttributesProperty.go
- CfnMessageTemplate_SystemEndpointAttributesProperty.go
- CfnMessageTemplate__checks.go
- main.go