Skip to content

Commit a7633a9

Browse files
authored
docs: canonicalize service name of Amazon Data Firehose (#33757)
### Reason for this change Docs in CDK sometimes refer the Amazon Data Firehose as former name "(Amazon) Kinesis Data Firehose" or "(Amazon) Kinesis Firehose". This PR updates them to canonical "Amazon Data Firehose". ### Description of changes - Fixed dangling links in `packages/aws-cdk-lib/aws-kinesisfirehose/README.md` - Updated README and docstrings to refer Amazon Data Firehose - Updated examples refer `@aws-cdk/aws-kinesisfirehose-alpha` - Following files are not changed: - Changelog entries - Test files - aws-kinesisfirehose alpha packages - `.github/ISSUE_TEMPLATE` - `packages/@aws-cdk/pkglint/lib/aws-service-official-names.json` ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent f67a88b commit a7633a9

File tree

31 files changed

+81
-95
lines changed

31 files changed

+81
-95
lines changed

packages/@aws-cdk/aws-iot-actions-alpha/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Currently supported are:
2828
- Capture CloudWatch metrics
2929
- Change state for a CloudWatch alarm
3030
- Put records to Kinesis Data stream
31-
- Put records to Kinesis Data Firehose stream
31+
- Put records to Amazon Data Firehose stream
3232
- Send messages to SQS queues
3333
- Publish messages on SNS topics
3434
- Write messages into columns of DynamoDB
@@ -232,10 +232,10 @@ const topicRule = new iot.TopicRule(this, 'TopicRule', {
232232
});
233233
```
234234

235-
## Put records to Kinesis Data Firehose stream
235+
## Put records to Amazon Data Firehose stream
236236

237237
The code snippet below creates an AWS IoT Rule that puts records to Put records
238-
to Kinesis Data Firehose stream when it is triggered.
238+
to Amazon Data Firehose stream when it is triggered.
239239

240240
```ts
241241
import * as firehose from 'aws-cdk-lib/aws-kinesisfirehose';

packages/@aws-cdk/aws-iot-actions-alpha/lib/firehose-put-record-action.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ export enum FirehoseRecordSeparator {
3030
}
3131

3232
/**
33-
* Configuration properties of an action for the Kinesis Data Firehose stream.
33+
* Configuration properties of an action for the Amazon Data Firehose stream.
3434
*/
3535
export interface FirehosePutRecordActionProps extends CommonActionProps {
3636
/**
37-
* Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch`.
37+
* Whether to deliver the Amazon Data Firehose stream as a batch by using `PutRecordBatch`.
3838
* When batchMode is true and the rule's SQL statement evaluates to an Array, each Array
3939
* element forms one record in the PutRecordBatch request. The resulting array can't have
4040
* more than 500 records.
@@ -44,23 +44,23 @@ export interface FirehosePutRecordActionProps extends CommonActionProps {
4444
readonly batchMode?: boolean;
4545

4646
/**
47-
* A character separator that will be used to separate records written to the Kinesis Data Firehose stream.
47+
* A character separator that will be used to separate records written to the Amazon Data Firehose stream.
4848
*
4949
* @default - none -- the stream does not use a separator
5050
*/
5151
readonly recordSeparator?: FirehoseRecordSeparator;
5252
}
5353

5454
/**
55-
* The action to put the record from an MQTT message to the Kinesis Data Firehose stream.
55+
* The action to put the record from an MQTT message to the Amazon Data Firehose stream.
5656
*/
5757
export class FirehosePutRecordAction implements iot.IAction {
5858
private readonly batchMode?: boolean;
5959
private readonly recordSeparator?: string;
6060
private readonly role?: iam.IRole;
6161

6262
/**
63-
* @param stream The Kinesis Data Firehose stream to which to put records.
63+
* @param stream The Amazon Data Firehose stream to which to put records.
6464
* @param props Optional properties to not use default
6565
*/
6666
constructor(private readonly stream: firehose.IDeliveryStream, props: FirehosePutRecordActionProps = {}) {

packages/@aws-cdk/aws-msk-alpha/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ const cluster = new msk.Cluster(this, 'Cluster', {
177177
## Logging
178178

179179
You can deliver Apache Kafka broker logs to one or more of the following destination types:
180-
Amazon CloudWatch Logs, Amazon S3, Amazon Kinesis Data Firehose.
180+
Amazon CloudWatch Logs, Amazon S3, Amazon Data Firehose.
181181

182182
To configure logs to be sent to an S3 bucket, provide a bucket in the `logging` config.
183183

packages/@aws-cdk/aws-msk-alpha/lib/cluster.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ export interface MonitoringConfiguration {
275275
*/
276276
export interface BrokerLogging {
277277
/**
278-
* The Kinesis Data Firehose delivery stream that is the destination for broker logs.
278+
* The Amazon Data Firehose delivery stream that is the destination for broker logs.
279279
*
280280
* @default - disabled
281281
*/

packages/@aws-cdk/aws-pipes-alpha/lib/logs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ export interface LogDestinationParameters {
111111
readonly cloudwatchLogsLogDestination?: CfnPipe.CloudwatchLogsLogDestinationProperty;
112112

113113
/**
114-
* The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
114+
* The Amazon Data Firehose logging configuration settings for the pipe.
115115
*
116116
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-firehoselogdestination
117117
*

packages/@aws-cdk/aws-scheduler-targets-alpha/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The following targets are supported:
3131
6. `targets.EventBridgePutEvents`: [Put Events on EventBridge](#send-events-to-an-eventbridge-event-bus)
3232
7. `targets.InspectorStartAssessmentRun`: [Start an Amazon Inspector assessment run](#start-an-amazon-inspector-assessment-run)
3333
8. `targets.KinesisStreamPutRecord`: [Put a record to an Amazon Kinesis Data Stream](#put-a-record-to-an-amazon-kinesis-data-stream)
34-
9. `targets.KinesisDataFirehosePutRecord`: [Put a record to a Kinesis Data Firehose](#put-a-record-to-a-kinesis-data-firehose)
34+
9. `targets.KinesisDataFirehosePutRecord`: [Put a record to an Amazon Data Firehose](#put-a-record-to-an-amazon-data-firehose)
3535
10. `targets.CodePipelineStartPipelineExecution`: [Start a CodePipeline execution](#start-a-codepipeline-execution)
3636
11. `targets.SageMakerStartPipelineExecution`: [Start a SageMaker pipeline execution](#start-a-sagemaker-pipeline-execution)
3737
12. `targets.Universal`: [Invoke a wider set of AWS API](#invoke-a-wider-set-of-aws-api)
@@ -252,9 +252,9 @@ new Schedule(this, 'Schedule', {
252252
});
253253
```
254254

255-
## Put a record to a Kinesis Data Firehose
255+
## Put a record to an Amazon Data Firehose
256256

257-
Use the `KinesisDataFirehosePutRecord` target to put a record to a Kinesis Data Firehose delivery stream.
257+
Use the `KinesisDataFirehosePutRecord` target to put a record to an Amazon Data Firehose delivery stream.
258258

259259
The code snippet below creates an event rule with a delivery stream as a target
260260
called every hour by EventBridge Scheduler with a custom payload.

packages/@aws-cdk/aws-scheduler-targets-alpha/lib/kinesis-data-firehose-put-record.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { IDeliveryStream } from 'aws-cdk-lib/aws-kinesisfirehose';
44
import { ScheduleTargetBase, ScheduleTargetBaseProps } from './target';
55

66
/**
7-
* Use an Amazon Kinesis Data Firehose as a target for AWS EventBridge Scheduler.
7+
* Use an Amazon Data Firehose as a target for AWS EventBridge Scheduler.
88
*/
99
export class KinesisDataFirehosePutRecord extends ScheduleTargetBase implements IScheduleTarget {
1010
constructor(

packages/aws-cdk-lib/aws-apigateway/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1400,7 +1400,7 @@ const api = new apigateway.RestApi(this, 'books', {
14001400

14011401
**Note:** The delivery stream name must start with `amazon-apigateway-`.
14021402

1403-
> Visit [Logging API calls to Kinesis Data Firehose](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-logging-to-kinesis.html) for more details.
1403+
> Visit [Logging API calls to Amazon Data Firehose](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-logging-to-kinesis.html) for more details.
14041404
14051405
## Cross Origin Resource Sharing (CORS)
14061406

packages/aws-cdk-lib/aws-config/lib/rule.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2754,7 +2754,7 @@ export class ResourceType {
27542754
public static readonly IAM_SAML_PROVIDER = new ResourceType('AWS::IAM::SAMLProvider');
27552755
/** AWS IAM ServerCertificate */
27562756
public static readonly IAM_SERVER_CERTIFICATE = new ResourceType('AWS::IAM::ServerCertificate');
2757-
/** Amazon Kinesis Firehose DeliveryStream */
2757+
/** Amazon Data Firehose DeliveryStream */
27582758
public static readonly KINESIS_FIREHOSE_DELIVERY_STREAM = new ResourceType('AWS::KinesisFirehose::DeliveryStream');
27592759
/** Amazon Pinpoint Campaign */
27602760
public static readonly PINPOINT_CAMPAIGN = new ResourceType('AWS::Pinpoint::Campaign');

packages/aws-cdk-lib/aws-ec2/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2202,7 +2202,7 @@ new ec2.FlowLog(this, 'FlowLogWithKeyPrefix', {
22022202
});
22032203
```
22042204

2205-
*Kinesis Data Firehose*
2205+
*Amazon Data Firehose*
22062206

22072207
```ts
22082208
import * as firehose from 'aws-cdk-lib/aws-kinesisfirehose';
@@ -2524,4 +2524,4 @@ new ec2.Instance(this, 'Instance', {
25242524
machineImage: ec2.MachineImage.latestAmazonLinux2023(),
25252525
instanceProfile,
25262526
});
2527-
```
2527+
```

0 commit comments

Comments
 (0)