Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsKinesis (v1.1.0)

Version 1.1.0

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.2
• 1.0.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.2
• 0.20.2
• 0.19.0
• 0.18.1
• 0.17.4
• 0.16.0
• 0.15.1
• 0.14.0
• 0.13.1
• 0.12.1
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.2

Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsKinesis.

Ingestion settings for Amazon Kinesis Data Streams.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#aws_role_arn

def aws_role_arn() -> ::String

Returns

• (::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.

#aws_role_arn=

def aws_role_arn=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#consumer_arn

def consumer_arn() -> ::String

Returns

• (::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.

#consumer_arn=

def consumer_arn=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#gcp_service_account

def gcp_service_account() -> ::String

Returns

• (::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.

#gcp_service_account=

def gcp_service_account=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#state

def state() -> ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsKinesis::State

Returns

• (::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsKinesis::State) — Output only. An output-only field that indicates the state of the Kinesis ingestion source.

#stream_arn

def stream_arn() -> ::String

Returns

• (::String) — Required. The Kinesis stream ARN to ingest data from.

#stream_arn=

def stream_arn=(value) -> ::String

Parameter

• value (::String) — Required. The Kinesis stream ARN to ingest data from.

Returns

• (::String) — Required. The Kinesis stream ARN to ingest data from.