mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-04-18 17:01:22 -07:00
adding ansible types in documentation (#303)
Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician
Alex Stephen
parent
72e4cc7214
commit
43536a1e38
81 changed files with 844 additions and 0 deletions
|
|
@ -56,10 +56,12 @@ options:
|
|||
- "* EXTERNAL: A database server that is not managed by Google."
|
||||
- 'Some valid choices include: "FIRST_GEN", "SECOND_GEN", "EXTERNAL"'
|
||||
required: false
|
||||
type: str
|
||||
connection_name:
|
||||
description:
|
||||
- Connection name of the Cloud SQL instance used in connection strings.
|
||||
required: false
|
||||
type: str
|
||||
database_version:
|
||||
description:
|
||||
- The database engine type and version. For First Generation instances, can be
|
||||
|
|
@ -69,11 +71,13 @@ options:
|
|||
changed after instance creation.'
|
||||
- 'Some valid choices include: "MYSQL_5_5", "MYSQL_5_6", "MYSQL_5_7", "POSTGRES_9_6"'
|
||||
required: false
|
||||
type: str
|
||||
failover_replica:
|
||||
description:
|
||||
- The name and status of the failover replica. This property is applicable only
|
||||
to Second Generation instances.
|
||||
required: false
|
||||
type: dict
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
|
|
@ -81,6 +85,7 @@ options:
|
|||
replica is created for the instance. The name doesn't include the project
|
||||
ID. This property is applicable only to Second Generation instances.
|
||||
required: false
|
||||
type: str
|
||||
instance_type:
|
||||
description:
|
||||
- The instance type. This can be one of the following.
|
||||
|
|
@ -89,32 +94,39 @@ options:
|
|||
- "* READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica."
|
||||
- 'Some valid choices include: "CLOUD_SQL_INSTANCE", "ON_PREMISES_INSTANCE", "READ_REPLICA_INSTANCE"'
|
||||
required: false
|
||||
type: str
|
||||
ipv6_address:
|
||||
description:
|
||||
- The IPv6 address assigned to the instance. This property is applicable only
|
||||
to First Generation instances.
|
||||
required: false
|
||||
type: str
|
||||
master_instance_name:
|
||||
description:
|
||||
- The name of the instance which will act as master in the replication setup.
|
||||
required: false
|
||||
type: str
|
||||
max_disk_size:
|
||||
description:
|
||||
- The maximum disk size of the instance in bytes.
|
||||
required: false
|
||||
type: int
|
||||
name:
|
||||
description:
|
||||
- Name of the Cloud SQL instance. This does not include the project ID.
|
||||
required: true
|
||||
type: str
|
||||
region:
|
||||
description:
|
||||
- The geographical region. Defaults to us-central or us-central1 depending on
|
||||
the instance type (First Generation or Second Generation/PostgreSQL).
|
||||
required: false
|
||||
type: str
|
||||
replica_configuration:
|
||||
description:
|
||||
- Configuration specific to failover replicas and read replicas.
|
||||
required: false
|
||||
type: dict
|
||||
suboptions:
|
||||
failover_target:
|
||||
description:
|
||||
|
|
@ -134,24 +146,29 @@ options:
|
|||
is used only to set up the replication connection and is stored by MySQL
|
||||
in a file named master.info in the data directory.
|
||||
required: false
|
||||
type: dict
|
||||
suboptions:
|
||||
ca_certificate:
|
||||
description:
|
||||
- PEM representation of the trusted CA's x509 certificate.
|
||||
required: false
|
||||
type: str
|
||||
client_certificate:
|
||||
description:
|
||||
- PEM representation of the slave's x509 certificate .
|
||||
required: false
|
||||
type: str
|
||||
client_key:
|
||||
description:
|
||||
- PEM representation of the slave's private key. The corresponding public
|
||||
key is encoded in the client's certificate.
|
||||
required: false
|
||||
type: str
|
||||
connect_retry_interval:
|
||||
description:
|
||||
- Seconds to wait between connect retries. MySQL's default is 60 seconds.
|
||||
required: false
|
||||
type: int
|
||||
dump_file_path:
|
||||
description:
|
||||
- Path to a SQL dump file in Google Cloud Storage from which the slave
|
||||
|
|
@ -160,22 +177,27 @@ options:
|
|||
binlog co-ordinates from which replication should begin. This can be
|
||||
accomplished by setting --master-data to 1 when using mysqldump.
|
||||
required: false
|
||||
type: str
|
||||
master_heartbeat_period:
|
||||
description:
|
||||
- Interval in milliseconds between replication heartbeats.
|
||||
required: false
|
||||
type: int
|
||||
password:
|
||||
description:
|
||||
- The password for the replication connection.
|
||||
required: false
|
||||
type: str
|
||||
ssl_cipher:
|
||||
description:
|
||||
- A list of permissible ciphers to use for SSL encryption.
|
||||
required: false
|
||||
type: str
|
||||
username:
|
||||
description:
|
||||
- The username for the replication connection.
|
||||
required: false
|
||||
type: str
|
||||
verify_server_certificate:
|
||||
description:
|
||||
- Whether or not to check the master's Common Name value in the certificate
|
||||
|
|
@ -186,20 +208,24 @@ options:
|
|||
description:
|
||||
- The replicas of the instance.
|
||||
required: false
|
||||
type: list
|
||||
service_account_email_address:
|
||||
description:
|
||||
- The service account email address assigned to the instance. This property
|
||||
is applicable only to Second Generation instances.
|
||||
required: false
|
||||
type: str
|
||||
settings:
|
||||
description:
|
||||
- The user settings.
|
||||
required: false
|
||||
type: dict
|
||||
suboptions:
|
||||
database_flags:
|
||||
description:
|
||||
- The database flags passed to the instance at startup.
|
||||
required: false
|
||||
type: list
|
||||
version_added: 2.9
|
||||
suboptions:
|
||||
name:
|
||||
|
|
@ -208,17 +234,20 @@ options:
|
|||
include both server options and system variables for MySQL. Flags should
|
||||
be specified with underscores, not hyphens.
|
||||
required: false
|
||||
type: str
|
||||
value:
|
||||
description:
|
||||
- The value of the flag. Booleans should be set to on for true and off
|
||||
for false. This field must be omitted if the flag doesn't take a value.
|
||||
required: false
|
||||
type: str
|
||||
ip_configuration:
|
||||
description:
|
||||
- The settings for IP Management. This allows to enable or disable the instance
|
||||
IP and manage which external networks can connect to the instance. The IPv4
|
||||
address cannot be disabled for Second Generation instances.
|
||||
required: false
|
||||
type: dict
|
||||
suboptions:
|
||||
ipv4_enabled:
|
||||
description:
|
||||
|
|
@ -231,22 +260,26 @@ options:
|
|||
using the IP. In CIDR notation, also known as 'slash' notation (e.g.
|
||||
192.168.100.0/24).
|
||||
required: false
|
||||
type: list
|
||||
suboptions:
|
||||
expiration_time:
|
||||
description:
|
||||
- The time when this access control entry expires in RFC 3339 format,
|
||||
for example 2012-11-15T16:19:00.094Z.
|
||||
required: false
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- An optional label to identify this entry.
|
||||
required: false
|
||||
type: str
|
||||
value:
|
||||
description:
|
||||
- The whitelisted value for the access control list. For example,
|
||||
to grant access to a client from an external IP (IPv4 or IPv6) address
|
||||
or subnet, use that address or subnet here.
|
||||
required: false
|
||||
type: str
|
||||
require_ssl:
|
||||
description:
|
||||
- Whether the mysqld should default to 'REQUIRE X509' for users connecting
|
||||
|
|
@ -259,15 +292,18 @@ options:
|
|||
For MySQL instances, this field determines whether the instance is Second
|
||||
Generation (recommended) or First Generation.
|
||||
required: false
|
||||
type: str
|
||||
availability_type:
|
||||
description:
|
||||
- The availabilityType define if your postgres instance is run zonal or regional.
|
||||
- 'Some valid choices include: "ZONAL", "REGIONAL"'
|
||||
required: false
|
||||
type: str
|
||||
backup_configuration:
|
||||
description:
|
||||
- The daily backup configuration for the instance.
|
||||
required: false
|
||||
type: dict
|
||||
suboptions:
|
||||
enabled:
|
||||
description:
|
||||
|
|
@ -284,6 +320,7 @@ options:
|
|||
description:
|
||||
- Define the backup start time in UTC (HH:MM) .
|
||||
required: false
|
||||
type: str
|
||||
extends_documentation_fragment: gcp
|
||||
'''
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue