You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Neptune::Types::DBInstance

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances action.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

Specifies the allocated storage size specified in gibibytes.

Returns:

  • (Integer) —

    Specifies the allocated storage size specified in gibibytes.

#auto_minor_version_upgrade ⇒ Boolean

Indicates that minor version patches are applied automatically.

Returns:

  • (Boolean) —

    Indicates that minor version patches are applied automatically.

#availability_zone ⇒ String

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

Returns:

  • (String) —

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

#backup_retention_period ⇒ Integer

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

Returns:

  • (Integer) —

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

#ca_certificate_identifier ⇒ String

The identifier of the CA certificate for this DB instance.

Returns:

  • (String) —

    The identifier of the CA certificate for this DB instance.

#character_set_name ⇒ String

(Not supported by Neptune)

Returns:

  • (String) —

    (Not supported by Neptune).

#copy_tags_to_snapshot ⇒ Boolean

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Returns:

  • (Boolean) —

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

#db_cluster_identifier ⇒ String

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.

Returns:

  • (String) —

    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 ⇒ String

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

Returns:

  • (String) —

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

#db_instance_class ⇒ String

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

Returns:

  • (String) —

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

#db_instance_identifier ⇒ String

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

Returns:

  • (String) —

    Contains a user-supplied database identifier.

#db_instance_port ⇒ Integer

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.

Returns:

  • (Integer) —

    Specifies the port that the DB instance listens on.

#db_instance_status ⇒ String

Specifies the current state of this database.

Returns:

  • (String) —

    Specifies the current state of this database.

#db_name ⇒ String

The database name.

Returns:

  • (String) —

    The database name.

#db_parameter_groups ⇒ Array<Types::DBParameterGroupStatus>

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

Returns:

#db_security_groups ⇒ Array<Types::DBSecurityGroupMembership>

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Returns:

  • (Array<Types::DBSecurityGroupMembership>) —

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

#db_subnet_group ⇒ Types::DBSubnetGroup

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

Returns:

  • (Types::DBSubnetGroup) —

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

#dbi_resource_id ⇒ String

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

Returns:

  • (String) —

    The AWS Region-unique, immutable identifier for the DB instance.

#deletion_protection ⇒ Boolean

Indicates whether or not the DB instance has deletion protection enabled. The instance can\'t be deleted when deletion protection is enabled. See Deleting a DB Instance.

Returns:

  • (Boolean) —

    Indicates whether or not the DB instance has deletion protection enabled.

#domain_memberships ⇒ Array<Types::DomainMembership>

Not supported

Returns:

#enabled_cloudwatch_logs_exports ⇒ Array<String>

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Returns:

  • (Array<String>) —

    A list of log types that this DB instance is configured to export to CloudWatch Logs.

#endpoint ⇒ Types::Endpoint

Specifies the connection endpoint.

Returns:

#engine ⇒ String

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

Returns:

  • (String) —

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

#engine_version ⇒ String

Indicates the database engine version.

Returns:

  • (String) —

    Indicates the database engine version.

#enhanced_monitoring_resource_arn ⇒ String

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

Returns:

  • (String) —

    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 ⇒ Boolean

True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

Returns:

  • (Boolean) —

    True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

#instance_create_time ⇒ Time

Provides the date and time the DB instance was created.

Returns:

  • (Time) —

    Provides the date and time the DB instance was created.

#iops ⇒ Integer

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

Returns:

  • (Integer) —

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

#kms_key_id ⇒ String

Not supported: The encryption for DB instances is managed by the DB cluster.

Returns:

  • (String) —

    Not supported: The encryption for DB instances is managed by the DB cluster.

#latest_restorable_time ⇒ Time

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

Returns:

  • (Time) —

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

#license_model ⇒ String

License model information for this DB instance.

Returns:

  • (String) —

    License model information for this DB instance.

#master_username ⇒ String

Contains the master username for the DB instance.

Returns:

  • (String) —

    Contains the master username for the DB instance.

#monitoring_interval ⇒ Integer

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

Returns:

  • (Integer) —

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

#monitoring_role_arn ⇒ String

The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Returns:

  • (String) —

    The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

#multi_az ⇒ Boolean

Specifies if the DB instance is a Multi-AZ deployment.

Returns:

  • (Boolean) —

    Specifies if the DB instance is a Multi-AZ deployment.

#option_group_memberships ⇒ Array<Types::OptionGroupMembership>

(Not supported by Neptune)

Returns:

#pending_modified_values ⇒ Types::PendingModifiedValues

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Returns:

#performance_insights_enabled ⇒ Boolean

(Not supported by Neptune)

Returns:

  • (Boolean) —

    (Not supported by Neptune).

#performance_insights_kms_key_id ⇒ String

(Not supported by Neptune)

Returns:

  • (String) —

    (Not supported by Neptune).

#preferred_backup_window ⇒ String

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

Returns:

  • (String) —

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

#preferred_maintenance_window ⇒ String

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

Returns:

  • (String) —

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

#promotion_tier ⇒ Integer

A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

Returns:

  • (Integer) —

    A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

#publicly_accessible ⇒ Boolean

This flag should no longer be used.

Returns:

  • (Boolean) —

    This flag should no longer be used.

#read_replica_db_cluster_identifiers ⇒ Array<String>

Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

Returns:

  • (Array<String>) —

    Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

#read_replica_db_instance_identifiers ⇒ Array<String>

Contains one or more identifiers of the Read Replicas associated with this DB instance.

Returns:

  • (Array<String>) —

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

#read_replica_source_db_instance_identifier ⇒ String

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

Returns:

  • (String) —

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

#secondary_availability_zone ⇒ String

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

Returns:

  • (String) —

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

#status_infos ⇒ Array<Types::DBInstanceStatusInfo>

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

Returns:

#storage_encrypted ⇒ Boolean

Not supported: The encryption for DB instances is managed by the DB cluster.

Returns:

  • (Boolean) —

    Not supported: The encryption for DB instances is managed by the DB cluster.

#storage_type ⇒ String

Specifies the storage type associated with DB instance.

Returns:

  • (String) —

    Specifies the storage type associated with DB instance.

#tde_credential_arn ⇒ String

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

Returns:

  • (String) —

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

#timezone ⇒ String

Not supported.

Returns:

  • (String) —

    Not supported.

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

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

Returns: