CreateDBInstanceReadReplicaRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.AmazonWebServiceRequest
- - software.amazon.awssdk.services.rds.model.CreateDBInstanceReadReplicaRequest

All Implemented Interfaces:: Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateDBInstanceReadReplicaRequest.Builder,CreateDBInstanceReadReplicaRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateDBInstanceReadReplicaRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateDBInstanceReadReplicaRequest.Builder,CreateDBInstanceReadReplicaRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateDBInstanceReadReplicaRequest.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`CreateDBInstanceReadReplicaRequest.Builder`

Field Summary
- Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest
  NOOP

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`autoMinorVersionUpgrade()`	Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
`String`	`availabilityZone()`	The Amazon EC2 Availability Zone that the Read Replica will be created in.
`static CreateDBInstanceReadReplicaRequest.Builder`	`builder()`
`Boolean`	`copyTagsToSnapshot()`	True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false.
`String`	`dbInstanceClass()`	The compute and memory capacity of the Read Replica.
`String`	`dbInstanceIdentifier()`	The DB instance identifier of the Read Replica.
`String`	`dbSubnetGroupName()`	Specifies a DB subnet group for the DB instance.
`Boolean`	`enableIAMDatabaseAuthentication()`	True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`Integer`	`iops()`	The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
`String`	`kmsKeyId()`	The AWS KMS key ID for an encrypted Read Replica.
`Integer`	`monitoringInterval()`	The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica.
`String`	`monitoringRoleArn()`	The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs.
`String`	`optionGroupName()`	The option group the DB instance will be associated with.
`Integer`	`port()`	The port number that the DB instance uses for connections.
`String`	`preSignedUrl()`	The URL that contains a Signature Version 4 signed request for the `CreateDBInstanceReadReplica` API action in the AWS region that contains the source DB instance.
`Boolean`	`publiclyAccessible()`	Specifies the accessibility options for the DB instance.
`static Class<? extends CreateDBInstanceReadReplicaRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceDBInstanceIdentifier()`	The identifier of the DB instance that will act as the source for the Read Replica.
`String`	`sourceRegion()`	The region where the source instance is located.
`String`	`storageType()`	Specifies the storage type to be associated with the Read Replica.
`List<Tag>`	`tags()`
`CreateDBInstanceReadReplicaRequest.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - dbInstanceIdentifier
```
public String dbInstanceIdentifier()
```
    The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
    
    Returns:
    
    The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
  - sourceDBInstanceIdentifier
```
public String sourceDBInstanceIdentifier()
```
    The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.
    
    Constraints:
    - Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance.
    - Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
    - Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later.
    - The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
    - If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
    - If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
    Returns:
    The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.
    
    Constraints:
    
    Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance.
    
    Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
    
    Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later.
    
    The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
    
    If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
    
    If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
  - dbInstanceClass
```
public String dbInstanceClass()
```
    The compute and memory capacity of the Read Replica. Note that not all instance classes are available in all regions for all DB engines.
    
    Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
    
    Default: Inherits from the source DB instance.
    
    Returns:
    
    The compute and memory capacity of the Read Replica. Note that not all instance classes are available in all regions for all DB engines.
    
    Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
    
    Default: Inherits from the source DB instance.
  - availabilityZone
```
public String availabilityZone()
```
    The Amazon EC2 Availability Zone that the Read Replica will be created in.
    
    Default: A random, system-chosen Availability Zone in the endpoint's region.
    
    Example: us-east-1d
    
    Returns:
    
    The Amazon EC2 Availability Zone that the Read Replica will be created in.
    
    Default: A random, system-chosen Availability Zone in the endpoint's region.
    
    Example: us-east-1d
  - port
```
public Integer port()
```
    The port number that the DB instance uses for connections.
    
    Default: Inherits from the source DB instance
    
    Valid Values: 1150-65535
    
    Returns:
    
    The port number that the DB instance uses for connections.
    
    Default: Inherits from the source DB instance
    
    Valid Values: 1150-65535
  - autoMinorVersionUpgrade
```
public Boolean autoMinorVersionUpgrade()
```
    Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
    
    Default: Inherits from the source DB instance
    
    Returns:
    
    Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
    
    Default: Inherits from the source DB instance
  - iops
```
public Integer iops()
```
    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
    
    Returns:
    
    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
  - optionGroupName
```
public String optionGroupName()
```
    The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.
    
    Returns:
    
    The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.
  - publiclyAccessible
```
public Boolean publiclyAccessible()
```
    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    - Default VPC:true
    - VPC:false
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
    Returns:
    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    
    Default VPC:true
    
    VPC:false
    
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
  - tags
```
public List<Tag> tags()
```
    Returns:
  - dbSubnetGroupName
```
public String dbSubnetGroupName()
```
    Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.
    
    Constraints:
    - Can only be specified if the source DB instance identifier specifies a DB instance in another region.
    - The specified DB subnet group must be in the same region in which the operation is running.
    - All Read Replicas in one region that are created from the same source DB instance must either:>
      
      Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
      
      Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
    
    Example: mySubnetgroup
    Returns:
    Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.
    
    Constraints:
    
    Can only be specified if the source DB instance identifier specifies a DB instance in another region.
    
    The specified DB subnet group must be in the same region in which the operation is running.
    
    All Read Replicas in one region that are created from the same source DB instance must either:>
    
    Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
    
    Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
    
    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
    
    Example: mySubnetgroup
  - storageType
```
public String storageType()
```
    Specifies the storage type to be associated with the Read Replica.
    
    Valid values: standard | gp2 | io1
    
    If you specify io1, you must also include a value for the Iops parameter.
    
    Default: io1 if the Iops parameter is specified; otherwise standard
    
    Returns:
    
    Specifies the storage type to be associated with the Read Replica.
    
    Valid values: standard | gp2 | io1
    
    If you specify io1, you must also include a value for the Iops parameter.
    
    Default: io1 if the Iops parameter is specified; otherwise standard
  - copyTagsToSnapshot
```
public Boolean copyTagsToSnapshot()
```
    True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
    
    Returns:
    
    True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
  - monitoringInterval
```
public Integer monitoringInterval()
```
    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
    
    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
    
    Valid Values: 0, 1, 5, 10, 15, 30, 60
    
    Returns:
    
    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
    
    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
    
    Valid Values: 0, 1, 5, 10, 15, 30, 60
  - monitoringRoleArn
```
public String monitoringRoleArn()
```
    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.
    
    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
    
    Returns:
    
    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.
    
    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
  - kmsKeyId
```
public String kmsKeyId()
```
    The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
    
    If you create an unencrypted Read Replica and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target Read Replica using the specified KMS encryption key.
    
    If you create an encrypted Read Replica from your AWS account, you can specify a value for KmsKeyId to encrypt the Read Replica with a new KMS encryption key. If you don't specify a value for KmsKeyId , then the Read Replica is encrypted with the same KMS key as the source DB instance.
    
    If you create an encrypted Read Replica in a different AWS region, then you must specify a KMS key for the destination AWS region. KMS encryption keys are specific to the region that they are created in, and you cannot use encryption keys from one region in another region.
    
    Returns:
    
    The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
    
    If you create an unencrypted Read Replica and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target Read Replica using the specified KMS encryption key.
    
    If you create an encrypted Read Replica from your AWS account, you can specify a value for KmsKeyId to encrypt the Read Replica with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the Read Replica is encrypted with the same KMS key as the source DB instance.
    
    If you create an encrypted Read Replica in a different AWS region, then you must specify a KMS key for the destination AWS region. KMS encryption keys are specific to the region that they are created in, and you cannot use encryption keys from one region in another region.
  - preSignedUrl
```
public String preSignedUrl()
```
    The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the AWS region that contains the source DB instance. The PreSignedUrl parameter must be used when encrypting a Read Replica from another AWS region.
    
    The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source region that contains the encrypted DB instance. The presigned URL request must contain the following parameter values:
    - DestinationRegion - The AWS Region that the Read Replica is created in. This region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.
      
      For example, if you create an encrypted Read Replica in the us-east-1 region, and the source DB instance is in the west-2 region, then you call the CreateDBInstanceReadReplica action in the us-east-1 region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.
    - KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination region, and the action contained in the presigned URL.
    - SourceDBInstanceIdentifier - The DB instance identifier for the encrypted Read Replica to be created. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you create an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier would look like this example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-instance-20161115.
    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
    Returns:
    The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the AWS region that contains the source DB instance. The PreSignedUrl parameter must be used when encrypting a Read Replica from another AWS region.
    
    The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source region that contains the encrypted DB instance. The presigned URL request must contain the following parameter values:
    
    DestinationRegion - The AWS Region that the Read Replica is created in. This region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.
    
    For example, if you create an encrypted Read Replica in the us-east-1 region, and the source DB instance is in the west-2 region, then you call the CreateDBInstanceReadReplica action in the us-east-1 region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.
    
    KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination region, and the action contained in the presigned URL.
    
    SourceDBInstanceIdentifier - The DB instance identifier for the encrypted Read Replica to be created. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you create an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier would look like this example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-instance-20161115.
    
    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
  - enableIAMDatabaseAuthentication
```
public Boolean enableIAMDatabaseAuthentication()
```
    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
    
    You can enable IAM database authentication for the following database engines
    - For MySQL 5.6, minor version 5.6.34 or higher
    - For MySQL 5.7, minor version 5.7.16 or higher
    - Aurora 5.6 or higher.
    Default: false
    Returns:
    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
    
    You can enable IAM database authentication for the following database engines
    
    For MySQL 5.6, minor version 5.6.34 or higher
    
    For MySQL 5.7, minor version 5.7.16 or higher
    
    Aurora 5.6 or higher.
    
    Default: false
  - sourceRegion
```
public String sourceRegion()
```
    The region where the source instance is located.
    
    Returns:
    
    The region where the source instance is located.
  - toBuilder
```
public CreateDBInstanceReadReplicaRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDBInstanceReadReplicaRequest.Builder,CreateDBInstanceReadReplicaRequest>
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateDBInstanceReadReplicaRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDBInstanceReadReplicaRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CreateDBInstanceReadReplicaRequest

Nested Class Summary

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

Method Summary

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Method Detail

dbInstanceIdentifier

sourceDBInstanceIdentifier

dbInstanceClass

availabilityZone

port

autoMinorVersionUpgrade

iops

optionGroupName

publiclyAccessible

tags

dbSubnetGroupName

storageType

copyTagsToSnapshot

monitoringInterval

monitoringRoleArn

kmsKeyId

preSignedUrl

enableIAMDatabaseAuthentication

sourceRegion

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString