RDS

rds.db_cluster
rds.db_instance

rds.db_cluster

class rds.db_cluster

Discovery Example:

>>> from cloudwanderer import CloudWanderer, ServiceResourceType
>>> from cloudwanderer.storage_connectors import GremlinStorageConnector
>>> cloud_wanderer = CloudWanderer(storage_connectors=[
...        GremlinStorageConnector(
...          endpoint_url="ws://localhost:8182",
...        )
...    ])
>>> cloud_wanderer.write_resources(
...     service_resource_types=[ServiceResourceType("rds","db_cluster")]
... )

OpenCypher Example:

How to query resources of this type using OpenCypher in Neptune.

MATCH (db_cluster:aws_rds_db_cluster)
RETURN *

Gremlin Example:

How to query resources of this type using Gremlin in Neptune/local Gremlin.

g.V().hasLabel('aws_rds_db_cluster').out().path().by(valueMap(true))

activity_stream_kinesis_stream_name: The name of the Amazon Kinesis data stream used for the database activity stream.

activity_stream_kms_key_id: The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

activity_stream_mode: The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

activity_stream_status: The status of the database activity stream.

allocated_storage: For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn’t fixed, but instead automatically adjusts as needed.

associated_roles: Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

auto_minor_version_upgrade: A value that indicates that minor version patches are applied automatically. This setting is only for non-Aurora Multi-AZ DB clusters.

automatic_restart_time: The time when a stopped DB cluster is restarted automatically.

availability_zones: Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

backtrack_consumed_change_records: The number of change records stored for Backtrack.

backtrack_window: The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

backup_retention_period: Specifies the number of days for which automatic DB snapshots are retained.

capacity: The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .

character_set_name: If present, specifies the name of the character set that this cluster is associated with.

clone_group_id: Identifies the clone group to which the DB cluster is associated.

cluster_create_time: Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

copy_tags_to_snapshot: Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

cross_account_clone: Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

custom_endpoints: Identifies all custom endpoints associated with the cluster.

database_name: Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

db_cluster_arn: The Amazon Resource Name (ARN) for the DB cluster.

db_cluster_identifier: Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

db_cluster_instance_class: The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters.

db_cluster_members: Provides the list of instances that make up the DB cluster.

db_cluster_option_group_memberships: Provides the list of option group memberships for this DB cluster.

db_cluster_parameter_group: Specifies the name of the DB cluster parameter group for the DB cluster.

db_cluster_resource_id: The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

db_subnet_group: Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

deletion_protection: Indicates if the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled.

domain_memberships: The Active Directory Domain membership records associated with the DB cluster.

earliest_backtrack_time: The earliest time to which a DB cluster can be backtracked.

earliest_restorable_time: The earliest time to which a database can be restored with point-in-time restore.

enabled_cloudwatch_logs_exports: A list of log types that this DB cluster is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

endpoint: Specifies the connection endpoint for the primary instance of the DB cluster.

engine: The name of the database engine to be used for this DB cluster.

engine_mode: The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster . For more information, see CreateDBCluster .

engine_version: Indicates the database engine version.

global_write_forwarding_requested: Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

global_write_forwarding_status: Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

hosted_zone_id: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

http_endpoint_enabled: A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .

iam_database_authentication_enabled: A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

iops: The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

kms_key_id: If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

latest_restorable_time: Specifies the latest time to which a database can be restored with point-in-time restore.

master_username: Contains the master username for the DB cluster.

monitoring_interval: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters.

monitoring_role_arn: The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This setting is only for non-Aurora Multi-AZ DB clusters.

multi_az: Specifies whether the DB cluster has instances in multiple Availability Zones.

pending_modified_values: A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

percent_progress: Specifies the progress of the operation as a percentage.

performance_insights_enabled: True if Performance Insights is enabled for the DB cluster, and otherwise false. This setting is only for non-Aurora Multi-AZ DB clusters.

performance_insights_kms_key_id: The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for non-Aurora Multi-AZ DB clusters.

performance_insights_retention_period: The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). This setting is only for non-Aurora Multi-AZ DB clusters.

port: Specifies the port that the database engine is listening on.

preferred_backup_window: Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

preferred_maintenance_window: Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

publicly_accessible: Specifies the accessibility options for the DB instance. When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance’s VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn’t permit it. When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance . This setting is only for non-Aurora Multi-AZ DB clusters.

read_replica_identifiers: Contains one or more identifiers of the read replicas associated with this DB cluster.

reader_endpoint: The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

replication_source_identifier: Contains the identifier of the source DB cluster if this DB cluster is a read replica.

scaling_configuration_info: Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode. For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .

status: Specifies the current state of this DB cluster.

storage_encrypted: Specifies whether the DB cluster is encrypted.

storage_type: The storage type associated with the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters.

tag_list: A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

vpc_security_groups: Provides a list of VPC security groups that the DB cluster belongs to.

rds.db_instance

class rds.db_instance

Discovery Example:

>>> from cloudwanderer import CloudWanderer, ServiceResourceType
>>> from cloudwanderer.storage_connectors import GremlinStorageConnector
>>> cloud_wanderer = CloudWanderer(storage_connectors=[
...        GremlinStorageConnector(
...          endpoint_url="ws://localhost:8182",
...        )
...    ])
>>> cloud_wanderer.write_resources(
...     service_resource_types=[ServiceResourceType("rds","db_instance")]
... )

