Class: Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/pubsub/v1/pubsub.rb

Overview

Ingestion settings for Amazon MSK.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#aws_role_arn ⇒ ::String

Returns Required. AWS role ARN to be used for Federated Identity authentication with Amazon MSK. 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 Amazon MSK. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 349

class AwsMsk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states for managed ingestion from Amazon MSK.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Ingestion is active.
    ACTIVE = 1

    # Permission denied encountered while consuming data from Amazon MSK.
    MSK_PERMISSION_DENIED = 2

    # Permission denied encountered while publishing to the topic.
    PUBLISH_PERMISSION_DENIED = 3

    # The provided MSK cluster wasn't found.
    CLUSTER_NOT_FOUND = 4

    # The provided topic wasn't found.
    TOPIC_NOT_FOUND = 5
  end
end

#cluster_arn ⇒ ::String

Returns Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Returns:

  • (::String) —

    Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 349

class AwsMsk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states for managed ingestion from Amazon MSK.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Ingestion is active.
    ACTIVE = 1

    # Permission denied encountered while consuming data from Amazon MSK.
    MSK_PERMISSION_DENIED = 2

    # Permission denied encountered while publishing to the topic.
    PUBLISH_PERMISSION_DENIED = 3

    # The provided MSK cluster wasn't found.
    CLUSTER_NOT_FOUND = 4

    # The provided topic wasn't found.
    TOPIC_NOT_FOUND = 5
  end
end

#gcp_service_account ⇒ ::String

Returns Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (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 Amazon MSK (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.



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 349

class AwsMsk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states for managed ingestion from Amazon MSK.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Ingestion is active.
    ACTIVE = 1

    # Permission denied encountered while consuming data from Amazon MSK.
    MSK_PERMISSION_DENIED = 2

    # Permission denied encountered while publishing to the topic.
    PUBLISH_PERMISSION_DENIED = 3

    # The provided MSK cluster wasn't found.
    CLUSTER_NOT_FOUND = 4

    # The provided topic wasn't found.
    TOPIC_NOT_FOUND = 5
  end
end

#state ⇒ ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk::State (readonly)

Returns Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.

Returns:



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 349

class AwsMsk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states for managed ingestion from Amazon MSK.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Ingestion is active.
    ACTIVE = 1

    # Permission denied encountered while consuming data from Amazon MSK.
    MSK_PERMISSION_DENIED = 2

    # Permission denied encountered while publishing to the topic.
    PUBLISH_PERMISSION_DENIED = 3

    # The provided MSK cluster wasn't found.
    CLUSTER_NOT_FOUND = 4

    # The provided topic wasn't found.
    TOPIC_NOT_FOUND = 5
  end
end

#topic ⇒ ::String

Returns Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.

Returns:

  • (::String) —

    Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 349

class AwsMsk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible states for managed ingestion from Amazon MSK.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # Ingestion is active.
    ACTIVE = 1

    # Permission denied encountered while consuming data from Amazon MSK.
    MSK_PERMISSION_DENIED = 2

    # Permission denied encountered while publishing to the topic.
    PUBLISH_PERMISSION_DENIED = 3

    # The provided MSK cluster wasn't found.
    CLUSTER_NOT_FOUND = 4

    # The provided topic wasn't found.
    TOPIC_NOT_FOUND = 5
  end
end