API.md

API Reference

Constructs

CommercetoolsSubscription

new CommercetoolsSubscription(this, 'CTToEventBusSubscription', { messages: [ { "resourceTypeId" : "product", "types: [ ] }], changes: [], projectKey: props.ctProjektKey, secret: Secret.fromSecretNameV2(this, 'CTSecret', /ct/${props.envName}/commercetools-subscription-mgmt), target: new EventbridgeSubscriptionTarget(this.eventBus) }).

Initializers

import { CommercetoolsSubscription } from '@larsfronius/commercetools-cdk-constructs'

new CommercetoolsSubscription(scope: Construct, id: string, props: ICommercetoolsSubscriptionProps)

Name	Type	Description
scope*	constructs.Construct	No description.
id*	string	No description.
props*	@larsfronius/commercetools-cdk-constructs.ICommercetoolsSubscriptionProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: @larsfronius/commercetools-cdk-constructs.ICommercetoolsSubscriptionProps

---

Properties

Name	Type	Description
id*	aws-cdk-lib.Reference	No description.
version*	aws-cdk-lib.Reference	No description.
eventBridgeSource	aws-cdk-lib.Reference	No description.

---

id^Required

public readonly id: Reference;

• Type: aws-cdk-lib.Reference

---

version^Required

public readonly version: Reference;

• Type: aws-cdk-lib.Reference

---

eventBridgeSource^Optional

public readonly eventBridgeSource: Reference;

• Type: aws-cdk-lib.Reference

---

Structs

EventBridgeDestination

Initializer

import { EventBridgeDestination } from '@larsfronius/commercetools-cdk-constructs'

const eventBridgeDestination: EventBridgeDestination = { ... }

Properties

Name	Type	Description
accountId*	string	No description.
region*	string	No description.
type*	string	No description.

---

accountId^Required

public readonly accountId: string;

• Type: string

---

region^Required

public readonly region: string;

• Type: string

---

type^Required

public readonly type: string;

• Type: string

---

SnsDestination

Initializer

import { SnsDestination } from '@larsfronius/commercetools-cdk-constructs'

const snsDestination: SnsDestination = { ... }

Properties

Name	Type	Description
accessKey*	string	No description.
accessSecret*	string	No description.
topicArn*	string	No description.
type*	string	No description.

---

accessKey^Required

public readonly accessKey: string;

• Type: string

---

accessSecret^Required

public readonly accessSecret: string;

• Type: string

---

topicArn^Required

public readonly topicArn: string;

• Type: string

---

type^Required

public readonly type: string;

• Type: string

---

SqsDestination

Initializer

import { SqsDestination } from '@larsfronius/commercetools-cdk-constructs'

const sqsDestination: SqsDestination = { ... }

Properties

Name	Type	Description
accessKey*	string	No description.
accessSecret*	string	No description.
queueUrl*	string	No description.
region*	string	No description.
type*	string	No description.

---

accessKey^Required

public readonly accessKey: string;

• Type: string

---

accessSecret^Required

public readonly accessSecret: string;

• Type: string

---

queueUrl^Required

public readonly queueUrl: string;

• Type: string

---

region^Required

public readonly region: string;

• Type: string

---

type^Required

public readonly type: string;

• Type: string

---

Classes

EventbridgeSubscriptionTarget

• Implements: @larsfronius/commercetools-cdk-constructs.ICommercetoolsSubscriptionTarget

Initializers

import { EventbridgeSubscriptionTarget } from '@larsfronius/commercetools-cdk-constructs'

new EventbridgeSubscriptionTarget(eventbus?: IEventBus)

Name	Type	Description
eventbus	aws-cdk-lib.aws_events.IEventBus	No description.

---

eventbus^Optional

• Type: aws-cdk-lib.aws_events.IEventBus

---

Methods

Name	Description
getDestination	No description.
postSubscription	No description.

---

getDestination

public getDestination(scope: Construct)

scope^Required

• Type: constructs.Construct

---

postSubscription

public postSubscription(subscription: CommercetoolsSubscription)

subscription^Required

• Type: @larsfronius/commercetools-cdk-constructs.CommercetoolsSubscription

---

Properties

Name	Type	Description
eventBus	aws-cdk-lib.aws_events.IEventBus	No description.

---

eventBus^Optional

public readonly eventBus: IEventBus;

• Type: aws-cdk-lib.aws_events.IEventBus

---

SnsSubscriptionTarget

• Implements: @larsfronius/commercetools-cdk-constructs.ICommercetoolsSubscriptionTarget

Initializers

import { SnsSubscriptionTarget } from '@larsfronius/commercetools-cdk-constructs'

new SnsSubscriptionTarget(topic?: ITopic)

Name	Type	Description
topic	aws-cdk-lib.aws_sns.ITopic	No description.

---

topic^Optional

• Type: aws-cdk-lib.aws_sns.ITopic

---

Methods

Name	Description
getDestination	No description.

---

getDestination

public getDestination(scope: Construct)

scope^Required

• Type: constructs.Construct

---

Properties

Name	Type	Description
snsTopic	aws-cdk-lib.aws_sns.ITopic	No description.

---

snsTopic^Optional

public readonly snsTopic: ITopic;

• Type: aws-cdk-lib.aws_sns.ITopic

---

SQSSubscriptionTarget

• Implements: @larsfronius/commercetools-cdk-constructs.ICommercetoolsSubscriptionTarget

Initializers

import { SQSSubscriptionTarget } from '@larsfronius/commercetools-cdk-constructs'

new SQSSubscriptionTarget(queue?: IQueue)

Name	Type	Description
queue	aws-cdk-lib.aws_sqs.IQueue	No description.

---

queue^Optional

• Type: aws-cdk-lib.aws_sqs.IQueue

---

Methods

Name	Description
getDestination	No description.

---

getDestination

public getDestination(scope: Construct)

scope^Required

• Type: constructs.Construct

---

Properties

Name	Type	Description
queue	aws-cdk-lib.aws_sqs.IQueue	No description.

---

queue^Optional

public readonly queue: IQueue;

• Type: aws-cdk-lib.aws_sqs.IQueue

---

Protocols

ICommercetoolsChangeSubscription

• Implemented By: @larsfronius/commercetools-cdk-constructs.ICommercetoolsChangeSubscription

Properties

Name	Type	Description
resourceTypeId*	string	No description.

---

resourceTypeId^Required

public readonly resourceTypeId: string;

• Type: string

---

ICommercetoolsMessageSubscription

• Implemented By: @larsfronius/commercetools-cdk-constructs.ICommercetoolsMessageSubscription

Properties

Name	Type	Description
resourceTypeId*	string	No description.
types*	string[]	No description.

---

resourceTypeId^Required

public readonly resourceTypeId: string;

• Type: string

---

types^Required

public readonly types: string[];

• Type: string[]

---

ICommercetoolsSubscriptionProps

• Implemented By: @larsfronius/commercetools-cdk-constructs.ICommercetoolsSubscriptionProps

Properties

Name	Type	Description
changes*	@larsfronius/commercetools-cdk-constructs.ICommercetoolsChangeSubscription[]	No description.
messages*	@larsfronius/commercetools-cdk-constructs.ICommercetoolsMessageSubscription[]	No description.
projectKey*	string	No description.
secret*	aws-cdk-lib.aws_secretsmanager.ISecret	No description.
target*	@larsfronius/commercetools-cdk-constructs.ICommercetoolsSubscriptionTarget	target is one of EventbridgeSubscriptionTarget, SQSSubscriptionTarget or SnsSubscriptionTarget.
baseUri	string	baseUri is the base URI of your commercetools instance.
oAuthUri	string	oAuthUri is the oauth URI of your commercetools instance.

---

changes^Required

public readonly changes: ICommercetoolsChangeSubscription[];

• Type: @larsfronius/commercetools-cdk-constructs.ICommercetoolsChangeSubscription[]

---

messages^Required

public readonly messages: ICommercetoolsMessageSubscription[];

• Type: @larsfronius/commercetools-cdk-constructs.ICommercetoolsMessageSubscription[]

---

projectKey^Required

public readonly projectKey: string;

• Type: string

---

secret^Required

public readonly secret: ISecret;

• Type: aws-cdk-lib.aws_secretsmanager.ISecret

---

target^Required

public readonly target: ICommercetoolsSubscriptionTarget;

• Type: @larsfronius/commercetools-cdk-constructs.ICommercetoolsSubscriptionTarget

target is one of EventbridgeSubscriptionTarget, SQSSubscriptionTarget or SnsSubscriptionTarget.

---

baseUri^Optional

public readonly baseUri: string;

• Type: string

baseUri is the base URI of your commercetools instance.

Defaults to 'https://api.europe-west1.gcp.commercetools.com'

---

oAuthUri^Optional

public readonly oAuthUri: string;

• Type: string

oAuthUri is the oauth URI of your commercetools instance.

Defaults to 'https://auth.europe-west1.gcp.commercetools.com'

---

ICommercetoolsSubscriptionTarget

• Implemented By: @larsfronius/commercetools-cdk-constructs.EventbridgeSubscriptionTarget, @larsfronius/commercetools-cdk-constructs.SQSSubscriptionTarget, @larsfronius/commercetools-cdk-constructs.SnsSubscriptionTarget, @larsfronius/commercetools-cdk-constructs.ICommercetoolsSubscriptionTarget

Methods

Name	Description
getDestination	No description.
postSubscription	No description.

---

getDestination

public getDestination(scope: Construct)

scope^Required

• Type: constructs.Construct

---

postSubscription

public postSubscription(subscription: CommercetoolsSubscription)

subscription^Required

• Type: @larsfronius/commercetools-cdk-constructs.CommercetoolsSubscription

---