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

Class RestoreDbClusterFromS3Request

    • Method Detail

      • hasAvailabilityZones

        public final boolean hasAvailabilityZones()
        For responses, this returns true if the service returned a value for the AvailabilityZones 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.

      • availabilityZones

        public final List<String> availabilityZones()

        A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

        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 hasAvailabilityZones() method.

        Returns:
        A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

      • backupRetentionPeriod

        public final Integer backupRetentionPeriod()

        The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

        Default: 1

        Constraints:

        • Must be a value from 1 to 35

        Returns:
        The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

        Default: 1

        Constraints:

        • Must be a value from 1 to 35

      • characterSetName

        public final String characterSetName()

        A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

        Returns:
        A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

      • databaseName

        public final String databaseName()

        The database name for the restored DB cluster.

        Returns:
        The database name for the restored DB cluster.

      • dbClusterIdentifier

        public final String dbClusterIdentifier()

        The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

        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: my-cluster1

        Returns:
        The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

        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: my-cluster1

      • dbClusterParameterGroupName

        public final String dbClusterParameterGroupName()

        The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.

        Constraints:

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

        Returns:
        The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.

        Constraints:

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

      • 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 the restored DB cluster.

        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 the restored DB cluster.

      • dbSubnetGroupName

        public final String dbSubnetGroupName()

        A DB subnet group to associate with the restored DB cluster.

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

        Example: mydbsubnetgroup

        Returns:
        A DB subnet group to associate with the restored DB cluster.

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

        Example: mydbsubnetgroup

      • engine

        public final String engine()

        The name of the database engine to be used for this DB cluster.

        Valid Values: aurora-mysql (for Aurora MySQL)

        Returns:
        The name of the database engine to be used for this DB cluster.

        Valid Values: aurora-mysql (for Aurora MySQL)

      • engineVersion

        public final String engineVersion()

        The version number of the database engine to use.

        To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:

        aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

        Aurora MySQL

        Examples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0

        Returns:
        The version number of the database engine to use.

        To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:

        aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

        Aurora MySQL

        Examples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0

      • port

        public final Integer port()

        The port number on which the instances in the restored DB cluster accept connections.

        Default: 3306

        Returns:
        The port number on which the instances in the restored DB cluster accept connections.

        Default: 3306

      • masterUsername

        public final String masterUsername()

        The name of the master user for the restored DB cluster.

        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 of the master user for the restored DB cluster.

        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 database user. This password can contain any printable ASCII character except "/", """, or "@".

        Constraints:

        • Must contain from 8 to 41 characters.

        • Can't be specified if ManageMasterUserPassword is turned on.

        Returns:
        The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

        Constraints:

        • Must contain from 8 to 41 characters.

        • Can't be specified if ManageMasterUserPassword is turned on.

      • optionGroupName

        public final String optionGroupName()

        A value that indicates that the restored DB cluster should be associated with the specified option group.

        Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

        Returns:
        A value that indicates that the restored DB cluster should be associated with the specified option group.

        Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

      • preferredBackupWindow

        public final String preferredBackupWindow()

        The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora 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 daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora 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.

      • preferredMaintenanceWindow

        public final String preferredMaintenanceWindow()

        The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Format: ddd:hh24:mi-ddd:hh24:mi

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

        Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

        Constraints: Minimum 30-minute window.

        Returns:
        The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Format: ddd:hh24:mi-ddd:hh24:mi

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

        Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

        Constraints: Minimum 30-minute window.

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

      • storageEncrypted

        public final Boolean storageEncrypted()

        Specifies whether the restored DB cluster is encrypted.

        Returns:
        Specifies whether the restored DB cluster is encrypted.

      • kmsKeyId

        public final String kmsKeyId()

        The Amazon Web Services KMS key identifier for an encrypted DB cluster.

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

        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.

      • 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 isn't enabled.

        For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

        Returns:
        Specifies 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, see IAM Database Authentication in the Amazon Aurora User Guide.

      • sourceEngine

        public final String sourceEngine()

        The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

        Valid Values: mysql

        Returns:
        The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

        Valid Values: mysql

      • sourceEngineVersion

        public final String sourceEngineVersion()

        The version of the database that the backup files were created from.

        MySQL versions 5.7 and 8.0 are supported.

        Example: 5.7.40, 8.0.28

        Returns:
        The version of the database that the backup files were created from.

        MySQL versions 5.7 and 8.0 are supported.

        Example: 5.7.40, 8.0.28

      • s3BucketName

        public final String s3BucketName()

        The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

        Returns:
        The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

      • s3Prefix

        public final String s3Prefix()

        The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

        Returns:
        The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

      • s3IngestionRoleArn

        public final String s3IngestionRoleArn()

        The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

        Returns:
        The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

      • backtrackWindow

        public final Long backtrackWindow()

        The target backtrack window, in seconds. To disable backtracking, set this value to 0.

        Currently, Backtrack is only supported for Aurora MySQL DB clusters.

        Default: 0

        Constraints:

        • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

        Returns:
        The target backtrack window, in seconds. To disable backtracking, set this value to 0.

        Currently, Backtrack is only supported for Aurora MySQL DB clusters.

        Default: 0

        Constraints:

        • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      • 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 cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.

        Aurora MySQL

        Possible values are audit, error, general, instance, slowquery, and iam-db-auth-error.

        Aurora PostgreSQL

        Possible value are instance, postgresql, and iam-db-auth-error.

        For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

        For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora 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 cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.

        Aurora MySQL

        Possible values are audit, error, general, instance, slowquery, and iam-db-auth-error.

        Aurora PostgreSQL

        Possible value are instance, postgresql, and iam-db-auth-error.

        For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

        For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      • deletionProtection

        public final Boolean deletionProtection()

        Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

        Returns:
        Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

      • copyTagsToSnapshot

        public final Boolean copyTagsToSnapshot()

        Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

        Returns:
        Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

      • domain

        public final String domain()

        Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

        For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

        Returns:
        Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

        For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

      • domainIAMRoleName

        public final String domainIAMRoleName()

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

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

      • serverlessV2ScalingConfiguration

        public final ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration()
        Returns the value of the ServerlessV2ScalingConfiguration property for this object.
        Returns:
        The value of the ServerlessV2ScalingConfiguration property for this object.

      • networkType

        public final String networkType()

        The network type of the DB cluster.

        Valid Values:

        • IPV4

        • DUAL

        The network type is determined by the DBSubnetGroup specified for the DB cluster. 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 Aurora User Guide.

        Returns:
        The network type of the DB cluster.

        Valid Values:

        • IPV4

        • DUAL

        The network type is determined by the DBSubnetGroup specified for the DB cluster. 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 Aurora User Guide.

      • masterUserSecretKmsKeyId

        public final String masterUserSecretKmsKeyId()

        The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

        This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.

        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 you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed 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 to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

        This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.

        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 you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed 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.

      • storageType

        public final String storageType()

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

        Valid Values: aurora, aurora-iopt1

        Default: aurora

        Valid for: Aurora DB clusters only

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

        Valid Values: aurora, aurora-iopt1

        Default: aurora

        Valid for: Aurora DB clusters only

      • engineLifecycleSupport

        public final String engineLifecycleSupport()

        The life cycle type for this DB cluster.

        By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

        You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

        Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

        Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

        Default: open-source-rds-extended-support

        Returns:
        The life cycle type for this DB cluster.

        By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

        You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

        Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

        Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

        Default: open-source-rds-extended-support

      • 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