GCPCredentialsControllerService

GCPCredentialsControllerService 2.2.0

Bundle: org.apache.nifi | nifi-gcp-nar
Description: Defines credentials for Google Cloud Platform processors. Uses Application Default credentials without configuration. Application Default credentials support environmental variable (GOOGLE_APPLICATION_CREDENTIALS) pointing to a credential file, the config generated by `gcloud auth application-default login`, AppEngine/Compute Engine service accounts, etc.
Tags: credentials, gcp, provider
Input Requirement
Supports Sensitive Dynamic Properties: false

Properties

Use Application Default Credentials
If true, uses Google Application Default Credentials, which checks the GOOGLE_APPLICATION_CREDENTIALS environment variable for a filepath to a service account JSON key, the config generated by the gcloud sdk, the App Engine service account, and the Compute Engine service account.
Display Name

Use Application Default Credentials

Description

If true, uses Google Application Default Credentials, which checks the GOOGLE_APPLICATION_CREDENTIALS environment variable for a filepath to a service account JSON key, the config generated by the gcloud sdk, the App Engine service account, and the Compute Engine service account.

API Name

application-default-credentials

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Use Compute Engine Credentials
If true, uses Google Compute Engine Credentials of the Compute Engine VM Instance which NiFi is running on.
Display Name

Use Compute Engine Credentials

Description

If true, uses Google Compute Engine Credentials of the Compute Engine VM Instance which NiFi is running on.

API Name

compute-engine-credentials

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Delegation Strategy
The Delegation Strategy determines which account is used when calls are made with the GCP Credential.
Display Name

Delegation Strategy

Description

The Delegation Strategy determines which account is used when calls are made with the GCP Credential.

API Name

Delegation Strategy

Default Value

Service Account

Allowable Values
- Service Account
- Delegated Account
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Delegation User
This user will be impersonated by the service account for api calls. API calls made using this credential will appear as if they are coming from delegate user with the delegate user's access. Any scopes supplied from processors to this credential must have domain-wide delegation setup with the service account.
Display Name

Delegation User

Description

This user will be impersonated by the service account for api calls. API calls made using this credential will appear as if they are coming from delegate user with the delegate user's access. Any scopes supplied from processors to this credential must have domain-wide delegation setup with the service account.

API Name

Delegation User

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true

Dependencies
- Delegation Strategy is set to any of [Delegated Account]
Proxy Configuration Service
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

Display Name

Proxy Configuration Service

Description

Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

API Name

proxy-configuration-service

Service Interface

org.apache.nifi.proxy.ProxyConfigurationService

Service Implementations

org.apache.nifi.proxy.StandardProxyConfigurationService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Service Account JSON
The raw JSON containing a Service Account keyfile.

Display Name

Service Account JSON

Description

The raw JSON containing a Service Account keyfile.

API Name

service-account-json

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

true

Required

false
Service Account JSON File
Path to a file containing a Service Account key file in JSON format.

Display Name

Service Account JSON File

Description

Path to a file containing a Service Account key file in JSON format.

API Name

service-account-json-file

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Restrictions

Required Permission	Explanation
access environment credentials	The default configuration can read environment variables and system properties for credentials