Reference documentation and code samples for the Cloud PubSub V1 Client class AwsMsk.
Ingestion settings for Amazon MSK.
Generated from protobuf message google.pubsub.v1.IngestionDataSourceSettings.AwsMsk
Namespace
Google \ Cloud \ PubSub \ V1 \ IngestionDataSourceSettingsMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ state |
int
Output only. An output-only field that indicates the state of the Amazon MSK ingestion source. |
↳ cluster_arn |
string
Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
↳ topic |
string
Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from. |
↳ aws_role_arn |
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. |
↳ gcp_service_account |
string
Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a |
getState
Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClusterArn
Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClusterArn
Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTopic
Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTopic
Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAwsRoleArn
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 | |
|---|---|
| Type | Description |
string |
|
setAwsRoleArn
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGcpServiceAccount
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 | |
|---|---|
| Type | Description |
string |
|
setGcpServiceAccount
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|