Class: Google::Apis::PubsubV1::AwsKinesis

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/pubsub_v1/classes.rb,
lib/google/apis/pubsub_v1/representations.rb,
lib/google/apis/pubsub_v1/representations.rb

Overview

Ingestion settings for Amazon Kinesis Data Streams.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AwsKinesis

Returns a new instance of AwsKinesis.



106
107
108
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 106

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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. Corresponds to the JSON property awsRoleArn

Returns:

  • (String) 


79
80
81
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 79

def aws_role_arn
  @aws_role_arn
end

#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. Corresponds to the JSON property consumerArn

Returns:

  • (String) 


85
86
87
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 85

def consumer_arn
  @consumer_arn
end

#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. Corresponds to the JSON property gcpServiceAccount

Returns:

  • (String) 


93
94
95
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 93

def 
  @gcp_service_account
end

#state ⇒ String

Output only. An output-only field that indicates the state of the Kinesis ingestion source. Corresponds to the JSON property state

Returns:

  • (String) 


99
100
101
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 99

def state
  @state
end

#stream_arn ⇒ String

Required. The Kinesis stream ARN to ingest data from. Corresponds to the JSON property streamArn

Returns:

  • (String) 


104
105
106
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 104

def stream_arn
  @stream_arn
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



111
112
113
114
115
116
117
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 111

def update!(**args)
  @aws_role_arn = args[:aws_role_arn] if args.key?(:aws_role_arn)
  @consumer_arn = args[:consumer_arn] if args.key?(:consumer_arn)
  @gcp_service_account = args[:gcp_service_account] if args.key?(:gcp_service_account)
  @state = args[:state] if args.key?(:state)
  @stream_arn = args[:stream_arn] if args.key?(:stream_arn)
end