OpenCypher Example:

How to query resources of this type using OpenCypher in Neptune.

MATCH (db_instance:aws_rds_db_instance)
RETURN *

Gremlin Example:

How to query resources of this type using Gremlin in Neptune/local Gremlin.

g.V().hasLabel('aws_rds_db_instance').out().path().by(valueMap(true))

activity_stream_engine_native_audit_fields_included: Indicates whether engine-native audit fields are included in the database activity stream.

activity_stream_kinesis_stream_name: The name of the Amazon Kinesis data stream used for the database activity stream.

activity_stream_kms_key_id: The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

activity_stream_mode: The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

activity_stream_status: The status of the database activity stream.

allocated_storage: Specifies the allocated storage size specified in gibibytes (GiB).

associated_roles: The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

auto_minor_version_upgrade: A value that indicates that minor version patches are applied automatically.

automatic_restart_time: The time when a stopped DB instance is restarted automatically.

automation_mode: The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .

availability_zone: Specifies the name of the Availability Zone the DB instance is located in.

aws_backup_recovery_point_arn: The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

backup_retention_period: Specifies the number of days for which automatic DB snapshots are retained.

backup_target: Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

ca_certificate_identifier: The identifier of the CA certificate for this DB instance.

character_set_name: If present, specifies the name of the character set that this instance is associated with.

copy_tags_to_snapshot: Specifies whether tags are copied from the DB instance to snapshots of the DB instance. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .

custom_iam_instance_profile: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: * The profile must exist in your account. * The profile must have an IAM role that Amazon EC2 has permissions to assume. * The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom . For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide .

customer_owned_ip_enabled: Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide . For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .

db_cluster_identifier: If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

db_instance_arn: The Amazon Resource Name (ARN) for the DB instance.

db_instance_automated_backups_replications: The list of replicated automated backups associated with the DB instance.

db_instance_class: Contains the name of the compute and memory capacity class of the DB instance.

db_instance_identifier: Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

db_instance_port: Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

db_instance_status: Specifies the current state of this database. For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

db_name: The meaning of this parameter differs according to the database engine you use. MySQL, MariaDB, SQL Server, PostgreSQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

db_parameter_groups: Provides the list of DB parameter groups applied to this DB instance.

db_security_groups: A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

db_subnet_group: Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

dbi_resource_id: The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.

deletion_protection: Indicates if the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .

domain_memberships: The Active Directory Domain membership records associated with the DB instance.

enabled_cloudwatch_logs_exports: A list of log types that this DB instance is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

endpoint: Specifies the connection endpoint. .. note:: The endpoint might not be shown for instances whose status is creating .

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

engine_version: Indicates the database engine version.

enhanced_monitoring_resource_arn: The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

iam_database_authentication_enabled: True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. IAM database authentication can be enabled for the following database engines * For MySQL 5.6, minor version 5.6.34 or higher * For MySQL 5.7, minor version 5.7.16 or higher * Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

instance_create_time: Provides the date and time the DB instance was created.

iops: Specifies the Provisioned IOPS (I/O operations per second) value.

kms_key_id: If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

latest_restorable_time: Specifies the latest time to which a database can be restored with point-in-time restore.

license_model: License model information for this DB instance. This setting doesn’t apply to RDS Custom.

listener_endpoint: Specifies the listener connection endpoint for SQL Server Always On.

master_username: Contains the master username for the DB instance.

max_allocated_storage: The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

monitoring_interval: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

monitoring_role_arn: The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

multi_az: Specifies if the DB instance is a Multi-AZ deployment. This setting doesn’t apply to RDS Custom.

nchar_character_set_name: The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

option_group_memberships: Provides the list of option group memberships for this DB instance.

pending_modified_values: A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

performance_insights_enabled: True if Performance Insights is enabled for the DB instance, and otherwise false.

performance_insights_kms_key_id: The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

performance_insights_retention_period: The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

preferred_backup_window: Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

preferred_maintenance_window: Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

processor_features: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

promotion_tier: A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .

publicly_accessible: Specifies the accessibility options for the DB instance. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it. When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance .

read_replica_db_cluster_identifiers: Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn’t contain information about cross-Region Aurora read replicas. .. note:: Currently, each RDS DB instance can have only one Aurora read replica.

read_replica_db_instance_identifiers: Contains one or more identifiers of the read replicas associated with this DB instance.

read_replica_source_db_instance_identifier: Contains the identifier of the source DB instance if this DB instance is a read replica.

replica_mode: The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide . .. note:: This attribute is only supported in RDS for Oracle.

resume_full_automation_mode_time: The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

secondary_availability_zone: If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

status_infos: The status of a read replica. If the instance isn’t a read replica, this is blank.

storage_encrypted: Specifies whether the DB instance is encrypted.

storage_type: Specifies the storage type associated with DB instance.

tag_list: A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

tde_credential_arn: The ARN from the key store with which the instance is associated for TDE encryption.

timezone: The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

vpc_security_groups: Provides a list of VPC security group elements that the DB instance belongs to.