class CfnSubscriberPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.EventsV2.CfnSubscriberPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awseventsv2#CfnSubscriberPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.eventsv2.CfnSubscriberPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_eventsv2.CfnSubscriberPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_eventsv2 » CfnSubscriberPropsMixin

Implements IMixin

Extends Mixin

Resource type definition for AWS::EventsV2::Subscriber, an Amazon EventBridge subscription that delivers events from an event bus to a target.

Canonical identity is the combination of bus, name, and target. Replacement uses delete_then_create.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventsv2-subscriber.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eventsv2 as eventsv2 } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnSubscriberPropsMixin = new eventsv2.CfnSubscriberPropsMixin({
  batchConfiguration: {
    maxBatchSize: 123,
    maxBatchWindowInSeconds: 123,
  },
  description: 'description',
  eventBusArn: 'eventBusArn',
  filterConfiguration: {
    filters: [{
      pattern: 'pattern',
      scope: 'scope',
    }],
    language: 'language',
  },
  logConfiguration: {
    includePayload: 'includePayload',
    level: 'level',
  },
  name: 'name',
  onFailureConfiguration: {
    arn: 'arn',
  },
  pointInTimeConfiguration: {
    endPoint: 123,
    pointType: 'pointType',
    startingPoint: 123,
  },
  resumePosition: 'resumePosition',
  retryPolicy: {
    maxEventAgeInSeconds: 123,
    maxRetryAttempts: 123,
    retryStrategy: 'retryStrategy',
  },
  startingPosition: 'startingPosition',
  state: 'state',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  transformer: {
    jsonataConfiguration: {
      expression: 'expression',
    },
    type: 'type',
  },
  type: 'type',
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnSubscriberPropsMixin(props: CfnSubscriberMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnSubscriberMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::EventsV2::Subscriber.

Properties

Name	Type	Description
props	CfnSubscriberMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnSubscriberMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.