com.amazonaws.services.rds.model

Class CreateDBInstanceReadReplicaRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.CreateDBInstanceReadReplicaRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDBInstanceReadReplicaRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDBInstanceReadReplicaRequest() Default constructor for CreateDBInstanceReadReplicaRequest object.
CreateDBInstanceReadReplicaRequest(String dBInstanceIdentifier, String sourceDBInstanceIdentifier) Constructs a new CreateDBInstanceReadReplicaRequest object.

Method Summary

Modifier and Type	Method and Description
CreateDBInstanceReadReplicaRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getAutoMinorVersionUpgrade() Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
String	getAvailabilityZone() The Amazon EC2 Availability Zone that the Read Replica is created in.
Boolean	getCopyTagsToSnapshot() True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false.
String	getDBInstanceClass() The compute and memory capacity of the Read Replica, for example, db.m4.large.
String	getDBInstanceIdentifier() The DB instance identifier of the Read Replica.
String	getDBSubnetGroupName() Specifies a DB subnet group for the DB instance.
Boolean	getEnableIAMDatabaseAuthentication() True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
Boolean	getEnablePerformanceInsights() True to enable Performance Insights for the read replica; otherwise false.
Integer	getIops() The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
String	getKmsKeyId() The AWS KMS key ID for an encrypted Read Replica.
Integer	getMonitoringInterval() The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica.
String	getMonitoringRoleArn() The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs.
String	getOptionGroupName() The option group the DB instance is associated with.
String	getPerformanceInsightsKMSKeyId() The KMS key identifier for encryption of Performance Insights data.
Integer	getPort() The port number that the DB instance uses for connections.
String	getPreSignedUrl() The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.
Boolean	getPubliclyAccessible() Specifies the accessibility options for the DB instance.
String	getSourceDBInstanceIdentifier() The identifier of the DB instance that will act as the source for the Read Replica.
String	getSourceRegion() The region where the source instance is located.
String	getStorageType() Specifies the storage type to be associated with the Read Replica.
List<Tag>	getTags()
int	hashCode()
Boolean	isAutoMinorVersionUpgrade() Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
Boolean	isCopyTagsToSnapshot() True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false.
Boolean	isEnableIAMDatabaseAuthentication() True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
Boolean	isEnablePerformanceInsights() True to enable Performance Insights for the read replica; otherwise false.
Boolean	isPubliclyAccessible() Specifies the accessibility options for the DB instance.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
void	setAvailabilityZone(String availabilityZone) The Amazon EC2 Availability Zone that the Read Replica is created in.
void	setCopyTagsToSnapshot(Boolean copyTagsToSnapshot) True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false.
void	setDBInstanceClass(String dBInstanceClass) The compute and memory capacity of the Read Replica, for example, db.m4.large.
void	setDBInstanceIdentifier(String dBInstanceIdentifier) The DB instance identifier of the Read Replica.
void	setDBSubnetGroupName(String dBSubnetGroupName) Specifies a DB subnet group for the DB instance.
void	setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
void	setEnablePerformanceInsights(Boolean enablePerformanceInsights) True to enable Performance Insights for the read replica; otherwise false.
void	setIops(Integer iops) The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
void	setKmsKeyId(String kmsKeyId) The AWS KMS key ID for an encrypted Read Replica.
void	setMonitoringInterval(Integer monitoringInterval) The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica.
void	setMonitoringRoleArn(String monitoringRoleArn) The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs.
void	setOptionGroupName(String optionGroupName) The option group the DB instance is associated with.
void	setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId) The KMS key identifier for encryption of Performance Insights data.
void	setPort(Integer port) The port number that the DB instance uses for connections.
void	setPreSignedUrl(String preSignedUrl) The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.
void	setPubliclyAccessible(Boolean publiclyAccessible) Specifies the accessibility options for the DB instance.
void	setSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier) The identifier of the DB instance that will act as the source for the Read Replica.
void	setSourceRegion(String sourceRegion) The region where the source instance is located.
void	setStorageType(String storageType) Specifies the storage type to be associated with the Read Replica.
void	setTags(Collection<Tag> tags)
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateDBInstanceReadReplicaRequest	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
CreateDBInstanceReadReplicaRequest	withAvailabilityZone(String availabilityZone) The Amazon EC2 Availability Zone that the Read Replica is created in.
CreateDBInstanceReadReplicaRequest	withCopyTagsToSnapshot(Boolean copyTagsToSnapshot) True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false.
CreateDBInstanceReadReplicaRequest	withDBInstanceClass(String dBInstanceClass) The compute and memory capacity of the Read Replica, for example, db.m4.large.
CreateDBInstanceReadReplicaRequest	withDBInstanceIdentifier(String dBInstanceIdentifier) The DB instance identifier of the Read Replica.
CreateDBInstanceReadReplicaRequest	withDBSubnetGroupName(String dBSubnetGroupName) Specifies a DB subnet group for the DB instance.
CreateDBInstanceReadReplicaRequest	withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
CreateDBInstanceReadReplicaRequest	withEnablePerformanceInsights(Boolean enablePerformanceInsights) True to enable Performance Insights for the read replica; otherwise false.
CreateDBInstanceReadReplicaRequest	withIops(Integer iops) The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
CreateDBInstanceReadReplicaRequest	withKmsKeyId(String kmsKeyId) The AWS KMS key ID for an encrypted Read Replica.
CreateDBInstanceReadReplicaRequest	withMonitoringInterval(Integer monitoringInterval) The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica.
CreateDBInstanceReadReplicaRequest	withMonitoringRoleArn(String monitoringRoleArn) The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs.
CreateDBInstanceReadReplicaRequest	withOptionGroupName(String optionGroupName) The option group the DB instance is associated with.
CreateDBInstanceReadReplicaRequest	withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId) The KMS key identifier for encryption of Performance Insights data.
CreateDBInstanceReadReplicaRequest	withPort(Integer port) The port number that the DB instance uses for connections.
CreateDBInstanceReadReplicaRequest	withPreSignedUrl(String preSignedUrl) The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.
CreateDBInstanceReadReplicaRequest	withPubliclyAccessible(Boolean publiclyAccessible) Specifies the accessibility options for the DB instance.
CreateDBInstanceReadReplicaRequest	withSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier) The identifier of the DB instance that will act as the source for the Read Replica.
CreateDBInstanceReadReplicaRequest	withSourceRegion(String sourceRegion) The region where the source instance is located.
CreateDBInstanceReadReplicaRequest	withStorageType(String storageType) Specifies the storage type to be associated with the Read Replica.
CreateDBInstanceReadReplicaRequest	withTags(Collection<Tag> tags)
CreateDBInstanceReadReplicaRequest	withTags(Tag... tags) NOTE: This method appends the values to the existing list (if any).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDBInstanceReadReplicaRequest

public CreateDBInstanceReadReplicaRequest()

Default constructor for CreateDBInstanceReadReplicaRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.

CreateDBInstanceReadReplicaRequest

public CreateDBInstanceReadReplicaRequest(String dBInstanceIdentifier,
                                          String sourceDBInstanceIdentifier)

Constructs a new CreateDBInstanceReadReplicaRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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

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

Constraints:

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

• Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.

• Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross region replication).

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

• If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

• If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).

Method Detail

setDBInstanceIdentifier

public void setDBInstanceIdentifier(String dBInstanceIdentifier)

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.

Parameters:

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

getDBInstanceIdentifier

public String getDBInstanceIdentifier()

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:

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.

withDBInstanceIdentifier

public CreateDBInstanceReadReplicaRequest withDBInstanceIdentifier(String dBInstanceIdentifier)

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.

Parameters:

dBInstanceIdentifier - 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:

Returns a reference to this object so that method calls can be chained together.

setSourceDBInstanceIdentifier

public void setSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)

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

Constraints:

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

• Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.

• Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross region replication).

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

• If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

• If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).

Parameters:

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

Constraints:

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

• Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.

• Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross region replication).

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

• If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

• If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).

getSourceDBInstanceIdentifier

public String getSourceDBInstanceIdentifier()

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

Constraints:

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

• Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.

• Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross region replication).

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

• If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

• If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).

Returns:

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

Constraints:

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

• Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.

• Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross region replication).

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

• If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

• If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).

withSourceDBInstanceIdentifier

public CreateDBInstanceReadReplicaRequest withSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)

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

