New in version 2.6.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_kind
string
/ required
|
|
The type of credential used.
|
labels
-
added in 2.8 |
A set of key/value label pairs to assign to this Topic.
|
|
name
-
/ required
|
Name of the topic.
|
|
project
string
|
The Google Cloud Platform project to use.
|
|
scopes
list
|
Array of scopes to be used.
|
|
service_account_contents
string
|
A string representing the contents of a Service Account JSON file.
This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON)
|
|
service_account_email
string
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
|
service_account_file
path
|
The path of a Service Account JSON file if serviceaccount is selected as type.
|
|
state
-
|
|
Whether the given object should exist in GCP
|
Note
GCP_SERVICE_ACCOUNT_FILE
env variable.GCP_SERVICE_ACCOUNT_EMAIL
env variable.GCP_SERVICE_ACCOUNT_CONTENTS
env variable.GCP_AUTH_KIND
env variable.GCP_SCOPES
env variable.- name: create a topic
gcp_pubsub_topic:
name: test-topic1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
labels
dictionary
|
success |
A set of key/value label pairs to assign to this Topic.
|
name
string
|
success |
Name of the topic.
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.