Package software.amazon.awscdk.services.appintegrations

Class CfnEventIntegration

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.appintegrations.CfnEventIntegration
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IEventIntegrationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:39:57.888Z") @Stability(Stable) public class CfnEventIntegration extends CfnResource implements IInspectable, IEventIntegrationRef, ITaggable
Creates an event integration.

You provide a name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that will push events to that bus. No objects are created in your account, only metadata that is persisted on the EventIntegration control plane.

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.appintegrations.*;
 CfnEventIntegration cfnEventIntegration = CfnEventIntegration.Builder.create(this, "MyCfnEventIntegration")
         .eventBridgeBus("eventBridgeBus")
         .eventFilter(EventFilterProperty.builder()
                 .source("source")
                 .build())
         .name("name")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.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

    • CfnEventIntegration

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

    • CfnEventIntegration

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

    • CfnEventIntegration

      @Stability(Stable) public CfnEventIntegration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEventIntegrationProps 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

    • fromEventIntegrationArn

      @Stability(Stable) @NotNull public static IEventIntegrationRef fromEventIntegrationArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IEventIntegrationRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromEventIntegrationName

      @Stability(Stable) @NotNull public static IEventIntegrationRef fromEventIntegrationName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String eventIntegrationName)
      Creates a new IEventIntegrationRef from a eventIntegrationName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      eventIntegrationName - This parameter is required.

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

    • getAttrEventIntegrationArn

      @Stability(Stable) @NotNull public String getAttrEventIntegrationArn()
      The Amazon Resource Name (ARN) of the event integration.

    • getCfnProperties

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

    • getEventIntegrationRef

      @Stability(Stable) @NotNull public EventIntegrationReference getEventIntegrationRef()
      A reference to a EventIntegration resource.
      Specified by:
      getEventIntegrationRef in interface IEventIntegrationRef

    • getTags

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

    • getEventBridgeBus

      @Stability(Stable) @NotNull public String getEventBridgeBus()
      The Amazon EventBridge bus for the event integration.

    • setEventBridgeBus

      @Stability(Stable) public void setEventBridgeBus(@NotNull String value)
      The Amazon EventBridge bus for the event integration.

    • getEventFilter

      @Stability(Stable) @NotNull public Object getEventFilter()
      The event integration filter.

      Returns union: either IResolvable or CfnEventIntegration.EventFilterProperty

    • setEventFilter

      @Stability(Stable) public void setEventFilter(@NotNull IResolvable value)
      The event integration filter.

    • setEventFilter

      @Stability(Stable) public void setEventFilter(@NotNull CfnEventIntegration.EventFilterProperty value)
      The event integration filter.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the event integration.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the event integration.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The event integration description.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The event integration description.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.