AWS SDK for C++  1.9.2
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest Class Reference

#include <RestoreDBInstanceFromDBSnapshotRequest.h>

+ Inheritance diagram for Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest:

Public Member Functions

 RestoreDBInstanceFromDBSnapshotRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDBInstanceIdentifier () const
 
bool DBInstanceIdentifierHasBeenSet () const
 
void SetDBInstanceIdentifier (const Aws::String &value)
 
void SetDBInstanceIdentifier (Aws::String &&value)
 
void SetDBInstanceIdentifier (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBInstanceIdentifier (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBInstanceIdentifier (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBInstanceIdentifier (const char *value)
 
const Aws::StringGetDBSnapshotIdentifier () const
 
bool DBSnapshotIdentifierHasBeenSet () const
 
void SetDBSnapshotIdentifier (const Aws::String &value)
 
void SetDBSnapshotIdentifier (Aws::String &&value)
 
void SetDBSnapshotIdentifier (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBSnapshotIdentifier (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBSnapshotIdentifier (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBSnapshotIdentifier (const char *value)
 
const Aws::StringGetDBInstanceClass () const
 
bool DBInstanceClassHasBeenSet () const
 
void SetDBInstanceClass (const Aws::String &value)
 
void SetDBInstanceClass (Aws::String &&value)
 
void SetDBInstanceClass (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBInstanceClass (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBInstanceClass (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBInstanceClass (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
RestoreDBInstanceFromDBSnapshotRequestWithPort (int value)
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithAvailabilityZone (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithAvailabilityZone (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithAvailabilityZone (const char *value)
 
const Aws::StringGetDBSubnetGroupName () const
 
bool DBSubnetGroupNameHasBeenSet () const
 
void SetDBSubnetGroupName (const Aws::String &value)
 
void SetDBSubnetGroupName (Aws::String &&value)
 
void SetDBSubnetGroupName (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBSubnetGroupName (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBSubnetGroupName (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBSubnetGroupName (const char *value)
 
bool GetMultiAZ () const
 
bool MultiAZHasBeenSet () const
 
void SetMultiAZ (bool value)
 
RestoreDBInstanceFromDBSnapshotRequestWithMultiAZ (bool value)
 
bool GetPubliclyAccessible () const
 
bool PubliclyAccessibleHasBeenSet () const
 
void SetPubliclyAccessible (bool value)
 
RestoreDBInstanceFromDBSnapshotRequestWithPubliclyAccessible (bool value)
 
bool GetAutoMinorVersionUpgrade () const
 
bool AutoMinorVersionUpgradeHasBeenSet () const
 
void SetAutoMinorVersionUpgrade (bool value)
 
RestoreDBInstanceFromDBSnapshotRequestWithAutoMinorVersionUpgrade (bool value)
 
const Aws::StringGetLicenseModel () const
 
bool LicenseModelHasBeenSet () const
 
void SetLicenseModel (const Aws::String &value)
 
void SetLicenseModel (Aws::String &&value)
 
void SetLicenseModel (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithLicenseModel (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithLicenseModel (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithLicenseModel (const char *value)
 
const Aws::StringGetDBName () const
 
bool DBNameHasBeenSet () const
 
void SetDBName (const Aws::String &value)
 
void SetDBName (Aws::String &&value)
 
void SetDBName (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBName (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBName (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBName (const char *value)
 
const Aws::StringGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Aws::String &value)
 
void SetEngine (Aws::String &&value)
 
void SetEngine (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithEngine (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithEngine (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithEngine (const char *value)
 
int GetIops () const
 
bool IopsHasBeenSet () const
 
void SetIops (int value)
 
RestoreDBInstanceFromDBSnapshotRequestWithIops (int value)
 
const Aws::StringGetOptionGroupName () const
 
bool OptionGroupNameHasBeenSet () const
 
void SetOptionGroupName (const Aws::String &value)
 
void SetOptionGroupName (Aws::String &&value)
 
void SetOptionGroupName (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithOptionGroupName (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithOptionGroupName (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithOptionGroupName (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithTags (const Aws::Vector< Tag > &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithTags (Aws::Vector< Tag > &&value)
 
RestoreDBInstanceFromDBSnapshotRequestAddTags (const Tag &value)
 
RestoreDBInstanceFromDBSnapshotRequestAddTags (Tag &&value)
 
const Aws::StringGetStorageType () const
 
bool StorageTypeHasBeenSet () const
 
void SetStorageType (const Aws::String &value)
 
void SetStorageType (Aws::String &&value)
 
void SetStorageType (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithStorageType (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithStorageType (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithStorageType (const char *value)
 
const Aws::StringGetTdeCredentialArn () const
 
bool TdeCredentialArnHasBeenSet () const
 
void SetTdeCredentialArn (const Aws::String &value)
 
void SetTdeCredentialArn (Aws::String &&value)
 
void SetTdeCredentialArn (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithTdeCredentialArn (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithTdeCredentialArn (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithTdeCredentialArn (const char *value)
 
const Aws::StringGetTdeCredentialPassword () const
 
bool TdeCredentialPasswordHasBeenSet () const
 
void SetTdeCredentialPassword (const Aws::String &value)
 
void SetTdeCredentialPassword (Aws::String &&value)
 
void SetTdeCredentialPassword (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithTdeCredentialPassword (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithTdeCredentialPassword (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithTdeCredentialPassword (const char *value)
 
const Aws::Vector< Aws::String > & GetVpcSecurityGroupIds () const
 
bool VpcSecurityGroupIdsHasBeenSet () const
 
void SetVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
RestoreDBInstanceFromDBSnapshotRequestAddVpcSecurityGroupIds (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestAddVpcSecurityGroupIds (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestAddVpcSecurityGroupIds (const char *value)
 
const Aws::StringGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const Aws::String &value)
 
void SetDomain (Aws::String &&value)
 
void SetDomain (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDomain (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDomain (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDomain (const char *value)
 
bool GetCopyTagsToSnapshot () const
 
bool CopyTagsToSnapshotHasBeenSet () const
 
void SetCopyTagsToSnapshot (bool value)
 
RestoreDBInstanceFromDBSnapshotRequestWithCopyTagsToSnapshot (bool value)
 
const Aws::StringGetDomainIAMRoleName () const
 
bool DomainIAMRoleNameHasBeenSet () const
 
void SetDomainIAMRoleName (const Aws::String &value)
 
void SetDomainIAMRoleName (Aws::String &&value)
 
void SetDomainIAMRoleName (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDomainIAMRoleName (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDomainIAMRoleName (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDomainIAMRoleName (const char *value)
 
bool GetEnableIAMDatabaseAuthentication () const
 
bool EnableIAMDatabaseAuthenticationHasBeenSet () const
 
void SetEnableIAMDatabaseAuthentication (bool value)
 
RestoreDBInstanceFromDBSnapshotRequestWithEnableIAMDatabaseAuthentication (bool value)
 
const Aws::Vector< Aws::String > & GetEnableCloudwatchLogsExports () const
 
bool EnableCloudwatchLogsExportsHasBeenSet () const
 
void SetEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
void SetEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
RestoreDBInstanceFromDBSnapshotRequestAddEnableCloudwatchLogsExports (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestAddEnableCloudwatchLogsExports (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestAddEnableCloudwatchLogsExports (const char *value)
 
const Aws::Vector< ProcessorFeature > & GetProcessorFeatures () const
 
bool ProcessorFeaturesHasBeenSet () const
 
void SetProcessorFeatures (const Aws::Vector< ProcessorFeature > &value)
 
void SetProcessorFeatures (Aws::Vector< ProcessorFeature > &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithProcessorFeatures (const Aws::Vector< ProcessorFeature > &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithProcessorFeatures (Aws::Vector< ProcessorFeature > &&value)
 
RestoreDBInstanceFromDBSnapshotRequestAddProcessorFeatures (const ProcessorFeature &value)
 
RestoreDBInstanceFromDBSnapshotRequestAddProcessorFeatures (ProcessorFeature &&value)
 
bool GetUseDefaultProcessorFeatures () const
 
bool UseDefaultProcessorFeaturesHasBeenSet () const
 
void SetUseDefaultProcessorFeatures (bool value)
 
RestoreDBInstanceFromDBSnapshotRequestWithUseDefaultProcessorFeatures (bool value)
 
const Aws::StringGetDBParameterGroupName () const
 
bool DBParameterGroupNameHasBeenSet () const
 
void SetDBParameterGroupName (const Aws::String &value)
 
void SetDBParameterGroupName (Aws::String &&value)
 
void SetDBParameterGroupName (const char *value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBParameterGroupName (const Aws::String &value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBParameterGroupName (Aws::String &&value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDBParameterGroupName (const char *value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
RestoreDBInstanceFromDBSnapshotRequestWithDeletionProtection (bool value)
 
bool GetEnableCustomerOwnedIp () const
 
bool EnableCustomerOwnedIpHasBeenSet () const
 
void SetEnableCustomerOwnedIp (bool value)
 
RestoreDBInstanceFromDBSnapshotRequestWithEnableCustomerOwnedIp (bool value)
 
- Public Member Functions inherited from Aws::RDS::RDSRequest
virtual ~RDSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::RDS::RDSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 27 of file RestoreDBInstanceFromDBSnapshotRequest.h.

Constructor & Destructor Documentation

◆ RestoreDBInstanceFromDBSnapshotRequest()

Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::RestoreDBInstanceFromDBSnapshotRequest ( )

Member Function Documentation

◆ AddEnableCloudwatchLogsExports() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AddEnableCloudwatchLogsExports ( Aws::String &&  value)
inline

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Definition at line 1421 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ AddEnableCloudwatchLogsExports() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AddEnableCloudwatchLogsExports ( const Aws::String value)
inline

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Definition at line 1411 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ AddEnableCloudwatchLogsExports() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AddEnableCloudwatchLogsExports ( const char *  value)
inline

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Definition at line 1431 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ AddProcessorFeatures() [1/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AddProcessorFeatures ( const ProcessorFeature value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 1474 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ AddProcessorFeatures() [2/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AddProcessorFeatures ( ProcessorFeature &&  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 1480 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ AddTags() [1/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AddTags ( const Tag value)
inline

Definition at line 906 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ AddTags() [2/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AddTags ( Tag &&  value)
inline

Definition at line 909 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AddVpcSecurityGroupIds ( Aws::String &&  value)
inline

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1137 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AddVpcSecurityGroupIds ( const Aws::String value)
inline

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1130 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AddVpcSecurityGroupIds ( const char *  value)
inline

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1144 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AutoMinorVersionUpgradeHasBeenSet ( ) const
inline

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

Definition at line 523 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ AvailabilityZoneHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::AvailabilityZoneHasBeenSet ( ) const
inline

The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a

Definition at line 323 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ CopyTagsToSnapshotHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::CopyTagsToSnapshotHasBeenSet ( ) const
inline

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

Definition at line 1238 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ DBInstanceClassHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::DBInstanceClassHasBeenSet ( ) const
inline

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

Definition at line 211 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ DBInstanceIdentifierHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::DBInstanceIdentifierHasBeenSet ( ) const
inline

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

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Definition at line 61 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ DBNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::DBNameHasBeenSet ( ) const
inline

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

Definition at line 605 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ DBParameterGroupNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::DBParameterGroupNameHasBeenSet ( ) const
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

Constraints:

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

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1528 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ DBSnapshotIdentifierHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::DBSnapshotIdentifierHasBeenSet ( ) const
inline

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.

Definition at line 134 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ DBSubnetGroupNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::DBSubnetGroupNameHasBeenSet ( ) const
inline

The DB subnet group name to use for the new instance.

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

Example: mySubnetgroup

Definition at line 386 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ DeletionProtectionHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::DeletionProtectionHasBeenSet ( ) const
inline

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 1613 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ DomainHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::DomainHasBeenSet ( ) const
inline

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1165 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ DomainIAMRoleNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::DomainIAMRoleNameHasBeenSet ( ) const
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1263 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ DumpBodyToUrl()

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EnableCloudwatchLogsExportsHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::EnableCloudwatchLogsExportsHasBeenSet ( ) const
inline

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Definition at line 1361 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ EnableCustomerOwnedIpHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::EnableCustomerOwnedIpHasBeenSet ( ) const
inline

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.

Definition at line 1662 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ EnableIAMDatabaseAuthenticationHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::EnableIAMDatabaseAuthenticationHasBeenSet ( ) const
inline

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 1320 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ EngineHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::EngineHasBeenSet ( ) const
inline

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 672 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetAutoMinorVersionUpgrade()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetAutoMinorVersionUpgrade ( ) const
inline

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

Definition at line 517 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetAvailabilityZone ( ) const
inline

The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a

Definition at line 315 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetCopyTagsToSnapshot()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetCopyTagsToSnapshot ( ) const
inline

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

Definition at line 1232 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetDBInstanceClass()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetDBInstanceClass ( ) const
inline

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

Definition at line 200 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetDBInstanceIdentifier()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetDBInstanceIdentifier ( ) const
inline

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

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Definition at line 52 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetDBName()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetDBName ( ) const
inline

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

Definition at line 599 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetDBParameterGroupName()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetDBParameterGroupName ( ) const
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

Constraints:

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

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1517 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetDBSnapshotIdentifier()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetDBSnapshotIdentifier ( ) const
inline

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.

Definition at line 125 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetDBSubnetGroupName()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetDBSubnetGroupName ( ) const
inline

The DB subnet group name to use for the new instance.

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

Example: mySubnetgroup

Definition at line 379 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetDeletionProtection()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetDeletionProtection ( ) const
inline

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 1604 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetDomain()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetDomain ( ) const
inline

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1155 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetDomainIAMRoleName()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetDomainIAMRoleName ( ) const
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1257 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetEnableCloudwatchLogsExports()

const Aws::Vector<Aws::String>& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetEnableCloudwatchLogsExports ( ) const
inline

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Definition at line 1351 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetEnableCustomerOwnedIp()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetEnableCustomerOwnedIp ( ) const
inline

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.

Definition at line 1647 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetEnableIAMDatabaseAuthentication()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetEnableIAMDatabaseAuthentication ( ) const
inline

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 1310 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetEngine()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetEngine ( ) const
inline

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 657 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetIops()

int Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetIops ( ) const
inline

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't 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 in the Amazon RDS User Guide.

Constraints: Must be an integer greater than 1000.

Definition at line 777 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetLicenseModel()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetLicenseModel ( ) const
inline

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 543 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetMultiAZ()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetMultiAZ ( ) const
inline

A value that indicates whether the DB instance is a Multi-AZ deployment.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Definition at line 436 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetOptionGroupName()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetOptionGroupName ( ) const
inline

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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 828 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetPort()

int Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetPort ( ) const
inline

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

Definition at line 285 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetProcessorFeatures()

const Aws::Vector<ProcessorFeature>& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetProcessorFeatures ( ) const
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 1438 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetPubliclyAccessible()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetPubliclyAccessible ( ) const
inline

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 471 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GetStorageType()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetStorageType ( ) const
inline

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 gp2

Definition at line 919 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetTags ( ) const
inline

Definition at line 888 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetTdeCredentialArn()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetTdeCredentialArn ( ) const
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 989 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetTdeCredentialPassword()

const Aws::String& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetTdeCredentialPassword ( ) const
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 1038 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetUseDefaultProcessorFeatures()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetUseDefaultProcessorFeatures ( ) const
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 1487 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ GetVpcSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::GetVpcSecurityGroupIds ( ) const
inline

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1088 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ IopsHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::IopsHasBeenSet ( ) const
inline

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't 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 in the Amazon RDS User Guide.

Constraints: Must be an integer greater than 1000.

Definition at line 791 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ LicenseModelHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::LicenseModelHasBeenSet ( ) const
inline

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 550 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ MultiAZHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::MultiAZHasBeenSet ( ) const
inline

A value that indicates whether the DB instance is a Multi-AZ deployment.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Definition at line 443 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ OptionGroupNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::OptionGroupNameHasBeenSet ( ) const
inline

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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 836 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ PortHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::PortHasBeenSet ( ) const
inline

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

Definition at line 292 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ ProcessorFeaturesHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::ProcessorFeaturesHasBeenSet ( ) const
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 1444 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ PubliclyAccessibleHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::PubliclyAccessibleHasBeenSet ( ) const
inline

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 484 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SerializePayload()

Aws::String Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAutoMinorVersionUpgrade()

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetAutoMinorVersionUpgrade ( bool  value)
inline

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

Definition at line 529 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetAvailabilityZone() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a

Definition at line 339 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetAvailabilityZone() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetAvailabilityZone ( const Aws::String value)
inline

The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a

Definition at line 331 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetAvailabilityZone() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetAvailabilityZone ( const char *  value)
inline

The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a

Definition at line 347 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetCopyTagsToSnapshot()

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetCopyTagsToSnapshot ( bool  value)
inline

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

Definition at line 1244 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBInstanceClass() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBInstanceClass ( Aws::String &&  value)
inline

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

Definition at line 233 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBInstanceClass() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBInstanceClass ( const Aws::String value)
inline

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

Definition at line 222 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBInstanceClass() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBInstanceClass ( const char *  value)
inline

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

Definition at line 244 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBInstanceIdentifier() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBInstanceIdentifier ( Aws::String &&  value)
inline

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

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Definition at line 79 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBInstanceIdentifier ( const Aws::String value)
inline

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

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Definition at line 70 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBInstanceIdentifier ( const char *  value)
inline

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

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Definition at line 88 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBName() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBName ( Aws::String &&  value)
inline

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

Definition at line 617 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBName() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBName ( const Aws::String value)
inline

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

Definition at line 611 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBName() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBName ( const char *  value)
inline

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

Definition at line 623 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBParameterGroupName() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBParameterGroupName ( Aws::String &&  value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

Constraints:

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

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1550 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBParameterGroupName() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBParameterGroupName ( const Aws::String value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

Constraints:

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

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1539 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBParameterGroupName() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBParameterGroupName ( const char *  value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

Constraints:

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

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1561 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBSnapshotIdentifier() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBSnapshotIdentifier ( Aws::String &&  value)
inline

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.

Definition at line 152 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBSnapshotIdentifier() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBSnapshotIdentifier ( const Aws::String value)
inline

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.

Definition at line 143 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBSnapshotIdentifier() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBSnapshotIdentifier ( const char *  value)
inline

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.

Definition at line 161 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBSubnetGroupName() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBSubnetGroupName ( Aws::String &&  value)
inline

The DB subnet group name to use for the new instance.

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

Example: mySubnetgroup

Definition at line 400 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBSubnetGroupName() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBSubnetGroupName ( const Aws::String value)
inline

The DB subnet group name to use for the new instance.

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

Example: mySubnetgroup

Definition at line 393 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDBSubnetGroupName() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDBSubnetGroupName ( const char *  value)
inline

The DB subnet group name to use for the new instance.

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

Example: mySubnetgroup

Definition at line 407 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDeletionProtection()

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDeletionProtection ( bool  value)
inline

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 1622 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDomain() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDomain ( Aws::String &&  value)
inline

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1185 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDomain() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDomain ( const Aws::String value)
inline

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1175 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDomain() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDomain ( const char *  value)
inline

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1195 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDomainIAMRoleName() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDomainIAMRoleName ( Aws::String &&  value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1275 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDomainIAMRoleName() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDomainIAMRoleName ( const Aws::String value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1269 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetDomainIAMRoleName() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetDomainIAMRoleName ( const char *  value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1281 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetEnableCloudwatchLogsExports() [1/2]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetEnableCloudwatchLogsExports ( Aws::Vector< Aws::String > &&  value)
inline

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Definition at line 1381 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetEnableCloudwatchLogsExports() [2/2]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetEnableCloudwatchLogsExports ( const Aws::Vector< Aws::String > &  value)
inline

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Definition at line 1371 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetEnableCustomerOwnedIp()

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetEnableCustomerOwnedIp ( bool  value)
inline

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.

Definition at line 1677 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetEnableIAMDatabaseAuthentication()

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetEnableIAMDatabaseAuthentication ( bool  value)
inline

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 1330 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetEngine() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetEngine ( Aws::String &&  value)
inline

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 702 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetEngine() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetEngine ( const Aws::String value)
inline

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 687 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetEngine() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetEngine ( const char *  value)
inline

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 717 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetIops()

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetIops ( int  value)
inline

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't 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 in the Amazon RDS User Guide.

Constraints: Must be an integer greater than 1000.

Definition at line 805 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetLicenseModel() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetLicenseModel ( Aws::String &&  value)
inline

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 564 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetLicenseModel() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetLicenseModel ( const Aws::String value)
inline

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 557 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetLicenseModel() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetLicenseModel ( const char *  value)
inline

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 571 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetMultiAZ()

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetMultiAZ ( bool  value)
inline

A value that indicates whether the DB instance is a Multi-AZ deployment.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Definition at line 450 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetOptionGroupName() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetOptionGroupName ( Aws::String &&  value)
inline

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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 852 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetOptionGroupName() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetOptionGroupName ( const Aws::String value)
inline

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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 844 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetOptionGroupName() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetOptionGroupName ( const char *  value)
inline

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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 860 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetPort()

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetPort ( int  value)
inline

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

Definition at line 299 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetProcessorFeatures() [1/2]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetProcessorFeatures ( Aws::Vector< ProcessorFeature > &&  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 1456 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetProcessorFeatures() [2/2]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetProcessorFeatures ( const Aws::Vector< ProcessorFeature > &  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 1450 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetPubliclyAccessible()

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetPubliclyAccessible ( bool  value)
inline

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 497 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetStorageType() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetStorageType ( Aws::String &&  value)
inline

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 gp2

Definition at line 946 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetStorageType() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetStorageType ( const Aws::String value)
inline

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 gp2

Definition at line 937 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetStorageType() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetStorageType ( const char *  value)
inline

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 gp2

Definition at line 955 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetTags() [1/2]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Definition at line 897 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetTags() [2/2]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Definition at line 894 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetTdeCredentialArn() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetTdeCredentialArn ( Aws::String &&  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 1007 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetTdeCredentialArn() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetTdeCredentialArn ( const Aws::String value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 1001 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetTdeCredentialArn() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetTdeCredentialArn ( const char *  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 1013 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetTdeCredentialPassword() [1/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetTdeCredentialPassword ( Aws::String &&  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 1056 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetTdeCredentialPassword() [2/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetTdeCredentialPassword ( const Aws::String value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 1050 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetTdeCredentialPassword() [3/3]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetTdeCredentialPassword ( const char *  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 1062 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetUseDefaultProcessorFeatures()

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetUseDefaultProcessorFeatures ( bool  value)
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 1499 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1109 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

void Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::SetVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1102 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ StorageTypeHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::StorageTypeHasBeenSet ( ) const
inline

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 gp2

Definition at line 928 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ TagsHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::TagsHasBeenSet ( ) const
inline

Definition at line 891 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ TdeCredentialArnHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::TdeCredentialArnHasBeenSet ( ) const
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 995 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ TdeCredentialPasswordHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::TdeCredentialPasswordHasBeenSet ( ) const
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 1044 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ UseDefaultProcessorFeaturesHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::UseDefaultProcessorFeaturesHasBeenSet ( ) const
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 1493 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

bool Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::VpcSecurityGroupIdsHasBeenSet ( ) const
inline

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1095 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithAutoMinorVersionUpgrade()

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithAutoMinorVersionUpgrade ( bool  value)
inline

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

Definition at line 535 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithAvailabilityZone() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a

Definition at line 363 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithAvailabilityZone() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithAvailabilityZone ( const Aws::String value)
inline

The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a

Definition at line 355 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithAvailabilityZone() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithAvailabilityZone ( const char *  value)
inline

The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a

Definition at line 371 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithCopyTagsToSnapshot()

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithCopyTagsToSnapshot ( bool  value)
inline

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

Definition at line 1250 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBInstanceClass() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBInstanceClass ( Aws::String &&  value)
inline

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

Definition at line 266 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBInstanceClass() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBInstanceClass ( const Aws::String value)
inline

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

Definition at line 255 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBInstanceClass() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBInstanceClass ( const char *  value)
inline

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

Definition at line 277 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBInstanceIdentifier ( Aws::String &&  value)
inline

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

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Definition at line 106 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBInstanceIdentifier ( const Aws::String value)
inline

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

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Definition at line 97 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBInstanceIdentifier ( const char *  value)
inline

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

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Definition at line 115 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBName() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBName ( Aws::String &&  value)
inline

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

Definition at line 635 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBName() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBName ( const Aws::String value)
inline

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

Definition at line 629 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBName() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBName ( const char *  value)
inline

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

Definition at line 641 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBParameterGroupName() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBParameterGroupName ( Aws::String &&  value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

Constraints:

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

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1583 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBParameterGroupName() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBParameterGroupName ( const Aws::String value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

Constraints:

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

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1572 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBParameterGroupName() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBParameterGroupName ( const char *  value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

Constraints:

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

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1594 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBSnapshotIdentifier() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBSnapshotIdentifier ( Aws::String &&  value)
inline

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.

Definition at line 179 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBSnapshotIdentifier() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBSnapshotIdentifier ( const Aws::String value)
inline

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.

Definition at line 170 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBSnapshotIdentifier() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBSnapshotIdentifier ( const char *  value)
inline

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.

Definition at line 188 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBSubnetGroupName() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBSubnetGroupName ( Aws::String &&  value)
inline

The DB subnet group name to use for the new instance.

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

Example: mySubnetgroup

Definition at line 421 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBSubnetGroupName() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBSubnetGroupName ( const Aws::String value)
inline

The DB subnet group name to use for the new instance.

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

Example: mySubnetgroup

Definition at line 414 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDBSubnetGroupName() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDBSubnetGroupName ( const char *  value)
inline

The DB subnet group name to use for the new instance.

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

Example: mySubnetgroup

Definition at line 428 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDeletionProtection()

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDeletionProtection ( bool  value)
inline

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 1631 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDomain() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDomain ( Aws::String &&  value)
inline

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1215 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDomain() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDomain ( const Aws::String value)
inline

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1205 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDomain() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDomain ( const char *  value)
inline

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1225 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDomainIAMRoleName() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDomainIAMRoleName ( Aws::String &&  value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1293 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDomainIAMRoleName() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDomainIAMRoleName ( const Aws::String value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1287 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithDomainIAMRoleName() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithDomainIAMRoleName ( const char *  value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1299 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithEnableCloudwatchLogsExports() [1/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithEnableCloudwatchLogsExports ( Aws::Vector< Aws::String > &&  value)
inline

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Definition at line 1401 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithEnableCloudwatchLogsExports() [2/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithEnableCloudwatchLogsExports ( const Aws::Vector< Aws::String > &  value)
inline

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Definition at line 1391 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithEnableCustomerOwnedIp()

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithEnableCustomerOwnedIp ( bool  value)
inline

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.

Definition at line 1692 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithEnableIAMDatabaseAuthentication()

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithEnableIAMDatabaseAuthentication ( bool  value)
inline

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 1340 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithEngine() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithEngine ( Aws::String &&  value)
inline

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 747 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithEngine() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithEngine ( const Aws::String value)
inline

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 732 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithEngine() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithEngine ( const char *  value)
inline

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 762 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithIops()

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithIops ( int  value)
inline

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't 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 in the Amazon RDS User Guide.

Constraints: Must be an integer greater than 1000.

Definition at line 819 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithLicenseModel() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithLicenseModel ( Aws::String &&  value)
inline

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 585 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithLicenseModel() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithLicenseModel ( const Aws::String value)
inline

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 578 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithLicenseModel() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithLicenseModel ( const char *  value)
inline

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 592 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithMultiAZ()

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithMultiAZ ( bool  value)
inline

A value that indicates whether the DB instance is a Multi-AZ deployment.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Definition at line 457 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithOptionGroupName() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithOptionGroupName ( Aws::String &&  value)
inline

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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 876 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithOptionGroupName() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithOptionGroupName ( const Aws::String value)
inline

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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 868 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithOptionGroupName() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithOptionGroupName ( const char *  value)
inline

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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 884 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithPort()

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithPort ( int  value)
inline

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

Definition at line 306 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithProcessorFeatures() [1/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithProcessorFeatures ( Aws::Vector< ProcessorFeature > &&  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 1468 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithProcessorFeatures() [2/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithProcessorFeatures ( const Aws::Vector< ProcessorFeature > &  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 1462 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithPubliclyAccessible()

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithPubliclyAccessible ( bool  value)
inline

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 510 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithStorageType() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithStorageType ( Aws::String &&  value)
inline

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 gp2

Definition at line 973 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithStorageType() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithStorageType ( const Aws::String value)
inline

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 gp2

Definition at line 964 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithStorageType() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithStorageType ( const char *  value)
inline

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 gp2

Definition at line 982 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithTags() [1/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Definition at line 903 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithTags() [2/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Definition at line 900 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithTdeCredentialArn() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithTdeCredentialArn ( Aws::String &&  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 1025 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithTdeCredentialArn() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithTdeCredentialArn ( const Aws::String value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 1019 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithTdeCredentialArn() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithTdeCredentialArn ( const char *  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 1031 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithTdeCredentialPassword() [1/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithTdeCredentialPassword ( Aws::String &&  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 1074 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithTdeCredentialPassword() [2/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithTdeCredentialPassword ( const Aws::String value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 1068 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithTdeCredentialPassword() [3/3]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithTdeCredentialPassword ( const char *  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 1080 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithUseDefaultProcessorFeatures()

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithUseDefaultProcessorFeatures ( bool  value)
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 1505 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1123 of file RestoreDBInstanceFromDBSnapshotRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

RestoreDBInstanceFromDBSnapshotRequest& Aws::RDS::Model::RestoreDBInstanceFromDBSnapshotRequest::WithVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1116 of file RestoreDBInstanceFromDBSnapshotRequest.h.


The documentation for this class was generated from the following file: