Package software.amazon.awscdk.services.eventschemas

Class CfnSchema

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.eventschemas.CfnSchema
All Implemented Interfaces:
IInspectable, ITaggable, ISchemaRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:40.332Z") @Stability(Stable) public class CfnSchema extends CfnResource implements IInspectable, ISchemaRef, ITaggable
Use the AWS::EventSchemas::Schema resource to specify an event schema.

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.*;
 CfnSchema cfnSchema = CfnSchema.Builder.create(this, "MyCfnSchema")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSchema

      protected CfnSchema(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSchema

      protected CfnSchema(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSchema

      @Stability(Stable) public CfnSchema(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSchemaProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrLastModified

      @Stability(Stable) @NotNull public String getAttrLastModified()
      The date and time that schema was modified.

    • getAttrSchemaArn

      @Stability(Stable) @NotNull public String getAttrSchemaArn()
      The ARN of the schema.

    • getAttrSchemaName

      @Stability(Stable) @NotNull public String getAttrSchemaName()
      The name of the schema.

    • getAttrSchemaVersion

      @Stability(Stable) @NotNull public String getAttrSchemaVersion()
      The version number of the schema.

    • getAttrVersionCreatedDate

      @Stability(Stable) @NotNull public String getAttrVersionCreatedDate()
      The date the schema version was created.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getSchemaRef

      @Stability(Stable) @NotNull public SchemaReference getSchemaRef()
      A reference to a Schema resource.
      Specified by:
      getSchemaRef in interface ISchemaRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getContent

      @Stability(Stable) @NotNull public String getContent()
      The source of the schema definition.

    • setContent

      @Stability(Stable) public void setContent(@NotNull String value)
      The source of the schema definition.

    • getRegistryName

      @Stability(Stable) @NotNull public String getRegistryName()
      The name of the schema registry.

    • setRegistryName

      @Stability(Stable) public void setRegistryName(@NotNull String value)
      The name of the schema registry.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of schema.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of schema.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the schema.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the schema.

    • getSchemaName

      @Stability(Stable) @Nullable public String getSchemaName()
      The name of the schema.

    • setSchemaName

      @Stability(Stable) public void setSchemaName(@Nullable String value)
      The name of the schema.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnSchema.TagsEntryProperty> getTagsRaw()
      Tags associated with the schema.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnSchema.TagsEntryProperty> value)
      Tags associated with the schema.