Class RestoreDBInstanceFromDBSnapshotRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.rds.model.RestoreDBInstanceFromDBSnapshotRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class RestoreDBInstanceFromDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description RestoreDBInstanceFromDBSnapshotRequest()
Default constructor for RestoreDBInstanceFromDBSnapshotRequest object.RestoreDBInstanceFromDBSnapshotRequest(String dBInstanceIdentifier, String dBSnapshotIdentifier)
Constructs a new RestoreDBInstanceFromDBSnapshotRequest object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RestoreDBInstanceFromDBSnapshotRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Boolean
getAutoMinorVersionUpgrade()
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.String
getAvailabilityZone()
The EC2 Availability Zone that the database instance will be created in.Boolean
getCopyTagsToSnapshot()
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false.String
getDBInstanceClass()
The compute and memory capacity of the Amazon RDS DB instance.String
getDBInstanceIdentifier()
Name of the DB instance to create from the DB snapshot.String
getDBName()
The database name for the restored DB instance.String
getDBSnapshotIdentifier()
The identifier for the DB snapshot to restore from.String
getDBSubnetGroupName()
The DB subnet group name to use for the new instance.String
getDomain()
Specify the Active Directory Domain to restore the instance in.String
getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.String
getEngine()
The database engine to use for the new instance.Integer
getIops()
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.String
getLicenseModel()
License model information for the restored DB instance.Boolean
getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.String
getOptionGroupName()
The name of the option group to be used for the restored DB instance.Integer
getPort()
The port number on which the database accepts connections.Boolean
getPubliclyAccessible()
Specifies the accessibility options for the DB instance.String
getStorageType()
Specifies the storage type to be associated with the DB instance.List<Tag>
getTags()
String
getTdeCredentialArn()
The ARN from the Key Store with which to associate the instance for TDE encryption.String
getTdeCredentialPassword()
The password for the given ARN from the Key Store in order to access the device.int
hashCode()
Boolean
isAutoMinorVersionUpgrade()
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.Boolean
isCopyTagsToSnapshot()
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false.Boolean
isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.Boolean
isPubliclyAccessible()
Specifies the accessibility options for the DB instance.void
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.void
setAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance will be created in.void
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false.void
setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance.void
setDBInstanceIdentifier(String dBInstanceIdentifier)
Name of the DB instance to create from the DB snapshot.void
setDBName(String dBName)
The database name for the restored DB instance.void
setDBSnapshotIdentifier(String dBSnapshotIdentifier)
The identifier for the DB snapshot to restore from.void
setDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.void
setDomain(String domain)
Specify the Active Directory Domain to restore the instance in.void
setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.void
setEngine(String engine)
The database engine to use for the new instance.void
setIops(Integer iops)
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.void
setLicenseModel(String licenseModel)
License model information for the restored DB instance.void
setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.void
setOptionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.void
setPort(Integer port)
The port number on which the database accepts connections.void
setPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.void
setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.void
setTags(Collection<Tag> tags)
void
setTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.void
setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.String
toString()
Returns a string representation of this object; useful for testing and debugging.RestoreDBInstanceFromDBSnapshotRequest
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.RestoreDBInstanceFromDBSnapshotRequest
withAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance will be created in.RestoreDBInstanceFromDBSnapshotRequest
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false.RestoreDBInstanceFromDBSnapshotRequest
withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance.RestoreDBInstanceFromDBSnapshotRequest
withDBInstanceIdentifier(String dBInstanceIdentifier)
Name of the DB instance to create from the DB snapshot.RestoreDBInstanceFromDBSnapshotRequest
withDBName(String dBName)
The database name for the restored DB instance.RestoreDBInstanceFromDBSnapshotRequest
withDBSnapshotIdentifier(String dBSnapshotIdentifier)
The identifier for the DB snapshot to restore from.RestoreDBInstanceFromDBSnapshotRequest
withDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.RestoreDBInstanceFromDBSnapshotRequest
withDomain(String domain)
Specify the Active Directory Domain to restore the instance in.RestoreDBInstanceFromDBSnapshotRequest
withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.RestoreDBInstanceFromDBSnapshotRequest
withEngine(String engine)
The database engine to use for the new instance.RestoreDBInstanceFromDBSnapshotRequest
withIops(Integer iops)
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.RestoreDBInstanceFromDBSnapshotRequest
withLicenseModel(String licenseModel)
License model information for the restored DB instance.RestoreDBInstanceFromDBSnapshotRequest
withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.RestoreDBInstanceFromDBSnapshotRequest
withOptionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.RestoreDBInstanceFromDBSnapshotRequest
withPort(Integer port)
The port number on which the database accepts connections.RestoreDBInstanceFromDBSnapshotRequest
withPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.RestoreDBInstanceFromDBSnapshotRequest
withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.RestoreDBInstanceFromDBSnapshotRequest
withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any).RestoreDBInstanceFromDBSnapshotRequest
withTags(Collection<Tag> tags)
RestoreDBInstanceFromDBSnapshotRequest
withTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.RestoreDBInstanceFromDBSnapshotRequest
withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Constructor Detail
-
RestoreDBInstanceFromDBSnapshotRequest
public RestoreDBInstanceFromDBSnapshotRequest()
Default constructor for RestoreDBInstanceFromDBSnapshotRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
-
RestoreDBInstanceFromDBSnapshotRequest
public RestoreDBInstanceFromDBSnapshotRequest(String dBInstanceIdentifier, String dBSnapshotIdentifier)
Constructs a new RestoreDBInstanceFromDBSnapshotRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
dBInstanceIdentifier
- Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
dBSnapshotIdentifier
- The identifier for the DB snapshot to restore from.Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.
-
-
Method Detail
-
setDBInstanceIdentifier
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
- Parameters:
dBInstanceIdentifier
- Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
-
getDBInstanceIdentifier
public String getDBInstanceIdentifier()
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
- Returns:
- Name of the DB instance to create from the DB snapshot. This
parameter isn't case-sensitive.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
-
withDBInstanceIdentifier
public RestoreDBInstanceFromDBSnapshotRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
- Parameters:
dBInstanceIdentifier
- Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBSnapshotIdentifier
public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)
The identifier for the DB snapshot to restore from.
Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.- Parameters:
dBSnapshotIdentifier
- The identifier for the DB snapshot to restore from.Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.
-
getDBSnapshotIdentifier
public String getDBSnapshotIdentifier()
The identifier for the DB snapshot to restore from.
Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.- Returns:
- The identifier for the DB snapshot to restore from.
Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.
-
withDBSnapshotIdentifier
public RestoreDBInstanceFromDBSnapshotRequest withDBSnapshotIdentifier(String dBSnapshotIdentifier)
The identifier for the DB snapshot to restore from.
Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.- Parameters:
dBSnapshotIdentifier
- The identifier for the DB snapshot to restore from.Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBInstanceClass
public void setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.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
- Parameters:
dBInstanceClass
- The compute and memory capacity of the Amazon RDS DB instance.Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.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
-
getDBInstanceClass
public String getDBInstanceClass()
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.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
- Returns:
- The compute and memory capacity of the Amazon RDS DB instance.
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.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
-
withDBInstanceClass
public RestoreDBInstanceFromDBSnapshotRequest withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.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
- Parameters:
dBInstanceClass
- The compute and memory capacity of the Amazon RDS DB instance.Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPort
public void setPort(Integer port)
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be
1150-65535
- Parameters:
port
- The port number on which the database accepts connections.Default: The same port as the original DB instance
Constraints: Value must be
1150-65535
-
getPort
public Integer getPort()
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be
1150-65535
- Returns:
- The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be
1150-65535
-
withPort
public RestoreDBInstanceFromDBSnapshotRequest withPort(Integer port)
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be
1150-65535
- Parameters:
port
- The port number on which the database accepts connections.Default: The same port as the original DB instance
Constraints: Value must be
1150-65535
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAvailabilityZone
public void setAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.Example:
us-east-1a
- Parameters:
availabilityZone
- The EC2 Availability Zone that the database instance will be created in.Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.Example:
us-east-1a
-
getAvailabilityZone
public String getAvailabilityZone()
The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.Example:
us-east-1a
- Returns:
- The EC2 Availability Zone that the database instance will be
created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.Example:
us-east-1a
-
withAvailabilityZone
public RestoreDBInstanceFromDBSnapshotRequest withAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.Example:
us-east-1a
- Parameters:
availabilityZone
- The EC2 Availability Zone that the database instance will be created in.Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.Example:
us-east-1a
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBSubnetGroupName
public void setDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Parameters:
dBSubnetGroupName
- The DB subnet group name to use for the new instance.Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
-
getDBSubnetGroupName
public String getDBSubnetGroupName()
The DB subnet group name to use for the new instance.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Returns:
- The DB subnet group name to use for the new instance.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
-
withDBSubnetGroupName
public RestoreDBInstanceFromDBSnapshotRequest withDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Parameters:
dBSubnetGroupName
- The DB subnet group name to use for the new instance.Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMultiAZ
public void setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.- Parameters:
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.
-
getMultiAZ
public Boolean getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.- Returns:
- Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.
-
withMultiAZ
public RestoreDBInstanceFromDBSnapshotRequest withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.- Parameters:
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isMultiAZ
public Boolean isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.- Returns:
- Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.
-
setPubliclyAccessible
public void setPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
- Default VPC: true
- VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance 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.
- Parameters:
publiclyAccessible
- Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
- Default VPC: true
- VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance 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.
-
getPubliclyAccessible
public Boolean getPubliclyAccessible()
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
- Default VPC: true
- VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance 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.
-
withPubliclyAccessible
public RestoreDBInstanceFromDBSnapshotRequest withPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
- Default VPC: true
- VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance 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.
- Parameters:
publiclyAccessible
- Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
- Default VPC: true
- VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance 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:
- Returns a reference to this object so that method calls can be chained together.
-
isPubliclyAccessible
public Boolean isPubliclyAccessible()
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
- Default VPC: true
- VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance 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.
-
setAutoMinorVersionUpgrade
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
- Parameters:
autoMinorVersionUpgrade
- Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
-
getAutoMinorVersionUpgrade
public Boolean getAutoMinorVersionUpgrade()
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
- Returns:
- Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
-
withAutoMinorVersionUpgrade
public RestoreDBInstanceFromDBSnapshotRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
- Parameters:
autoMinorVersionUpgrade
- Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isAutoMinorVersionUpgrade
public Boolean isAutoMinorVersionUpgrade()
Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
- Returns:
- Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
-
setLicenseModel
public void setLicenseModel(String licenseModel)
License model information for the restored DB instance.
Default: Same as source.
Valid values:
license-included
|bring-your-own-license
|general-public-license
- Parameters:
licenseModel
- License model information for the restored DB instance.Default: Same as source.
Valid values:
license-included
|bring-your-own-license
|general-public-license
-
getLicenseModel
public String getLicenseModel()
License model information for the restored DB instance.
Default: Same as source.
Valid values:
license-included
|bring-your-own-license
|general-public-license
- Returns:
- License model information for the restored DB instance.
Default: Same as source.
Valid values:
license-included
|bring-your-own-license
|general-public-license
-
withLicenseModel
public RestoreDBInstanceFromDBSnapshotRequest withLicenseModel(String licenseModel)
License model information for the restored DB instance.
Default: Same as source.
Valid values:
license-included
|bring-your-own-license
|general-public-license
- Parameters:
licenseModel
- License model information for the restored DB instance.Default: Same as source.
Valid values:
license-included
|bring-your-own-license
|general-public-license
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBName
public void setDBName(String dBName)
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL or MariaDB engines.
- Parameters:
dBName
- The database name for the restored DB instance.This parameter doesn't apply to the MySQL or MariaDB engines.
-
getDBName
public String getDBName()
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL or MariaDB engines.
- Returns:
- The database name for the restored DB instance.
This parameter doesn't apply to the MySQL or MariaDB engines.
-
withDBName
public RestoreDBInstanceFromDBSnapshotRequest withDBName(String dBName)
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL or MariaDB engines.
- Parameters:
dBName
- The database name for the restored DB instance.This parameter doesn't apply to the MySQL or MariaDB engines.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEngine
public void setEngine(String engine)
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
- Parameters:
engine
- The database engine to use for the new instance.Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
-
getEngine
public String getEngine()
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
- Returns:
- The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
-
withEngine
public RestoreDBInstanceFromDBSnapshotRequest withEngine(String engine)
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
- Parameters:
engine
- The database engine to use for the new instance.Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIops
public void setIops(Integer iops)
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
- Parameters:
iops
- Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
-
getIops
public Integer getIops()
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
- Returns:
- Specifies the amount of provisioned IOPS for the DB instance,
expressed in I/O operations per second. If this parameter is not
specified, the IOPS value will be taken from the backup. If this
parameter is set to 0, the new instance will be converted to a
non-PIOPS instance, which will take additional time, though your
DB instance will be available for connections before the
conversion starts.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
-
withIops
public RestoreDBInstanceFromDBSnapshotRequest withIops(Integer iops)
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
- Parameters:
iops
- Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOptionGroupName
public void setOptionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
- Parameters:
optionGroupName
- The name of the option group to be used for the restored DB instance.Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
-
getOptionGroupName
public String getOptionGroupName()
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
- Returns:
- The name of the option group to be used for the restored DB
instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
-
withOptionGroupName
public RestoreDBInstanceFromDBSnapshotRequest withOptionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
- Parameters:
optionGroupName
- The name of the option group to be used for the restored DB instance.Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTags
public void setTags(Collection<Tag> tags)
- Parameters:
tags
-
-
withTags
public RestoreDBInstanceFromDBSnapshotRequest withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
public RestoreDBInstanceFromDBSnapshotRequest withTags(Collection<Tag> tags)
- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStorageType
public void setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Parameters:
storageType
- Specifies the storage type to be associated with the DB instance.Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
-
getStorageType
public String getStorageType()
Specifies the storage type to be associated with the DB instance.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Returns:
- Specifies the storage type to be associated with the DB instance.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
-
withStorageType
public RestoreDBInstanceFromDBSnapshotRequest withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Parameters:
storageType
- Specifies the storage type to be associated with the DB instance.Valid values:
standard | gp2 | io1
If you specify
io1
, you must also include a value for theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTdeCredentialArn
public void setTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
- Parameters:
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for TDE encryption.
-
getTdeCredentialArn
public String getTdeCredentialArn()
The ARN from the Key Store with which to associate the instance for TDE encryption.
- Returns:
- The ARN from the Key Store with which to associate the instance for TDE encryption.
-
withTdeCredentialArn
public RestoreDBInstanceFromDBSnapshotRequest withTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
- Parameters:
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for TDE encryption.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTdeCredentialPassword
public void setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
- Parameters:
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access the device.
-
getTdeCredentialPassword
public String getTdeCredentialPassword()
The password for the given ARN from the Key Store in order to access the device.
- Returns:
- The password for the given ARN from the Key Store in order to access the device.
-
withTdeCredentialPassword
public RestoreDBInstanceFromDBSnapshotRequest withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
- Parameters:
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access the device.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDomain
public void setDomain(String domain)
Specify the Active Directory Domain to restore the instance in.
- Parameters:
domain
- Specify the Active Directory Domain to restore the instance in.
-
getDomain
public String getDomain()
Specify the Active Directory Domain to restore the instance in.
- Returns:
- Specify the Active Directory Domain to restore the instance in.
-
withDomain
public RestoreDBInstanceFromDBSnapshotRequest withDomain(String domain)
Specify the Active Directory Domain to restore the instance in.
- Parameters:
domain
- Specify the Active Directory Domain to restore the instance in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCopyTagsToSnapshot
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
- Parameters:
copyTagsToSnapshot
- True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
-
getCopyTagsToSnapshot
public Boolean getCopyTagsToSnapshot()
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
- Returns:
- True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
-
withCopyTagsToSnapshot
public RestoreDBInstanceFromDBSnapshotRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
- Parameters:
copyTagsToSnapshot
- True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isCopyTagsToSnapshot
public Boolean isCopyTagsToSnapshot()
True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
- Returns:
- True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
-
setDomainIAMRoleName
public void setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
- Parameters:
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.
-
getDomainIAMRoleName
public String getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
- Returns:
- Specify the name of the IAM role to be used when making API calls to the Directory Service.
-
withDomainIAMRoleName
public RestoreDBInstanceFromDBSnapshotRequest withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
- Parameters:
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public RestoreDBInstanceFromDBSnapshotRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-