chore(kinesis-firehose-alpha): change Stream's destination property t…

…ype from array to single IDestination
aws · Oct 2, 2024 · 5c4c153 · 5c4c153
1 parent be70c82
commit 5c4c153
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 44 deletions.
diff --git a/packages/@aws-cdk/aws-kinesisfirehose-alpha/lib/delivery-stream.ts b/packages/@aws-cdk/aws-kinesisfirehose-alpha/lib/delivery-stream.ts
@@ -189,7 +189,7 @@ export interface DeliveryStreamProps {
    *
    * Only a singleton array is supported at this time.
    */
-  readonly destinations: IDestination[];
+  readonly destinations: IDestination;
 
   /**
    * A name for the delivery stream.
@@ -324,10 +324,6 @@ export class DeliveryStream extends DeliveryStreamBase {
 
     this._role = props.role;
 
-    if (props.destinations.length !== 1) {
-      throw new Error(`Only one destination is allowed per delivery stream, given ${props.destinations.length}`);
-    }
-
     if (props.encryption?.encryptionKey || props.sourceStream) {
       this._role = this._role ?? new iam.Role(this, 'Service Role', {
         assumedBy: new iam.ServicePrincipal('firehose.amazonaws.com'),
@@ -369,7 +365,7 @@ export class DeliveryStream extends DeliveryStreamBase {
       readStreamGrant = props.sourceStream.grantRead(this._role);
     }
 
-    const destinationConfig = props.destinations[0].bind(this, {});
+    const destinationConfig = props.destinations.bind(this, {});
 
     const resource = new CfnDeliveryStream(this, 'Resource', {
       deliveryStreamEncryptionConfigurationInput: encryptionConfig,

diff --git a/packages/@aws-cdk/aws-kinesisfirehose-alpha/test/delivery-stream.test.ts b/packages/@aws-cdk/aws-kinesisfirehose-alpha/test/delivery-stream.test.ts
@@ -46,7 +46,7 @@ describe('delivery stream', () => {
 
   test('creates stream with default values', () => {
     new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
 
     Template.fromStack(stack).hasResourceProperties('AWS::KinesisFirehose::DeliveryStream', {
@@ -63,7 +63,7 @@ describe('delivery stream', () => {
 
   test('creates stream with events target V2 class', () => {
     const stream = new firehose.DeliveryStream(stack, 'DeliveryStream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
 
     new events.Rule(stack, 'rule', {
@@ -102,7 +102,7 @@ describe('delivery stream', () => {
     });
 
     const deliveryStream = new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
       role: role,
     });
 
@@ -111,7 +111,7 @@ describe('delivery stream', () => {
 
   test('not providing sourceStream or encryptionKey creates only one role (used for S3 destination)', () => {
     new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
 
     Template.fromStack(stack).hasResourceProperties('AWS::IAM::Role', {
@@ -133,7 +133,7 @@ describe('delivery stream', () => {
     const sourceStream = new kinesis.Stream(stack, 'Source Stream');
 
     new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
       sourceStream: sourceStream,
     });
 
@@ -156,7 +156,7 @@ describe('delivery stream', () => {
     const key = new kms.Key(stack, 'Key');
 
     new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
       encryption: StreamEncryption.customerManagedKey(key),
     });
 
@@ -179,7 +179,7 @@ describe('delivery stream', () => {
     const sourceStream = new kinesis.Stream(stack, 'Source Stream');
 
     new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
       sourceStream: sourceStream,
       role: deliveryStreamRole,
     });
@@ -215,7 +215,7 @@ describe('delivery stream', () => {
 
   test('requesting customer-owned encryption creates key and configuration', () => {
     new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
       encryption: firehose.StreamEncryption.customerManagedKey(),
       role: deliveryStreamRole,
     });
@@ -251,7 +251,7 @@ describe('delivery stream', () => {
     const key = new kms.Key(stack, 'Key');
 
     new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
       encryption: StreamEncryption.customerManagedKey(key),
       role: deliveryStreamRole,
     });
@@ -281,7 +281,7 @@ describe('delivery stream', () => {
 
   test('requesting AWS-owned key does not create key and creates configuration', () => {
     new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
       encryption: firehose.StreamEncryption.awsOwnedKey(),
       role: deliveryStreamRole,
     });
@@ -299,7 +299,7 @@ describe('delivery stream', () => {
 
   test('requesting no encryption creates no configuration', () => {
     new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
       encryption: firehose.StreamEncryption.unencrypted(),
       role: deliveryStreamRole,
     });
@@ -316,17 +316,17 @@ describe('delivery stream', () => {
     const sourceStream = new kinesis.Stream(stack, 'Source Stream');
 
     expect(() => new firehose.DeliveryStream(stack, 'Delivery Stream 1', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
       encryption: firehose.StreamEncryption.awsOwnedKey(),
       sourceStream,
     })).toThrowError('Requested server-side encryption but delivery stream source is a Kinesis data stream. Specify server-side encryption on the data stream instead.');
     expect(() => new firehose.DeliveryStream(stack, 'Delivery Stream 2', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
       encryption: firehose.StreamEncryption.customerManagedKey(),
       sourceStream,
     })).toThrowError('Requested server-side encryption but delivery stream source is a Kinesis data stream. Specify server-side encryption on the data stream instead.');
     expect(() => new firehose.DeliveryStream(stack, 'Delivery Stream 3', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
       encryption: StreamEncryption.customerManagedKey(new kms.Key(stack, 'Key')),
       sourceStream,
     })).toThrowError('Requested server-side encryption but delivery stream source is a Kinesis data stream. Specify server-side encryption on the data stream instead.');
@@ -337,7 +337,7 @@ describe('delivery stream', () => {
       assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),
     });
     const deliveryStream = new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
 
     deliveryStream.grant(role, 'firehose:PutRecord');
@@ -360,7 +360,7 @@ describe('delivery stream', () => {
       assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),
     });
     const deliveryStream = new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
 
     deliveryStream.grantPutRecords(role);
@@ -385,7 +385,7 @@ describe('delivery stream', () => {
     const dependableId = stack.resolve((Node.of(dependable).defaultChild as cdk.CfnResource).logicalId);
 
     new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
 
     Template.fromStack(stack).hasResource('AWS::KinesisFirehose::DeliveryStream', {
@@ -396,18 +396,9 @@ describe('delivery stream', () => {
     });
   });
 
-  test('supplying 0 or multiple destinations throws', () => {
-    expect(() => new firehose.DeliveryStream(stack, 'No Destinations', {
-      destinations: [],
-    })).toThrowError(/Only one destination is allowed per delivery stream/);
-    expect(() => new firehose.DeliveryStream(stack, 'Too Many Destinations', {
-      destinations: [mockS3Destination, mockS3Destination],
-    })).toThrowError(/Only one destination is allowed per delivery stream/);
-  });
-
   test('creating new stream should return IAM role when calling getter for grantPrincipal (backwards compatibility)', () => {
     const deliveryStream = new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
     expect(deliveryStream.grantPrincipal).toBeInstanceOf(iam.Role);
   });
@@ -418,7 +409,7 @@ describe('delivery stream', () => {
     beforeEach(() => {
       stack = new cdk.Stack(undefined, undefined, { env: { account: '000000000000', region: 'us-west-1' } });
       deliveryStream = new firehose.DeliveryStream(stack, 'Delivery Stream', {
-        destinations: [mockS3Destination],
+        destinations: mockS3Destination,
       });
     });
 
@@ -516,7 +507,7 @@ describe('delivery stream', () => {
     const vpc = new ec2.Vpc(stack, 'VPC');
     const securityGroup = new ec2.SecurityGroup(stack, 'Security Group', { vpc });
     const deliveryStream = new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
 
     securityGroup.connections.allowFrom(deliveryStream, ec2.Port.allTcp());
@@ -542,7 +533,7 @@ describe('delivery stream', () => {
     const vpc = new ec2.Vpc(stack, 'VPC');
     const securityGroup = new ec2.SecurityGroup(stack, 'Security Group', { vpc });
     const deliveryStream = new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
 
     securityGroup.connections.allowFrom(deliveryStream, ec2.Port.allTcp());
@@ -558,10 +549,10 @@ describe('delivery stream', () => {
 
   test('only adds one Firehose IP address mapping to stack even if multiple delivery streams defined', () => {
     new firehose.DeliveryStream(stack, 'Delivery Stream 1', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
     new firehose.DeliveryStream(stack, 'Delivery Stream 2', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
 
     Template.fromStack(stack).hasMapping('*', {
@@ -573,7 +564,7 @@ describe('delivery stream', () => {
 
   test('can add tags', () => {
     const deliveryStream = new firehose.DeliveryStream(stack, 'Delivery Stream', {
-      destinations: [mockS3Destination],
+      destinations: mockS3Destination,
     });
 
     cdk.Tags.of(deliveryStream).add('tagKey', 'tagValue');

diff --git a/packages/@aws-cdk/aws-kinesisfirehose-alpha/test/integ.delivery-stream.source-stream.ts b/packages/@aws-cdk/aws-kinesisfirehose-alpha/test/integ.delivery-stream.source-stream.ts
@@ -34,12 +34,12 @@ const mockS3Destination: firehose.IDestination = {
 const sourceStream = new kinesis.Stream(stack, 'Source Stream');
 
 new firehose.DeliveryStream(stack, 'Delivery Stream', {
-  destinations: [mockS3Destination],
+  destinations: mockS3Destination,
   sourceStream,
 });
 
 new firehose.DeliveryStream(stack, 'Delivery Stream No Source Or Encryption Key', {
-  destinations: [mockS3Destination],
+  destinations: mockS3Destination,
 });
 
 app.synth();
diff --git a/packages/@aws-cdk/aws-kinesisfirehose-alpha/test/integ.delivery-stream.ts b/packages/@aws-cdk/aws-kinesisfirehose-alpha/test/integ.delivery-stream.ts
@@ -36,12 +36,12 @@ const key = new kms.Key(stack, 'Key', {
 });
 
 new firehose.DeliveryStream(stack, 'Delivery Stream', {
-  destinations: [mockS3Destination],
+  destinations: mockS3Destination,
   encryption: firehose.StreamEncryption.customerManagedKey(key),
 });
 
 new firehose.DeliveryStream(stack, 'Delivery Stream No Source Or Encryption Key', {
-  destinations: [mockS3Destination],
+  destinations: mockS3Destination,
 });
 
 app.synth();
diff --git a/packages/@aws-cdk/aws-kinesisfirehose-alpha/test/integ.kinesis-stream-events-target.ts b/packages/@aws-cdk/aws-kinesisfirehose-alpha/test/integ.kinesis-stream-events-target.ts
@@ -34,7 +34,7 @@ const mockS3Destination: firehose.IDestination = {
 };
 
 const stream = new firehose.DeliveryStream(stack, 'Delivery Stream No Source Or Encryption Key', {
-  destinations: [mockS3Destination],
+  destinations: mockS3Destination,
 });
 
 new events.Rule(stack, 'rule', {