Skip to content

feat(PubSub): Add create_topic_with_kinesis_ingestion sample #2092

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions pubsub/api/src/create_topic_with_kinesis_ingestion.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<?php

/**
* Copyright 2025 Google LLC.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/**
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/blob/main/pubsub/api/README.md
*/

namespace Google\Cloud\Samples\PubSub;

# [START pubsub_create_topic_with_kinesis_ingestion]
use Google\Cloud\PubSub\PubSubClient;

/**
* Creates a Pub/Sub topic with AWS Kinesis ingestion.
*
* @param string $projectId The Google project ID.
* @param string $topicName The Pub/Sub topic name.
* @param string $streamArn The Kinesis stream ARN to ingest data from.
* @param string $consumerArn The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.
* @param string $awsRoleArn AWS role ARN to be used for Federated Identity authentication with Kinesis. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.
* @param string $gcpServiceAccount The GCP service account to be used for Federated Identity authentication with Kinesis (via a AssumeRoleWithWebIdentity call for the provided role). The $awsRoleArn must be set up with accounts.google.com:sub equals to this service account number.
*/
function create_topic_with_kinesis_ingestion(
string $projectId,
string $topicName,
string $streamArn,
string $consumerArn,
string $awsRoleArn,
string $gcpServiceAccount
): void {
$pubsub = new PubSubClient([
'projectId' => $projectId,
]);

$topic = $pubsub->createTopic($topicName, [
'ingestionDataSourceSettings' => [
'aws_kinesis' => [
'stream_arn' => $streamArn,
'consumer_arn' => $consumerArn,
'aws_role_arn' => $awsRoleArn,
'gcp_service_account' => $gcpServiceAccount
]
]
]);

printf('Topic created: %s' . PHP_EOL, $topic->name());
}
# [END pubsub_create_topic_with_kinesis_ingestion]
require_once __DIR__ . '/../../../testing/sample_helpers.php';
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
24 changes: 24 additions & 0 deletions pubsub/api/test/pubsubTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -725,4 +725,28 @@ public function testCreateTopicWithAzureEventHubsIngestion()
$this->assertMatchesRegularExpression('/Topic deleted:/', $output);
$this->assertMatchesRegularExpression(sprintf('/%s/', $topic), $output);
}

public function testCreateTopicWithKinesisIngestion()
{
$this->requireEnv('PUBSUB_EMULATOR_HOST');

$topic = 'test-topic-' . rand();
$output = $this->runFunctionSnippet('create_topic_with_kinesis_ingestion', [
self::$projectId,
$topic,
'arn:aws:kinesis:us-west-2:111111111111:stream/fake-stream-name',
'arn:aws:kinesis:us-west-2:111111111111:stream/fake-stream-name/consumer/consumer-1:1111111111',
self::$awsRoleArn,
self::$gcpServiceAccount
]);
$this->assertMatchesRegularExpression('/Topic created:/', $output);
$this->assertMatchesRegularExpression(sprintf('/%s/', $topic), $output);

$output = $this->runFunctionSnippet('delete_topic', [
self::$projectId,
$topic,
]);
$this->assertMatchesRegularExpression('/Topic deleted:/', $output);
$this->assertMatchesRegularExpression(sprintf('/%s/', $topic), $output);
}
}