Class AwsKinesis (2.20.1)

Version 2.20.1

• 2.26.1 (latest)
• 2.26.0
• 2.25.2
• 2.23.1
• 2.22.0
• 2.21.5
• 2.20.3
• 2.19.8
• 2.18.4
• 2.17.1
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.12
• 2.12.1
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.1
• 2.6.1
• 2.5.0
• 2.4.2
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.7.2
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.2
• 0.45.0
• 0.44.0
• 0.43.0

AwsKinesis(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Ingestion settings for Amazon Kinesis Data Streams.

Attributes
Name	Description
state :noindex:	google.pubsub_v1.types.IngestionDataSourceSettings.AwsKinesis.State Output only. An output-only field that indicates the state of the Kinesis ingestion source.
stream_arn :noindex:	str Required. The Kinesis stream ARN to ingest data from.
consumer_arn :noindex:	str 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 :noindex:	str 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 :noindex:	str 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.

Classes

State

State(value)

Possible states for ingestion from Amazon Kinesis Data Streams.

Values: STATE_UNSPECIFIED (0): Default value. This value is unused. ACTIVE (1): Ingestion is active. KINESIS_PERMISSION_DENIED (2): Permission denied encountered while consuming data from Kinesis. This can happen if:

    -  The provided `aws_role_arn` does not exist or does not
       have the appropriate permissions attached.
    -  The provided `aws_role_arn` is not set up properly for
       Identity Federation using `gcp_service_account`.
    -  The Pub/Sub SA is not granted the
       `iam.serviceAccounts.getOpenIdToken` permission on
       `gcp_service_account`.
PUBLISH_PERMISSION_DENIED (3):
    Permission denied encountered while publishing to the topic.
    This can happen due to Pub/Sub SA has not been granted the
    `appropriate publish
    permissions <https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher>`__
STREAM_NOT_FOUND (4):
    The Kinesis stream does not exist.
CONSUMER_NOT_FOUND (5):
    The Kinesis consumer does not exist.