software.amazon.awscdk.services.wisdom

Class CfnKnowledgeBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.wisdom.CfnKnowledgeBase

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.653Z")
 @Stability(value=Stable)
public class CfnKnowledgeBase
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Wisdom::KnowledgeBase`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wisdom.*;
 CfnKnowledgeBase cfnKnowledgeBase = CfnKnowledgeBase.Builder.create(this, "MyCfnKnowledgeBase")
         .knowledgeBaseType("knowledgeBaseType")
         .name("name")
         // the properties below are optional
         .description("description")
         .renderingConfiguration(RenderingConfigurationProperty.builder()
                 .templateUri("templateUri")
                 .build())
         .serverSideEncryptionConfiguration(ServerSideEncryptionConfigurationProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .build())
         .sourceConfiguration(SourceConfigurationProperty.builder()
                 .appIntegrations(AppIntegrationsConfigurationProperty.builder()
                         .appIntegrationArn("appIntegrationArn")
                         .objectFields(List.of("objectFields"))
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnKnowledgeBase.AppIntegrationsConfigurationProperty Example:
static class	CfnKnowledgeBase.Builder A fluent builder for CfnKnowledgeBase.
static interface	CfnKnowledgeBase.RenderingConfigurationProperty Example:
static interface	CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty Example:
static interface	CfnKnowledgeBase.SourceConfigurationProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnKnowledgeBase(software.constructs.Construct scope, String id, CfnKnowledgeBaseProps props) Create a new `AWS::Wisdom::KnowledgeBase`.
protected	CfnKnowledgeBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnKnowledgeBase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrKnowledgeBaseArn()
String	getAttrKnowledgeBaseId()
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::Wisdom::KnowledgeBase.Description`.
String	getKnowledgeBaseType() `AWS::Wisdom::KnowledgeBase.KnowledgeBaseType`.
String	getName() `AWS::Wisdom::KnowledgeBase.Name`.
Object	getRenderingConfiguration() `AWS::Wisdom::KnowledgeBase.RenderingConfiguration`.
Object	getServerSideEncryptionConfiguration() `AWS::Wisdom::KnowledgeBase.ServerSideEncryptionConfiguration`.
Object	getSourceConfiguration() `AWS::Wisdom::KnowledgeBase.SourceConfiguration`.
TagManager	getTags() `AWS::Wisdom::KnowledgeBase.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) `AWS::Wisdom::KnowledgeBase.Description`.
void	setKnowledgeBaseType(String value) `AWS::Wisdom::KnowledgeBase.KnowledgeBaseType`.
void	setName(String value) `AWS::Wisdom::KnowledgeBase.Name`.
void	setRenderingConfiguration(CfnKnowledgeBase.RenderingConfigurationProperty value) `AWS::Wisdom::KnowledgeBase.RenderingConfiguration`.
void	setRenderingConfiguration(IResolvable value) `AWS::Wisdom::KnowledgeBase.RenderingConfiguration`.
void	setServerSideEncryptionConfiguration(CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty value) `AWS::Wisdom::KnowledgeBase.ServerSideEncryptionConfiguration`.
void	setServerSideEncryptionConfiguration(IResolvable value) `AWS::Wisdom::KnowledgeBase.ServerSideEncryptionConfiguration`.
void	setSourceConfiguration(CfnKnowledgeBase.SourceConfigurationProperty value) `AWS::Wisdom::KnowledgeBase.SourceConfiguration`.
void	setSourceConfiguration(IResolvable value) `AWS::Wisdom::KnowledgeBase.SourceConfiguration`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnKnowledgeBase

protected CfnKnowledgeBase(software.amazon.jsii.JsiiObjectRef objRef)

CfnKnowledgeBase

protected CfnKnowledgeBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnKnowledgeBase

@Stability(value=Stable)
public CfnKnowledgeBase(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnKnowledgeBaseProps props)

Create a new `AWS::Wisdom::KnowledgeBase`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrKnowledgeBaseArn

@Stability(value=Stable)
 @NotNull
public String getAttrKnowledgeBaseArn()

getAttrKnowledgeBaseId

@Stability(value=Stable)
 @NotNull
public String getAttrKnowledgeBaseId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::Wisdom::KnowledgeBase.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::Wisdom::KnowledgeBase.Description`.

getKnowledgeBaseType

@Stability(value=Stable)
 @NotNull
public String getKnowledgeBaseType()

`AWS::Wisdom::KnowledgeBase.KnowledgeBaseType`.

setKnowledgeBaseType

@Stability(value=Stable)
public void setKnowledgeBaseType(@NotNull
                                                          String value)

`AWS::Wisdom::KnowledgeBase.KnowledgeBaseType`.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

`AWS::Wisdom::KnowledgeBase.Name`.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

`AWS::Wisdom::KnowledgeBase.Name`.

getRenderingConfiguration

@Stability(value=Stable)
 @Nullable
public Object getRenderingConfiguration()

`AWS::Wisdom::KnowledgeBase.RenderingConfiguration`.

setRenderingConfiguration

@Stability(value=Stable)
public void setRenderingConfiguration(@Nullable
                                                               CfnKnowledgeBase.RenderingConfigurationProperty value)

`AWS::Wisdom::KnowledgeBase.RenderingConfiguration`.

setRenderingConfiguration

@Stability(value=Stable)
public void setRenderingConfiguration(@Nullable
                                                               IResolvable value)

`AWS::Wisdom::KnowledgeBase.RenderingConfiguration`.

getServerSideEncryptionConfiguration

@Stability(value=Stable)
 @Nullable
public Object getServerSideEncryptionConfiguration()

`AWS::Wisdom::KnowledgeBase.ServerSideEncryptionConfiguration`.

setServerSideEncryptionConfiguration

@Stability(value=Stable)
public void setServerSideEncryptionConfiguration(@Nullable
                                                                          CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty value)

`AWS::Wisdom::KnowledgeBase.ServerSideEncryptionConfiguration`.

setServerSideEncryptionConfiguration

@Stability(value=Stable)
public void setServerSideEncryptionConfiguration(@Nullable
                                                                          IResolvable value)

`AWS::Wisdom::KnowledgeBase.ServerSideEncryptionConfiguration`.

getSourceConfiguration

@Stability(value=Stable)
 @Nullable
public Object getSourceConfiguration()

`AWS::Wisdom::KnowledgeBase.SourceConfiguration`.

setSourceConfiguration

@Stability(value=Stable)
public void setSourceConfiguration(@Nullable
                                                            CfnKnowledgeBase.SourceConfigurationProperty value)

`AWS::Wisdom::KnowledgeBase.SourceConfiguration`.

setSourceConfiguration

@Stability(value=Stable)
public void setSourceConfiguration(@Nullable
                                                            IResolvable value)

`AWS::Wisdom::KnowledgeBase.SourceConfiguration`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::Wisdom::KnowledgeBase.Tags`.