/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.rds.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateDBInstanceReadReplicaRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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. *
*/ private String dBInstanceIdentifier; /** ** 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 MySQL, MariaDB, 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. *
** 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 from the source DB instance. *
*/ private String dBInstanceClass; /** ** 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
*
* The port number that the DB instance uses for connections. *
** Default: Inherits from the source DB instance *
*
* Valid Values: 1150-65535
*
* A value that indicates 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. *
*/ private Boolean multiAZ; /** ** A value that indicates whether minor engine upgrades are applied automatically to the read replica during the * maintenance window. *
** This setting doesn't apply to RDS Custom. *
** Default: Inherits from the source DB instance *
*/ private Boolean autoMinorVersionUpgrade; /** ** The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB * instance. *
*/ private Integer iops; /** ** The option group the DB instance is associated with. If omitted, the option group associated with the source * instance or cluster is used. *
** For SQL Server, you must use the option group associated with the source. *
** This setting doesn't apply to RDS Custom. *
*/ private String optionGroupName; /** ** The name of the DB parameter group to associate with this DB instance. *
*
* If you do not specify a value for DBParameterGroupName
, then Amazon RDS uses the
* DBParameterGroup
of source DB instance for a same Region read replica, or the default
* DBParameterGroup
for the specified DB engine for a cross-Region read replica.
*
* Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't * supported 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 *
** A value that indicates 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. *
*/ private Boolean publiclyAccessible; private com.amazonaws.internal.SdkInternalList* 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 isn't created in a VPC. *
** Constraints: *
** If supplied, must match the name of an existing DBSubnetGroup. *
** 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
*
* A list of Amazon EC2 VPC security groups to associate with the read replica. *
** This setting doesn't apply to RDS Custom. *
** Default: The default EC2 VPC security group for the DB subnet group's VPC. *
*/ private com.amazonaws.internal.SdkInternalList* Specifies the storage type to be associated with the read replica. *
*
* Valid values: gp2 | gp3 | io1 | standard
*
* If you specify io1
or gp3
, you must also include a value for the Iops
* parameter.
*
* Default: io1
if the Iops
parameter is specified, otherwise gp2
*
* A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By * default, tags are not copied. *
*/ private Boolean copyTagsToSnapshot; /** ** 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.
*
* This setting doesn't apply to RDS Custom. *
*
* Valid Values: 0, 1, 5, 10, 15, 30, 60
*
* 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. *
*/ private String monitoringRoleArn; /** ** 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. *
*/ private String kmsKeyId; /** *
* 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. *
*
* 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.
*
* SourceRegion
isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support
* cross-Region read replicas.
*
* This setting doesn't apply to RDS Custom. *
*/ private String preSignedUrl; /** ** A value that indicates 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. *
*/ private Boolean enableIAMDatabaseAuthentication; /** ** A value that indicates 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. *
*/ private Boolean enablePerformanceInsights; /** ** 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. *
*/ private String performanceInsightsKMSKeyId; /** ** The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: *
** 7 *
** month * 31, where month is a number of months from 1-23 *
** 731 *
** For example, the following values are valid: *
** 93 (3 months * 31) *
** 341 (11 months * 31) *
** 589 (19 months * 31) *
** 731 *
** If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. *
** This setting doesn't apply to RDS Custom. *
*/ private Integer performanceInsightsRetentionPeriod; /** ** 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 in the Amazon RDS User Guide. *
** This setting doesn't apply to RDS Custom. *
*/ private com.amazonaws.internal.SdkInternalList* 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. *
*/ private com.amazonaws.internal.SdkInternalList* A value that indicates whether the DB instance class of the DB instance uses its default processor features. *
** This setting doesn't apply to RDS Custom. *
*/ private Boolean useDefaultProcessorFeatures; /** ** A value that indicates whether the DB instance has deletion protection enabled. 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. *
*/ private Boolean deletionProtection; /** ** 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. *
*/ private String domain; /** ** The name of the IAM role to be used when making API calls to the Directory Service. *
** This setting doesn't apply to RDS Custom. *
*/ private String domainIAMRoleName; /** ** The fully qualified domain name (FQDN) of an Active Directory domain. *
** Constraints: *
** Can't be longer than 64 characters. *
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*
* 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
*
* 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
*
* 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
*
* The open mode of the replica database: mounted or read-only. *
** This parameter is only supported for Oracle DB instances. *
** 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.
*
* 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. *
*/ private Integer maxAllocatedStorage; /** ** 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. *
*/ private String customIamInstanceProfile; /** ** 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. *
*/ private String networkType; /** ** Specifies the storage throughput value for the read replica. *
** This setting doesn't apply to RDS Custom or Amazon Aurora. *
*/ private Integer storageThroughput; /** ** A value that indicates 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. *
*/ private Boolean enableCustomerOwnedIp; /** *
* The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules
* specified in CreateDBInstance
.
*
* 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. *
** 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. *
** Constraints: *
** Must be the identifier of an existing MySQL, MariaDB, 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. *
** 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. *
* * @param 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. */ public void setDBInstanceIdentifier(String dBInstanceIdentifier) { this.dBInstanceIdentifier = 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. *
* * @return 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. */ public String getDBInstanceIdentifier() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withDBInstanceIdentifier(String dBInstanceIdentifier) { setDBInstanceIdentifier(dBInstanceIdentifier); return this; } /** ** 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 MySQL, MariaDB, 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. *
** Constraints: *
** Must be the identifier of an existing MySQL, MariaDB, 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. *
** 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 MySQL, MariaDB, 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. *
** Constraints: *
** Must be the identifier of an existing MySQL, MariaDB, 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. *
** 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 MySQL, MariaDB, 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. *
** Constraints: *
** Must be the identifier of an existing MySQL, MariaDB, 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. *
** 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 from the source DB instance. *
* * @param dBInstanceClass * 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 from the source DB instance. */ public void setDBInstanceClass(String dBInstanceClass) { this.dBInstanceClass = dBInstanceClass; } /** *
* 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 from the source DB instance. *
* * @return 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 from the source DB instance. */ public String getDBInstanceClass() { return this.dBInstanceClass; } /** *
* 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 from the source DB instance. *
* * @param dBInstanceClass * 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 from the source DB instance. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withDBInstanceClass(String dBInstanceClass) { setDBInstanceClass(dBInstanceClass); return this; } /** *
* 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
*
* Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region. *
*
* Example: us-east-1d
*/
public void setAvailabilityZone(String availabilityZone) {
this.availabilityZone = availabilityZone;
}
/**
*
* 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
*
* Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region. *
*
* Example: us-east-1d
*/
public String getAvailabilityZone() {
return this.availabilityZone;
}
/**
*
* 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
*
* Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region. *
*
* Example: us-east-1d
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withAvailabilityZone(String availabilityZone) {
setAvailabilityZone(availabilityZone);
return this;
}
/**
*
* The port number that the DB instance uses for connections. *
** Default: Inherits from the source DB instance *
*
* Valid Values: 1150-65535
*
* Default: Inherits from the source DB instance *
*
* Valid Values: 1150-65535
*/
public void setPort(Integer port) {
this.port = port;
}
/**
*
* The port number that the DB instance uses for connections. *
** Default: Inherits from the source DB instance *
*
* Valid Values: 1150-65535
*
* Default: Inherits from the source DB instance *
*
* Valid Values: 1150-65535
*/
public Integer getPort() {
return this.port;
}
/**
*
* The port number that the DB instance uses for connections. *
** Default: Inherits from the source DB instance *
*
* Valid Values: 1150-65535
*
* Default: Inherits from the source DB instance *
*
* Valid Values: 1150-65535
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withPort(Integer port) {
setPort(port);
return this;
}
/**
*
* A value that indicates 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. *
* * @param multiAZ * A value that indicates 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. */ public void setMultiAZ(Boolean multiAZ) { this.multiAZ = multiAZ; } /** *
* A value that indicates 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. *
* * @return A value that indicates 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. */ public Boolean getMultiAZ() { return this.multiAZ; } /** *
* A value that indicates 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. *
* * @param multiAZ * A value that indicates 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withMultiAZ(Boolean multiAZ) { setMultiAZ(multiAZ); return this; } /** *
* A value that indicates 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. *
* * @return A value that indicates 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. */ public Boolean isMultiAZ() { return this.multiAZ; } /** *
* A value that indicates whether minor engine upgrades are applied automatically to the read replica during the * maintenance window. *
** This setting doesn't apply to RDS Custom. *
** Default: Inherits from the source DB instance *
* * @param autoMinorVersionUpgrade * A value that indicates whether minor engine upgrades are applied automatically to the read replica during * the maintenance window. ** This setting doesn't apply to RDS Custom. *
** Default: Inherits from the source DB instance */ public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) { this.autoMinorVersionUpgrade = autoMinorVersionUpgrade; } /** *
* A value that indicates whether minor engine upgrades are applied automatically to the read replica during the * maintenance window. *
** This setting doesn't apply to RDS Custom. *
** Default: Inherits from the source DB instance *
* * @return A value that indicates whether minor engine upgrades are applied automatically to the read replica during * the maintenance window. ** This setting doesn't apply to RDS Custom. *
** Default: Inherits from the source DB instance */ public Boolean getAutoMinorVersionUpgrade() { return this.autoMinorVersionUpgrade; } /** *
* A value that indicates whether minor engine upgrades are applied automatically to the read replica during the * maintenance window. *
** This setting doesn't apply to RDS Custom. *
** Default: Inherits from the source DB instance *
* * @param autoMinorVersionUpgrade * A value that indicates whether minor engine upgrades are applied automatically to the read replica during * the maintenance window. ** This setting doesn't apply to RDS Custom. *
** Default: Inherits from the source DB instance * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) { setAutoMinorVersionUpgrade(autoMinorVersionUpgrade); return this; } /** *
* A value that indicates whether minor engine upgrades are applied automatically to the read replica during the * maintenance window. *
** This setting doesn't apply to RDS Custom. *
** Default: Inherits from the source DB instance *
* * @return A value that indicates whether minor engine upgrades are applied automatically to the read replica during * the maintenance window. ** This setting doesn't apply to RDS Custom. *
** Default: Inherits from the source DB instance */ public Boolean isAutoMinorVersionUpgrade() { return this.autoMinorVersionUpgrade; } /** *
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB * instance. *
* * @param iops * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB * instance. */ public void setIops(Integer iops) { this.iops = iops; } /** ** The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB * instance. *
* * @return The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB * instance. */ public Integer getIops() { return this.iops; } /** ** The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB * instance. *
* * @param iops * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB * instance. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withIops(Integer iops) { setIops(iops); return this; } /** ** The option group the DB instance is associated with. If omitted, the option group associated with the source * instance or cluster is used. *
** For SQL Server, you must use the option group associated with the source. *
** This setting doesn't apply to RDS Custom. *
* * @param optionGroupName * The option group the DB instance is associated with. If omitted, the option group associated with the * source instance or cluster is used.* For SQL Server, you must use the option group associated with the source. *
** This setting doesn't apply to RDS Custom. */ public void setOptionGroupName(String optionGroupName) { this.optionGroupName = optionGroupName; } /** *
* The option group the DB instance is associated with. If omitted, the option group associated with the source * instance or cluster is used. *
** For SQL Server, you must use the option group associated with the source. *
** This setting doesn't apply to RDS Custom. *
* * @return The option group the DB instance is associated with. If omitted, the option group associated with the * source instance or cluster is used.* For SQL Server, you must use the option group associated with the source. *
** This setting doesn't apply to RDS Custom. */ public String getOptionGroupName() { return this.optionGroupName; } /** *
* The option group the DB instance is associated with. If omitted, the option group associated with the source * instance or cluster is used. *
** For SQL Server, you must use the option group associated with the source. *
** This setting doesn't apply to RDS Custom. *
* * @param optionGroupName * The option group the DB instance is associated with. If omitted, the option group associated with the * source instance or cluster is used.* For SQL Server, you must use the option group associated with the source. *
** This setting doesn't apply to RDS Custom. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withOptionGroupName(String optionGroupName) { setOptionGroupName(optionGroupName); return this; } /** *
* The name of the DB parameter group to associate with this DB instance. *
*
* If you do not specify a value for DBParameterGroupName
, then Amazon RDS uses the
* DBParameterGroup
of source DB instance for a same Region read replica, or the default
* DBParameterGroup
for the specified DB engine for a cross-Region read replica.
*
* Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't * supported 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 *
*
* If you do not specify a value for DBParameterGroupName
, then Amazon RDS uses the
* DBParameterGroup
of source DB instance for a same Region read replica, or the default
* DBParameterGroup
for the specified DB engine for a cross-Region read replica.
*
* Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It * isn't supported 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 *
** The name of the DB parameter group to associate with this DB instance. *
*
* If you do not specify a value for DBParameterGroupName
, then Amazon RDS uses the
* DBParameterGroup
of source DB instance for a same Region read replica, or the default
* DBParameterGroup
for the specified DB engine for a cross-Region read replica.
*
* Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't * supported 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 *
*
* If you do not specify a value for DBParameterGroupName
, then Amazon RDS uses the
* DBParameterGroup
of source DB instance for a same Region read replica, or the default
* DBParameterGroup
for the specified DB engine for a cross-Region read replica.
*
* Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It * isn't supported 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 *
** The name of the DB parameter group to associate with this DB instance. *
*
* If you do not specify a value for DBParameterGroupName
, then Amazon RDS uses the
* DBParameterGroup
of source DB instance for a same Region read replica, or the default
* DBParameterGroup
for the specified DB engine for a cross-Region read replica.
*
* Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't * supported 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 *
*
* If you do not specify a value for DBParameterGroupName
, then Amazon RDS uses the
* DBParameterGroup
of source DB instance for a same Region read replica, or the default
* DBParameterGroup
for the specified DB engine for a cross-Region read replica.
*
* Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It * isn't supported 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 *
** A value that indicates 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. *
* * @param publiclyAccessible * A value that indicates 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. */ public void setPubliclyAccessible(Boolean publiclyAccessible) { this.publiclyAccessible = publiclyAccessible; } /** *
* A value that indicates 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. *
* * @return A value that indicates 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. */ public Boolean getPubliclyAccessible() { return this.publiclyAccessible; } /** *
* A value that indicates 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. *
* * @param publiclyAccessible * A value that indicates 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withPubliclyAccessible(Boolean publiclyAccessible) { setPubliclyAccessible(publiclyAccessible); return this; } /** *
* A value that indicates 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. *
* * @return A value that indicates 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.
*/
public Boolean isPubliclyAccessible() {
return this.publiclyAccessible;
}
/**
* @return
*/
public java.util.List
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
* 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 isn't created in a VPC.
*
* Constraints:
*
* If supplied, must match the name of an existing DBSubnetGroup.
*
* 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
*
* Constraints: *
** If supplied, must match the name of an existing DBSubnetGroup. *
** 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
*/
public void setDBSubnetGroupName(String dBSubnetGroupName) {
this.dBSubnetGroupName = 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 isn't created in a VPC. *
** Constraints: *
** If supplied, must match the name of an existing DBSubnetGroup. *
** 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
*
* Constraints: *
** If supplied, must match the name of an existing DBSubnetGroup. *
** 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
*/
public String getDBSubnetGroupName() {
return this.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 isn't created in a VPC. *
** Constraints: *
** If supplied, must match the name of an existing DBSubnetGroup. *
** 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
*
* Constraints: *
** If supplied, must match the name of an existing DBSubnetGroup. *
** 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withDBSubnetGroupName(String dBSubnetGroupName) {
setDBSubnetGroupName(dBSubnetGroupName);
return this;
}
/**
*
* A list of Amazon EC2 VPC security groups to associate with the read replica. *
** This setting doesn't apply to RDS Custom. *
** Default: The default EC2 VPC security group for the DB subnet group's VPC. *
* * @return A list of Amazon EC2 VPC security groups to associate with the read replica. ** This setting doesn't apply to RDS Custom. *
*
* Default: The default EC2 VPC security group for the DB subnet group's VPC.
*/
public java.util.List
* A list of Amazon EC2 VPC security groups to associate with the read replica.
*
* This setting doesn't apply to RDS Custom.
*
* Default: The default EC2 VPC security group for the DB subnet group's VPC.
*
* This setting doesn't apply to RDS Custom. *
*
* Default: The default EC2 VPC security group for the DB subnet group's VPC.
*/
public void setVpcSecurityGroupIds(java.util.Collection
* A list of Amazon EC2 VPC security groups to associate with the read replica.
*
* This setting doesn't apply to RDS Custom.
*
* Default: The default EC2 VPC security group for the DB subnet group's VPC.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setVpcSecurityGroupIds(java.util.Collection)} or {@link #withVpcSecurityGroupIds(java.util.Collection)}
* if you want to override the existing values.
*
* This setting doesn't apply to RDS Custom. *
*
* Default: The default EC2 VPC security group for the DB subnet group's VPC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds) {
if (this.vpcSecurityGroupIds == null) {
setVpcSecurityGroupIds(new com.amazonaws.internal.SdkInternalList
* A list of Amazon EC2 VPC security groups to associate with the read replica.
*
* This setting doesn't apply to RDS Custom.
*
* Default: The default EC2 VPC security group for the DB subnet group's VPC.
*
* This setting doesn't apply to RDS Custom. *
*
* Default: The default EC2 VPC security group for the DB subnet group's VPC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withVpcSecurityGroupIds(java.util.Collection
* Specifies the storage type to be associated with the read replica.
*
* Valid values:
* If you specify
* Default: gp2 | gp3 | io1 | standard
* io1
or gp3
, you must also include a value for the Iops
* parameter.
* io1
if the Iops
parameter is specified, otherwise gp2
*
* Valid values: gp2 | gp3 | io1 | standard
*
* If you specify io1
or gp3
, you must also include a value for the
* Iops
parameter.
*
* Default: io1
if the Iops
parameter is specified, otherwise gp2
*/
public void setStorageType(String storageType) {
this.storageType = storageType;
}
/**
*
* Specifies the storage type to be associated with the read replica. *
*
* Valid values: gp2 | gp3 | io1 | standard
*
* If you specify io1
or gp3
, you must also include a value for the Iops
* parameter.
*
* Default: io1
if the Iops
parameter is specified, otherwise gp2
*
* Valid values: gp2 | gp3 | io1 | standard
*
* If you specify io1
or gp3
, you must also include a value for the
* Iops
parameter.
*
* Default: io1
if the Iops
parameter is specified, otherwise gp2
*/
public String getStorageType() {
return this.storageType;
}
/**
*
* Specifies the storage type to be associated with the read replica. *
*
* Valid values: gp2 | gp3 | io1 | standard
*
* If you specify io1
or gp3
, you must also include a value for the Iops
* parameter.
*
* Default: io1
if the Iops
parameter is specified, otherwise gp2
*
* Valid values: gp2 | gp3 | io1 | standard
*
* If you specify io1
or gp3
, you must also include a value for the
* Iops
parameter.
*
* Default: io1
if the Iops
parameter is specified, otherwise gp2
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withStorageType(String storageType) {
setStorageType(storageType);
return this;
}
/**
*
* A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By * default, tags are not copied. *
* * @param copyTagsToSnapshot * A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By * default, tags are not copied. */ public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot) { this.copyTagsToSnapshot = copyTagsToSnapshot; } /** ** A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By * default, tags are not copied. *
* * @return A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. * By default, tags are not copied. */ public Boolean getCopyTagsToSnapshot() { return this.copyTagsToSnapshot; } /** ** A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By * default, tags are not copied. *
* * @param copyTagsToSnapshot * A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By * default, tags are not copied. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot) { setCopyTagsToSnapshot(copyTagsToSnapshot); return this; } /** ** A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By * default, tags are not copied. *
* * @return A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. * By default, tags are not copied. */ public Boolean isCopyTagsToSnapshot() { return this.copyTagsToSnapshot; } /** ** 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.
*
* This setting doesn't apply to RDS Custom. *
*
* Valid Values: 0, 1, 5, 10, 15, 30, 60
*
* If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
* a value other than 0.
*
* This setting doesn't apply to RDS Custom. *
*
* Valid Values: 0, 1, 5, 10, 15, 30, 60
*/
public void setMonitoringInterval(Integer monitoringInterval) {
this.monitoringInterval = 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.
*
* This setting doesn't apply to RDS Custom. *
*
* Valid Values: 0, 1, 5, 10, 15, 30, 60
*
* If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
* a value other than 0.
*
* This setting doesn't apply to RDS Custom. *
*
* Valid Values: 0, 1, 5, 10, 15, 30, 60
*/
public Integer getMonitoringInterval() {
return this.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.
*
* This setting doesn't apply to RDS Custom. *
*
* Valid Values: 0, 1, 5, 10, 15, 30, 60
*
* If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
* a value other than 0.
*
* This setting doesn't apply to RDS Custom. *
*
* Valid Values: 0, 1, 5, 10, 15, 30, 60
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withMonitoringInterval(Integer monitoringInterval) {
setMonitoringInterval(monitoringInterval);
return this;
}
/**
*
* 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. *
* * @param monitoringRoleArn * 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. */ public void setMonitoringRoleArn(String monitoringRoleArn) { this.monitoringRoleArn = monitoringRoleArn; } /** *
* 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. *
* * @return 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. */ public String getMonitoringRoleArn() { return this.monitoringRoleArn; } /** *
* 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. *
* * @param monitoringRoleArn * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withMonitoringRoleArn(String monitoringRoleArn) { setMonitoringRoleArn(monitoringRoleArn); return this; } /** *
* 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. *
* * @param kmsKeyId * 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. */ public void setKmsKeyId(String kmsKeyId) { this.kmsKeyId = kmsKeyId; } /** *
* 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. *
* * @return 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. */ public String getKmsKeyId() { return this.kmsKeyId; } /** *
* 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. *
* * @param kmsKeyId * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withKmsKeyId(String kmsKeyId) { setKmsKeyId(kmsKeyId); return this; } /** *
* 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. *
*
* 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.
*
* SourceRegion
isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support
* cross-Region read replicas.
*
* This setting doesn't apply to RDS Custom. *
* * @param preSignedUrl * 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 theCreateDBInstanceReadReplica
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. *
*
* 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.
*
* SourceRegion
isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't
* support cross-Region read replicas.
*
* This setting doesn't apply to RDS Custom. */ public void setPreSignedUrl(String preSignedUrl) { this.preSignedUrl = preSignedUrl; } /** *
* 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. *
*
* 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.
*
* SourceRegion
isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support
* cross-Region read replicas.
*
* This setting doesn't apply to RDS Custom. *
* * @return 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 theCreateDBInstanceReadReplica
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. *
*
* 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.
*
* SourceRegion
isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't
* support cross-Region read replicas.
*
* This setting doesn't apply to RDS Custom. */ public String getPreSignedUrl() { return this.preSignedUrl; } /** *
* 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. *
*
* 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.
*
* SourceRegion
isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support
* cross-Region read replicas.
*
* This setting doesn't apply to RDS Custom. *
* * @param preSignedUrl * 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 theCreateDBInstanceReadReplica
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. *
*
* 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.
*
* SourceRegion
isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't
* support cross-Region read replicas.
*
* This setting doesn't apply to RDS Custom. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withPreSignedUrl(String preSignedUrl) { setPreSignedUrl(preSignedUrl); return this; } /** *
* A value that indicates 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. *
* * @param enableIAMDatabaseAuthentication * A value that indicates 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. */ public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) { this.enableIAMDatabaseAuthentication = enableIAMDatabaseAuthentication; } /** *
* A value that indicates 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. *
* * @return A value that indicates 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. */ public Boolean getEnableIAMDatabaseAuthentication() { return this.enableIAMDatabaseAuthentication; } /** *
* A value that indicates 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. *
* * @param enableIAMDatabaseAuthentication * A value that indicates 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) { setEnableIAMDatabaseAuthentication(enableIAMDatabaseAuthentication); return this; } /** *
* A value that indicates 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. *
* * @return A value that indicates 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. */ public Boolean isEnableIAMDatabaseAuthentication() { return this.enableIAMDatabaseAuthentication; } /** *
* A value that indicates 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. *
* * @param enablePerformanceInsights * A value that indicates 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. */ public void setEnablePerformanceInsights(Boolean enablePerformanceInsights) { this.enablePerformanceInsights = enablePerformanceInsights; } /** *
* A value that indicates 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. *
* * @return A value that indicates 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. */ public Boolean getEnablePerformanceInsights() { return this.enablePerformanceInsights; } /** *
* A value that indicates 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. *
* * @param enablePerformanceInsights * A value that indicates 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights) { setEnablePerformanceInsights(enablePerformanceInsights); return this; } /** *
* A value that indicates 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. *
* * @return A value that indicates 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. */ public Boolean isEnablePerformanceInsights() { return this.enablePerformanceInsights; } /** *
* 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. *
* * @param performanceInsightsKMSKeyId * 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. */ public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId) { this.performanceInsightsKMSKeyId = performanceInsightsKMSKeyId; } /** *
* 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. *
* * @return 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. */ public String getPerformanceInsightsKMSKeyId() { return this.performanceInsightsKMSKeyId; } /** *
* 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. *
* * @param performanceInsightsKMSKeyId * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId) { setPerformanceInsightsKMSKeyId(performanceInsightsKMSKeyId); return this; } /** *
* The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: *
** 7 *
** month * 31, where month is a number of months from 1-23 *
** 731 *
** For example, the following values are valid: *
** 93 (3 months * 31) *
** 341 (11 months * 31) *
** 589 (19 months * 31) *
** 731 *
** If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. *
** This setting doesn't apply to RDS Custom. *
* * @param performanceInsightsRetentionPeriod * The number of days to retain Performance Insights data. The default is 7 days. The following values are * valid: ** 7 *
** month * 31, where month is a number of months from 1-23 *
** 731 *
** For example, the following values are valid: *
** 93 (3 months * 31) *
** 341 (11 months * 31) *
** 589 (19 months * 31) *
** 731 *
** If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. *
** This setting doesn't apply to RDS Custom. */ public void setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod) { this.performanceInsightsRetentionPeriod = performanceInsightsRetentionPeriod; } /** *
* The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: *
** 7 *
** month * 31, where month is a number of months from 1-23 *
** 731 *
** For example, the following values are valid: *
** 93 (3 months * 31) *
** 341 (11 months * 31) *
** 589 (19 months * 31) *
** 731 *
** If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. *
** This setting doesn't apply to RDS Custom. *
* * @return The number of days to retain Performance Insights data. The default is 7 days. The following values are * valid: ** 7 *
** month * 31, where month is a number of months from 1-23 *
** 731 *
** For example, the following values are valid: *
** 93 (3 months * 31) *
** 341 (11 months * 31) *
** 589 (19 months * 31) *
** 731 *
** If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. *
** This setting doesn't apply to RDS Custom. */ public Integer getPerformanceInsightsRetentionPeriod() { return this.performanceInsightsRetentionPeriod; } /** *
* The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: *
** 7 *
** month * 31, where month is a number of months from 1-23 *
** 731 *
** For example, the following values are valid: *
** 93 (3 months * 31) *
** 341 (11 months * 31) *
** 589 (19 months * 31) *
** 731 *
** If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. *
** This setting doesn't apply to RDS Custom. *
* * @param performanceInsightsRetentionPeriod * The number of days to retain Performance Insights data. The default is 7 days. The following values are * valid: ** 7 *
** month * 31, where month is a number of months from 1-23 *
** 731 *
** For example, the following values are valid: *
** 93 (3 months * 31) *
** 341 (11 months * 31) *
** 589 (19 months * 31) *
** 731 *
** If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. *
** This setting doesn't apply to RDS Custom. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod) { setPerformanceInsightsRetentionPeriod(performanceInsightsRetentionPeriod); return this; } /** *
* 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 in the Amazon RDS User Guide. *
** This setting doesn't apply to RDS Custom. *
* * @return 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 in the Amazon RDS User Guide. *
* This setting doesn't apply to RDS Custom.
*/
public java.util.List
* 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 in the Amazon RDS User Guide.
*
* This setting doesn't apply to RDS Custom.
*
* This setting doesn't apply to RDS Custom.
*/
public void setEnableCloudwatchLogsExports(java.util.Collection
* 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 in the Amazon RDS User Guide.
*
* This setting doesn't apply to RDS Custom.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setEnableCloudwatchLogsExports(java.util.Collection)} or
* {@link #withEnableCloudwatchLogsExports(java.util.Collection)} if you want to override the existing values.
*
* This setting doesn't apply to RDS Custom.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports) {
if (this.enableCloudwatchLogsExports == null) {
setEnableCloudwatchLogsExports(new com.amazonaws.internal.SdkInternalList
* 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 in the Amazon RDS User Guide.
*
* This setting doesn't apply to RDS Custom.
*
* This setting doesn't apply to RDS Custom.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withEnableCloudwatchLogsExports(java.util.Collection
* 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.
*
* This setting doesn't apply to RDS Custom.
*/
public java.util.List
* 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.
*
* This setting doesn't apply to RDS Custom.
*/
public void setProcessorFeatures(java.util.Collection
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setProcessorFeatures(java.util.Collection)} or {@link #withProcessorFeatures(java.util.Collection)} if
* you want to override the existing values.
*
* This setting doesn't apply to RDS Custom.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withProcessorFeatures(ProcessorFeature... processorFeatures) {
if (this.processorFeatures == null) {
setProcessorFeatures(new com.amazonaws.internal.SdkInternalList
* 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.
*
* This setting doesn't apply to RDS Custom.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withProcessorFeatures(java.util.Collection
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
*
* This setting doesn't apply to RDS Custom.
*
* This setting doesn't apply to RDS Custom. */ public void setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures) { this.useDefaultProcessorFeatures = useDefaultProcessorFeatures; } /** *
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. *
** This setting doesn't apply to RDS Custom. *
* * @return A value that indicates whether the DB instance class of the DB instance uses its default processor * features. ** This setting doesn't apply to RDS Custom. */ public Boolean getUseDefaultProcessorFeatures() { return this.useDefaultProcessorFeatures; } /** *
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. *
** This setting doesn't apply to RDS Custom. *
* * @param useDefaultProcessorFeatures * A value that indicates whether the DB instance class of the DB instance uses its default processor * features. ** This setting doesn't apply to RDS Custom. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures) { setUseDefaultProcessorFeatures(useDefaultProcessorFeatures); return this; } /** *
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. *
** This setting doesn't apply to RDS Custom. *
* * @return A value that indicates whether the DB instance class of the DB instance uses its default processor * features. ** This setting doesn't apply to RDS Custom. */ public Boolean isUseDefaultProcessorFeatures() { return this.useDefaultProcessorFeatures; } /** *
* A value that indicates whether the DB instance has deletion protection enabled. 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. *
* * @param deletionProtection * A value that indicates whether the DB instance has deletion protection enabled. 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. */ public void setDeletionProtection(Boolean deletionProtection) { this.deletionProtection = deletionProtection; } /** ** A value that indicates whether the DB instance has deletion protection enabled. 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. *
* * @return A value that indicates whether the DB instance has deletion protection enabled. 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. */ public Boolean getDeletionProtection() { return this.deletionProtection; } /** ** A value that indicates whether the DB instance has deletion protection enabled. 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. *
* * @param deletionProtection * A value that indicates whether the DB instance has deletion protection enabled. 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withDeletionProtection(Boolean deletionProtection) { setDeletionProtection(deletionProtection); return this; } /** ** A value that indicates whether the DB instance has deletion protection enabled. 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. *
* * @return A value that indicates whether the DB instance has deletion protection enabled. 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. */ public Boolean isDeletionProtection() { return this.deletionProtection; } /** ** 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. *
* * @param domain * 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. */ public void setDomain(String domain) { this.domain = domain; } /** *
* 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. *
* * @return 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. */ public String getDomain() { return this.domain; } /** *
* 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. *
* * @param domain * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withDomain(String domain) { setDomain(domain); return this; } /** *
* The name of the IAM role to be used when making API calls to the Directory Service. *
** This setting doesn't apply to RDS Custom. *
* * @param domainIAMRoleName * The name of the IAM role to be used when making API calls to the Directory Service. ** This setting doesn't apply to RDS Custom. */ public void setDomainIAMRoleName(String domainIAMRoleName) { this.domainIAMRoleName = domainIAMRoleName; } /** *
* The name of the IAM role to be used when making API calls to the Directory Service. *
** This setting doesn't apply to RDS Custom. *
* * @return The name of the IAM role to be used when making API calls to the Directory Service. ** This setting doesn't apply to RDS Custom. */ public String getDomainIAMRoleName() { return this.domainIAMRoleName; } /** *
* The name of the IAM role to be used when making API calls to the Directory Service. *
** This setting doesn't apply to RDS Custom. *
* * @param domainIAMRoleName * The name of the IAM role to be used when making API calls to the Directory Service. ** This setting doesn't apply to RDS Custom. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withDomainIAMRoleName(String domainIAMRoleName) { setDomainIAMRoleName(domainIAMRoleName); return this; } /** *
* The fully qualified domain name (FQDN) of an Active Directory domain. *
** Constraints: *
** Can't be longer than 64 characters. *
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*
* Constraints: *
** Can't be longer than 64 characters. *
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*/
public void setDomainFqdn(String domainFqdn) {
this.domainFqdn = domainFqdn;
}
/**
*
* The fully qualified domain name (FQDN) of an Active Directory domain. *
** Constraints: *
** Can't be longer than 64 characters. *
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*
* Constraints: *
** Can't be longer than 64 characters. *
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*/
public String getDomainFqdn() {
return this.domainFqdn;
}
/**
*
* The fully qualified domain name (FQDN) of an Active Directory domain. *
** Constraints: *
** Can't be longer than 64 characters. *
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*
* Constraints: *
** Can't be longer than 64 characters. *
*
* Example: mymanagedADtest.mymanagedAD.mydomain
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withDomainFqdn(String domainFqdn) {
setDomainFqdn(domainFqdn);
return this;
}
/**
*
* 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
*
* Constraints: *
** Must be in the distinguished name format. *
** Can't be longer than 64 characters. *
*
* Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
*/
public void setDomainOu(String domainOu) {
this.domainOu = domainOu;
}
/**
*
* 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
*
* Constraints: *
** Must be in the distinguished name format. *
** Can't be longer than 64 characters. *
*
* Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
*/
public String getDomainOu() {
return this.domainOu;
}
/**
*
* 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
*
* Constraints: *
** Must be in the distinguished name format. *
** Can't be longer than 64 characters. *
*
* Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withDomainOu(String domainOu) {
setDomainOu(domainOu);
return this;
}
/**
*
* 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
*
* Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
*/
public void setDomainAuthSecretArn(String domainAuthSecretArn) {
this.domainAuthSecretArn = domainAuthSecretArn;
}
/**
*
* 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
*
* Example:
* arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
*/
public String getDomainAuthSecretArn() {
return this.domainAuthSecretArn;
}
/**
*
* 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
*
* Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withDomainAuthSecretArn(String domainAuthSecretArn) {
setDomainAuthSecretArn(domainAuthSecretArn);
return this;
}
/**
*
* 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
*
* 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:
* 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
*/
public java.util.List
*
* 123.124.125.126,234.235.236.237
*
* 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:
* 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:
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDomainDnsIps(java.util.Collection)} or {@link #withDomainDnsIps(java.util.Collection)} if you want to
* override the existing values.
* 123.124.125.126,234.235.236.237
*/
public void setDomainDnsIps(java.util.Collection
*
* 123.124.125.126,234.235.236.237
*
* 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:
* 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withDomainDnsIps(String... domainDnsIps) {
if (this.domainDnsIps == null) {
setDomainDnsIps(new com.amazonaws.internal.SdkInternalList
*
* 123.124.125.126,234.235.236.237
*
* 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:
* The open mode of the replica database: mounted or read-only.
*
* This parameter is only supported for Oracle DB instances.
*
* 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 123.124.125.126,234.235.236.237
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDBInstanceReadReplicaRequest withDomainDnsIps(java.util.Collectionmounted
. The value won't be set by
* default. After replica creation, you can manage the open mode manually.
*
* This parameter is only supported for Oracle DB instances. *
** 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.
* @see ReplicaMode
*/
public void setReplicaMode(String replicaMode) {
this.replicaMode = replicaMode;
}
/**
*
* The open mode of the replica database: mounted or read-only. *
** This parameter is only supported for Oracle DB instances. *
** 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.
*
* This parameter is only supported for Oracle DB instances. *
** 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.
* @see ReplicaMode
*/
public String getReplicaMode() {
return this.replicaMode;
}
/**
*
* The open mode of the replica database: mounted or read-only. *
** This parameter is only supported for Oracle DB instances. *
** 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.
*
* This parameter is only supported for Oracle DB instances. *
** 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReplicaMode
*/
public CreateDBInstanceReadReplicaRequest withReplicaMode(String replicaMode) {
setReplicaMode(replicaMode);
return this;
}
/**
*
* The open mode of the replica database: mounted or read-only. *
** This parameter is only supported for Oracle DB instances. *
** 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.
*
* This parameter is only supported for Oracle DB instances. *
** 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReplicaMode
*/
public CreateDBInstanceReadReplicaRequest withReplicaMode(ReplicaMode replicaMode) {
this.replicaMode = replicaMode.toString();
return this;
}
/**
*
* 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. *
* * @param maxAllocatedStorage * 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. */ public void setMaxAllocatedStorage(Integer maxAllocatedStorage) { this.maxAllocatedStorage = maxAllocatedStorage; } /** *
* 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. *
* * @return 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. */ public Integer getMaxAllocatedStorage() { return this.maxAllocatedStorage; } /** *
* 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. *
* * @param maxAllocatedStorage * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withMaxAllocatedStorage(Integer maxAllocatedStorage) { setMaxAllocatedStorage(maxAllocatedStorage); return this; } /** *
* 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. *
* * @param customIamInstanceProfile * 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. */ public void setCustomIamInstanceProfile(String customIamInstanceProfile) { this.customIamInstanceProfile = customIamInstanceProfile; } /** *
* 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. *
* * @return 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. */ public String getCustomIamInstanceProfile() { return this.customIamInstanceProfile; } /** *
* 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. *
* * @param customIamInstanceProfile * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withCustomIamInstanceProfile(String customIamInstanceProfile) { setCustomIamInstanceProfile(customIamInstanceProfile); return this; } /** *
* 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. *
* * @param networkType * 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. */ public void setNetworkType(String networkType) { this.networkType = networkType; } /** *
* 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. *
* * @return 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. */ public String getNetworkType() { return this.networkType; } /** *
* 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. *
* * @param networkType * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withNetworkType(String networkType) { setNetworkType(networkType); return this; } /** *
* Specifies the storage throughput value for the read replica. *
** This setting doesn't apply to RDS Custom or Amazon Aurora. *
* * @param storageThroughput * Specifies the storage throughput value for the read replica. ** This setting doesn't apply to RDS Custom or Amazon Aurora. */ public void setStorageThroughput(Integer storageThroughput) { this.storageThroughput = storageThroughput; } /** *
* Specifies the storage throughput value for the read replica. *
** This setting doesn't apply to RDS Custom or Amazon Aurora. *
* * @return Specifies the storage throughput value for the read replica. ** This setting doesn't apply to RDS Custom or Amazon Aurora. */ public Integer getStorageThroughput() { return this.storageThroughput; } /** *
* Specifies the storage throughput value for the read replica. *
** This setting doesn't apply to RDS Custom or Amazon Aurora. *
* * @param storageThroughput * Specifies the storage throughput value for the read replica. ** This setting doesn't apply to RDS Custom or Amazon Aurora. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withStorageThroughput(Integer storageThroughput) { setStorageThroughput(storageThroughput); return this; } /** *
* A value that indicates 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. *
* * @param enableCustomerOwnedIp * A value that indicates 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. */ public void setEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp) { this.enableCustomerOwnedIp = enableCustomerOwnedIp; } /** *
* A value that indicates 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. *
* * @return A value that indicates 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. */ public Boolean getEnableCustomerOwnedIp() { return this.enableCustomerOwnedIp; } /** *
* A value that indicates 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. *
* * @param enableCustomerOwnedIp * A value that indicates 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp) { setEnableCustomerOwnedIp(enableCustomerOwnedIp); return this; } /** *
* A value that indicates 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. *
* * @return A value that indicates 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. */ public Boolean isEnableCustomerOwnedIp() { return this.enableCustomerOwnedIp; } /** *
* The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules
* specified in CreateDBInstance
.
*
* 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. *
*CreateDBInstance
. * 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. *
*/ public void setAllocatedStorage(Integer allocatedStorage) { this.allocatedStorage = allocatedStorage; } /** *
* The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules
* specified in CreateDBInstance
.
*
* 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. *
*CreateDBInstance
. * 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. *
*/ public Integer getAllocatedStorage() { return this.allocatedStorage; } /** *
* The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules
* specified in CreateDBInstance
.
*
* 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. *
*CreateDBInstance
. * 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. *
* @return Returns a reference to this object so that method calls can be chained together. */ public CreateDBInstanceReadReplicaRequest withAllocatedStorage(Integer allocatedStorage) { setAllocatedStorage(allocatedStorage); return this; } /** ** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
*