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.
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.
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.
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-09-03 UTC."],[],[],null,["# Interface IngestionDataSourceSettings.AwsMskOrBuilder (1.141.2)\n\nVersion latestkeyboard_arrow_down\n\n- [1.141.2 (latest)](/java/docs/reference/google-cloud-pubsub/latest/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.141.1](/java/docs/reference/google-cloud-pubsub/1.141.1/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.140.2](/java/docs/reference/google-cloud-pubsub/1.140.2/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.139.4](/java/docs/reference/google-cloud-pubsub/1.139.4/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.138.0](/java/docs/reference/google-cloud-pubsub/1.138.0/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.137.1](/java/docs/reference/google-cloud-pubsub/1.137.1/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.136.1](/java/docs/reference/google-cloud-pubsub/1.136.1/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.135.0](/java/docs/reference/google-cloud-pubsub/1.135.0/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.134.2](/java/docs/reference/google-cloud-pubsub/1.134.2/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.133.1](/java/docs/reference/google-cloud-pubsub/1.133.1/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.132.2](/java/docs/reference/google-cloud-pubsub/1.132.2/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.131.0](/java/docs/reference/google-cloud-pubsub/1.131.0/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.130.0](/java/docs/reference/google-cloud-pubsub/1.130.0/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.129.6](/java/docs/reference/google-cloud-pubsub/1.129.6/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.127.3](/java/docs/reference/google-cloud-pubsub/1.127.3/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.126.6](/java/docs/reference/google-cloud-pubsub/1.126.6/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.125.13](/java/docs/reference/google-cloud-pubsub/1.125.13/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.123.18](/java/docs/reference/google-cloud-pubsub/1.123.18/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.122.2](/java/docs/reference/google-cloud-pubsub/1.122.2/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.121.1](/java/docs/reference/google-cloud-pubsub/1.121.1/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.120.24](/java/docs/reference/google-cloud-pubsub/1.120.24/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.119.1](/java/docs/reference/google-cloud-pubsub/1.119.1/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.118.0](/java/docs/reference/google-cloud-pubsub/1.118.0/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.117.0](/java/docs/reference/google-cloud-pubsub/1.117.0/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.116.4](/java/docs/reference/google-cloud-pubsub/1.116.4/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder)\n- [1.115.5](/java/docs/reference/google-cloud-pubsub/1.115.5/com.google.pubsub.v1.IngestionDataSourceSettings.AwsMskOrBuilder) \n\n public static interface IngestionDataSourceSettings.AwsMskOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### getAwsRoleArn()\n\n public abstract String getAwsRoleArn()\n\nRequired. AWS role ARN to be used for Federated Identity authentication\nwith Amazon MSK. Check the Pub/Sub docs for how to set up this role and\nthe required permissions that need to be attached to it.\n\n`string aws_role_arn = 4 [(.google.api.field_behavior) = REQUIRED];`\n\n### getAwsRoleArnBytes()\n\n public abstract ByteString getAwsRoleArnBytes()\n\nRequired. AWS role ARN to be used for Federated Identity authentication\nwith Amazon MSK. Check the Pub/Sub docs for how to set up this role and\nthe required permissions that need to be attached to it.\n\n`string aws_role_arn = 4 [(.google.api.field_behavior) = REQUIRED];`\n\n### getClusterArn()\n\n public abstract String getClusterArn()\n\nRequired. The Amazon Resource Name (ARN) that uniquely identifies the\ncluster.\n\n`string cluster_arn = 2 [(.google.api.field_behavior) = REQUIRED];`\n\n### getClusterArnBytes()\n\n public abstract ByteString getClusterArnBytes()\n\nRequired. The Amazon Resource Name (ARN) that uniquely identifies the\ncluster.\n\n`string cluster_arn = 2 [(.google.api.field_behavior) = REQUIRED];`\n\n### getGcpServiceAccount()\n\n public abstract String getGcpServiceAccount()\n\nRequired. The GCP service account to be used for Federated Identity\nauthentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call\nfor the provided role). The `aws_role_arn` must be set up with\n`accounts.google.com:sub` equals to this service account number.\n\n`string gcp_service_account = 5 [(.google.api.field_behavior) = REQUIRED];`\n\n### getGcpServiceAccountBytes()\n\n public abstract ByteString getGcpServiceAccountBytes()\n\nRequired. The GCP service account to be used for Federated Identity\nauthentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call\nfor the provided role). The `aws_role_arn` must be set up with\n`accounts.google.com:sub` equals to this service account number.\n\n`string gcp_service_account = 5 [(.google.api.field_behavior) = REQUIRED];`\n\n### getState()\n\n public abstract IngestionDataSourceSettings.AwsMsk.State getState()\n\nOutput only. An output-only field that indicates the state of the Amazon\nMSK ingestion source.\n\n`\n.google.pubsub.v1.IngestionDataSourceSettings.AwsMsk.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];\n`\n\n### getStateValue()\n\n public abstract int getStateValue()\n\nOutput only. An output-only field that indicates the state of the Amazon\nMSK ingestion source.\n\n`\n.google.pubsub.v1.IngestionDataSourceSettings.AwsMsk.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];\n`\n\n### getTopic()\n\n public abstract String getTopic()\n\nRequired. The name of the topic in the Amazon MSK cluster that Pub/Sub\nwill import from.\n\n`string topic = 3 [(.google.api.field_behavior) = REQUIRED];`\n\n### getTopicBytes()\n\n public abstract ByteString getTopicBytes()\n\nRequired. The name of the topic in the Amazon MSK cluster that Pub/Sub\nwill import from.\n\n`string topic = 3 [(.google.api.field_behavior) = REQUIRED];`"]]
