Class: Aws::RDS::Types::CreateDBInstanceReadReplicaMessage

Inherits:

Struct

Object
Struct
Aws::RDS::Types::CreateDBInstanceReadReplicaMessage

show all

Includes:: Structure

Defined in:: lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass CreateDBInstanceReadReplicaMessage data as a hash:

{
  db_instance_identifier: "String", # required
  source_db_instance_identifier: "String", # required
  db_instance_class: "String",
  availability_zone: "String",
  port: 1,
  multi_az: false,
  auto_minor_version_upgrade: false,
  iops: 1,
  option_group_name: "String",
  publicly_accessible: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  db_subnet_group_name: "String",
  vpc_security_group_ids: ["String"],
  storage_type: "String",
  copy_tags_to_snapshot: false,
  monitoring_interval: 1,
  monitoring_role_arn: "String",
  kms_key_id: "String",
  pre_signed_url: "String",
  enable_iam_database_authentication: false,
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  performance_insights_retention_period: 1,
  enable_cloudwatch_logs_exports: ["String"],
  processor_features: [
    {
      name: "String",
      value: "String",
    },
  ],
  use_default_processor_features: false,
  deletion_protection: false,
  source_region: "String",
}

Instance Attribute Summary collapse

#auto_minor_version_upgrade ⇒ Boolean

Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
#availability_zone ⇒ String

The Amazon EC2 Availability Zone that the Read Replica is created in.
#copy_tags_to_snapshot ⇒ Boolean

True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false.
#db_instance_class ⇒ String

The compute and memory capacity of the Read Replica, for example, ‘db.m4.large`.
#db_instance_identifier ⇒ String

The DB instance identifier of the Read Replica.
#db_subnet_group_name ⇒ String

Specifies a DB subnet group for the DB instance.
#deletion_protection ⇒ Boolean

Indicates if the DB instance should have deletion protection enabled.
#destination_region ⇒ String
#enable_cloudwatch_logs_exports ⇒ Array<String>

The list of logs that the new DB instance is to export to CloudWatch Logs.
#enable_iam_database_authentication ⇒ Boolean

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
#enable_performance_insights ⇒ Boolean

True to enable Performance Insights for the read replica, and otherwise false.
#iops ⇒ Integer

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
#kms_key_id ⇒ String

The AWS KMS key ID for an encrypted Read Replica.
#monitoring_interval ⇒ Integer

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica.
#monitoring_role_arn ⇒ String

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
#multi_az ⇒ Boolean

Specifies whether the Read Replica is in a Multi-AZ deployment.
#option_group_name ⇒ String

The option group the DB instance is associated with.
#performance_insights_kms_key_id ⇒ String

The AWS KMS key identifier for encryption of Performance Insights data.
#performance_insights_retention_period ⇒ Integer

The amount of time, in days, to retain Performance Insights data.
#port ⇒ Integer

The port number that the DB instance uses for connections.
#pre_signed_url ⇒ String

The URL that contains a Signature Version 4 signed request for the ‘CreateDBInstanceReadReplica` API action in the source AWS Region that contains the source DB instance.
#processor_features ⇒ Array<Types::ProcessorFeature>

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
#publicly_accessible ⇒ Boolean

Specifies the accessibility options for the DB instance.
#source_db_instance_identifier ⇒ String

The identifier of the DB instance that will act as the source for the Read Replica.
#source_region ⇒ String

The source region of the snapshot.
#storage_type ⇒ String

Specifies the storage type to be associated with the Read Replica.
#tags ⇒ Array<Types::Tag>

A list of tags.
#use_default_processor_features ⇒ Boolean

A value that specifies that the DB instance class of the DB instance uses its default processor features.
#vpc_security_group_ids ⇒ Array<String>

A list of EC2 VPC security groups to associate with the Read Replica.

Instance Attribute Details

#auto_minor_version_upgrade ⇒ `Boolean`

Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB instance

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#availability_zone ⇒ `String`

