Cloud Pub/Sub v1 API - Class IngestionDataSourceSettings.Types.AwsKinesis (3.19.0)

public sealed class IngestionDataSourceSettings.Types.AwsKinesis : IMessage<IngestionDataSourceSettings.Types.AwsKinesis>, IEquatable<IngestionDataSourceSettings.Types.AwsKinesis>, IDeepCloneable<IngestionDataSourceSettings.Types.AwsKinesis>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Pub/Sub v1 API class IngestionDataSourceSettings.Types.AwsKinesis.

Ingestion settings for Amazon Kinesis Data Streams.

Inheritance

object > IngestionDataSourceSettings.Types.AwsKinesis

Implements

IMessage IngestionDataSourceSettings Types AwsKinesis, IEquatable IngestionDataSourceSettings Types AwsKinesis, IDeepCloneable IngestionDataSourceSettings Types AwsKinesis, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

AwsKinesis()

public AwsKinesis()

AwsKinesis(AwsKinesis)

public AwsKinesis(IngestionDataSourceSettings.Types.AwsKinesis other)

Parameter
Name	Description
`other`	`IngestionDataSourceSettingsTypesAwsKinesis`

Properties

AwsRoleArn

public string AwsRoleArn { get; set; }

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.

Property Value
Type	Description
`string`

ConsumerArn

public string ConsumerArn { get; set; }

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.

Property Value
Type	Description
`string`

GcpServiceAccount

public string GcpServiceAccount { get; set; }

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.

Property Value
Type	Description
`string`

State

public IngestionDataSourceSettings.Types.AwsKinesis.Types.State State { get; set; }

Output only. An output-only field that indicates the state of the Kinesis ingestion source.

Property Value
Type	Description
`IngestionDataSourceSettingsTypesAwsKinesisTypesState`

StreamArn

public string StreamArn { get; set; }

Required. The Kinesis stream ARN to ingest data from.

Property Value
Type	Description
`string`