Package 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.104.0 (build e79254c)",
           date="2024-12-27T17:02:02.400Z")
@Stability(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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Details

getContent

@Stability(Stable)
@NotNull
String getContent()

The source of the schema definition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-content

getRegistryName

@Stability(Stable)
@NotNull
String getRegistryName()

The name of the schema registry.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-registryname

getType

@Stability(Stable)
@NotNull
String getType()

The type of schema.

Valid types include OpenApi3 and JSONSchemaDraft4 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-type

getDescription

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

A description of the schema.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-description

getSchemaName

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

The name of the schema.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-schemaname

getTags

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

Tags associated with the schema.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html#cfn-eventschemas-schema-tags

builder

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

Returns:

a CfnSchemaProps.Builder of CfnSchemaProps