Reference documentation and code samples for the Cloud PubSub V1 Client class AwsKinesis.
Ingestion settings for Amazon Kinesis Data Streams.
Generated from protobuf message google.pubsub.v1.IngestionDataSourceSettings.AwsKinesis
Namespace
Google \ Cloud \ PubSub \ V1 \ IngestionDataSourceSettings
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ state
int
Output only. An output-only field that indicates the state of the Kinesis ingestion source.
↳ stream_arn
string
Required. The Kinesis stream ARN to ingest data from.
↳ consumer_arn
string
Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.
↳ aws_role_arn
string
Required. 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.
↳ gcp_service_account
string
Required. The GCP service account to be used for Federated Identity authentication with Kinesis (via a AssumeRoleWithWebIdentity call for the provided role). The aws_role_arn must be set up with accounts.google.com:sub equals to this service account number.
getState
Output only. An output-only field that indicates the state of the Kinesis
ingestion source.
Returns
Type
Description
int
Enum of type State.
setState
Output only. An output-only field that indicates the state of the Kinesis
ingestion source.
Parameter
Name
Description
var
int
Enum of type State.
Returns
Type
Description
$this
getStreamArn
Required. The Kinesis stream ARN to ingest data from.
Returns
Type
Description
string
setStreamArn
Required. The Kinesis stream ARN to ingest data from.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getConsumerArn
Required. The Kinesis consumer ARN to used for ingestion in Enhanced
Fan-Out mode. The consumer must be already created and ready to be used.
Returns
Type
Description
string
setConsumerArn
Required. The Kinesis consumer ARN to used for ingestion in Enhanced
Fan-Out mode. The consumer must be already created and ready to be used.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAwsRoleArn
Required. 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.
Returns
Type
Description
string
setAwsRoleArn
Required. 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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getGcpServiceAccount
Required. The GCP service account to be used for Federated Identity
authentication with Kinesis (via a AssumeRoleWithWebIdentity call for
the provided role). The aws_role_arn must be set up with
accounts.google.com:sub equals to this service account number.
Returns
Type
Description
string
setGcpServiceAccount
Required. The GCP service account to be used for Federated Identity
authentication with Kinesis (via a AssumeRoleWithWebIdentity call for
the provided role). The aws_role_arn must be set up with
accounts.google.com:sub equals to this service account number.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud PubSub V1 Client - Class AwsKinesis (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.IngestionDataSourceSettings.AwsKinesis)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.IngestionDataSourceSettings.AwsKinesis)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.IngestionDataSourceSettings.AwsKinesis) \nReference documentation and code samples for the Cloud PubSub V1 Client class AwsKinesis.\n\nIngestion settings for Amazon Kinesis Data Streams.\n\nGenerated from protobuf message `google.pubsub.v1.IngestionDataSourceSettings.AwsKinesis`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1 \\\\ IngestionDataSourceSettings\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getState\n\nOutput only. An output-only field that indicates the state of the Kinesis\ningestion source.\n\n### setState\n\nOutput only. An output-only field that indicates the state of the Kinesis\ningestion source.\n\n### getStreamArn\n\nRequired. The Kinesis stream ARN to ingest data from.\n\n### setStreamArn\n\nRequired. The Kinesis stream ARN to ingest data from.\n\n### getConsumerArn\n\nRequired. The Kinesis consumer ARN to used for ingestion in Enhanced\nFan-Out mode. The consumer must be already created and ready to be used.\n\n### setConsumerArn\n\nRequired. The Kinesis consumer ARN to used for ingestion in Enhanced\nFan-Out mode. The consumer must be already created and ready to be used.\n\n### getAwsRoleArn\n\nRequired. AWS role ARN to be used for Federated Identity authentication\nwith Kinesis. Check the Pub/Sub docs for how to set up this role and the\nrequired permissions that need to be attached to it.\n\n### setAwsRoleArn\n\nRequired. AWS role ARN to be used for Federated Identity authentication\nwith Kinesis. Check the Pub/Sub docs for how to set up this role and the\nrequired permissions that need to be attached to it.\n\n### getGcpServiceAccount\n\nRequired. The GCP service account to be used for Federated Identity\nauthentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for\nthe provided role). The `aws_role_arn` must be set up with\n`accounts.google.com:sub` equals to this service account number.\n\n### setGcpServiceAccount\n\nRequired. The GCP service account to be used for Federated Identity\nauthentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for\nthe provided role). The `aws_role_arn` must be set up with\n`accounts.google.com:sub` equals to this service account number."]]
