Package software.amazon.awscdk.services.eventschemas

Class CfnDiscoverer

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.CfnDiscoverer
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.699Z") @Stability(Stable) public class CfnDiscoverer extends CfnResource implements IInspectable
A CloudFormation AWS::EventSchemas::Discoverer.

Use the AWS::EventSchemas::Discoverer resource to specify a discoverer that is associated with an event bus. A discoverer allows the Amazon EventBridge Schema Registry to automatically generate schemas based on events on an event bus.

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.*;
 CfnDiscoverer cfnDiscoverer = CfnDiscoverer.Builder.create(this, "MyCfnDiscoverer")
         .sourceArn("sourceArn")
         // the properties below are optional
         .crossAccount(false)
         .description("description")
         .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

    • CfnDiscoverer

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

    • CfnDiscoverer

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

    • CfnDiscoverer

      @Stability(Stable) public CfnDiscoverer(@NotNull Construct scope, @NotNull String id, @NotNull CfnDiscovererProps props)
      Create a new AWS::EventSchemas::Discoverer.

      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.

    • getAttrCrossAccount

      @Stability(Stable) @NotNull public IResolvable getAttrCrossAccount()
      Defines whether event schemas from other accounts are discovered.

      Default is True.

    • getAttrDiscovererArn

      @Stability(Stable) @NotNull public String getAttrDiscovererArn()
      The ARN of the discoverer.

    • getAttrDiscovererId

      @Stability(Stable) @NotNull public String getAttrDiscovererId()
      The ID of the discoverer.

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

    • getSourceArn

      @Stability(Stable) @NotNull public String getSourceArn()
      The ARN of the event bus.

    • setSourceArn

      @Stability(Stable) public void setSourceArn(@NotNull String value)
      The ARN of the event bus.

    • getCrossAccount

      @Stability(Stable) @Nullable public Object getCrossAccount()
      Allows for the discovery of the event schemas that are sent to the event bus from another account.

    • setCrossAccount

      @Stability(Stable) public void setCrossAccount(@Nullable Boolean value)
      Allows for the discovery of the event schemas that are sent to the event bus from another account.

    • setCrossAccount

      @Stability(Stable) public void setCrossAccount(@Nullable IResolvable value)
      Allows for the discovery of the event schemas that are sent to the event bus from another account.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the discoverer.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the discoverer.