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 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 NewCfnAIAgentVersion_Override(c CfnAIAgentVersion, scope constructs.Construct, id *string, ...)
- func NewCfnAIAgent_Override(c CfnAIAgent, scope constructs.Construct, id *string, props *CfnAIAgentProps)
- 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, ...)
- 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_TagConditionProperty
- type CfnAIAgent_TagFilterProperty
- 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_RenderingConfigurationProperty
- type CfnKnowledgeBase_ServerSideEncryptionConfigurationProperty
- type CfnKnowledgeBase_SourceConfigurationProperty
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 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 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 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)
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 // 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{ 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{ 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: 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{ 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{ 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: 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 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 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 { // 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"` // 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 { // 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"` // 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"` }
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{ 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{ 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_AnswerRecommendationAIAgentConfigurationProperty ¶ added in v2.166.0
type CfnAIAgent_AnswerRecommendationAIAgentConfigurationProperty struct { // 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"` // 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"` // 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"` // 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"` }
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{ 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 { // 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"` }
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 { // 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"` // 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"` // 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"` }
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 { // 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"` // 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"` }
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 { // 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"` // 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"` }
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{ 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"` // 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_TagConditionProperty ¶ added in v2.166.0
type CfnAIAgent_TagConditionProperty struct { // 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"` // 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"` }
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 { // 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"` // 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"` // 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"` }
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 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 // 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 AiPromptId() *string SetAiPromptId(val *string) AssistantId() *string SetAssistantId(val *string) 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 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 { // 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"` // 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"` // 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 { // 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"` }
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 { // 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"` }
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{} // 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"), }, }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
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"` }
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"), }, }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
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_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_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:"required" json:"appIntegrations" yaml:"appIntegrations"` }
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"), }, }, }
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_TagConditionProperty.go
- CfnAIAgent_TagFilterProperty.go
- CfnAIAgent__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_RenderingConfigurationProperty.go
- CfnKnowledgeBase_ServerSideEncryptionConfigurationProperty.go
- CfnKnowledgeBase_SourceConfigurationProperty.go
- CfnKnowledgeBase__checks.go
- main.go