Class: Aws::DocDB::Types::CreateDBInstanceMessage

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

Overview

Represents the input to CreateDBInstance.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgradeBoolean

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

Returns:

  • (Boolean)


903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zoneString

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Returns:

  • (String)


903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshotBoolean

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Returns:

  • (Boolean)


903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifierString

The identifier of the cluster that the instance will belong to.

Returns:

  • (String)


903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_classString

The compute and memory capacity of the instance; for example, db.r5.large.

Returns:

  • (String)


903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifierString

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

Returns:

  • (String)


903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#enable_performance_insightsBoolean

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

Returns:

  • (Boolean)


903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

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

Valid value: docdb

Returns:

  • (String)


903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_kms_key_idString

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

Returns:

  • (String)


903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_windowString

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Returns:

  • (String)


903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#promotion_tierInteger

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

Returns:

  • (Integer)


903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Returns:



903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 903

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :enable_performance_insights,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end