Package software.amazon.awscdk.services.eventsv2

Interface CfnEventSource.PartnerEventsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventSource.PartnerEventsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnEventSource

@Stability(Stable)
public static interface CfnEventSource.PartnerEventsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Forward a partner event source's events through a managed partner 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.eventsv2.*;
 PartnerEventsConfigurationProperty partnerEventsConfigurationProperty = PartnerEventsConfigurationProperty.builder()
         .partnerEventSourceArn("partnerEventSourceArn")
         // the properties below are optional
         .onFailureConfiguration(OnFailureConfigurationProperty.builder()
                 .arn("arn")
                 .build())
         .partnerBusKmsKeyIdentifier("partnerBusKmsKeyIdentifier")
         .pattern("pattern")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-partnereventsconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEventSource.PartnerEventsConfigurationProperty.Builder	A builder for CfnEventSource.PartnerEventsConfigurationProperty
static final class	CfnEventSource.PartnerEventsConfigurationProperty.Jsii$Proxy	An implementation for CfnEventSource.PartnerEventsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnEventSource.PartnerEventsConfigurationProperty.Builder	builder()
default Object	getOnFailureConfiguration()	The destination for events that could not be forwarded by the managed forwarding target or, for partner event sources, the managed partner event bus.
default String	getPartnerBusKmsKeyIdentifier()	The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on the managed partner event bus.
String	getPartnerEventSourceArn()	The ARN of the partner event source to forward.
default String	getPattern()	A filter pattern, as a JSON string, that defines which events from the specified partner event source are forwarded to the event bus.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPartnerEventSourceArn

@Stability(Stable)
@NotNull
String getPartnerEventSourceArn()

The ARN of the partner event source to forward.

The partner owns the event source, so the ARN's account segment is empty. Changing this property replaces the event source. Because Name and EventBusArn together identify an event source, and the replacement is created before the old resource is deleted, change Name in the same update.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-partnereventsconfiguration.html#cfn-eventsv2-eventsource-partnereventsconfiguration-partnereventsourcearn

getOnFailureConfiguration

@Stability(Stable)
@Nullable
default Object getOnFailureConfiguration()

The destination for events that could not be forwarded by the managed forwarding target or, for partner event sources, the managed partner event bus.

Arn is optional. An empty object removes a configured destination on update.

Returns union: either IResolvable or CfnEventSource.OnFailureConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-partnereventsconfiguration.html#cfn-eventsv2-eventsource-partnereventsconfiguration-onfailureconfiguration

getPartnerBusKmsKeyIdentifier

@Stability(Stable)
@Nullable
default String getPartnerBusKmsKeyIdentifier()

The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on the managed partner event bus.

The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt events on the event bus.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-partnereventsconfiguration.html#cfn-eventsv2-eventsource-partnereventsconfiguration-partnerbuskmskeyidentifier

getPattern

@Stability(Stable)
@Nullable
default String getPattern()

A filter pattern, as a JSON string, that defines which events from the specified partner event source are forwarded to the event bus.

If you do not specify a pattern, all events from the partner event source are forwarded.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-eventsource-partnereventsconfiguration.html#cfn-eventsv2-eventsource-partnereventsconfiguration-pattern

builder

@Stability(Stable)
static CfnEventSource.PartnerEventsConfigurationProperty.Builder builder()

Returns:

a CfnEventSource.PartnerEventsConfigurationProperty.Builder of CfnEventSource.PartnerEventsConfigurationProperty