software.amazon.awscdk.services.eventschemas

Interface CfnSchemaProps

All Known Implementing Classes:

CfnSchemaProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:46.373Z")
public interface CfnSchemaProps

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()
java.lang.String	getContent() The source of the schema definition.
default java.lang.String	getDescription() A description of the schema.
java.lang.String	getRegistryName() The name of the schema registry.
default java.lang.String	getSchemaName() The name of the schema.
default java.util.List<CfnSchema.TagsEntryProperty>	getTags() Tags associated with the schema.
java.lang.String	getType() The type of schema.

Method Detail

getContent

java.lang.String getContent()

The source of the schema definition.

getRegistryName

java.lang.String getRegistryName()

The name of the schema registry.

getType

java.lang.String getType()

The type of schema.

Valid types include OpenApi3 and JSONSchemaDraft4 .

getDescription

default java.lang.String getDescription()

A description of the schema.

getSchemaName

default java.lang.String getSchemaName()

The name of the schema.

getTags

default java.util.List<CfnSchema.TagsEntryProperty> getTags()

Tags associated with the schema.

builder

static CfnSchemaProps.Builder builder()

Returns:

a CfnSchemaProps.Builder of CfnSchemaProps