@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RestoreDBInstanceFromDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RestoreDBInstanceFromDBSnapshotRequest()
Default constructor for RestoreDBInstanceFromDBSnapshotRequest object.
|
RestoreDBInstanceFromDBSnapshotRequest(String dBInstanceIdentifier,
String dBSnapshotIdentifier)
Constructs a new RestoreDBInstanceFromDBSnapshotRequest object.
|
Modifier and Type | Method and Description |
---|---|
RestoreDBInstanceFromDBSnapshotRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getAutoMinorVersionUpgrade()
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
|
String |
getAvailabilityZone()
The EC2 Availability Zone that the database instance is 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, for example,
db.m4.large . |
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.
|
Boolean |
getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise
false.
|
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 are 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 |
isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; 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 are applied automatically to the DB instance during the maintenance window.
|
void |
setAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance is 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, for example,
db.m4.large . |
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 |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise
false.
|
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 are applied automatically to the DB instance during the maintenance window.
|
RestoreDBInstanceFromDBSnapshotRequest |
withAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance is 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, for example,
db.m4.large . |
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 |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise
false.
|
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(Collection<Tag> tags) |
RestoreDBInstanceFromDBSnapshotRequest |
withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any).
|
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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public RestoreDBInstanceFromDBSnapshotRequest()
public RestoreDBInstanceFromDBSnapshotRequest(String dBInstanceIdentifier, String dBSnapshotIdentifier)
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 numbers, letters, or hyphens
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 match the identifier of an existing DBSnapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the
ARN of the shared DB snapshot.
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 numbers, letters, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
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 numbers, letters, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
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 numbers, letters, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Constraints:
Must contain from 1 to 63 numbers, letters, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
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 numbers, letters, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
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 numbers, letters, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DBSnapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the ARN of
the shared DB snapshot.
dBSnapshotIdentifier
- The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DBSnapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the
ARN of the shared DB snapshot.
public String getDBSnapshotIdentifier()
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DBSnapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the ARN of
the shared DB snapshot.
Constraints:
Must match the identifier of an existing DBSnapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the
ARN of the shared DB snapshot.
public RestoreDBInstanceFromDBSnapshotRequest withDBSnapshotIdentifier(String dBSnapshotIdentifier)
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DBSnapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the ARN of
the shared DB snapshot.
dBSnapshotIdentifier
- The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DBSnapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the
ARN of the shared DB snapshot.
public void setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all regions, or for all database engines. For the full list of DB instance
classes, and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
dBInstanceClass
- The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large
. Not
all DB instance classes are available in all regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
public String getDBInstanceClass()
The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all regions, or for all database engines. For the full list of DB instance
classes, and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
db.m4.large
. Not
all DB instance classes are available in all regions, or for all database engines. For the full list of
DB instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
public RestoreDBInstanceFromDBSnapshotRequest withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all regions, or for all database engines. For the full list of DB instance
classes, and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
dBInstanceClass
- The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large
. Not
all DB instance classes are available in all regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
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
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
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
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
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
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
public void setAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance is 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
availabilityZone
- The EC2 Availability Zone that the database instance is 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
public String getAvailabilityZone()
The EC2 Availability Zone that the database instance is 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
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
public RestoreDBInstanceFromDBSnapshotRequest withAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance is 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
availabilityZone
- The EC2 Availability Zone that the database instance is 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
public void setDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
dBSubnetGroupName
- The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
public String getDBSubnetGroupName()
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
public RestoreDBInstanceFromDBSnapshotRequest withDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
dBSubnetGroupName
- The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
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
.
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
.
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
.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.
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
.
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
.
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
.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.
public void setPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
publiclyAccessible
- Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing
instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false
specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
public Boolean getPubliclyAccessible()
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
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 is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
publiclyAccessible
- Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing
instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false
specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
public Boolean isPubliclyAccessible()
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
autoMinorVersionUpgrade
- Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance
window.public Boolean getAutoMinorVersionUpgrade()
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
public RestoreDBInstanceFromDBSnapshotRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
autoMinorVersionUpgrade
- Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance
window.public Boolean isAutoMinorVersionUpgrade()
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
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
licenseModel
- License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
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
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
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
licenseModel
- License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public void setDBName(String dBName)
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
dBName
- The database name for the restored DB instance. This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
public String getDBName()
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
public RestoreDBInstanceFromDBSnapshotRequest withDBName(String dBName)
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
dBName
- The database name for the restored DB instance. This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
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. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
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. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
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. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Default: The same as source
Constraint: Must be compatible with the engine of the source. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
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. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
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. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
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 is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance.
Constraints: Must be an integer greater than 1000.
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 is taken from the backup. If this parameter is set to 0,
the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your
DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance.
Constraints: Must be an integer greater than 1000.
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 is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance.
Constraints: Must be an integer greater than 1000.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance.
Constraints: Must be an integer greater than 1000.
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 is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance.
Constraints: Must be an integer greater than 1000.
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 is taken from the backup. If this parameter is set to 0,
the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your
DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance.
Constraints: Must be an integer greater than 1000.
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
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
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
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
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
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
public void setTags(Collection<Tag> tags)
tags
- public RestoreDBInstanceFromDBSnapshotRequest withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- public RestoreDBInstanceFromDBSnapshotRequest withTags(Collection<Tag> tags)
tags
- 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 the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise standard
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 the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise standard
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 the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise standard
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
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 the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise standard
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 the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise standard
public void setTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for TDE encryption.public String getTdeCredentialArn()
The ARN from the Key Store with which to associate the instance for TDE encryption.
public RestoreDBInstanceFromDBSnapshotRequest withTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for TDE encryption.public void setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access the device.public String getTdeCredentialPassword()
The password for the given ARN from the Key Store in order to access the device.
public RestoreDBInstanceFromDBSnapshotRequest withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access the device.public void setDomain(String domain)
Specify the Active Directory Domain to restore the instance in.
domain
- Specify the Active Directory Domain to restore the instance in.public String getDomain()
Specify the Active Directory Domain to restore the instance in.
public RestoreDBInstanceFromDBSnapshotRequest withDomain(String domain)
Specify the Active Directory Domain to restore the instance in.
domain
- Specify the Active Directory Domain to restore the instance in.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.
copyTagsToSnapshot
- True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The
default is false.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.
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.
copyTagsToSnapshot
- True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The
default is false.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.
public void setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.public String getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public RestoreDBInstanceFromDBSnapshotRequest withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
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
public Boolean getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
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
public RestoreDBInstanceFromDBSnapshotRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
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
public Boolean isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
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
public String toString()
toString
in class Object
Object.toString()
public RestoreDBInstanceFromDBSnapshotRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.