Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk.
Ingestion settings for Amazon MSK.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#aws_role_arn
defaws_role_arn()->::String
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.
#aws_role_arn=
defaws_role_arn=(value)->::String
Parameter
value (::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.
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.
#cluster_arn
defcluster_arn()->::String
Returns
(::String) โ Required. The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
#cluster_arn=
defcluster_arn=(value)->::String
Parameter
value (::String) โ Required. The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
Returns
(::String) โ Required. The Amazon Resource Name (ARN) that uniquely identifies the
cluster.
#gcp_service_account
defgcp_service_account()->::String
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.
#gcp_service_account=
defgcp_service_account=(value)->::String
Parameter
value (::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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk (v1.11.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.11.1 (latest)](/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.11.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.11.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.10.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.10.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.9.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.9.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.8.2](/ruby/docs/reference/google-cloud-pubsub-v1/1.8.2/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.7.1](/ruby/docs/reference/google-cloud-pubsub-v1/1.7.1/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.6.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.6.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.5.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.5.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.4.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.4.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.3.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.3.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.2.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.2.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.1.2](/ruby/docs/reference/google-cloud-pubsub-v1/1.1.2/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [1.0.0](/ruby/docs/reference/google-cloud-pubsub-v1/1.0.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.25.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.25.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.24.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.24.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.23.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.23.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.22.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.22.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.21.2](/ruby/docs/reference/google-cloud-pubsub-v1/0.21.2/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.20.2](/ruby/docs/reference/google-cloud-pubsub-v1/0.20.2/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.19.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.19.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.18.1](/ruby/docs/reference/google-cloud-pubsub-v1/0.18.1/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.17.4](/ruby/docs/reference/google-cloud-pubsub-v1/0.17.4/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.16.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.16.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.15.1](/ruby/docs/reference/google-cloud-pubsub-v1/0.15.1/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.14.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.14.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.13.1](/ruby/docs/reference/google-cloud-pubsub-v1/0.13.1/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.12.1](/ruby/docs/reference/google-cloud-pubsub-v1/0.12.1/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.11.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.11.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.10.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.10.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.9.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.9.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.8.0](/ruby/docs/reference/google-cloud-pubsub-v1/0.8.0/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.7.1](/ruby/docs/reference/google-cloud-pubsub-v1/0.7.1/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk)\n- [0.6.2](/ruby/docs/reference/google-cloud-pubsub-v1/0.6.2/Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk) \nReference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk.\n\nIngestion settings for Amazon MSK. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #aws_role_arn\n\n def aws_role_arn() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #aws_role_arn=\n\n def aws_role_arn=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #cluster_arn\n\n def cluster_arn() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.\n\n### #cluster_arn=\n\n def cluster_arn=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster. \n**Returns**\n\n- (::String) --- Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.\n\n### #gcp_service_account\n\n def gcp_service_account() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #gcp_service_account=\n\n def gcp_service_account=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk::State\n\n**Returns**\n\n- ([::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk::State](./Google-Cloud-PubSub-V1-IngestionDataSourceSettings-AwsMsk-State)) --- Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.\n\n### #topic\n\n def topic() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.\n\n### #topic=\n\n def topic=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from. \n**Returns**\n\n- (::String) --- Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from."]]
