software.amazon.awscdk.services.eventschemas

Interface CfnSchemaProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSchemaProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.348Z")
 @Stability(value=Stable)
public interface CfnSchemaProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnSchema`.

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.eventschemas.*;
 CfnSchemaProps cfnSchemaProps = CfnSchemaProps.builder()
         .content("content")
         .registryName("registryName")
         .type("type")
         // the properties below are optional
         .description("description")
         .schemaName("schemaName")
         .tags(List.of(TagsEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSchemaProps.Builder A builder for CfnSchemaProps
static class	CfnSchemaProps.Jsii$Proxy An implementation for CfnSchemaProps

Method Summary

Modifier and Type	Method and Description
static CfnSchemaProps.Builder	builder()
String	getContent() The source of the schema definition.
default String	getDescription() A description of the schema.
String	getRegistryName() The name of the schema registry.
default String	getSchemaName() The name of the schema.
default List<CfnSchema.TagsEntryProperty>	getTags() Tags associated with the schema.
String	getType() The type of schema.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContent

@Stability(value=Stable)
 @NotNull
String getContent()

The source of the schema definition.

getRegistryName

@Stability(value=Stable)
 @NotNull
String getRegistryName()

The name of the schema registry.

getType

@Stability(value=Stable)
 @NotNull
String getType()

The type of schema.

Valid types include OpenApi3 and JSONSchemaDraft4 .

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the schema.

getSchemaName

@Stability(value=Stable)
 @Nullable
default String getSchemaName()

The name of the schema.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnSchema.TagsEntryProperty> getTags()

Tags associated with the schema.

builder

@Stability(value=Stable)
static CfnSchemaProps.Builder builder()

Returns:

a CfnSchemaProps.Builder of CfnSchemaProps