View Source GoogleApi.PubSub.V1.Model.AwsKinesis (google_api_pub_sub v0.38.0)

Ingestion settings for Amazon Kinesis Data Streams.

Attributes

  • awsRoleArn (type: String.t, default: nil) - 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.
  • consumerArn (type: String.t, default: nil) - 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.
  • gcpServiceAccount (type: String.t, default: nil) - 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 (type: String.t, default: nil) - Output only. An output-only field that indicates the state of the Kinesis ingestion source.
  • streamArn (type: String.t, default: nil) - Required. The Kinesis stream ARN to ingest data from.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.PubSub.V1.Model.AwsKinesis{
  awsRoleArn: String.t() | nil,
  consumerArn: String.t() | nil,
  gcpServiceAccount: String.t() | nil,
  state: String.t() | nil,
  streamArn: String.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.