Package software.amazon.awscdk.cfnpropertymixins.services.eventsv2

Interface CfnEventSourcePropsMixin.AwsServiceEventsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventSourcePropsMixin.AwsServiceEventsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnEventSourcePropsMixin

@Stability(Stable)
public static interface CfnEventSourcePropsMixin.AwsServiceEventsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Forward a single AWS service's events from the account's default 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.cfnpropertymixins.services.eventsv2.*;
 AwsServiceEventsConfigurationProperty awsServiceEventsConfigurationProperty = AwsServiceEventsConfigurationProperty.builder()
         .awsService("awsService")
         .onFailureConfiguration(OnFailureConfigurationProperty.builder()
                 .arn("arn")
                 .build())
         .pattern("pattern")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEventSourcePropsMixin.AwsServiceEventsConfigurationProperty.Builder	builder()
default String	getAwsService()	A single AWS service source identifier, for example aws.s3.
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	getPattern()	A filter pattern, as a JSON string, that defines which events from the specified AWS service are forwarded to the event bus.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAwsService

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

A single AWS service source identifier, for example aws.s3. Wildcards and lists are not allowed.

See Also:

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

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 CfnEventSourcePropsMixin.OnFailureConfigurationProperty

See Also:

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

getPattern

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

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

Do not include source, account, or region as top-level fields. If you do not specify a pattern, all events from the service are forwarded.

See Also:

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

builder

@Stability(Stable)
static CfnEventSourcePropsMixin.AwsServiceEventsConfigurationProperty.Builder builder()

Returns:

a CfnEventSourcePropsMixin.AwsServiceEventsConfigurationProperty.Builder of CfnEventSourcePropsMixin.AwsServiceEventsConfigurationProperty