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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Rds_instance

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/rds_instance.rb

Overview

Create, modify, and delete RDS instances.

Instance Method Summary

• #allocated_storage ⇒ String^?

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

• #allow_major_version_upgrade ⇒ Symbol^?

  Whether to allow major version upgrades.

• #apply_immediately ⇒ Symbol^?

  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.

• #auto_minor_version_upgrade ⇒ Symbol^?

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

• #availability_zone ⇒ Object^?

  A list of EC2 Availability Zones that instances in the DB cluster can be created in.

• #backup_retention_period ⇒ Object^?

  The number of days for which automated backups are retained (must be greater or equal to 1).

• #ca_certificate_identifier ⇒ Object^?

  The identifier of the CA certificate for the DB instance.

• #character_set_name ⇒ Object^?

  The character set to associate with the DB cluster.

• #copy_tags_to_snapshot ⇒ Symbol^?

  Whether or not to copy all tags from the DB instance to snapshots of the instance.

• #creation_source ⇒ :snapshot, ...

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

• #db_cluster_identifier ⇒ Object^?

  The DB cluster (lowercase) identifier to add the aurora DB instance to.

• #db_instance_class ⇒ String^?

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

• #db_instance_identifier ⇒ String

  The DB instance (lowercase) identifier.

• #db_name ⇒ Object^?

  The name for your database.

• #db_parameter_group_name ⇒ Object^?

  The name of the DB parameter group to associate with this DB instance.

• #db_security_groups ⇒ Array<String>, ...

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

• #db_snapshot_identifier ⇒ Object^?

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

• #db_subnet_group_name ⇒ Object^?

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

• #domain ⇒ Object^?

  The Active Directory Domain to restore the instance in.

• #domain_iam_role_name ⇒ Object^?

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

• #enable_cloudwatch_logs_exports ⇒ Array<String>, ...

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

• #enable_iam_database_authentication ⇒ Symbol^?

  Enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

• #enable_performance_insights ⇒ Symbol^?

  Whether to enable Performance Insights for the DB instance.

• #engine ⇒ String^?

  The name of the database engine to be used for this DB instance.

• #engine_version ⇒ Object^?

  The version number of the database engine to use.

• #final_db_snapshot_identifier ⇒ Object^?

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

• #force_failover ⇒ Symbol^?

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

• #force_update_password ⇒ Symbol^?

  Set to True to update your cluster password with I(master_user_password).

• #iops ⇒ Object^?

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

• #kms_key_id ⇒ Object^?

  The ARN of the AWS KMS key identifier for an encrypted DB instance.

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

  The license model for the DB instance.

• #master_user_password ⇒ Object^?

  An 8-41 character password for the master database user.

• #purge_cloudwatch_logs_exports ⇒ Boolean^?

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

• #purge_tags ⇒ Boolean^?

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

• #read_replica ⇒ Symbol^?

  Set to False to promote a read replica cluster or true to create one.

• #state ⇒ :present, ...

  Whether the snapshot should exist or not.

• #wait ⇒ Boolean^?

  Whether to wait for the cluster to be available, stopped, or deleted.

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #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^?

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

attribute :allocated_storage

#allow_major_version_upgrade ⇒ Symbol^?

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

attribute :allow_major_version_upgrade

#apply_immediately ⇒ Symbol^?

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

attribute :apply_immediately

#auto_minor_version_upgrade ⇒ Symbol^?

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

attribute :auto_minor_version_upgrade

#availability_zone ⇒ Object^?

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

attribute :availability_zone

#backup_retention_period ⇒ Object^?

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

attribute :backup_retention_period

#ca_certificate_identifier ⇒ Object^?

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

attribute :ca_certificate_identifier

#character_set_name ⇒ Object^?

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

attribute :character_set_name

#copy_tags_to_snapshot ⇒ Symbol^?

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

attribute :copy_tags_to_snapshot

#creation_source ⇒ :snapshot, ...

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

attribute :creation_source

#db_cluster_identifier ⇒ Object^?

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

attribute :db_cluster_identifier

#db_instance_class ⇒ String^?

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

attribute :db_instance_class

#db_instance_identifier ⇒ String

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

attribute :db_instance_identifier

#db_name ⇒ Object^?

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

attribute :db_name

#db_parameter_group_name ⇒ Object^?

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

attribute :db_parameter_group_name

#db_security_groups ⇒ Array<String>, ...

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

attribute :db_security_groups

#db_snapshot_identifier ⇒ Object^?

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

attribute :db_snapshot_identifier

#db_subnet_group_name ⇒ Object^?

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

attribute :db_subnet_group_name

#domain ⇒ Object^?

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

attribute :domain

#domain_iam_role_name ⇒ Object^?

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

attribute :domain_iam_role_name

#enable_cloudwatch_logs_exports ⇒ Array<String>, ...

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

attribute :enable_cloudwatch_logs_exports

#enable_iam_database_authentication ⇒ Symbol^?

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

attribute :enable_iam_database_authentication

#enable_performance_insights ⇒ Symbol^?

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

attribute :enable_performance_insights

#engine ⇒ String^?

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

attribute :engine

#engine_version ⇒ Object^?

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

attribute :engine_version

#final_db_snapshot_identifier ⇒ Object^?

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

attribute :final_db_snapshot_identifier

#force_failover ⇒ Symbol^?

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

attribute :force_failover

#force_update_password ⇒ Symbol^?

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

attribute :force_update_password

#iops ⇒ Object^?

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

attribute :iops

#kms_key_id ⇒ Object^?

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

attribute :kms_key_id

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

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

attribute :license_model

#master_user_password ⇒ Object^?

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

attribute :master_user_password

#purge_cloudwatch_logs_exports ⇒ Boolean^?

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

attribute :purge_cloudwatch_logs_exports

#purge_tags ⇒ Boolean^?

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

attribute :purge_tags

#read_replica ⇒ Symbol^?

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

attribute :read_replica

#state ⇒ :present, ...

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

attribute :state

#wait ⇒ Boolean^?

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

attribute :wait