Class CfnSchema
A CloudFormation AWS::Personalize::Schema
.
Inherited Members
Namespace: Amazon.CDK.AWS.Personalize
Assembly: Amazon.CDK.AWS.Personalize.dll
Syntax (csharp)
public class CfnSchema : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSchema
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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
CloudformationResource: AWS::Personalize::Schema
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-schema.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Personalize;
var cfnSchema = new CfnSchema(this, "MyCfnSchema", new CfnSchemaProps {
Name = "name",
Schema = "schema",
// the properties below are optional
Domain = "domain"
});
Synopsis
Constructors
CfnSchema(Construct, String, ICfnSchemaProps) | Create a new |
CfnSchema(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSchema(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrSchemaArn | The Amazon Resource Name (ARN) of the schema. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Domain | The domain of a schema that you created for a dataset in a Domain dataset group. |
Name | The name of the schema. |
Schema | The schema. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSchema(Construct, String, ICfnSchemaProps)
Create a new AWS::Personalize::Schema
.
public CfnSchema(Construct scope, string id, ICfnSchemaProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSchemaProps
- resource properties.
CfnSchema(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSchema(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSchema(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSchema(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrSchemaArn
The Amazon Resource Name (ARN) of the schema.
public virtual string AttrSchemaArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SchemaArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Domain
The domain of a schema that you created for a dataset in a Domain dataset group.
public virtual string Domain { get; set; }
Property Value
System.String
Remarks
Name
The name of the schema.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Schema
The schema.
public virtual string Schema { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>