RestoreDbInstanceFromS3Request (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RestoreDbInstanceFromS3Request.Builder,RestoreDbInstanceFromS3Request>

@Generated(value="software.amazon.awssdk:codegen")
public final class RestoreDbInstanceFromS3Request
extends RdsRequest
implements ToCopyableBuilder<RestoreDbInstanceFromS3Request.Builder,RestoreDbInstanceFromS3Request>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RestoreDbInstanceFromS3Request.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`allocatedStorage()` The amount of storage (in gigabytes) to allocate initially for the DB instance.
`Boolean`	`autoMinorVersionUpgrade()` A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.
`String`	`availabilityZone()` The Availability Zone that the DB instance is created in.
`Integer`	`backupRetentionPeriod()` The number of days for which automated backups are retained.
`static RestoreDbInstanceFromS3Request.Builder`	`builder()`
`Boolean`	`copyTagsToSnapshot()` A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance.
`String`	`dbInstanceClass()` The compute and memory capacity of the DB instance, for example db.m4.large.
`String`	`dbInstanceIdentifier()` The DB instance identifier.
`String`	`dbName()` The name of the database to create when the DB instance is created.
`String`	`dbParameterGroupName()` The name of the DB parameter group to associate with this DB instance.
`List<String>`	`dbSecurityGroups()` A list of DB security groups to associate with this DB instance.
`String`	`dbSubnetGroupName()` A DB subnet group to associate with this DB instance.
`Boolean`	`deletionProtection()` A value that indicates whether the DB instance has deletion protection enabled.
`List<String>`	`enableCloudwatchLogsExports()` The list of logs that the restored DB instance is to export to CloudWatch Logs.
`Boolean`	`enableIAMDatabaseAuthentication()` A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts.
`Boolean`	`enablePerformanceInsights()` A value that indicates whether to enable Performance Insights for the DB instance.
`String`	`engine()` The name of the database engine to be used for this instance.
`String`	`engineVersion()` The version number of the database engine to use.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDbSecurityGroups()` For responses, this returns true if the service returned a value for the DBSecurityGroups property.
`boolean`	`hasEnableCloudwatchLogsExports()` For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property.
`int`	`hashCode()`
`boolean`	`hasProcessorFeatures()` For responses, this returns true if the service returned a value for the ProcessorFeatures property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasVpcSecurityGroupIds()` For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
`Integer`	`iops()` The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance.
`String`	`kmsKeyId()` The Amazon Web Services KMS key identifier for an encrypted DB instance.
`String`	`licenseModel()` The license model for this DB instance.
`String`	`masterUsername()` The name for the master user.
`String`	`masterUserPassword()` The password for the master user.
`Integer`	`maxAllocatedStorage()` The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
`Integer`	`monitoringInterval()` The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
`String`	`monitoringRoleArn()` The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
`Boolean`	`multiAZ()` A value that indicates whether the DB instance is a Multi-AZ deployment.
`String`	`networkType()` The network type of the DB instance.
`String`	`optionGroupName()` The name of the option group to associate with this DB instance.
`String`	`performanceInsightsKMSKeyId()` The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
`Integer`	`performanceInsightsRetentionPeriod()` The number of days to retain Performance Insights data.
`Integer`	`port()` The port number on which the database accepts connections.
`String`	`preferredBackupWindow()` The time range each day during which automated backups are created if automated backups are enabled.
`String`	`preferredMaintenanceWindow()` The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
`List<ProcessorFeature>`	`processorFeatures()` The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
`Boolean`	`publiclyAccessible()` A value that indicates whether the DB instance is publicly accessible.
`String`	`s3BucketName()` The name of your Amazon S3 bucket that contains your database backup file.
`String`	`s3IngestionRoleArn()` An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
`String`	`s3Prefix()` The prefix of your Amazon S3 bucket.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RestoreDbInstanceFromS3Request.Builder>`	`serializableBuilderClass()`
`String`	`sourceEngine()` The name of the engine of your source database.
`String`	`sourceEngineVersion()` The version of the database that the backup files were created from.
`Boolean`	`storageEncrypted()` A value that indicates whether the new DB instance is encrypted or not.
`String`	`storageType()` Specifies the storage type to be associated with the DB instance.
`List<Tag>`	`tags()` A list of tags to associate with this DB instance.
`RestoreDbInstanceFromS3Request.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Boolean`	`useDefaultProcessorFeatures()` A value that indicates whether the DB instance class of the DB instance uses its default processor features.
`List<String>`	`vpcSecurityGroupIds()` A list of VPC security groups to associate with this DB instance.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - dbName
```
public final String dbName()
```
    The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
    
    Returns:
    
    The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
  - dbInstanceIdentifier
```
public final String dbInstanceIdentifier()
```
    The DB instance identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 63 letters, numbers, or hyphens.
    - First character must be a letter.
    - Can't end with a hyphen or contain two consecutive hyphens.
    Example: mydbinstance
    Returns:
    The DB instance identifier. This parameter is stored as a lowercase string.
    
    Constraints:
    
    Must contain from 1 to 63 letters, numbers, or hyphens.
    
    First character must be a letter.
    
    Can't end with a hyphen or contain two consecutive hyphens.
    
    Example: mydbinstance
  - allocatedStorage
```
public final Integer allocatedStorage()
```
    The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
    
    Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
    
    Returns:
    
    The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
    
    Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
  - dbInstanceClass
```
public final String dbInstanceClass()
```
    The compute and memory capacity of the 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.
    
    Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
    
    Returns:
    
    The compute and memory capacity of the 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.
    
    Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
  - engine
```
public final String engine()
```
    The name of the database engine to be used for this instance.
    
    Valid Values: mysql
    
    Returns:
    
    The name of the database engine to be used for this instance.
    
    Valid Values: mysql
  - masterUsername
```
public final String masterUsername()
```
    The name for the master user.
    
    Constraints:
    - Must be 1 to 16 letters or numbers.
    - First character must be a letter.
    - Can't be a reserved word for the chosen database engine.
    Returns:
    The name for the master user.
    
    Constraints:
    
    Must be 1 to 16 letters or numbers.
    
    First character must be a letter.
    
    Can't be a reserved word for the chosen database engine.
  - masterUserPassword
```
public final String masterUserPassword()
```
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
    
    Constraints: Must contain from 8 to 41 characters.
    
    Returns:
    
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
    
    Constraints: Must contain from 8 to 41 characters.
  - hasDbSecurityGroups
```
public final boolean hasDbSecurityGroups()
```
    For responses, this returns true if the service returned a value for the DBSecurityGroups 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.
  - dbSecurityGroups
```
public final List<String> dbSecurityGroups()
```
    A list of DB security groups to associate with this DB instance.
    
    Default: The default DB security group for the database engine.
    
    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 hasDbSecurityGroups() method.
    
    Returns:
    
    A list of DB security groups to associate with this DB instance.
    
    Default: The default DB security group for the database engine.
  - 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 VPC security groups to associate with this DB instance.
    
    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 VPC security groups to associate with this DB instance.
  - availabilityZone
```
public final String availabilityZone()
```
    The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
    
    Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
    
    Example: us-east-1d
    
    Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
    
    Returns:
    
    The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
    
    Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
    
    Example: us-east-1d
    
    Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
  - dbSubnetGroupName
```
public final String dbSubnetGroupName()
```
    A DB subnet group to associate with this DB instance.
    
    Constraints: If supplied, must match the name of an existing DBSubnetGroup.
    
    Example: mydbsubnetgroup
    
    Returns:
    
    A DB subnet group to associate with this DB instance.
    
    Constraints: If supplied, must match the name of an existing DBSubnetGroup.
    
    Example: mydbsubnetgroup
  - preferredMaintenanceWindow
```
public final String preferredMaintenanceWindow()
```
    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
    
    Constraints:
    - Must be in the format ddd:hh24:mi-ddd:hh24:mi.
    - Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
    - Must be in Universal Coordinated Time (UTC).
    - Must not conflict with the preferred backup window.
    - Must be at least 30 minutes.
    Returns:
    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
    
    Constraints:
    
    Must be in the format ddd:hh24:mi-ddd:hh24:mi.
    
    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
    
    Must be in Universal Coordinated Time (UTC).
    
    Must not conflict with the preferred backup window.
    
    Must be at least 30 minutes.
  - dbParameterGroupName
```
public final String dbParameterGroupName()
```
    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.
    
    Returns:
    
    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.
  - backupRetentionPeriod
```
public final Integer backupRetentionPeriod()
```
    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.
    
    Returns:
    
    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.
  - preferredBackupWindow
```
public final String preferredBackupWindow()
```
    The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
    
    Constraints:
    - Must be in the format hh24:mi-hh24:mi.
    - Must be in Universal Coordinated Time (UTC).
    - Must not conflict with the preferred maintenance window.
    - Must be at least 30 minutes.
    Returns:
    The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
    
    Constraints:
    
    Must be in the format hh24:mi-hh24:mi.
    
    Must be in Universal Coordinated Time (UTC).
    
    Must not conflict with the preferred maintenance window.
    
    Must be at least 30 minutes.
  - port
```
public final Integer port()
```
    The port number on which the database accepts connections.
    
    Type: Integer
    
    Valid Values: 1150-65535
    
    Default: 3306
    
    Returns:
    
    The port number on which the database accepts connections.
    
    Type: Integer
    
    Valid Values: 1150-65535
    
    Default: 3306
  - multiAZ
```
public final Boolean multiAZ()
```
    A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.
    
    Returns:
    
    A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.
  - engineVersion
```
public final String engineVersion()
```
    The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
    
    Returns:
    
    The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
  - autoMinorVersionUpgrade
```
public final Boolean autoMinorVersionUpgrade()
```
    A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
    
    Returns:
    
    A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
  - licenseModel
```
public final String licenseModel()
```
    The license model for this DB instance. Use general-public-license.
    
    Returns:
    
    The license model for this DB instance. Use general-public-license.
  - iops
```
public final Integer iops()
```
    The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
    
    Returns:
    
    The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
  - optionGroupName
```
public final String optionGroupName()
```
    The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
    
    Returns:
    
    The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
  - publiclyAccessible
```
public final Boolean publiclyAccessible()
```
    A value that indicates 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:
    
    A value that indicates 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.
  - 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()
```
    A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
    
    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:
    
    A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
  - storageType
```
public final String storageType()
```
    Specifies the storage type to be associated with the DB instance.
    
    Valid values: standard | gp2 | io1
    
    If you specify io1, you must also include a value for the Iops parameter.
    
    Default: io1 if the Iops parameter is specified; otherwise gp2
    
    Returns:
    
    Specifies the storage type to be associated with the DB instance.
    
    Valid values: standard | gp2 | io1
    
    If you specify io1, you must also include a value for the Iops parameter.
    
    Default: io1 if the Iops parameter is specified; otherwise gp2
  - storageEncrypted
```
public final Boolean storageEncrypted()
```
    A value that indicates whether the new DB instance is encrypted or not.
    
    Returns:
    
    A value that indicates whether the new DB instance is encrypted or not.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The Amazon Web Services KMS key identifier for an encrypted DB instance.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
    
    If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
    
    Returns:
    
    The Amazon Web Services KMS key identifier for an encrypted DB instance.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
    
    If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
  - copyTagsToSnapshot
```
public final Boolean copyTagsToSnapshot()
```
    A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
    
    Returns:
    
    A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
  - monitoringInterval
```
public final Integer monitoringInterval()
```
    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
    
    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
    
    Valid Values: 0, 1, 5, 10, 15, 30, 60
    
    Default: 0
    
    Returns:
    
    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
    
    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
    
    Valid Values: 0, 1, 5, 10, 15, 30, 60
    
    Default: 0
  - monitoringRoleArn
```
public final String monitoringRoleArn()
```
    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
    
    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
    
    Returns:
    
    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
    
    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
  - enableIAMDatabaseAuthentication
```
public final Boolean enableIAMDatabaseAuthentication()
```
    A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
    
    For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
    
    Returns:
    
    A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
    
    For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
  - sourceEngine
```
public final String sourceEngine()
```
    The name of the engine of your source database.
    
    Valid Values: mysql
    
    Returns:
    
    The name of the engine of your source database.
    
    Valid Values: mysql
  - sourceEngineVersion
```
public final String sourceEngineVersion()
```
    The version of the database that the backup files were created from.
    
    MySQL versions 5.6 and 5.7 are supported.
    
    Example: 5.6.40
    
    Returns:
    
    The version of the database that the backup files were created from.
    
    MySQL versions 5.6 and 5.7 are supported.
    
    Example: 5.6.40
  - s3BucketName
```
public final String s3BucketName()
```
    The name of your Amazon S3 bucket that contains your database backup file.
    
    Returns:
    
    The name of your Amazon S3 bucket that contains your database backup file.
  - s3Prefix
```
public final String s3Prefix()
```
    The prefix of your Amazon S3 bucket.
    
    Returns:
    
    The prefix of your Amazon S3 bucket.
  - s3IngestionRoleArn
```
public final String s3IngestionRoleArn()
```
    An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
    
    Returns:
    
    An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
  - enablePerformanceInsights
```
public final Boolean enablePerformanceInsights()
```
    A value that indicates whether to enable Performance Insights for the DB instance.
    
    For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
    
    Returns:
    
    A value that indicates whether to enable Performance Insights for the DB instance.
    
    For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
  - performanceInsightsKMSKeyId
```
public final String performanceInsightsKMSKeyId()
```
    The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    
    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
    
    Returns:
    
    The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    
    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
  - performanceInsightsRetentionPeriod
```
public final Integer performanceInsightsRetentionPeriod()
```
    The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
    - 7
    - month * 31, where month is a number of months from 1-23
    - 731
    For example, the following values are valid:
    - 93 (3 months * 31)
    - 341 (11 months * 31)
    - 589 (19 months * 31)
    - 731
    If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
    Returns:
    The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
    
    7
    
    month * 31, where month is a number of months from 1-23
    
    731
    
    For example, the following values are valid:
    
    93 (3 months * 31)
    
    341 (11 months * 31)
    
    589 (19 months * 31)
    
    731
    
    If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
  - 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 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.
    
    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 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.
  - 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.
    
    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.
  - useDefaultProcessorFeatures
```
public final Boolean useDefaultProcessorFeatures()
```
    A value that indicates whether the DB instance class of the DB instance uses its default processor features.
    
    Returns:
    
    A value that indicates whether the DB instance class of the DB instance uses its default processor features.
  - deletionProtection
```
public final Boolean deletionProtection()
```
    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 isn't enabled. For more information, see Deleting a DB Instance.
    
    Returns:
    
    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 isn't enabled. For more information, see Deleting a DB Instance.
  - maxAllocatedStorage
```
public final Integer maxAllocatedStorage()
```
    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
    
    For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
    
    Returns:
    
    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
    
    For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling 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.
  - toBuilder
```
public RestoreDbInstanceFromS3Request.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RestoreDbInstanceFromS3Request.Builder,RestoreDbInstanceFromS3Request>
    
    Specified by:
    
    toBuilder in class RdsRequest
  - builder
```
public static RestoreDbInstanceFromS3Request.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RestoreDbInstanceFromS3Request.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RestoreDbInstanceFromS3Request

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dbName

dbInstanceIdentifier

allocatedStorage

dbInstanceClass

engine

masterUsername

masterUserPassword

hasDbSecurityGroups

dbSecurityGroups

hasVpcSecurityGroupIds

vpcSecurityGroupIds

availabilityZone

dbSubnetGroupName

preferredMaintenanceWindow

dbParameterGroupName

backupRetentionPeriod

preferredBackupWindow

port

multiAZ

engineVersion

autoMinorVersionUpgrade

licenseModel

iops

optionGroupName

publiclyAccessible

hasTags

tags

storageType

storageEncrypted

kmsKeyId

copyTagsToSnapshot

monitoringInterval

monitoringRoleArn

enableIAMDatabaseAuthentication

sourceEngine

sourceEngineVersion

s3BucketName

s3Prefix

s3IngestionRoleArn

enablePerformanceInsights

performanceInsightsKMSKeyId

performanceInsightsRetentionPeriod

hasEnableCloudwatchLogsExports

enableCloudwatchLogsExports

hasProcessorFeatures

processorFeatures

useDefaultProcessorFeatures

deletionProtection

maxAllocatedStorage

networkType

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields