Class: Aws::Neptune::Types::DBCluster

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 cluster.

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

Returns:

  • (Integer)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#associated_roles ⇒ Array<Types::DBClusterRole>

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

Returns:



2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#automatic_restart_time ⇒ Time

Time at which the DB cluster will be automatically restarted.

Returns:

  • (Time)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zones ⇒ Array<String>

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

Returns:

  • (Array<String>)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_period ⇒ Integer

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

Returns:

  • (Integer)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#character_set_name ⇒ String

Not supported by Neptune.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#clone_group_id ⇒ String

Identifies the clone group to which the DB cluster is associated.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_create_time ⇒ Time

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

Returns:

  • (Time)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshot ⇒ Boolean

If set to true, tags are copied to any snapshot of the DB cluster that is created.

Returns:

  • (Boolean)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#cross_account_clone ⇒ Boolean

If set to true, the DB cluster can be cloned across accounts.

Returns:

  • (Boolean)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ String

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

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_arn ⇒ String

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

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ String

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

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_members ⇒ Array<Types::DBClusterMember>

Provides the list of instances that make up the DB cluster.

Returns:



2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_option_group_memberships ⇒ Array<Types::DBClusterOptionGroupStatus>

Not supported by Neptune.



2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_parameter_group ⇒ String

Specifies the name of the DB cluster parameter group for the DB cluster.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_resource_id ⇒ String

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

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_subnet_group ⇒ String

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

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ Boolean

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

Returns:

  • (Boolean)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#earliest_restorable_time ⇒ Time

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

Returns:

  • (Time)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#enabled_cloudwatch_logs_exports ⇒ Array<String>

A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

Returns:

  • (Array<String>)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

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

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

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

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

Indicates the database engine version.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_identifier ⇒ String

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#hosted_zone_id ⇒ String

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

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#iam_database_authentication_enabled ⇒ Boolean

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

  • (Boolean)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#io_optimized_next_allowed_modification_time ⇒ Time

The next time you can modify the DB cluster to use the iopt1 storage type.

Returns:

  • (Time)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#latest_restorable_time ⇒ Time

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

Returns:

  • (Time)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ String

Not supported by Neptune.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#multi_az ⇒ Boolean

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

Returns:

  • (Boolean)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ String

The network type of the DB cluster.

Valid Values:

  • IPV4   –   The DB cluster uses only IPv4 addresses for communication.

  • DUAL   –   The DB cluster uses both IPv4 and IPv6 addresses for communication.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#pending_modified_values ⇒ Types::ClusterPendingModifiedValues

This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.



2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#percent_progress ⇒ String

Specifies the progress of the operation as a percentage.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

Specifies the port that the database engine is listening on.

Returns:

  • (Integer)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_backup_window ⇒ String

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

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ String

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

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#read_replica_identifiers ⇒ Array<String>

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

Returns:

  • (Array<String>)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#reader_endpoint ⇒ String

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#replication_source_identifier ⇒ String

Not supported by Neptune.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfigurationInfo

Shows the scaling configuration for a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.



2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Specifies the current state of this DB cluster.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ Boolean

Specifies whether the DB cluster is encrypted.

Returns:

  • (Boolean)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ String

The storage type used by the DB cluster.

Valid Values:

  • standard   –   ( the default ) Provides cost-effective database storage for applications with moderate to small I/O usage.

  • iopt1   –   Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.

    Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.

Returns:

  • (String)


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

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



2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 2081

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :copy_tags_to_snapshot,
  :enabled_cloudwatch_logs_exports,
  :pending_modified_values,
  :deletion_protection,
  :cross_account_clone,
  :automatic_restart_time,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :io_optimized_next_allowed_modification_time,
  :storage_type,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end