The Amazon EC2 Availability Zone that the Read Replica is created in.

Default: A random, system-chosen Availability Zone in the endpoint’s AWS Region.

Example: ‘us-east-1d`

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#copy_tags_to_snapshot ⇒ `Boolean`

True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#db_instance_class ⇒ `String`

The compute and memory capacity of the Read Replica, for example, ‘db.m4.large`. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB Instance Class] in the *Amazon RDS User Guide.*

Default: Inherits from the source DB instance.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#db_instance_identifier ⇒ `String`

The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#db_subnet_group_name ⇒ `String`

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

Constraints:

Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same AWS Region in which the operation is running.
All Read Replicas in one AWS Region that are created from the same source DB instance must either:>
- Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.
- Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

Example: ‘mySubnetgroup`

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

Indicates if the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false. For more information, see [ Deleting a DB Instance].

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#destination_region ⇒ `String`

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#enable_cloudwatch_logs_exports ⇒ `Array<String>`

The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs ][1] in the *Amazon RDS User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch

Returns:

(Array<String>)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#enable_iam_database_authentication ⇒ `Boolean`

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora MySQL 5.6 or higher

Default: ‘false`

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#enable_performance_insights ⇒ `Boolean`

True to enable Performance Insights for the read replica, and otherwise false.

For more information, see [Using Amazon Performance Insights] in the *Amazon RDS User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#iops ⇒ `Integer`

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#kms_key_id ⇒ `String`

The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.

If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can’t use encryption keys from one AWS Region in another AWS Region.

You can’t create an encrypted Read Replica from an unencrypted DB instance.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#monitoring_interval ⇒ `Integer`

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If ‘MonitoringRoleArn` is specified, then you must also set `MonitoringInterval` to a value other than 0.

Valid Values: ‘0, 1, 5, 10, 15, 30, 60`

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#monitoring_role_arn ⇒ `String`

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ‘arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role, go to [To create an IAM role for Amazon RDS Enhanced Monitoring] in the *Amazon RDS User Guide*.

If ‘MonitoringInterval` is set to a value other than 0, then you must supply a `MonitoringRoleArn` value.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#multi_az ⇒ `Boolean`

Specifies whether the Read Replica is in a Multi-AZ deployment.

You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#option_group_name ⇒ `String`

The option group the DB instance is associated with. If omitted, the default option group for the engine specified is used.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#performance_insights_kms_key_id ⇒ `String`

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#performance_insights_retention_period ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#port ⇒ `Integer`

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: ‘1150-65535`

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#pre_signed_url ⇒ `String`

The URL that contains a Signature Version 4 signed request for the ‘CreateDBInstanceReadReplica` API action in the source AWS Region that contains the source DB instance.

You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the ‘–source-region` option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the ‘CreateDBInstanceReadReplica` API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

‘DestinationRegion` - The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the `CreateDBInstanceReadReplica` action is called that contains this presigned URL.

For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the ‘CreateDBInstanceReadReplica` action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the `CreateDBInstanceReadReplica` action in the us-west-2 AWS Region. For this example, the `DestinationRegion` in the presigned URL must be set to the us-east-1 AWS Region.
‘KmsKeyId` - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the `CreateDBInstanceReadReplica` action that is called in the destination AWS Region, and the action contained in the presigned URL.
‘SourceDBInstanceIdentifier` - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your `SourceDBInstanceIdentifier` looks like the following example: `arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115`.

To learn how to generate a Signature Version 4 signed request, see [Authenticating Requests: Using Query Parameters (AWS Signature Version 4)] and [Signature Version 4 Signing Process].

[1]: docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html [2]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#processor_features ⇒ `Array<Types::ProcessorFeature>`

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

Returns:

(Array<Types::ProcessorFeature>)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#publicly_accessible ⇒ `Boolean`

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#source_db_instance_identifier ⇒ `String`

The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

Constraints:

Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance.
Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6 or later.
Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).
The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to [ Constructing an ARN for Amazon RDS] in the *Amazon RDS User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#source_region ⇒ `String`

The source region of the snapshot. This is only needed when the shapshot is encrypted and in a different region.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#storage_type ⇒ `String`

Specifies the storage type to be associated with the Read Replica.

Valid values: ‘standard | gp2 | io1`