Constraints:

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

• Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.

• Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross region replication).

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

• If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

• If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).

Parameters:

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

Constraints:

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

• Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.

• Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross region replication).

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

• If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

• If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).

Returns:

Returns a reference to this object so that method calls can be chained together.

setDBInstanceClass

public void setDBInstanceClass(String dBInstanceClass)

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

Default: Inherits from the source DB instance.

Parameters:

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

Default: Inherits from the source DB instance.

getDBInstanceClass

public String getDBInstanceClass()

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

Default: Inherits from the source DB instance.

Returns:

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

Default: Inherits from the source DB instance.

withDBInstanceClass

public CreateDBInstanceReadReplicaRequest withDBInstanceClass(String dBInstanceClass)

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

Default: Inherits from the source DB instance.

Parameters:

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

Default: Inherits from the source DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAvailabilityZone

public void setAvailabilityZone(String availabilityZone)

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

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

Example: us-east-1d

Parameters:

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

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

Example: us-east-1d

getAvailabilityZone

public String getAvailabilityZone()

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

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

Example: us-east-1d

Returns:

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

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

Example: us-east-1d

withAvailabilityZone

public CreateDBInstanceReadReplicaRequest withAvailabilityZone(String availabilityZone)

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

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

Example: us-east-1d

Parameters:

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

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

Example: us-east-1d

Returns:

Returns a reference to this object so that method calls can be chained together.

setPort

public void setPort(Integer port)

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Parameters:

port - The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

getPort

public Integer getPort()

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Returns:

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

withPort

public CreateDBInstanceReadReplicaRequest withPort(Integer port)

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Parameters:

port - The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Returns:

Returns a reference to this object so that method calls can be chained together.

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

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

Default: Inherits from the source DB instance

Parameters:

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

Default: Inherits from the source DB instance

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

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

Default: Inherits from the source DB instance

Returns:

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

Default: Inherits from the source DB instance

withAutoMinorVersionUpgrade

public CreateDBInstanceReadReplicaRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

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

Default: Inherits from the source DB instance

Parameters:

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

Default: Inherits from the source DB instance

Returns:

Returns a reference to this object so that method calls can be chained together.

isAutoMinorVersionUpgrade

public Boolean isAutoMinorVersionUpgrade()

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

Default: Inherits from the source DB instance

Returns:

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

Default: Inherits from the source DB instance

setIops

public void setIops(Integer iops)

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

Parameters:

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

getIops

public Integer getIops()

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

Returns:

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

withIops

public CreateDBInstanceReadReplicaRequest withIops(Integer iops)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setOptionGroupName

public void setOptionGroupName(String optionGroupName)

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

Parameters:

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

getOptionGroupName

public String getOptionGroupName()

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

Returns:

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

withOptionGroupName

