feat(scheduler-targets-alpha): KinesisStreamPutRecord Target

[go-to-k]

This PR adds KinesisStreamPutRecord Target for EventBridge Scheduler.

Closes #27451.

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[aws-cdk-automation]

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

[lpizzinidev]

Looks good overall, thanks 👍
The unit tests on imported streams will require a fix on the importing function.

[lpizzinidev]

Suggested change

	* A length of `partitionKey` must be between 1 and 256.
	* The length must be between 1 and 256.

[lpizzinidev]

Suggested change

	test('throws when stream is imported from different account', () => {
	const stack2 = new Stack(app, 'Stack2', {
	env: {
	region: 'us-east-1',
	account: '234567890123',
	},
	});
	const importedStream = kinesis.Stream.fromStreamArn(stack2, 'ImportedStream', 'arn:aws:kinesis:us-east-1:234567890123:stream/Foo');
	const streamTarget = new KinesisStreamPutRecord(importedStream, {
	partitionKey: 'key',
	});
	expect(() =>
	new Schedule(stack, 'MyScheduleDummy', {
	schedule: expr,
	target: streamTarget,
	})).toThrow(/Both the schedule and the stream must be in the same account/);
	});
	test('throws when stream is imported from different region', () => {
	const stack2 = new Stack(app, 'Stack2', {
	env: {
	region: 'us-west-2',
	account: '123456789012',
	},
	});
	const importedStream = kinesis.Stream.fromStreamArn(stack2, 'ImportedStream', 'arn:aws:kinesis:us-west-2:123456789012:stream/Foo');
	const streamTarget = new KinesisStreamPutRecord(importedStream, {
	partitionKey: 'key',
	});
	expect(() =>
	new Schedule(stack, 'MyScheduleDummy', {
	schedule: expr,
	target: streamTarget,
	})).toThrow(/Both the schedule and the stream must be in the same region/);
	});
	test.each([
	['account', 'arn:aws: kinesis:us-east-1:999999999999:stream/Foo', /Both the schedule and the stream must be in the same account./],
	['region', 'arn:aws: kinesis:eu-central-1:123456789012:stream/Foo', /Both the schedule and the stream must be in the same region./],
	])('throws when Kinesis Data Stream is imported from different %s', (_, arn: string, expectedError: RegExp) => {
	const importedStream = kinesis.Stream.fromStreamArn(stack, 'ImportedStream', arn);
	const streamTarget = new KinesisStreamPutRecord(importedStream, {
	partitionKey: 'key',
	});
	expect(() =>
	new Schedule(stack, 'MyScheduleDummy', {
	schedule: expr,
	target: target,
	})).toThrow(expectedError);
	});

fromStreamArn should use the same stack.
fromStreamAttributes will require to solve the environment for the imported stream ARN:

  public static fromStreamAttributes(scope: Construct, id: string, attrs: StreamAttributes): IStream {
    class Import extends StreamBase {
      public readonly streamArn = attrs.streamArn;
      public readonly streamName = Stack.of(scope).splitArn(attrs.streamArn, ArnFormat.SLASH_RESOURCE_NAME).resourceName!;
      public readonly encryptionKey = attrs.encryptionKey;
    }

    return new Import(scope, id, {
      environmentFromArn: attrs.streamArn,
    });
  }

Also, can you please add unit tests to verify that the environment gets resolved correctly when using fromStreamArn and fromStreamAttributes after this change?

[go-to-k]

@lpizzinidev

I just changed! Please check them.

[lpizzinidev]

Thanks 👍

[aws-cdk-automation]

This PR cannot be merged because it has conflicts. Please resolve them. The PR will be considered stale and closed if it remains in an unmergeable state.

[vinayak-kukreja]

Hey @go-to-k , thank you for this contribution.

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

Pull request has been modified.

[go-to-k]

@vinayak-kukreja

Thanks for your approval! I fixed conflicts. Please approve again.

I fixed the other PR the same way, but when one of them gets merged, the other one gets conflicts again. If that happens, I will fix it again.

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: d47f958
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).