google.cloud.gcp_sql_database – Creates a GCP Database¶
Note
This plugin is part of the google.cloud collection (version 1.0.2).
To install it use: ansible-galaxy collection install google.cloud
.
To use it in a playbook, specify: google.cloud.gcp_sql_database
.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_kind
string
/ required
|
|
The type of credential used.
|
charset
string
|
The charset value. See MySQL's [Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html) and Postgres' [Character Set Support](https://www.postgresql.org/docs/9.6/static/multibyte.html) for more details and supported values. Postgres databases only support a value of `UTF8` at creation time.
|
|
collation
string
|
The collation value. See MySQL's [Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html) and Postgres' [Collation Support](https://www.postgresql.org/docs/9.6/static/collation.html) for more details and supported values. Postgres databases only support a value of `en_US.UTF8` at creation time.
|
|
env_type
string
|
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
|
|
instance
string
/ required
|
The name of the Cloud SQL instance. This does not include the project ID.
|
|
name
string
/ required
|
The name of the database in the Cloud SQL instance.
This does not include the project ID or instance name.
|
|
project
string
|
The Google Cloud Platform project to use.
|
|
scopes
list
/ elements=string
|
Array of scopes to be used
|
|
service_account_contents
jsonarg
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
|
|
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
string
|
|
Whether the given object should exist in GCP
|
Examples¶
- name: create a instance
google.cloud.gcp_sql_instance:
name: "{{resource_name}}-3"
settings:
ip_configuration:
authorized_networks:
- name: google dns server
value: 8.8.8.8/32
tier: db-n1-standard-1
region: us-central1
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: instance
- name: create a database
google.cloud.gcp_sql_database:
name: test_object
charset: utf8
instance: "{{ instance.name }}"
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
charset
string
|
success |
The charset value. See MySQL's [Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html) and Postgres' [Character Set Support](https://www.postgresql.org/docs/9.6/static/multibyte.html) for more details and supported values. Postgres databases only support a value of `UTF8` at creation time.
|
collation
string
|
success |
The collation value. See MySQL's [Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html) and Postgres' [Collation Support](https://www.postgresql.org/docs/9.6/static/collation.html) for more details and supported values. Postgres databases only support a value of `en_US.UTF8` at creation time.
|
instance
string
|
success |
The name of the Cloud SQL instance. This does not include the project ID.
|
name
string
|
success |
The name of the database in the Cloud SQL instance.
This does not include the project ID or instance name.
|
Authors¶
Google Inc. (@googlecloudplatform)