software.amazon.awscdk.services.appintegrations

Class CfnEventIntegration

java.lang.Object

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.appintegrations.CfnEventIntegration

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:28:56.518Z")
public class CfnEventIntegration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppIntegrations::EventIntegration`.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEventIntegration.Builder A fluent builder for CfnEventIntegration.
static interface	CfnEventIntegration.EventFilterProperty The event integration filter.
static interface	CfnEventIntegration.EventIntegrationAssociationProperty The event integration association.
static interface	CfnEventIntegration.MetadataProperty The metadata associated with the client.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEventIntegration(Construct scope, java.lang.String id, CfnEventIntegrationProps props) Create a new `AWS::AppIntegrations::EventIntegration`.
protected	CfnEventIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEventIntegration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IResolvable	getAttrAssociations() The association status of the event integration, returned as an array of EventIntegrationAssociation objects.
java.lang.String	getAttrEventIntegrationArn() The Amazon Resource Name (ARN) of the event integration.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The event integration description.
java.lang.String	getEventBridgeBus() The Amazon EventBridge bus for the event integration.
java.lang.Object	getEventFilter() The event integration filter.
java.lang.String	getName() The name of the event integration.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) The event integration description.
void	setEventBridgeBus(java.lang.String value) The Amazon EventBridge bus for the event integration.
void	setEventFilter(CfnEventIntegration.EventFilterProperty value) The event integration filter.
void	setEventFilter(IResolvable value) The event integration filter.
void	setName(java.lang.String value) The name of the event integration.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEventIntegration

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

CfnEventIntegration

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

CfnEventIntegration

public CfnEventIntegration(Construct scope,
                           java.lang.String id,
                           CfnEventIntegrationProps props)

Create a new `AWS::AppIntegrations::EventIntegration`.

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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAssociations

public IResolvable getAttrAssociations()

The association status of the event integration, returned as an array of EventIntegrationAssociation objects.

getAttrEventIntegrationArn

public java.lang.String getAttrEventIntegrationArn()

The Amazon Resource Name (ARN) of the event integration.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getEventBridgeBus

public java.lang.String getEventBridgeBus()

The Amazon EventBridge bus for the event integration.

setEventBridgeBus

public void setEventBridgeBus(java.lang.String value)

The Amazon EventBridge bus for the event integration.

getEventFilter

public java.lang.Object getEventFilter()

The event integration filter.

setEventFilter

public void setEventFilter(IResolvable value)

The event integration filter.

setEventFilter

public void setEventFilter(CfnEventIntegration.EventFilterProperty value)

The event integration filter.

getName

public java.lang.String getName()

The name of the event integration.

setName

public void setName(java.lang.String value)

The name of the event integration.

getDescription

public java.lang.String getDescription()

The event integration description.

setDescription

public void setDescription(java.lang.String value)

The event integration description.