Class: Ansible::Ruby::Modules::Gcp_sql_instance

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb

Overview

Represents a Cloud SQL instance. Cloud SQL instances are SQL databases hosted in Google’s cloud. The Instances resource provides methods for common configuration and management tasks.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#backend_type ⇒ :FIRST_GEN, ...

Returns * FIRST_GEN: First Generation instance. MySQL only.,* SECOND_GEN: Second Generation instance or PostgreSQL instance.,* EXTERNAL: A database server that is not managed by Google.

Returns:

  • (:FIRST_GEN, :SECOND_GEN, :EXTERNAL, nil) —

    • FIRST_GEN: First Generation instance. MySQL only.,* SECOND_GEN: Second Generation instance or PostgreSQL instance.,* EXTERNAL: A database server that is not managed by Google.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 16

attribute :backend_type

#connection_name ⇒ Object?

Returns Connection name of the Cloud SQL instance used in connection strings.

Returns:

  • (Object, nil) —

    Connection name of the Cloud SQL instance used in connection strings.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 20

attribute :connection_name

#database_version ⇒ :MYSQL_5_5, ...

Returns The database engine type and version. For First Generation instances, can be MYSQL_5_5, or MYSQL_5_6. For Second Generation instances, can be MYSQL_5_6 or MYSQL_5_7. Defaults to MYSQL_5_6.,PostgreSQL instances: POSTGRES_9_6 The databaseVersion property can not be changed after instance creation.

Returns:

  • (:MYSQL_5_5, :MYSQL_5_6, :MYSQL_5_7, :POSTGRES_9_6, nil) —

    The database engine type and version. For First Generation instances, can be MYSQL_5_5, or MYSQL_5_6. For Second Generation instances, can be MYSQL_5_6 or MYSQL_5_7. Defaults to MYSQL_5_6.,PostgreSQL instances: POSTGRES_9_6 The databaseVersion property can not be changed after instance creation.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 23

attribute :database_version

#failover_replica ⇒ Object?

Returns The name and status of the failover replica. This property is applicable only to Second Generation instances.

Returns:

  • (Object, nil) —

    The name and status of the failover replica. This property is applicable only to Second Generation instances.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 27

attribute :failover_replica

#instance_type ⇒ :CLOUD_SQL_INSTANCE, ...

Returns The instance type. This can be one of the following.,* CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.,* ON_PREMISES_INSTANCE: An instance running on the customer’s premises.,* READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.

Returns:

  • (:CLOUD_SQL_INSTANCE, :ON_PREMISES_INSTANCE, :READ_REPLICA_INSTANCE, nil) —

    The instance type. This can be one of the following.,* CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master.,* ON_PREMISES_INSTANCE: An instance running on the customer’s premises.,* READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 30

attribute :instance_type

#ipv6_address ⇒ Object?

Returns The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.

Returns:

  • (Object, nil) —

    The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 34

attribute :ipv6_address

#master_instance_name ⇒ Object?

Returns The name of the instance which will act as master in the replication setup.

Returns:

  • (Object, nil) —

    The name of the instance which will act as master in the replication setup.



37
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 37

attribute :master_instance_name

#max_disk_size ⇒ Object?

Returns The maximum disk size of the instance in bytes.

Returns:

  • (Object, nil) —

    The maximum disk size of the instance in bytes.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 40

attribute :max_disk_size

#name ⇒ String

Returns Name of the Cloud SQL instance. This does not include the project ID.

Returns:

  • (String) —

    Name of the Cloud SQL instance. This does not include the project ID.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 43

attribute :name

#region ⇒ String?

Returns The geographical region. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation/PostgreSQL).

Returns:

  • (String, nil) —

    The geographical region. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation/PostgreSQL).



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 47

attribute :region

#replica_configuration ⇒ Object?

Returns Configuration specific to failover replicas and read replicas.

Returns:

  • (Object, nil) —

    Configuration specific to failover replicas and read replicas.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 51

attribute :replica_configuration

#settings ⇒ Hash?

Returns The user settings.

Returns:

  • (Hash, nil) —

    The user settings.



54
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 54

attribute :settings

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_sql_instance.rb', line 12

attribute :state