New in version 2.8.
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.
|
|
id
-
/ required
|
The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter.
Trailing hyphens are prohibited.
|
||
labels
-
|
The labels associated with this Project.
Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
No more than 256 labels can be associated with a given resource.
Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed .
|
||
name
-
|
The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point.
|
||
parent
-
|
A parent organization.
|
||
id
-
|
Id of the organization.
|
||
type
-
|
Must be organization.
|
||
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 project
gcp_resourcemanager_project:
name: My Sample Project
id: alextest-{{ 10000000000 | random }}
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
parent:
type: organization
id: 636173955921
state: present
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
createTime
string
|
success |
Time of creation.
|
|
id
string
|
success |
The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter.
Trailing hyphens are prohibited.
|
|
labels
dictionary
|
success |
The labels associated with this Project.
Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
No more than 256 labels can be associated with a given resource.
Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed .
|
|
lifecycleState
string
|
success |
The Project lifecycle state.
|
|
name
string
|
success |
The user-assigned display name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point.
|
|
number
integer
|
success |
Number uniquely identifying the project.
|
|
parent
complex
|
success |
A parent organization.
|
|
id
string
|
success |
Id of the organization.
|
|
type
string
|
success |
Must be organization.
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.