public CreateDBInstanceReadReplicaRequest withOptionGroupName(String optionGroupName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setPubliclyAccessible

public void setPubliclyAccessible(Boolean publiclyAccessible)

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

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true

• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.

Parameters:

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

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true

• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.

getPubliclyAccessible

public Boolean getPubliclyAccessible()

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

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true

• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.

Returns:

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

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true

• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.

withPubliclyAccessible

public CreateDBInstanceReadReplicaRequest withPubliclyAccessible(Boolean publiclyAccessible)

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

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true

• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.

Parameters:

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

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true

• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.

Returns:

Returns a reference to this object so that method calls can be chained together.

isPubliclyAccessible

public Boolean isPubliclyAccessible()

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

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true

• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.

Returns:

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

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

• Default VPC:true

• VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.

getTags

public List<Tag> getTags()

Returns:

setTags

public void setTags(Collection<Tag> tags)

Parameters:

tags -

withTags

public CreateDBInstanceReadReplicaRequest withTags(Tag... tags)

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags -

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateDBInstanceReadReplicaRequest withTags(Collection<Tag> tags)

Parameters:

tags -

Returns:

Returns a reference to this object so that method calls can be chained together.

setDBSubnetGroupName

public void setDBSubnetGroupName(String dBSubnetGroupName)

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

Constraints:

• Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

• If supplied, must match the name of an existing DBSubnetGroup.

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

• All Read Replicas in one AWS Region that are created from the same source DB instance must either:>

  • Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

  • Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

Example: mySubnetgroup

Parameters:

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

Constraints:

• Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

• If supplied, must match the name of an existing DBSubnetGroup.

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

• All Read Replicas in one AWS Region that are created from the same source DB instance must either:>

  • Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

  • Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

Example: mySubnetgroup

getDBSubnetGroupName

public String getDBSubnetGroupName()

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

Constraints:

• Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

• If supplied, must match the name of an existing DBSubnetGroup.

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

• All Read Replicas in one AWS Region that are created from the same source DB instance must either:>

  • Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

  • Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

Example: mySubnetgroup

Returns:

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

Constraints:

• Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

• If supplied, must match the name of an existing DBSubnetGroup.

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

• All Read Replicas in one AWS Region that are created from the same source DB instance must either:>

  • Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

  • Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

Example: mySubnetgroup

withDBSubnetGroupName

public CreateDBInstanceReadReplicaRequest withDBSubnetGroupName(String dBSubnetGroupName)

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

Constraints:

• Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

• If supplied, must match the name of an existing DBSubnetGroup.

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

• All Read Replicas in one AWS Region that are created from the same source DB instance must either:>

  • Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

  • Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

Example: mySubnetgroup

Parameters:

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

Constraints:

• Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

• If supplied, must match the name of an existing DBSubnetGroup.

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

• All Read Replicas in one AWS Region that are created from the same source DB instance must either:>

  • Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

  • Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

Example: mySubnetgroup

Returns:

Returns a reference to this object so that method calls can be chained together.

setStorageType

public void setStorageType(String storageType)

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

Valid values: standard | gp2 | io1

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

Default: io1 if the Iops parameter is specified; otherwise standard

Parameters:

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

Valid values: standard | gp2 | io1

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

Default: io1 if the Iops parameter is specified; otherwise standard

getStorageType

public String getStorageType()

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

Valid values: standard | gp2 | io1

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

Default: io1 if the Iops parameter is specified; otherwise standard

Returns:

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

Valid values: standard | gp2 | io1

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

Default: io1 if the Iops parameter is specified; otherwise standard

withStorageType

public CreateDBInstanceReadReplicaRequest withStorageType(String storageType)

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

Valid values: standard | gp2 | io1

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

Default: io1 if the Iops parameter is specified; otherwise standard

Parameters:

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

Valid values: standard | gp2 | io1

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

Default: io1 if the Iops parameter is specified; otherwise standard

Returns:

Returns a reference to this object so that method calls can be chained together.

setCopyTagsToSnapshot

public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)

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

Parameters:

copyTagsToSnapshot - True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.

getCopyTagsToSnapshot

public Boolean getCopyTagsToSnapshot()

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

Returns:

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

withCopyTagsToSnapshot

public CreateDBInstanceReadReplicaRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)

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

Parameters:

copyTagsToSnapshot - True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.

Returns:

Returns a reference to this object so that method calls can be chained together.

isCopyTagsToSnapshot

public Boolean isCopyTagsToSnapshot()

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

Returns:

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

setMonitoringInterval

public void setMonitoringInterval(Integer monitoringInterval)

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

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

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

Parameters:

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

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

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

getMonitoringInterval

public Integer getMonitoringInterval()

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

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

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

Returns:

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

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

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

withMonitoringInterval

public CreateDBInstanceReadReplicaRequest withMonitoringInterval(Integer monitoringInterval)

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

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

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

Parameters:

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

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMonitoringRoleArn

public void setMonitoringRoleArn(String monitoringRoleArn)

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to 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.

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

Parameters:

monitoringRoleArn - The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to 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.

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

getMonitoringRoleArn

public String getMonitoringRoleArn()

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to 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.

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

Returns:

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to 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.

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

withMonitoringRoleArn

public CreateDBInstanceReadReplicaRequest withMonitoringRoleArn(String monitoringRoleArn)

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to 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.

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

Parameters:

monitoringRoleArn - The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to 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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

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

If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.

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

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

Parameters:

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

If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.

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

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

getKmsKeyId

public String getKmsKeyId()

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

If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.

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

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

Returns:

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

If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.

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

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

withKmsKeyId

public CreateDBInstanceReadReplicaRequest withKmsKeyId(String kmsKeyId)

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