If you specify ‘io1`, you must also include a value for the `Iops` parameter.

Default: ‘io1` if the `Iops` parameter is specified, otherwise `standard`

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

A list of tags. For more information, see [Tagging Amazon RDS Resources] in the *Amazon RDS User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#use_default_processor_features ⇒ `Boolean`

A value that specifies that the DB instance class of the DB instance uses its default processor features.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

#vpc_security_group_ids ⇒ `Array<String>`

A list of EC2 VPC security groups to associate with the Read Replica.

Default: The default EC2 VPC security group for the DB subnet group’s VPC.

Returns:

(Array<String>)

# File 'lib/aws-sdk-rds/types.rb', line 3152

class CreateDBInstanceReadReplicaMessage < Struct.new(
  :db_instance_identifier,
  :source_db_instance_identifier,
  :db_instance_class,
  :availability_zone,
  :port,
  :multi_az,
  :auto_minor_version_upgrade,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :storage_type,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :destination_region,
  :source_region)
  include Aws::Structure
end

Class: Aws::RDS::Types::CreateDBInstanceReadReplicaMessage

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgrade ⇒ Boolean

#availability_zone ⇒ String

#copy_tags_to_snapshot ⇒ Boolean

#db_instance_class ⇒ String

#db_instance_identifier ⇒ String

#db_subnet_group_name ⇒ String

#deletion_protection ⇒ Boolean

#destination_region ⇒ String

#enable_cloudwatch_logs_exports ⇒ Array<String>

#enable_iam_database_authentication ⇒ Boolean

#enable_performance_insights ⇒ Boolean

#iops ⇒ Integer

#kms_key_id ⇒ String

#monitoring_interval ⇒ Integer

#monitoring_role_arn ⇒ String

#multi_az ⇒ Boolean

#option_group_name ⇒ String

#performance_insights_kms_key_id ⇒ String

#performance_insights_retention_period ⇒ Integer

#port ⇒ Integer

#pre_signed_url ⇒ String

#processor_features ⇒ Array<Types::ProcessorFeature>

#publicly_accessible ⇒ Boolean

#source_db_instance_identifier ⇒ String

#source_region ⇒ String

#storage_type ⇒ String

#tags ⇒ Array<Types::Tag>

#use_default_processor_features ⇒ Boolean

#vpc_security_group_ids ⇒ Array<String>

#auto_minor_version_upgrade ⇒ `Boolean`

#availability_zone ⇒ `String`

#copy_tags_to_snapshot ⇒ `Boolean`

#db_instance_class ⇒ `String`

#db_instance_identifier ⇒ `String`

#db_subnet_group_name ⇒ `String`

#deletion_protection ⇒ `Boolean`

#destination_region ⇒ `String`

#enable_cloudwatch_logs_exports ⇒ `Array<String>`

#enable_iam_database_authentication ⇒ `Boolean`

#enable_performance_insights ⇒ `Boolean`

#iops ⇒ `Integer`

#kms_key_id ⇒ `String`

#monitoring_interval ⇒ `Integer`

#monitoring_role_arn ⇒ `String`

#multi_az ⇒ `Boolean`

#option_group_name ⇒ `String`

#performance_insights_kms_key_id ⇒ `String`

#performance_insights_retention_period ⇒ `Integer`

#port ⇒ `Integer`

#pre_signed_url ⇒ `String`

#processor_features ⇒ `Array<Types::ProcessorFeature>`

#publicly_accessible ⇒ `Boolean`

#source_db_instance_identifier ⇒ `String`

#source_region ⇒ `String`

#storage_type ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#use_default_processor_features ⇒ `Boolean`

#vpc_security_group_ids ⇒ `Array<String>`