software.amazon.awscdk.services.eventschemas

Class CfnDiscoverer

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

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.345Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDiscoverer.Builder A fluent builder for CfnDiscoverer.
static interface	CfnDiscoverer.TagsEntryProperty Tags to associate with the discoverer.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDiscoverer(software.constructs.Construct scope, String id, CfnDiscovererProps props) Create a new `AWS::EventSchemas::Discoverer`.
protected	CfnDiscoverer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDiscoverer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IResolvable	getAttrCrossAccount() Defines whether event schemas from other accounts are discovered.
String	getAttrDiscovererArn() The ARN of the discoverer.
String	getAttrDiscovererId() The ID of the discoverer.
protected Map<String,Object>	getCfnProperties()
Object	getCrossAccount() Allows for the discovery of the event schemas that are sent to the event bus from another account.
String	getDescription() A description for the discoverer.
String	getSourceArn() The ARN of the event bus.
TagManager	getTags() Tags associated with the resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCrossAccount(Boolean value) Allows for the discovery of the event schemas that are sent to the event bus from another account.
void	setCrossAccount(IResolvable value) Allows for the discovery of the event schemas that are sent to the event bus from another account.
void	setDescription(String value) A description for the discoverer.
void	setSourceArn(String value) The ARN of the event bus.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDiscoverer

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

CfnDiscoverer

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

CfnDiscoverer

@Stability(value=Stable)
public CfnDiscoverer(@NotNull
                                              software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public IResolvable getAttrCrossAccount()

Defines whether event schemas from other accounts are discovered.

Default is True.

getAttrDiscovererArn

@Stability(value=Stable)
 @NotNull
public String getAttrDiscovererArn()

The ARN of the discoverer.

getAttrDiscovererId

@Stability(value=Stable)
 @NotNull
public String getAttrDiscovererId()

The ID of the discoverer.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Tags associated with the resource.

getSourceArn

@Stability(value=Stable)
 @NotNull
public String getSourceArn()

The ARN of the event bus.

setSourceArn

@Stability(value=Stable)
public void setSourceArn(@NotNull
                                                  String value)

The ARN of the event bus.

getCrossAccount

@Stability(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getDescription()

A description for the discoverer.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description for the discoverer.