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

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

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.eventschemas.Schema

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::EventSchemas::Schema

    Example Usage

    Example

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

return await Deployment.RunAsync(() => 
{
    var executionStatusChangeSchema = new AwsNative.EventSchemas.Schema("executionStatusChangeSchema", new()
    {
        RegistryName = "aws.events",
        SchemaName = "ExecutionStatusChange",
        Description = "event emitted when the status of a state machine execution change",
        Type = "OpenApi3",
        Content = "{   \"openapi\": \"3.0.0\",   \"info\": {     \"version\": \"1.0.0\",     \"title\": \"StepFunctionsExecutionStatusChange\"   },   \"paths\":{},   \"components\": {     \"schemas\": {       \"StepFunctionsExecutionStatusChange\": {         \"type\": \"object\",         \"required\": [ \"output\", \"input\", \"executionArn\", \"name\", \"stateMachineArn\", \"startDate\", \"stopDate\", \"status\" ],         \"properties\": {           \"output\": {\"type\": \"string\",\"nullable\": true},           \"input\": {\"type\": \"string\"},           \"executionArn\": {\"type\": \"string\"},           \"name\": {\"type\": \"string\"},           \"stateMachineArn\": {\"type\": \"string\"},           \"startDate\": {\"type\": \"integer\",\"format\": \"int64\"},           \"stopDate\": {\"type\": \"integer\",\"format\": \"int64\",\"nullable\": true},           \"status\": {\"type\": \"string\",\"enum\": [ \"FAILED\", \"RUNNING\", \"SUCCEEDED\", \"ABORTED\" ]}         }       }     }   } }",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := eventschemas.NewSchema(ctx, "executionStatusChangeSchema", &eventschemas.SchemaArgs{
			RegistryName: pulumi.String("aws.events"),
			SchemaName:   pulumi.String("ExecutionStatusChange"),
			Description:  pulumi.String("event emitted when the status of a state machine execution change"),
			Type:         pulumi.String("OpenApi3"),
			Content:      pulumi.String("{   \"openapi\": \"3.0.0\",   \"info\": {     \"version\": \"1.0.0\",     \"title\": \"StepFunctionsExecutionStatusChange\"   },   \"paths\":{},   \"components\": {     \"schemas\": {       \"StepFunctionsExecutionStatusChange\": {         \"type\": \"object\",         \"required\": [ \"output\", \"input\", \"executionArn\", \"name\", \"stateMachineArn\", \"startDate\", \"stopDate\", \"status\" ],         \"properties\": {           \"output\": {\"type\": \"string\",\"nullable\": true},           \"input\": {\"type\": \"string\"},           \"executionArn\": {\"type\": \"string\"},           \"name\": {\"type\": \"string\"},           \"stateMachineArn\": {\"type\": \"string\"},           \"startDate\": {\"type\": \"integer\",\"format\": \"int64\"},           \"stopDate\": {\"type\": \"integer\",\"format\": \"int64\",\"nullable\": true},           \"status\": {\"type\": \"string\",\"enum\": [ \"FAILED\", \"RUNNING\", \"SUCCEEDED\", \"ABORTED\" ]}         }       }     }   } }"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

execution_status_change_schema = aws_native.eventschemas.Schema("executionStatusChangeSchema",
    registry_name="aws.events",
    schema_name="ExecutionStatusChange",
    description="event emitted when the status of a state machine execution change",
    type="OpenApi3",
    content="{   \"openapi\": \"3.0.0\",   \"info\": {     \"version\": \"1.0.0\",     \"title\": \"StepFunctionsExecutionStatusChange\"   },   \"paths\":{},   \"components\": {     \"schemas\": {       \"StepFunctionsExecutionStatusChange\": {         \"type\": \"object\",         \"required\": [ \"output\", \"input\", \"executionArn\", \"name\", \"stateMachineArn\", \"startDate\", \"stopDate\", \"status\" ],         \"properties\": {           \"output\": {\"type\": \"string\",\"nullable\": true},           \"input\": {\"type\": \"string\"},           \"executionArn\": {\"type\": \"string\"},           \"name\": {\"type\": \"string\"},           \"stateMachineArn\": {\"type\": \"string\"},           \"startDate\": {\"type\": \"integer\",\"format\": \"int64\"},           \"stopDate\": {\"type\": \"integer\",\"format\": \"int64\",\"nullable\": true},           \"status\": {\"type\": \"string\",\"enum\": [ \"FAILED\", \"RUNNING\", \"SUCCEEDED\", \"ABORTED\" ]}         }       }     }   } }")

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

const executionStatusChangeSchema = new aws_native.eventschemas.Schema("executionStatusChangeSchema", {
    registryName: "aws.events",
    schemaName: "ExecutionStatusChange",
    description: "event emitted when the status of a state machine execution change",
    type: "OpenApi3",
    content: "{   \"openapi\": \"3.0.0\",   \"info\": {     \"version\": \"1.0.0\",     \"title\": \"StepFunctionsExecutionStatusChange\"   },   \"paths\":{},   \"components\": {     \"schemas\": {       \"StepFunctionsExecutionStatusChange\": {         \"type\": \"object\",         \"required\": [ \"output\", \"input\", \"executionArn\", \"name\", \"stateMachineArn\", \"startDate\", \"stopDate\", \"status\" ],         \"properties\": {           \"output\": {\"type\": \"string\",\"nullable\": true},           \"input\": {\"type\": \"string\"},           \"executionArn\": {\"type\": \"string\"},           \"name\": {\"type\": \"string\"},           \"stateMachineArn\": {\"type\": \"string\"},           \"startDate\": {\"type\": \"integer\",\"format\": \"int64\"},           \"stopDate\": {\"type\": \"integer\",\"format\": \"int64\",\"nullable\": true},           \"status\": {\"type\": \"string\",\"enum\": [ \"FAILED\", \"RUNNING\", \"SUCCEEDED\", \"ABORTED\" ]}         }       }     }   } }",
});

    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,
           content: Optional[str] = None,
           registry_name: Optional[str] = None,
           type: Optional[str] = None,
           description: Optional[str] = None,
           schema_name: Optional[str] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = 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:eventschemas: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 schemaResource = new aws_native.eventschemas.Schema("schemaResource", {
    content: "string",
    registryName: "string",
    type: "string",
    description: "string",
    schemaName: "string",
    tags: [{
        key: "string",
        value: "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:

    Content string
    The source of the schema definition.
    RegistryName string
    The name of the schema registry.
    Type string
    The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
    Description string
    A description of the schema.
    SchemaName string
    The name of the schema.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Tags associated with the resource.
    Content string
    The source of the schema definition.
    RegistryName string
    The name of the schema registry.
    Type string
    The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
    Description string
    A description of the schema.
    SchemaName string
    The name of the schema.
    Tags TagArgs
    Tags associated with the resource.
    content String
    The source of the schema definition.
    registryName String
    The name of the schema registry.
    type String
    The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
    description String
    A description of the schema.
    schemaName String
    The name of the schema.
    tags List<Tag>
    Tags associated with the resource.
    content string
    The source of the schema definition.
    registryName string
    The name of the schema registry.
    type string
    The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
    description string
    A description of the schema.
    schemaName string
    The name of the schema.
    tags Tag[]
    Tags associated with the resource.
    content str
    The source of the schema definition.
    registry_name str
    The name of the schema registry.
    type str
    The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
    description str
    A description of the schema.
    schema_name str
    The name of the schema.
    tags Sequence[TagArgs]
    Tags associated with the resource.
    content String
    The source of the schema definition.
    registryName String
    The name of the schema registry.
    type String
    The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4.
    description String
    A description of the schema.
    schemaName String
    The name of the schema.
    tags List<Property Map>
    Tags associated with the resource.

    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.
    LastModified string
    The last modified time of the schema.
    SchemaArn string
    The ARN of the schema.
    SchemaVersion string
    The version number of the schema.
    VersionCreatedDate string
    The date the schema version was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModified string
    The last modified time of the schema.
    SchemaArn string
    The ARN of the schema.
    SchemaVersion string
    The version number of the schema.
    VersionCreatedDate string
    The date the schema version was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModified String
    The last modified time of the schema.
    schemaArn String
    The ARN of the schema.
    schemaVersion String
    The version number of the schema.
    versionCreatedDate String
    The date the schema version was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModified string
    The last modified time of the schema.
    schemaArn string
    The ARN of the schema.
    schemaVersion string
    The version number of the schema.
    versionCreatedDate string
    The date the schema version was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified str
    The last modified time of the schema.
    schema_arn str
    The ARN of the schema.
    schema_version str
    The version number of the schema.
    version_created_date str
    The date the schema version was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModified String
    The last modified time of the schema.
    schemaArn String
    The ARN of the schema.
    schemaVersion String
    The version number of the schema.
    versionCreatedDate String
    The date the schema version was created.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    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.105.0 published on Thursday, May 2, 2024 by Pulumi
    pulumi/pulumi-aws-native