Package software.amazon.awssdk.services.rds.model

Class RestoreDbInstanceFromDbSnapshotRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.rds.model.RdsRequest
software.amazon.awssdk.services.rds.model.RestoreDbInstanceFromDbSnapshotRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RestoreDbInstanceFromDbSnapshotRequest.Builder,RestoreDbInstanceFromDbSnapshotRequest>
@Generated("software.amazon.awssdk:codegen") public final class RestoreDbInstanceFromDbSnapshotRequest extends RdsRequest implements ToCopyableBuilder<RestoreDbInstanceFromDbSnapshotRequest.Builder,RestoreDbInstanceFromDbSnapshotRequest>

  • Method Details

    • dbInstanceIdentifier

      public final String dbInstanceIdentifier()

      The 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

      Returns:
      The 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

    • dbSnapshotIdentifier

      public final String dbSnapshotIdentifier()

      The identifier for the DB snapshot to restore from.

      Constraints:

      • Must match the identifier of an existing DB snapshot.

      • Can't be specified when DBClusterSnapshotIdentifier is specified.

      • Must be specified when DBClusterSnapshotIdentifier isn't specified.

      • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

      Returns:
      The identifier for the DB snapshot to restore from.

      Constraints:

      • Must match the identifier of an existing DB snapshot.

      • Can't be specified when DBClusterSnapshotIdentifier is specified.

      • Must be specified when DBClusterSnapshotIdentifier isn't specified.

      • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

    • dbInstanceClass

      public final String dbInstanceClass()

      The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

      Default: The same DBInstanceClass as the original DB instance.

      Returns:
      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 Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

      Default: The same DBInstanceClass as the original DB instance.

    • port

      public final Integer port()

      The port number on which the database accepts connections.

      Default: The same port as the original DB instance

      Constraints: Value must be 1150-65535

      Returns:
      The port number on which the database accepts connections.

      Default: The same port as the original DB instance

      Constraints: Value must be 1150-65535

    • availabilityZone

      public final String availabilityZone()

      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

      Returns:
      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

    • dbSubnetGroupName

      public final String dbSubnetGroupName()

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

      Constraints:

      • If supplied, must match the name of an existing DB subnet group.

      Example: mydbsubnetgroup

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

      Constraints:

      • If supplied, must match the name of an existing DB subnet group.

      Example: mydbsubnetgroup

    • multiAZ

      public final Boolean multiAZ()

      Specifies whether the DB instance is a Multi-AZ deployment.

      This setting doesn't apply to RDS Custom.

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

      Returns:
      Specifies whether the DB instance is a Multi-AZ deployment.

      This setting doesn't apply to RDS Custom.

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

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      Specifies whether the DB instance is publicly accessible.

      When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves 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. 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.

      Returns:
      Specifies whether the DB instance is publicly accessible.

      When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves 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. 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.

    • autoMinorVersionUpgrade

      public final Boolean autoMinorVersionUpgrade()

      Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window.

      If you restore an RDS Custom DB instance, you must disable this parameter.

      Returns:
      Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window.

      If you restore an RDS Custom DB instance, you must disable this parameter.

    • licenseModel

      public final String licenseModel()

      License model information for the restored DB instance.

      This setting doesn't apply to RDS Custom.

      Default: Same as source.

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

      Returns:
      License model information for the restored DB instance.

      This setting doesn't apply to RDS Custom.

      Default: Same as source.

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

    • dbName

      public final String dbName()

      The name of the database for the restored DB instance.

      This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS Custom DB instances.

      Returns:
      The name of the database for the restored DB instance.

      This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS Custom DB instances.

    • engine

      public final String engine()

      The database engine to use for the new instance.

      This setting doesn't apply to RDS Custom.

      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:

      • db2-ae

      • db2-se

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

      Returns:
      The database engine to use for the new instance.

      This setting doesn't apply to RDS Custom.

      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:

      • db2-ae

      • db2-se

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • iops

      public final Integer iops()

      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 in the Amazon RDS User Guide.

      Constraints: Must be an integer greater than 1000.

      Returns:
      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 in the Amazon RDS User Guide.

      Constraints: Must be an integer greater than 1000.

    • optionGroupName

      public final String optionGroupName()

      The name of the option group to be used for the restored DB instance.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.

      This setting doesn't apply to RDS Custom.

      Returns:
      The name of the option group to be used for the restored DB instance.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.

      This setting doesn't apply to RDS Custom.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()
      Returns the value of the Tags property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The value of the Tags property for this object.

    • storageType

      public final String storageType()

      Specifies the storage type to be associated with the DB instance.

      Valid Values: gp2 | gp3 | io1 | io2 | standard

      If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.

      Default: io1 if the Iops parameter is specified, otherwise gp2

      Returns:
      Specifies the storage type to be associated with the DB instance.

      Valid Values: gp2 | gp3 | io1 | io2 | standard

      If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.

      Default: io1 if the Iops parameter is specified, otherwise gp2

    • tdeCredentialArn

      public final String tdeCredentialArn()

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

      This setting doesn't apply to RDS Custom.

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

      This setting doesn't apply to RDS Custom.

    • tdeCredentialPassword

      public final String tdeCredentialPassword()

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

      This setting doesn't apply to RDS Custom.

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

      This setting doesn't apply to RDS Custom.

    • hasVpcSecurityGroupIds

      public final boolean hasVpcSecurityGroupIds()
      For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • vpcSecurityGroupIds

      public final List<String> vpcSecurityGroupIds()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.

      Returns:
      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.

    • domain

      public final String domain()

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

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

      This setting doesn't apply to RDS Custom.

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

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

      This setting doesn't apply to RDS Custom.

    • domainFqdn

      public final String domainFqdn()

      The fully qualified domain name (FQDN) of an Active Directory domain.

      Constraints:

      • Can't be longer than 64 characters.

      Example: mymanagedADtest.mymanagedAD.mydomain

      Returns:
      The fully qualified domain name (FQDN) of an Active Directory domain.

      Constraints:

      • Can't be longer than 64 characters.

      Example: mymanagedADtest.mymanagedAD.mydomain

    • domainOu

      public final String domainOu()

      The Active Directory organizational unit for your DB instance to join.

      Constraints:

      • Must be in the distinguished name format.

      • Can't be longer than 64 characters.

      Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

      Returns:
      The Active Directory organizational unit for your DB instance to join.

      Constraints:

      • Must be in the distinguished name format.

      • Can't be longer than 64 characters.

      Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

    • domainAuthSecretArn

      public final String domainAuthSecretArn()

      The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

      Constraints:

      • Can't be longer than 64 characters.

      Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

      Returns:
      The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

      Constraints:

      • Can't be longer than 64 characters.

      Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

    • hasDomainDnsIps

      public final boolean hasDomainDnsIps()
      For responses, this returns true if the service returned a value for the DomainDnsIps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • domainDnsIps

      public final List<String> domainDnsIps()

      The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

      Constraints:

      • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

      Example: 123.124.125.126,234.235.236.237

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDomainDnsIps() method.

      Returns:
      The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

      Constraints:

      • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

      Example: 123.124.125.126,234.235.236.237

    • copyTagsToSnapshot

      public final Boolean copyTagsToSnapshot()

      Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance.

      In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

      For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.

      Returns:
      Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance.

      In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

      For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.

    • domainIAMRoleName

      public final String domainIAMRoleName()

      The name of the IAM role to use when making API calls to the Directory Service.

      This setting doesn't apply to RDS Custom DB instances.

      Returns:
      The name of the IAM role to use when making API calls to the Directory Service.

      This setting doesn't apply to RDS Custom DB instances.

    • enableIAMDatabaseAuthentication

      public final Boolean enableIAMDatabaseAuthentication()

      Specifies whether to enable mapping of Amazon Web Services 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.

      This setting doesn't apply to RDS Custom.

      Returns:
      Specifies whether to enable mapping of Amazon Web Services 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.

      This setting doesn't apply to RDS Custom.

    • hasEnableCloudwatchLogsExports

      public final boolean hasEnableCloudwatchLogsExports()
      For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • enableCloudwatchLogsExports

      public final List<String> enableCloudwatchLogsExports()

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

      This setting doesn't apply to RDS Custom.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnableCloudwatchLogsExports() method.

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

      This setting doesn't apply to RDS Custom.

    • hasProcessorFeatures

      public final boolean hasProcessorFeatures()
      For responses, this returns true if the service returned a value for the ProcessorFeatures property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • processorFeatures

      public final List<ProcessorFeature> processorFeatures()

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

      This setting doesn't apply to RDS Custom.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProcessorFeatures() method.

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

      This setting doesn't apply to RDS Custom.

    • useDefaultProcessorFeatures

      public final Boolean useDefaultProcessorFeatures()

      Specifies whether the DB instance class of the DB instance uses its default processor features.

      This setting doesn't apply to RDS Custom.

      Returns:
      Specifies whether the DB instance class of the DB instance uses its default processor features.

      This setting doesn't apply to RDS Custom.

    • dbParameterGroupName

      public final String dbParameterGroupName()

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

      If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • If supplied, must match the name of an existing DB parameter group.

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

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

      If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • If supplied, must match the name of an existing DB parameter group.

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

    • deletionProtection

      public final Boolean deletionProtection()

      Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

      Returns:
      Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

    • enableCustomerOwnedIp

      public final Boolean enableCustomerOwnedIp()

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

      This setting doesn't apply to RDS Custom.

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

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

      Returns:
      Specifies 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.

      This setting doesn't apply to RDS Custom.

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

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

    • customIamInstanceProfile

      public final String customIamInstanceProfile()

      The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

      • The profile must exist in your account.

      • The profile must have an IAM role that Amazon EC2 has permissions to assume.

      • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

      For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

      This setting is required for RDS Custom.

      Returns:
      The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

      • The profile must exist in your account.

      • The profile must have an IAM role that Amazon EC2 has permissions to assume.

      • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

      For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

      This setting is required for RDS Custom.

    • backupTarget

      public final String backupTarget()

      Specifies where automated backups and manual snapshots are stored for the restored DB instance.

      Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

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

      Returns:
      Specifies where automated backups and manual snapshots are stored for the restored DB instance.

      Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

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

    • networkType

      public final String networkType()

      The network type of the DB instance.

      Valid Values:

      • IPV4

      • DUAL

      The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

      Returns:
      The network type of the DB instance.

      Valid Values:

      • IPV4

      • DUAL

      The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

    • storageThroughput

      public final Integer storageThroughput()

      Specifies the storage throughput value for the DB instance.

      This setting doesn't apply to RDS Custom or Amazon Aurora.

      Returns:
      Specifies the storage throughput value for the DB instance.

      This setting doesn't apply to RDS Custom or Amazon Aurora.

    • dbClusterSnapshotIdentifier

      public final String dbClusterSnapshotIdentifier()

      The identifier for the Multi-AZ DB cluster snapshot to restore from.

      For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

      Constraints:

      • Must match the identifier of an existing Multi-AZ DB cluster snapshot.

      • Can't be specified when DBSnapshotIdentifier is specified.

      • Must be specified when DBSnapshotIdentifier isn't specified.

      • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.

      • Can't be the identifier of an Aurora DB cluster snapshot.

      Returns:
      The identifier for the Multi-AZ DB cluster snapshot to restore from.

      For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

      Constraints:

      • Must match the identifier of an existing Multi-AZ DB cluster snapshot.

      • Can't be specified when DBSnapshotIdentifier is specified.

      • Must be specified when DBSnapshotIdentifier isn't specified.

      • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.

      • Can't be the identifier of an Aurora DB cluster snapshot.

    • allocatedStorage

      public final Integer allocatedStorage()

      The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

      Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.

      Returns:
      The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

      Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.

    • dedicatedLogVolume

      public final Boolean dedicatedLogVolume()

      Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

      Returns:
      Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

    • caCertificateIdentifier

      public final String caCertificateIdentifier()

      The CA certificate identifier to use for the DB instance's server certificate.

      This setting doesn't apply to RDS Custom DB instances.

      For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

      Returns:
      The CA certificate identifier to use for the DB instance's server certificate.

      This setting doesn't apply to RDS Custom DB instances.

      For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

    • toBuilder

      public RestoreDbInstanceFromDbSnapshotRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RestoreDbInstanceFromDbSnapshotRequest.Builder,RestoreDbInstanceFromDbSnapshotRequest>
      Specified by:
      toBuilder in class RdsRequest
      Returns:
      a builder for type T

    • builder

      public static RestoreDbInstanceFromDbSnapshotRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RestoreDbInstanceFromDbSnapshotRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.