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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb

Overview

Contains the details of an Amazon Neptune DB instance.

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

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

Specifies the allocated storage size specified in gibibytes.

Returns:

  • (Integer)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

Indicates that minor version patches are applied automatically.

Returns:

  • (Boolean)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#availability_zoneString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#backup_retention_periodInteger

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

Returns:

  • (Integer)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#ca_certificate_identifierString

The identifier of the CA certificate for this DB instance.

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#character_set_nameString

(Not supported by Neptune)

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#copy_tags_to_snapshotBoolean

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

Returns:

  • (Boolean)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#db_cluster_identifierString

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)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#db_instance_arnString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#db_instance_classString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#db_instance_identifierString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#db_instance_portInteger

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)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#db_instance_statusString

Specifies the current state of this database.

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#db_nameString

The database name.

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#db_parameter_groupsArray<Types::DBParameterGroupStatus>

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

Returns:



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#db_security_groupsArray<Types::DBSecurityGroupMembership>

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



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#db_subnet_groupTypes::DBSubnetGroup

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



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#dbi_resource_idString

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)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#deletion_protectionBoolean

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)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#domain_membershipsArray<Types::DomainMembership>

Not supported

Returns:



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#enabled_cloudwatch_logs_exportsArray<String>

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

Returns:

  • (Array<String>)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#endpointTypes::Endpoint

Specifies the connection endpoint.

Returns:



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#engineString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#engine_versionString

Indicates the database engine version.

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#enhanced_monitoring_resource_arnString

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)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#iam_database_authentication_enabledBoolean

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

Returns:

  • (Boolean)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#instance_create_timeTime

Provides the date and time the DB instance was created.

Returns:

  • (Time)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#iopsInteger

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

Returns:

  • (Integer)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#kms_key_idString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#latest_restorable_timeTime

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

Returns:

  • (Time)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#license_modelString

License model information for this DB instance.

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#master_usernameString

Contains the master username for the DB instance.

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#monitoring_intervalInteger

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

Returns:

  • (Integer)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#monitoring_role_arnString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#multi_azBoolean

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

Returns:

  • (Boolean)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#option_group_membershipsArray<Types::OptionGroupMembership>

(Not supported by Neptune)

Returns:



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#pending_modified_valuesTypes::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.



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#performance_insights_enabledBoolean

(Not supported by Neptune)

Returns:

  • (Boolean)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#performance_insights_kms_key_idString

(Not supported by Neptune)

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#preferred_backup_windowString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#preferred_maintenance_windowString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#promotion_tierInteger

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)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#publicly_accessibleBoolean

This flag should no longer be used.

Returns:

  • (Boolean)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#read_replica_db_cluster_identifiersArray<String>

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

Returns:

  • (Array<String>)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#read_replica_db_instance_identifiersArray<String>

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

Returns:

  • (Array<String>)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#read_replica_source_db_instance_identifierString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#secondary_availability_zoneString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#status_infosArray<Types::DBInstanceStatusInfo>

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

Returns:



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#storage_encryptedBoolean

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

Returns:

  • (Boolean)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#storage_typeString

Specifies the storage type associated with DB instance.

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#tde_credential_arnString

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

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#timezoneString

Not supported.

Returns:

  • (String)


2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end

#vpc_security_groupsArray<Types::VpcSecurityGroupMembership>

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



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2725

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  include Aws::Structure
end