Class: Ansible::Ruby::Modules::Rds_instance

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

Overview

Create, modify, and delete RDS instances.

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

#allocated_storage ⇒ String?

Returns The amount of storage (in gibibytes) to allocate for the DB instance.

Returns:

  • (String, nil) —

    The amount of storage (in gibibytes) to allocate for the DB instance.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 40

attribute :allocated_storage

#allow_major_version_upgrade ⇒ Symbol?

Returns Whether to allow major version upgrades.

Returns:

  • (Symbol, nil) —

    Whether to allow major version upgrades.



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 44

attribute :allow_major_version_upgrade

#apply_immediately ⇒ Symbol?

Returns A value that specifies whether modifying a cluster with I(new_db_instance_identifier) and I(master_user_password) should be applied as soon as possible, regardless of the I(preferred_maintenance_window) setting. If false, changes are applied during the next maintenance window.

Returns:

  • (Symbol, nil) —

    A value that specifies whether modifying a cluster with I(new_db_instance_identifier) and I(master_user_password) should be applied as soon as possible, regardless of the I(preferred_maintenance_window) setting. If false, changes are applied during the next maintenance window.



48
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 48

attribute :apply_immediately

#auto_minor_version_upgrade ⇒ Symbol?

Returns Whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

Returns:

  • (Symbol, nil) —

    Whether minor version upgrades are applied automatically to the DB instance during the maintenance window.



52
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 52

attribute :auto_minor_version_upgrade

#availability_zone ⇒ Object?

Returns A list of EC2 Availability Zones that instances in the DB cluster can be created in. May be used when creating a cluster or when restoring from S3 or a snapshot. Mutually exclusive with I(multi_az).

Returns:

  • (Object, nil) —

    A list of EC2 Availability Zones that instances in the DB cluster can be created in. May be used when creating a cluster or when restoring from S3 or a snapshot. Mutually exclusive with I(multi_az).



56
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 56

attribute :availability_zone

#backup_retention_period ⇒ Object?

Returns The number of days for which automated backups are retained (must be greater or equal to 1). May be used when creating a new cluster, when restoring from S3, or when modifying a cluster.

Returns:

  • (Object, nil) —

    The number of days for which automated backups are retained (must be greater or equal to 1). May be used when creating a new cluster, when restoring from S3, or when modifying a cluster.



59
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 59

attribute :backup_retention_period

#ca_certificate_identifier ⇒ Object?

Returns The identifier of the CA certificate for the DB instance.

Returns:

  • (Object, nil) —

    The identifier of the CA certificate for the DB instance.



62
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 62

attribute :ca_certificate_identifier

#character_set_name ⇒ Object?

Returns The character set to associate with the DB cluster.

Returns:

  • (Object, nil) —

    The character set to associate with the DB cluster.



65
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 65

attribute :character_set_name

#copy_tags_to_snapshot ⇒ Symbol?

Returns Whether or not to copy all tags from the DB instance to snapshots of the instance. When initially creating a DB instance the RDS API defaults this to false if unspecified.

Returns:

  • (Symbol, nil) —

    Whether or not to copy all tags from the DB instance to snapshots of the instance. When initially creating a DB instance the RDS API defaults this to false if unspecified.



68
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 68

attribute :copy_tags_to_snapshot

#creation_source ⇒ :snapshot, ...

Returns Which source to use if restoring from a template (an existing instance, S3 bucket, or snapshot).

Returns:

  • (:snapshot, :s3, :instance, nil) —

    Which source to use if restoring from a template (an existing instance, S3 bucket, or snapshot).



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 16

attribute :creation_source

#db_cluster_identifier ⇒ Object?

Returns The DB cluster (lowercase) identifier to add the aurora DB instance to. The identifier must contain from 1 to 63 letters, numbers, or hyphens and the first character must be a letter and may not end in a hyphen or contain consecutive hyphens.

Returns:

  • (Object, nil) —

    The DB cluster (lowercase) identifier to add the aurora DB instance to. The identifier must contain from 1 to 63 letters, numbers, or hyphens and the first character must be a letter and may not end in a hyphen or contain consecutive hyphens.



72
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 72

attribute :db_cluster_identifier

#db_instance_class ⇒ String?

Returns The compute and memory capacity of the DB instance, for example db.t2.micro.

Returns:

  • (String, nil) —

    The compute and memory capacity of the DB instance, for example db.t2.micro.



75
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 75

attribute :db_instance_class

#db_instance_identifier ⇒ String

Returns The DB instance (lowercase) identifier. The identifier must contain from 1 to 63 letters, numbers, or hyphens and the first character must be a letter and may not end in a hyphen or contain consecutive hyphens.

Returns:

  • (String) —

    The DB instance (lowercase) identifier. The identifier must contain from 1 to 63 letters, numbers, or hyphens and the first character must be a letter and may not end in a hyphen or contain consecutive hyphens.



79
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 79

attribute :db_instance_identifier

#db_name ⇒ Object?

Returns The name for your database. If a name is not provided Amazon RDS will not create a database.

Returns:

  • (Object, nil) —

    The name for your database. If a name is not provided Amazon RDS will not create a database.



83
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 83

attribute :db_name

#db_parameter_group_name ⇒ Object?

Returns The name of the DB parameter group to associate with this DB instance. When creating the DB instance if this argument is omitted the default DBParameterGroup for the specified engine is used.

Returns:

  • (Object, nil) —

    The name of the DB parameter group to associate with this DB instance. When creating the DB instance if this argument is omitted the default DBParameterGroup for the specified engine is used.



86
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 86

attribute :db_parameter_group_name

#db_security_groups ⇒ Array<String>, ...

Returns (EC2-Classic platform) A list of DB security groups to associate with this DB instance.

Returns:

  • (Array<String>, String, nil) —

    (EC2-Classic platform) A list of DB security groups to associate with this DB instance.



89
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 89

attribute :db_security_groups

#db_snapshot_identifier ⇒ Object?

Returns The identifier for the DB snapshot to restore from if using I(creation_source=snapshot).

Returns:

  • (Object, nil) —

    The identifier for the DB snapshot to restore from if using I(creation_source=snapshot).



93
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 93

attribute :db_snapshot_identifier

#db_subnet_group_name ⇒ Object?

Returns The DB subnet group name to use for the DB instance.

Returns:

  • (Object, nil) —

    The DB subnet group name to use for the DB instance.



96
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 96

attribute :db_subnet_group_name

#domain ⇒ Object?

Returns The Active Directory Domain to restore the instance in.

Returns:

  • (Object, nil) —

    The Active Directory Domain to restore the instance in.



99
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 99

attribute :domain

#domain_iam_role_name ⇒ Object?

Returns The name of the IAM role to be used when making API calls to the Directory Service.

Returns:

  • (Object, nil) —

    The name of the IAM role to be used when making API calls to the Directory Service.



102
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 102

attribute :domain_iam_role_name

#enable_cloudwatch_logs_exports ⇒ Array<String>, ...

Returns A list of log types that need to be enabled for exporting to CloudWatch Logs.

Returns:

  • (Array<String>, String, nil) —

    A list of log types that need to be enabled for exporting to CloudWatch Logs.



105
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 105

attribute :enable_cloudwatch_logs_exports

#enable_iam_database_authentication ⇒ Symbol?

Returns Enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. If this option is omitted when creating the cluster, Amazon RDS sets this to False.

Returns:

  • (Symbol, nil) —

    Enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. If this option is omitted when creating the cluster, Amazon RDS sets this to False.



109
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 109

attribute :enable_iam_database_authentication

#enable_performance_insights ⇒ Symbol?

Returns Whether to enable Performance Insights for the DB instance.

Returns:

  • (Symbol, nil) —

    Whether to enable Performance Insights for the DB instance.



113
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 113

attribute :enable_performance_insights

#engine ⇒ String?

Returns The name of the database engine to be used for this DB instance. This is required to create an instance. Valid choices are aurora | aurora-mysql | aurora-postgresql | mariadb | mysql | oracle-ee | oracle-se | oracle-se1 | oracle-se2 | postgres | sqlserver-ee | sqlserver-ex | sqlserver-se | sqlserver-web.

Returns:

  • (String, nil) —

    The name of the database engine to be used for this DB instance. This is required to create an instance. Valid choices are aurora | aurora-mysql | aurora-postgresql | mariadb | mysql | oracle-ee | oracle-se | oracle-se1 | oracle-se2 | postgres | sqlserver-ee | sqlserver-ex | sqlserver-se | sqlserver-web



117
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 117

attribute :engine

#engine_version ⇒ Object?

Returns The version number of the database engine to use. For Aurora MySQL that could be 5.6.10a , 5.7.12. Aurora PostgreSQL example, 9.6.3.

Returns:

  • (Object, nil) —

    The version number of the database engine to use. For Aurora MySQL that could be 5.6.10a , 5.7.12. Aurora PostgreSQL example, 9.6.3



121
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 121

attribute :engine_version

#final_db_snapshot_identifier ⇒ Object?

Returns The DB instance snapshot identifier of the new DB instance snapshot created when I(skip_final_snapshot) is false.

Returns:

  • (Object, nil) —

    The DB instance snapshot identifier of the new DB instance snapshot created when I(skip_final_snapshot) is false.



124
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 124

attribute :final_db_snapshot_identifier

#force_failover ⇒ Symbol?

Returns Set to true to conduct the reboot through a MultiAZ failover.

Returns:

  • (Symbol, nil) —

    Set to true to conduct the reboot through a MultiAZ failover.



127
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 127

attribute :force_failover

#force_update_password ⇒ Symbol?

Returns Set to True to update your cluster password with I(master_user_password). Since comparing passwords to determine if it needs to be updated is not possible this is set to False by default to allow idempotence.

Returns:

  • (Symbol, nil) —

    Set to True to update your cluster password with I(master_user_password). Since comparing passwords to determine if it needs to be updated is not possible this is set to False by default to allow idempotence.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 20

attribute :force_update_password

#iops ⇒ Object?

Returns The Provisioned IOPS (I/O operations per second) value.

Returns:

  • (Object, nil) —

    The Provisioned IOPS (I/O operations per second) value.



131
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 131

attribute :iops

#kms_key_id ⇒ Object?

Returns The ARN of the AWS KMS key identifier for an encrypted DB instance. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.,If I(storage_encrypted) is true and and this option is not provided, the default encryption key is used.

Returns:

  • (Object, nil) —

    The ARN of the AWS KMS key identifier for an encrypted DB instance. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.,If I(storage_encrypted) is true and and this option is not provided, the default encryption key is used.



134
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 134

attribute :kms_key_id

#license_model ⇒ :"license-included", ...

Returns The license model for the DB instance.

Returns:

  • (:"license-included", :"bring-your-own-license", :"general-public-license", nil) —

    The license model for the DB instance.



137
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 137

attribute :license_model

#master_user_password ⇒ Object?

Returns An 8-41 character password for the master database user. The password can contain any printable ASCII character except “/”,.

Returns:

  • (Object, nil) —

    An 8-41 character password for the master database user. The password can contain any printable ASCII character except “/”,



141
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 141

attribute :master_user_password

#purge_cloudwatch_logs_exports ⇒ Boolean?

Returns Set to False to retain any enabled cloudwatch logs that aren’t specified in the task and are associated with the instance.

Returns:

  • (Boolean, nil) —

    Set to False to retain any enabled cloudwatch logs that aren’t specified in the task and are associated with the instance.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 24

attribute :purge_cloudwatch_logs_exports

#purge_tags ⇒ Boolean?

Returns Set to False to retain any tags that aren’t specified in task and are associated with the instance.

Returns:

  • (Boolean, nil) —

    Set to False to retain any tags that aren’t specified in task and are associated with the instance.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 28

attribute :purge_tags

#read_replica ⇒ Symbol?

Returns Set to False to promote a read replica cluster or true to create one. When creating a read replica C(creation_source) should be set to ‘instance’ or not provided. C(source_db_instance_identifier) must be provided with this option.

Returns:

  • (Symbol, nil) —

    Set to False to promote a read replica cluster or true to create one. When creating a read replica C(creation_source) should be set to ‘instance’ or not provided. C(source_db_instance_identifier) must be provided with this option.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 32

attribute :read_replica

#state ⇒ :present, ...

Returns Whether the snapshot should exist or not. I(rebooted) is not idempotent and will leave the DB instance in a running state and start it prior to rebooting if it was stopped. I(present) will leave the DB instance in the current running/stopped state, (running if creating the DB instance).,I(state=running) and I(state=started) are synonyms, as are I(state=rebooted) and I(state=restarted). Note - rebooting the instance is not idempotent.

Returns:

  • (:present, :absent, :terminated, :running, :started, :stopped, :rebooted, :restarted, nil) —

    Whether the snapshot should exist or not. I(rebooted) is not idempotent and will leave the DB instance in a running state and start it prior to rebooting if it was stopped. I(present) will leave the DB instance in the current running/stopped state, (running if creating the DB instance).,I(state=running) and I(state=started) are synonyms, as are I(state=rebooted) and I(state=restarted). Note - rebooting the instance is not idempotent.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 12

attribute :state

#wait ⇒ Boolean?

Returns Whether to wait for the cluster to be available, stopped, or deleted. At a later time a wait_timeout option may be added. Following each API call to create/modify/delete the instance a waiter is used with a 60 second delay 30 times until the instance reaches the expected state (available/stopped/deleted). The total task time may also be influenced by AWSRetry which helps stabilize if the instance is in an invalid state to operate on to begin with (such as if you try to stop it when it is in the process of rebooting). If setting this to False task retries and delays may make your playbook execution better handle timeouts for major modifications.

Returns:

  • (Boolean, nil) —

    Whether to wait for the cluster to be available, stopped, or deleted. At a later time a wait_timeout option may be added. Following each API call to create/modify/delete the instance a waiter is used with a 60 second delay 30 times until the instance reaches the expected state (available/stopped/deleted). The total task time may also be influenced by AWSRetry which helps stabilize if the instance is in an invalid state to operate on to begin with (such as if you try to stop it when it is in the process of rebooting). If setting this to False task retries and delays may make your playbook execution better handle timeouts for major modifications.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb', line 36

attribute :wait