Package software.amazon.awscdk.services.eventschemas

Class CfnSchema

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.eventschemas.CfnSchema
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.705Z") @Stability(Stable) public class CfnSchema extends CfnResource implements IInspectable
A CloudFormation AWS::EventSchemas::Schema.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnSchemaProps props)
      Create a new AWS::EventSchemas::Schema.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • 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.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tags associated with the schema.

    • 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.

      Valid types include OpenApi3 and JSONSchemaDraft4 .

    • setType

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

      Valid types include OpenApi3 and JSONSchemaDraft4 .

    • 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.