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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in ‘CreateDBInstance`.

<note markdown=“1”> Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.

</note>

Returns:

  • (Integer)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

Specifies whether to automatically apply minor engine upgrades to the read replica during the maintenance window.

This setting doesn’t apply to RDS Custom DB instances.

Default: Inherits the value from the source DB instance.

Returns:

  • (Boolean)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zoneString

The Availability Zone (AZ) where the read replica will be created.

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

Example: ‘us-east-1d`

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#ca_certificate_identifierString

The CA certificate identifier to use for the read replica’s server certificate.

This setting doesn’t apply to RDS Custom DB instances.

For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshotBoolean

Specifies whether to copy all tags from the read replica to snapshots of the read replica. By default, tags aren’t copied.

Returns:

  • (Boolean)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#custom_iam_instance_profileString

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.

  • The profile must have an IAM role that Amazon EC2 has permissions to assume.

  • The instance profile name and the associated IAM role name must start with the prefix ‘AWSRDSCustom`.

For the list of permissions required for the IAM role, see [ Configure IAM and your VPC] in the *Amazon RDS User Guide*.

This setting is required for RDS Custom DB instances.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_classString

The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services 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 the value from the source DB instance.

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

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifierString

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)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#db_parameter_group_nameString

The name of the DB parameter group to associate with this read replica DB instance.

For Single-AZ or Multi-AZ DB instance read replica instances, if you don’t specify a value for ‘DBParameterGroupName`, then Amazon RDS uses the `DBParameterGroup` of the source DB instance for a same Region read replica, or the default `DBParameterGroup` for the specified DB engine for a cross-Region read replica.

For Multi-AZ DB cluster same Region read replica instances, if you don’t specify a value for ‘DBParameterGroupName`, then Amazon RDS uses the default `DBParameterGroup`.

Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas, for Multi-AZ DB cluster read replica instances, and for Oracle DB instances. It isn’t supported for MySQL DB instances for same Region read replicas or for RDS Custom.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can’t end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#db_subnet_group_nameString

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 isn’t created in a VPC.

Constraints:

  • If supplied, must match the name of an existing DB subnet group.

  • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

  • All read replicas in one Amazon Web Services 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: ‘mydbsubnetgroup`

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_log_volumeBoolean

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

Returns:

  • (Boolean)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protectionBoolean

Specifies whether to enable deletion protection for the DB instance. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled. For more information, see [ Deleting a DB Instance].

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

Returns:

  • (Boolean)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#domainString

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see [ Kerberos Authentication] in the *Amazon RDS User Guide*.

This setting doesn’t apply to RDS Custom DB instances.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#domain_auth_secret_arnString

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

Example: ‘arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#domain_dns_ipsArray<String>

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

Constraints:

  • Two IP addresses must be provided. If there isn’t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

^

Example: ‘123.124.125.126,234.235.236.237`

Returns:

  • (Array<String>)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#domain_fqdnString

The fully qualified domain name (FQDN) of an Active Directory domain.

Constraints:

  • Can’t be longer than 64 characters.

^

Example: ‘mymanagedADtest.mymanagedAD.mydomain`

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#domain_iam_role_nameString

The name of the IAM role to use when making API calls to the Directory Service.

This setting doesn’t apply to RDS Custom DB instances.

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#domain_ouString

The Active Directory organizational unit for your DB instance to join.

Constraints:

  • Must be in the distinguished name format.

  • Can’t be longer than 64 characters.

Example: ‘OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#enable_cloudwatch_logs_exportsArray<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*.

This setting doesn’t apply to RDS Custom DB instances.

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

Returns:

  • (Array<String>)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#enable_customer_owned_ipBoolean

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see [Working with Amazon RDS on Amazon Web Services Outposts] in the *Amazon RDS User Guide*.

For more information about CoIPs, see [Customer-owned IP addresses] in the *Amazon Web Services Outposts User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html [2]: docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing

Returns:

  • (Boolean)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#enable_iam_database_authenticationBoolean

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.

For more information about IAM database authentication, see [ IAM Database Authentication for MySQL and PostgreSQL] in the *Amazon RDS User Guide*.

This setting doesn’t apply to RDS Custom DB instances.

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

Returns:

  • (Boolean)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#enable_performance_insightsBoolean

Specifies whether to enable Performance Insights for the read replica.

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

This setting doesn’t apply to RDS Custom DB instances.

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

Returns:

  • (Boolean)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#iopsInteger

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

Returns:

  • (Integer)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

The Amazon Web Services KMS key identifier for an encrypted read replica.

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

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don’t specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can’t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

You can’t create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.

This setting doesn’t apply to RDS Custom, which uses the same KMS key as the primary replica.

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#max_allocated_storageInteger

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling] in the *Amazon RDS User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling

Returns:

  • (Integer)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_intervalInteger

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collection of Enhanced Monitoring metrics, specify ‘0`. The default is `0`.

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

This setting doesn’t apply to RDS Custom DB instances.

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

Default: ‘0`

Returns:

  • (Integer)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_role_arnString

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.

This setting doesn’t apply to RDS Custom DB instances.

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

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#multi_azBoolean

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 is a Multi-AZ DB instance or a Multi-AZ DB cluster.

This setting doesn’t apply to RDS Custom DB instances.

Returns:

  • (Boolean)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#network_typeString

The network type of the DB instance.

Valid Values:

  • ‘IPV4`

  • ‘DUAL`

The network type is determined by the ‘DBSubnetGroup` specified for read replica. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).

For more information, see [ Working with a DB instance in a VPC] in the *Amazon RDS User Guide.*

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

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_nameString

The option group to associate the DB instance with. If not specified, RDS uses the option group associated with the source DB instance or cluster.

<note markdown=“1”> For SQL Server, you must use the option group associated with the source.

</note>

This setting doesn’t apply to RDS Custom DB instances.

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_kms_key_idString

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services 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 RDS 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.

This setting doesn’t apply to RDS Custom DB instances.

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_retention_periodInteger

The number of days to retain Performance Insights data.

This setting doesn’t apply to RDS Custom DB instances.

Valid Values:

  • ‘7`

  • month * 31, where month is a number of months from 1-23. Examples: ‘93` (3 months * 31), `341` (11 months * 31), `589` (19 months * 31)

  • ‘731`

Default: ‘7` days

If you specify a retention period that isn’t valid, such as ‘94`, Amazon RDS returns an error.

Returns:

  • (Integer)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

The port number that the DB instance uses for connections.

Valid Values: ‘1150-65535`

Default: Inherits the value from the source DB instance.

Returns:

  • (Integer)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#pre_signed_urlString

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the ‘CreateDBInstanceReadReplica` API operation in the source Amazon Web Services Region that contains the source DB instance.

This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It’s ignored in other Amazon Web Services Regions.

This setting applies only when replicating from a source DB instance. Source DB clusters aren’t supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don’t specify ‘PreSignedUrl` when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the ‘CreateDBInstanceReadReplica` API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • ‘DestinationRegion` - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the `CreateDBInstanceReadReplica` operation is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the ‘CreateDBInstanceReadReplica` operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the `CreateDBInstanceReadReplica` operation in the us-west-2 Amazon Web Services Region. For this example, the `DestinationRegion` in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

  • ‘KmsKeyId` - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the `CreateDBInstanceReadReplica` operation that is called in the destination Amazon Web Services Region, and the operation 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 Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4)] and [Signature Version 4 Signing Process].

<note markdown=“1”> If you are using an Amazon Web Services SDK tool or the CLI, you can specify ‘SourceRegion` (or `–source-region` for the CLI) instead of specifying `PreSignedUrl` manually. Specifying `SourceRegion` autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

</note>

This setting doesn’t apply to RDS Custom DB instances.

[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)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#processor_featuresArray<Types::ProcessorFeature>

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

This setting doesn’t apply to RDS Custom DB instances.

Returns:



5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessibleBoolean

Specifies whether the DB instance is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.

When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Returns:

  • (Boolean)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#replica_modeString

The open mode of the replica database: mounted or read-only.

<note markdown=“1”> This parameter is only supported for Oracle DB instances.

</note>

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn’t use Active Data Guard to transmit information to the mounted replica. Because it doesn’t accept user connections, a mounted replica can’t serve a read-only workload.

You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see [Working with Oracle Read Replicas for Amazon RDS] in the *Amazon RDS User Guide*.

For RDS Custom, you must specify this parameter and set it to ‘mounted`. The value won’t be set by default. After replica creation, you can manage the open mode manually.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#source_db_cluster_identifierString

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.

Constraints:

  • Must be the identifier of an existing Multi-AZ DB cluster.

  • Can’t be specified if the ‘SourceDBInstanceIdentifier` parameter is also specified.

  • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.

  • The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn’t supported.

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#source_db_instance_identifierString

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.

Constraints:

  • Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB instance.

  • Can’t be specified if the ‘SourceDBClusterIdentifier` parameter is also specified.

  • For the limitations of Oracle read replicas, see [Version and licensing considerations for RDS for Oracle replicas] in the *Amazon RDS User Guide*.

  • For the limitations of SQL Server read replicas, see [Read replica limitations with SQL Server] in the *Amazon RDS User Guide*.

  • The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.

  • If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see [Constructing an ARN for Amazon RDS] in the *Amazon RDS User Guide*. This doesn’t apply to SQL Server or RDS Custom, which don’t support cross-Region replicas.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses [2]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations [3]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#source_regionString

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

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#storage_throughputInteger

Specifies the storage throughput value for the read replica.

This setting doesn’t apply to RDS Custom or Amazon Aurora DB instances.

Returns:

  • (Integer)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#storage_typeString

The storage type to associate with the read replica.

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

Valid Values: ‘gp2 | gp3 | io1 | io2 | standard`

Default: ‘io1` if the `Iops` parameter is specified. Otherwise, `gp2`.

Returns:

  • (String)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags.

For more information, see [Tagging Amazon RDS resources] in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources] in the *Amazon Aurora User Guide*.

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

Returns:



5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#upgrade_storage_configBoolean

Whether to upgrade the storage file system configuration on the read replica. This option migrates the read replica from the old storage file system layout to the preferred layout.

Returns:

  • (Boolean)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#use_default_processor_featuresBoolean

Specifies whether the DB instance class of the DB instance uses its default processor features.

This setting doesn’t apply to RDS Custom DB instances.

Returns:

  • (Boolean)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_idsArray<String>

A list of Amazon EC2 VPC security groups to associate with the read replica.

This setting doesn’t apply to RDS Custom DB instances.

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

Returns:

  • (Array<String>)


5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
# File 'lib/aws-sdk-rds/types.rb', line 5477

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,
  :db_parameter_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,
  :domain,
  :domain_iam_role_name,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :replica_mode,
  :max_allocated_storage,
  :custom_iam_instance_profile,
  :network_type,
  :storage_throughput,
  :enable_customer_owned_ip,
  :allocated_storage,
  :source_db_cluster_identifier,
  :dedicated_log_volume,
  :upgrade_storage_config,
  :ca_certificate_identifier,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end