Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. personalize
  5. Schema

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.personalize.Schema

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::Personalize::Schema.

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var mySchema = new AwsNative.Personalize.Schema("mySchema", new()
    {
        Name = "my-schema-name",
        SchemaValue = "{\"type\": \"record\",\"name\": \"Interactions\", \"namespace\": \"com.amazonaws.personalize.schema\", \"fields\": [ { \"name\": \"USER_ID\", \"type\": \"string\" }, { \"name\": \"ITEM_ID\", \"type\": \"string\" }, { \"name\": \"TIMESTAMP\", \"type\": \"long\"}], \"version\": \"1.0\"}",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/personalize"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := personalize.NewSchema(ctx, "mySchema", &personalize.SchemaArgs{
			Name:   pulumi.String("my-schema-name"),
			Schema: pulumi.String("{\"type\": \"record\",\"name\": \"Interactions\", \"namespace\": \"com.amazonaws.personalize.schema\", \"fields\": [ { \"name\": \"USER_ID\", \"type\": \"string\" }, { \"name\": \"ITEM_ID\", \"type\": \"string\" }, { \"name\": \"TIMESTAMP\", \"type\": \"long\"}], \"version\": \"1.0\"}"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

my_schema = aws_native.personalize.Schema("mySchema",
    name="my-schema-name",
    schema="{\"type\": \"record\",\"name\": \"Interactions\", \"namespace\": \"com.amazonaws.personalize.schema\", \"fields\": [ { \"name\": \"USER_ID\", \"type\": \"string\" }, { \"name\": \"ITEM_ID\", \"type\": \"string\" }, { \"name\": \"TIMESTAMP\", \"type\": \"long\"}], \"version\": \"1.0\"}")

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const mySchema = new aws_native.personalize.Schema("mySchema", {
    name: "my-schema-name",
    schema: "{\"type\": \"record\",\"name\": \"Interactions\", \"namespace\": \"com.amazonaws.personalize.schema\", \"fields\": [ { \"name\": \"USER_ID\", \"type\": \"string\" }, { \"name\": \"ITEM_ID\", \"type\": \"string\" }, { \"name\": \"TIMESTAMP\", \"type\": \"long\"}], \"version\": \"1.0\"}",
});

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var mySchema = new AwsNative.Personalize.Schema("mySchema", new()
    {
        Name = "my-schema-name",
        SchemaValue = "{\"type\": \"record\",\"name\": \"Interactions\", \"namespace\": \"com.amazonaws.personalize.schema\", \"fields\": [ { \"name\": \"USER_ID\", \"type\": \"string\" }, { \"name\": \"ITEM_ID\", \"type\": \"string\" }, { \"name\": \"TIMESTAMP\", \"type\": \"long\"}], \"version\": \"1.0\"}",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/personalize"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := personalize.NewSchema(ctx, "mySchema", &personalize.SchemaArgs{
			Name:   pulumi.String("my-schema-name"),
			Schema: pulumi.String("{\"type\": \"record\",\"name\": \"Interactions\", \"namespace\": \"com.amazonaws.personalize.schema\", \"fields\": [ { \"name\": \"USER_ID\", \"type\": \"string\" }, { \"name\": \"ITEM_ID\", \"type\": \"string\" }, { \"name\": \"TIMESTAMP\", \"type\": \"long\"}], \"version\": \"1.0\"}"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

my_schema = aws_native.personalize.Schema("mySchema",
    name="my-schema-name",
    schema="{\"type\": \"record\",\"name\": \"Interactions\", \"namespace\": \"com.amazonaws.personalize.schema\", \"fields\": [ { \"name\": \"USER_ID\", \"type\": \"string\" }, { \"name\": \"ITEM_ID\", \"type\": \"string\" }, { \"name\": \"TIMESTAMP\", \"type\": \"long\"}], \"version\": \"1.0\"}")

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const mySchema = new aws_native.personalize.Schema("mySchema", {
    name: "my-schema-name",
    schema: "{\"type\": \"record\",\"name\": \"Interactions\", \"namespace\": \"com.amazonaws.personalize.schema\", \"fields\": [ { \"name\": \"USER_ID\", \"type\": \"string\" }, { \"name\": \"ITEM_ID\", \"type\": \"string\" }, { \"name\": \"TIMESTAMP\", \"type\": \"long\"}], \"version\": \"1.0\"}",
});

    Coming soon!

    Create Schema Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Schema(name: string, args: SchemaArgs, opts?: CustomResourceOptions);
    @overload
def Schema(resource_name: str,
           args: SchemaArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Schema(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           schema: Optional[str] = None,
           domain: Optional[SchemaDomain] = None,
           name: Optional[str] = None)
    func NewSchema(ctx *Context, name string, args SchemaArgs, opts ...ResourceOption) (*Schema, error)
    public Schema(string name, SchemaArgs args, CustomResourceOptions? opts = null)
    public Schema(String name, SchemaArgs args)
public Schema(String name, SchemaArgs args, CustomResourceOptions options)

    type: aws-native:personalize:Schema
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SchemaArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SchemaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchemaArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const exampleschemaResourceResourceFromPersonalize = new aws_native.personalize.Schema("exampleschemaResourceResourceFromPersonalize", {
    schema: "string",
    domain: aws_native.personalize.SchemaDomain.Ecommerce,
    name: "string",
});

    Coming soon!

    Schema Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Schema resource accepts the following input properties:

    SchemaValue string
    A schema in Avro JSON format.
    Domain Pulumi.AwsNative.Personalize.SchemaDomain
    The domain of a Domain dataset group.
    Name string
    Name for the schema.
    Schema string
    A schema in Avro JSON format.
    Domain SchemaDomain
    The domain of a Domain dataset group.
    Name string
    Name for the schema.
    schema String
    A schema in Avro JSON format.
    domain SchemaDomain
    The domain of a Domain dataset group.
    name String
    Name for the schema.
    schema string
    A schema in Avro JSON format.
    domain SchemaDomain
    The domain of a Domain dataset group.
    name string
    Name for the schema.
    schema str
    A schema in Avro JSON format.
    domain SchemaDomain
    The domain of a Domain dataset group.
    name str
    Name for the schema.
    schema String
    A schema in Avro JSON format.
    domain "ECOMMERCE" | "VIDEO_ON_DEMAND"
    The domain of a Domain dataset group.
    name String
    Name for the schema.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Schema resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    SchemaArn string
    Arn for the schema.
    Id string
    The provider-assigned unique ID for this managed resource.
    SchemaArn string
    Arn for the schema.
    id String
    The provider-assigned unique ID for this managed resource.
    schemaArn String
    Arn for the schema.
    id string
    The provider-assigned unique ID for this managed resource.
    schemaArn string
    Arn for the schema.
    id str
    The provider-assigned unique ID for this managed resource.
    schema_arn str
    Arn for the schema.
    id String
    The provider-assigned unique ID for this managed resource.
    schemaArn String
    Arn for the schema.

    Supporting Types

    SchemaDomain, SchemaDomainArgs

    Ecommerce
    ECOMMERCE
    VideoOnDemand
    VIDEO_ON_DEMAND
    SchemaDomainEcommerce
    ECOMMERCE
    SchemaDomainVideoOnDemand
    VIDEO_ON_DEMAND
    Ecommerce
    ECOMMERCE
    VideoOnDemand
    VIDEO_ON_DEMAND
    Ecommerce
    ECOMMERCE
    VideoOnDemand
    VIDEO_ON_DEMAND
    ECOMMERCE
    ECOMMERCE
    VIDEO_ON_DEMAND
    VIDEO_ON_DEMAND
    "ECOMMERCE"
    ECOMMERCE
    "VIDEO_ON_DEMAND"
    VIDEO_ON_DEMAND

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native