chore(kinesisfirehose-alpha): rename bind method to _bind and mark as…

… internal
aws · Oct 21, 2024 · 206bb8b · 206bb8b
1 parent 318eae6
commit 206bb8b
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 9 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
@@ -358,7 +358,7 @@ export class DeliveryStream extends DeliveryStreamBase {
       readStreamGrant = props.source.grantRead(this._role);
     }
 
-    const destinationConfig = props.destination.bind(this, {});
+    const destinationConfig = props.destination._bind(this, {});
     const sourceConfig = props.source?._bind(this, this._role?.roleArn);
 
     const resource = new CfnDeliveryStream(this, 'Resource', {

diff --git a/packages/@aws-cdk/aws-kinesisfirehose-alpha/lib/destination.ts b/packages/@aws-cdk/aws-kinesisfirehose-alpha/lib/destination.ts
@@ -34,6 +34,8 @@ export interface IDestination {
    * Binds this destination to the Kinesis Data Firehose delivery stream.
    *
    * Implementers should use this method to bind resources to the stack and initialize values using the provided stream.
+   *
+   * @internal
    */
-  bind(scope: Construct, options: DestinationBindOptions): DestinationConfig;
+  _bind(scope: Construct, options: DestinationBindOptions): DestinationConfig;
 }
diff --git a/packages/@aws-cdk/aws-kinesisfirehose-alpha/lib/lambda-function-processor.ts b/packages/@aws-cdk/aws-kinesisfirehose-alpha/lib/lambda-function-processor.ts
@@ -15,7 +15,10 @@ export class LambdaFunctionProcessor implements IDataProcessor {
     this.props = props;
   }
 
-  public bind(_scope: Construct, options: DataProcessorBindOptions): DataProcessorConfig {
+  /**
+   * @internal
+   */
+  public _bind(_scope: Construct, options: DataProcessorBindOptions): DataProcessorConfig {
     this.lambdaFunction.grantInvoke(options.role);
 
     return {

diff --git a/packages/@aws-cdk/aws-kinesisfirehose-alpha/lib/processor.ts b/packages/@aws-cdk/aws-kinesisfirehose-alpha/lib/processor.ts
@@ -91,6 +91,8 @@ export interface IDataProcessor {
    *
    * Implementers should use this method to grant processor invocation permissions to the provided stream and return the
    * necessary configuration to register as a processor.
+   *
+   * @internal
    */
-  bind(scope: Construct, options: DataProcessorBindOptions): DataProcessorConfig;
+  _bind(scope: Construct, options: DataProcessorBindOptions): DataProcessorConfig;
 }
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
@@ -27,7 +27,7 @@ describe('delivery stream', () => {
       assumedBy: new iam.ServicePrincipal('firehose.amazonaws.com'),
     });
     mockS3Destination = {
-      bind(scope: Construct, _options: firehose.DestinationBindOptions): firehose.DestinationConfig {
+      _bind(scope: Construct, _options: firehose.DestinationBindOptions): firehose.DestinationConfig {
         dependable = new class extends Construct {
           constructor(depScope: Construct, id: string) {
             super(depScope, id);

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
@@ -20,7 +20,7 @@ const role = new iam.Role(stack, 'Role', {
 });
 
 const mockS3Destination: firehose.IDestination = {
-  bind(_scope: constructs.Construct, _options: firehose.DestinationBindOptions): firehose.DestinationConfig {
+  _bind(_scope: constructs.Construct, _options: firehose.DestinationBindOptions): firehose.DestinationConfig {
     const bucketGrant = bucket.grantReadWrite(role);
     return {
       extendedS3DestinationConfiguration: {

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
@@ -19,7 +19,7 @@ const role = new iam.Role(stack, 'Role', {
 });
 
 const mockS3Destination: firehose.IDestination = {
-  bind(_scope: constructs.Construct, _options: firehose.DestinationBindOptions): firehose.DestinationConfig {
+  _bind(_scope: constructs.Construct, _options: firehose.DestinationBindOptions): firehose.DestinationConfig {
     const bucketGrant = bucket.grantReadWrite(role);
     return {
       extendedS3DestinationConfiguration: {

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
@@ -21,7 +21,7 @@ const role = new iam.Role(stack, 'Role', {
 });
 
 const mockS3Destination: firehose.IDestination = {
-  bind(_scope: constructs.Construct, _options: firehose.DestinationBindOptions): firehose.DestinationConfig {
+  _bind(_scope: constructs.Construct, _options: firehose.DestinationBindOptions): firehose.DestinationConfig {
     const bucketGrant = bucket.grantReadWrite(role);
     return {
       extendedS3DestinationConfiguration: {

diff --git a/packages/@aws-cdk/aws-kinesisfirehose-destinations-alpha/lib/private/helpers.ts b/packages/@aws-cdk/aws-kinesisfirehose-destinations-alpha/lib/private/helpers.ts
@@ -115,7 +115,7 @@ function renderDataProcessor(
   scope: Construct,
   role: iam.IRole,
 ): CfnDeliveryStream.ProcessorProperty {
-  const processorConfig = processor.bind(scope, { role });
+  const processorConfig = processor._bind(scope, { role });
   const parameters = [{ parameterName: 'RoleArn', parameterValue: role.roleArn }];
   parameters.push(processorConfig.processorIdentifier);
   if (processor.props.bufferInterval) {