If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.

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

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

Parameters:

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

If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setPreSignedUrl

public void setPreSignedUrl(String preSignedUrl)

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

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

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

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

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

• KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

• SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

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

Parameters:

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

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

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

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

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

• KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

• SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

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

getPreSignedUrl

public String getPreSignedUrl()

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

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

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

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

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

• KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

• SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

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

Returns:

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

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

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

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

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

• KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

• SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

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

withPreSignedUrl

public CreateDBInstanceReadReplicaRequest withPreSignedUrl(String preSignedUrl)

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

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

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

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

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

• KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

• SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

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

Parameters:

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

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

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

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

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

• KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

• SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnableIAMDatabaseAuthentication

public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

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

You can enable IAM database authentication for the following database engines

• For MySQL 5.6, minor version 5.6.34 or higher

• For MySQL 5.7, minor version 5.7.16 or higher

• Aurora 5.6 or higher.

Default: false

Parameters:

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

You can enable IAM database authentication for the following database engines

• For MySQL 5.6, minor version 5.6.34 or higher

• For MySQL 5.7, minor version 5.7.16 or higher

• Aurora 5.6 or higher.

Default: false

getEnableIAMDatabaseAuthentication

public Boolean getEnableIAMDatabaseAuthentication()

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

You can enable IAM database authentication for the following database engines

• For MySQL 5.6, minor version 5.6.34 or higher

• For MySQL 5.7, minor version 5.7.16 or higher

• Aurora 5.6 or higher.

Default: false

Returns:

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

You can enable IAM database authentication for the following database engines

• For MySQL 5.6, minor version 5.6.34 or higher

• For MySQL 5.7, minor version 5.7.16 or higher

• Aurora 5.6 or higher.

Default: false

withEnableIAMDatabaseAuthentication

public CreateDBInstanceReadReplicaRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

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

You can enable IAM database authentication for the following database engines

• For MySQL 5.6, minor version 5.6.34 or higher

• For MySQL 5.7, minor version 5.7.16 or higher

• Aurora 5.6 or higher.

Default: false

Parameters:

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

You can enable IAM database authentication for the following database engines

• For MySQL 5.6, minor version 5.6.34 or higher

• For MySQL 5.7, minor version 5.7.16 or higher

• Aurora 5.6 or higher.

Default: false

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnableIAMDatabaseAuthentication

public Boolean isEnableIAMDatabaseAuthentication()

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

You can enable IAM database authentication for the following database engines

• For MySQL 5.6, minor version 5.6.34 or higher

• For MySQL 5.7, minor version 5.7.16 or higher

• Aurora 5.6 or higher.

Default: false

Returns:

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

You can enable IAM database authentication for the following database engines

• For MySQL 5.6, minor version 5.6.34 or higher

• For MySQL 5.7, minor version 5.7.16 or higher

• Aurora 5.6 or higher.

Default: false

setEnablePerformanceInsights

public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)

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

Parameters:

enablePerformanceInsights - True to enable Performance Insights for the read replica; otherwise false.

getEnablePerformanceInsights

public Boolean getEnablePerformanceInsights()

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

Returns:

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

withEnablePerformanceInsights

public CreateDBInstanceReadReplicaRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights)

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

Parameters:

enablePerformanceInsights - True to enable Performance Insights for the read replica; otherwise false.

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnablePerformanceInsights

public Boolean isEnablePerformanceInsights()

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

Returns:

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

setPerformanceInsightsKMSKeyId

public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)

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

Parameters:

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

getPerformanceInsightsKMSKeyId

public String getPerformanceInsightsKMSKeyId()

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

Returns:

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

withPerformanceInsightsKMSKeyId

public CreateDBInstanceReadReplicaRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSourceRegion

public void setSourceRegion(String sourceRegion)

The region where the source instance is located.

Parameters:

sourceRegion - The region where the source instance is located.

getSourceRegion

public String getSourceRegion()

The region where the source instance is located.

Returns:

The region where the source instance is located.

withSourceRegion

public CreateDBInstanceReadReplicaRequest withSourceRegion(String sourceRegion)

The region where the source instance is located.

Parameters:

sourceRegion - The region where the source instance is located.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDBInstanceReadReplicaRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()