software.amazon.awscdk.services.personalize

Class CfnSchema

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.personalize.CfnSchema

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-02T14:17:16.190Z")
 @Stability(value=Stable)
public class CfnSchema
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Personalize::Schema`.

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset .

For more information on schemas, see Datasets and schemas .

Related APIs - ListSchemas

• DescribeSchema
• DeleteSchema

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.personalize.*;
 CfnSchema cfnSchema = CfnSchema.Builder.create(this, "MyCfnSchema")
         .name("name")
         .schema("schema")
         // the properties below are optional
         .domain("domain")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSchema.Builder A fluent builder for CfnSchema.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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
	CfnSchema(Construct scope, String id, CfnSchemaProps props) Create a new `AWS::Personalize::Schema`.
protected	CfnSchema(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSchema(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrSchemaArn() The Amazon Resource Name (ARN) of the schema.
protected Map<String,Object>	getCfnProperties()
String	getDomain() The domain of a schema that you created for a dataset in a Domain dataset group.
String	getName() The name of the schema.
String	getSchema() The schema.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDomain(String value) The domain of a schema that you created for a dataset in a Domain dataset group.
void	setName(String value) The name of the schema.
void	setSchema(String value) The schema.

Methods inherited from class software.amazon.awscdk.core.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.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

CfnSchema

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

CfnSchema

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

CfnSchema

@Stability(value=Stable)
public CfnSchema(@NotNull
                                          Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          CfnSchemaProps props)

Create a new `AWS::Personalize::Schema`.

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.

getAttrSchemaArn

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

The Amazon Resource Name (ARN) of the schema.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getName

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

The name of the schema.

setName

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

The name of the schema.

getSchema

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

The schema.

setSchema

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

The schema.

getDomain

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

The domain of a schema that you created for a dataset in a Domain dataset group.

setDomain

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

The domain of a schema that you created for a dataset in a Domain dataset group.