Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.710Z") @Stability(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

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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSchema

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

    • CfnSchema

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

    • CfnSchema

      @Stability(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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrSchemaArn()
      The Amazon Resource Name (ARN) of the schema.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the schema.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the schema.

    • getSchema

      @Stability(Stable) @NotNull public String getSchema()
      The schema.

    • setSchema

      @Stability(Stable) public void setSchema(@NotNull String value)
      The schema.

    • getDomain

      @Stability(Stable) @Nullable public String getDomain()
      The domain of a schema that you created for a dataset in a Domain dataset group.

    • setDomain

      @Stability(Stable) public void setDomain(@Nullable String value)
      The domain of a schema that you created for a dataset in a Domain dataset group.