Documentation
¶
Index ¶
- func CfnAssistantAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAssistantAssociation_IsCfnElement(x interface{}) *bool
- func CfnAssistantAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAssistantAssociation_IsConstruct(x interface{}) *bool
- func CfnAssistant_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAssistant_IsCfnElement(x interface{}) *bool
- func CfnAssistant_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAssistant_IsConstruct(x interface{}) *bool
- func CfnKnowledgeBase_CFN_RESOURCE_TYPE_NAME() *string
- func CfnKnowledgeBase_IsCfnElement(x interface{}) *bool
- func CfnKnowledgeBase_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnKnowledgeBase_IsConstruct(x interface{}) *bool
- func NewCfnAssistantAssociation_Override(c CfnAssistantAssociation, scope awscdk.Construct, id *string, ...)
- func NewCfnAssistant_Override(c CfnAssistant, scope awscdk.Construct, id *string, props *CfnAssistantProps)
- func NewCfnKnowledgeBase_Override(c CfnKnowledgeBase, scope awscdk.Construct, id *string, ...)
- 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 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. Experimental.
func CfnAssistantAssociation_IsCfnResource ¶
func CfnAssistantAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnAssistantAssociation_IsConstruct ¶
func CfnAssistantAssociation_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnAssistant_IsCfnResource ¶
func CfnAssistant_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnAssistant_IsConstruct ¶
func CfnAssistant_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnKnowledgeBase_IsCfnResource ¶
func CfnKnowledgeBase_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnKnowledgeBase_IsConstruct ¶
func CfnKnowledgeBase_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnAssistantAssociation_Override ¶
func NewCfnAssistantAssociation_Override(c CfnAssistantAssociation, scope awscdk.Construct, id *string, props *CfnAssistantAssociationProps)
Create a new `AWS::Wisdom::AssistantAssociation`.
func NewCfnAssistant_Override ¶
func NewCfnAssistant_Override(c CfnAssistant, scope awscdk.Construct, id *string, props *CfnAssistantProps)
Create a new `AWS::Wisdom::Assistant`.
func NewCfnKnowledgeBase_Override ¶
func NewCfnKnowledgeBase_Override(c CfnKnowledgeBase, scope awscdk.Construct, id *string, props *CfnKnowledgeBaseProps)
Create a new `AWS::Wisdom::KnowledgeBase`.
Types ¶
type CfnAssistant ¶
type CfnAssistant interface {
awscdk.CfnResource
awscdk.IInspectable
// 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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The name of the assistant.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The KMS 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).
// Experimental.
Stack() awscdk.Stack
// The tags used to organize, track, or control access for this resource.
Tags() awscdk.TagManager
// The type of assistant.
Type() *string
SetType(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Wisdom::Assistant`.
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"),
},
},
})
func NewCfnAssistant ¶
func NewCfnAssistant(scope awscdk.Construct, id *string, props *CfnAssistantProps) CfnAssistant
Create a new `AWS::Wisdom::Assistant`.
type CfnAssistantAssociation ¶
type CfnAssistantAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// 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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags used to organize, track, or control access for this resource.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Wisdom::AssistantAssociation`.
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 awscdk.Construct, id *string, props *CfnAssistantAssociationProps) CfnAssistantAssociation
Create a new `AWS::Wisdom::AssistantAssociation`.
type CfnAssistantAssociationProps ¶
type CfnAssistantAssociationProps struct {
// The identifier of the Wisdom assistant.
AssistantId *string `field:"required" json:"assistantId" yaml:"assistantId"`
// The identifier of the associated resource.
Association interface{} `field:"required" json:"association" yaml:"association"`
// The type of association.
AssociationType *string `field:"required" json:"associationType" yaml:"associationType"`
// The tags used to organize, track, or control access for this resource.
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.
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.
Name *string `field:"required" json:"name" yaml:"name"`
// The type of assistant.
Type *string `field:"required" json:"type" yaml:"type"`
// The description of the assistant.
Description *string `field:"optional" json:"description" yaml:"description"`
// The KMS key used for encryption.
ServerSideEncryptionConfiguration interface{} `field:"optional" json:"serverSideEncryptionConfiguration" yaml:"serverSideEncryptionConfiguration"`
// The tags used to organize, track, or control access for this resource.
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"),
},
},
}
type CfnAssistant_ServerSideEncryptionConfigurationProperty ¶
type CfnAssistant_ServerSideEncryptionConfigurationProperty struct {
// The KMS key .
//
// For information about valid ID values, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) .
KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
}
The KMS 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
// 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.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
CreationStack() *[]*string
// The description.
Description() *string
SetDescription(val *string)
// 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.
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.
// Experimental.
LogicalId() *string
// The name of the knowledge base.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// Information about how to render the content.
RenderingConfiguration() interface{}
SetRenderingConfiguration(val interface{})
// The KMS key used for encryption.
ServerSideEncryptionConfiguration() interface{}
SetServerSideEncryptionConfiguration(val interface{})
// The source of the knowledge base content.
//
// Only set this argument for EXTERNAL knowledge bases.
SourceConfiguration() interface{}
SetSourceConfiguration(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags used to organize, track, or control access for this resource.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
GetAtt(attributeName *string) 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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// 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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Wisdom::KnowledgeBase`.
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"),
objectFields: []*string{
jsii.String("objectFields"),
},
},
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnKnowledgeBase ¶
func NewCfnKnowledgeBase(scope awscdk.Construct, id *string, props *CfnKnowledgeBaseProps) CfnKnowledgeBase
Create a new `AWS::Wisdom::KnowledgeBase`.
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.
KnowledgeBaseType *string `field:"required" json:"knowledgeBaseType" yaml:"knowledgeBaseType"`
// The name of the knowledge base.
Name *string `field:"required" json:"name" yaml:"name"`
// The description.
Description *string `field:"optional" json:"description" yaml:"description"`
// Information about how to render the content.
RenderingConfiguration interface{} `field:"optional" json:"renderingConfiguration" yaml:"renderingConfiguration"`
// The KMS key used for encryption.
ServerSideEncryptionConfiguration interface{} `field:"optional" json:"serverSideEncryptionConfiguration" yaml:"serverSideEncryptionConfiguration"`
// The source of the knowledge base content.
//
// Only set this argument for EXTERNAL knowledge bases.
SourceConfiguration interface{} `field:"optional" json:"sourceConfiguration" yaml:"sourceConfiguration"`
// The tags used to organize, track, or control access for this resource.
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"),
objectFields: []*string{
jsii.String("objectFields"),
},
},
},
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnKnowledgeBase_AppIntegrationsConfigurationProperty ¶
type CfnKnowledgeBase_AppIntegrationsConfigurationProperty struct {
// The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
AppIntegrationArn *string `field:"required" json:"appIntegrationArn" yaml:"appIntegrationArn"`
// The fields from the source that are made available to your agents in Wisdom.
//
// - 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` .
//
// Make sure to include additional fields. These fields are indexed and used to source recommendations.
ObjectFields *[]*string `field:"required" 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"),
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 and ServiceNow, 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`
//
// The variable is replaced with the actual value for a piece of content when calling [GetContent](https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html) .
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 KMS key .
//
// For information about valid ID values, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) .
KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
}
The KMS 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.
AppIntegrations interface{} `field:"optional" 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"),
objectFields: []*string{
jsii.String("objectFields"),
},
},
}