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

Interface ModifyCustomDbEngineVersionResponse.Builder

    • Method Detail

      • engine

        ModifyCustomDbEngineVersionResponse.Builder engine​(String engine)

        The name of the database engine.

        Parameters:
        engine - The name of the database engine.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineVersion

        ModifyCustomDbEngineVersionResponse.Builder engineVersion​(String engineVersion)

        The version number of the database engine.

        Parameters:
        engineVersion - The version number of the database engine.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbParameterGroupFamily

        ModifyCustomDbEngineVersionResponse.Builder dbParameterGroupFamily​(String dbParameterGroupFamily)

        The name of the DB parameter group family for the database engine.

        Parameters:
        dbParameterGroupFamily - The name of the DB parameter group family for the database engine.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbEngineDescription

        ModifyCustomDbEngineVersionResponse.Builder dbEngineDescription​(String dbEngineDescription)

        The description of the database engine.

        Parameters:
        dbEngineDescription - The description of the database engine.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbEngineVersionDescription

        ModifyCustomDbEngineVersionResponse.Builder dbEngineVersionDescription​(String dbEngineVersionDescription)

        The description of the database engine version.

        Parameters:
        dbEngineVersionDescription - The description of the database engine version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • defaultCharacterSet

        ModifyCustomDbEngineVersionResponse.Builder defaultCharacterSet​(CharacterSet defaultCharacterSet)

        The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

        Parameters:
        defaultCharacterSet - The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbEngineMediaType

        ModifyCustomDbEngineVersionResponse.Builder dbEngineMediaType​(String dbEngineMediaType)

        A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

        Parameters:
        dbEngineMediaType - A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedCharacterSets

        ModifyCustomDbEngineVersionResponse.Builder supportedCharacterSets​(Collection<CharacterSet> supportedCharacterSets)

        A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

        Parameters:
        supportedCharacterSets - A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedCharacterSets

        ModifyCustomDbEngineVersionResponse.Builder supportedCharacterSets​(CharacterSet... supportedCharacterSets)

        A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

        Parameters:
        supportedCharacterSets - A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedCharacterSets

        ModifyCustomDbEngineVersionResponse.Builder supportedCharacterSets​(Consumer<CharacterSet.Builder>... supportedCharacterSets)

        A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

        This is a convenience method that creates an instance of the CharacterSet.Builder avoiding the need to create one manually via CharacterSet.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #supportedCharacterSets(List).

        Parameters:
        supportedCharacterSets - a consumer that will call methods on CharacterSet.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #supportedCharacterSets(java.util.Collection)

      • supportedNcharCharacterSets

        ModifyCustomDbEngineVersionResponse.Builder supportedNcharCharacterSets​(Collection<CharacterSet> supportedNcharCharacterSets)

        A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

        Parameters:
        supportedNcharCharacterSets - A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedNcharCharacterSets

        ModifyCustomDbEngineVersionResponse.Builder supportedNcharCharacterSets​(CharacterSet... supportedNcharCharacterSets)

        A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

        Parameters:
        supportedNcharCharacterSets - A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedNcharCharacterSets

        ModifyCustomDbEngineVersionResponse.Builder supportedNcharCharacterSets​(Consumer<CharacterSet.Builder>... supportedNcharCharacterSets)

        A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

        This is a convenience method that creates an instance of the CharacterSet.Builder avoiding the need to create one manually via CharacterSet.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #supportedNcharCharacterSets(List).

        Parameters:
        supportedNcharCharacterSets - a consumer that will call methods on CharacterSet.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #supportedNcharCharacterSets(java.util.Collection)

      • validUpgradeTarget

        ModifyCustomDbEngineVersionResponse.Builder validUpgradeTarget​(Collection<UpgradeTarget> validUpgradeTarget)

        A list of engine versions that this database engine version can be upgraded to.

        Parameters:
        validUpgradeTarget - A list of engine versions that this database engine version can be upgraded to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • validUpgradeTarget

        ModifyCustomDbEngineVersionResponse.Builder validUpgradeTarget​(UpgradeTarget... validUpgradeTarget)

        A list of engine versions that this database engine version can be upgraded to.

        Parameters:
        validUpgradeTarget - A list of engine versions that this database engine version can be upgraded to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedTimezones

        ModifyCustomDbEngineVersionResponse.Builder supportedTimezones​(Collection<Timezone> supportedTimezones)

        A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

        Parameters:
        supportedTimezones - A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedTimezones

        ModifyCustomDbEngineVersionResponse.Builder supportedTimezones​(Timezone... supportedTimezones)

        A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

        Parameters:
        supportedTimezones - A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedTimezones

        ModifyCustomDbEngineVersionResponse.Builder supportedTimezones​(Consumer<Timezone.Builder>... supportedTimezones)

        A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

        This is a convenience method that creates an instance of the Timezone.Builder avoiding the need to create one manually via Timezone.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #supportedTimezones(List).

        Parameters:
        supportedTimezones - a consumer that will call methods on Timezone.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #supportedTimezones(java.util.Collection)

      • exportableLogTypes

        ModifyCustomDbEngineVersionResponse.Builder exportableLogTypes​(Collection<String> exportableLogTypes)

        The types of logs that the database engine has available for export to CloudWatch Logs.

        Parameters:
        exportableLogTypes - The types of logs that the database engine has available for export to CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exportableLogTypes

        ModifyCustomDbEngineVersionResponse.Builder exportableLogTypes​(String... exportableLogTypes)

        The types of logs that the database engine has available for export to CloudWatch Logs.

        Parameters:
        exportableLogTypes - The types of logs that the database engine has available for export to CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportsLogExportsToCloudwatchLogs

        ModifyCustomDbEngineVersionResponse.Builder supportsLogExportsToCloudwatchLogs​(Boolean supportsLogExportsToCloudwatchLogs)

        Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

        Parameters:
        supportsLogExportsToCloudwatchLogs - Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportsReadReplica

        ModifyCustomDbEngineVersionResponse.Builder supportsReadReplica​(Boolean supportsReadReplica)

        Indicates whether the database engine version supports read replicas.

        Parameters:
        supportsReadReplica - Indicates whether the database engine version supports read replicas.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedEngineModes

        ModifyCustomDbEngineVersionResponse.Builder supportedEngineModes​(Collection<String> supportedEngineModes)

        A list of the supported DB engine modes.

        Parameters:
        supportedEngineModes - A list of the supported DB engine modes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedEngineModes

        ModifyCustomDbEngineVersionResponse.Builder supportedEngineModes​(String... supportedEngineModes)

        A list of the supported DB engine modes.

        Parameters:
        supportedEngineModes - A list of the supported DB engine modes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedFeatureNames

        ModifyCustomDbEngineVersionResponse.Builder supportedFeatureNames​(Collection<String> supportedFeatureNames)

        A list of features supported by the DB engine.

        The supported features vary by DB engine and DB engine version.

        To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

        aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

        For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

        aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

        The supported features are listed under SupportedFeatureNames in the output.

        Parameters:
        supportedFeatureNames - A list of features supported by the DB engine.

        The supported features vary by DB engine and DB engine version.

        To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

        aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

        For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

        aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

        The supported features are listed under SupportedFeatureNames in the output.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedFeatureNames

        ModifyCustomDbEngineVersionResponse.Builder supportedFeatureNames​(String... supportedFeatureNames)

        A list of features supported by the DB engine.

        The supported features vary by DB engine and DB engine version.

        To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

        aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

        For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

        aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

        The supported features are listed under SupportedFeatureNames in the output.

        Parameters:
        supportedFeatureNames - A list of features supported by the DB engine.

        The supported features vary by DB engine and DB engine version.

        To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

        aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

        For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

        aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

        The supported features are listed under SupportedFeatureNames in the output.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        ModifyCustomDbEngineVersionResponse.Builder status​(String status)

        The status of the DB engine version, either available or deprecated.

        Parameters:
        status - The status of the DB engine version, either available or deprecated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportsParallelQuery

        ModifyCustomDbEngineVersionResponse.Builder supportsParallelQuery​(Boolean supportsParallelQuery)

        Indicates whether you can use Aurora parallel query with a specific DB engine version.

        Parameters:
        supportsParallelQuery - Indicates whether you can use Aurora parallel query with a specific DB engine version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportsGlobalDatabases

        ModifyCustomDbEngineVersionResponse.Builder supportsGlobalDatabases​(Boolean supportsGlobalDatabases)

        Indicates whether you can use Aurora global databases with a specific DB engine version.

        Parameters:
        supportsGlobalDatabases - Indicates whether you can use Aurora global databases with a specific DB engine version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • majorEngineVersion

        ModifyCustomDbEngineVersionResponse.Builder majorEngineVersion​(String majorEngineVersion)

        The major engine version of the CEV.

        Parameters:
        majorEngineVersion - The major engine version of the CEV.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • databaseInstallationFilesS3BucketName

        ModifyCustomDbEngineVersionResponse.Builder databaseInstallationFilesS3BucketName​(String databaseInstallationFilesS3BucketName)

        The name of the Amazon S3 bucket that contains your database installation files.

        Parameters:
        databaseInstallationFilesS3BucketName - The name of the Amazon S3 bucket that contains your database installation files.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • databaseInstallationFilesS3Prefix

        ModifyCustomDbEngineVersionResponse.Builder databaseInstallationFilesS3Prefix​(String databaseInstallationFilesS3Prefix)

        The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

        Parameters:
        databaseInstallationFilesS3Prefix - The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbEngineVersionArn

        ModifyCustomDbEngineVersionResponse.Builder dbEngineVersionArn​(String dbEngineVersionArn)

        The ARN of the custom engine version.

        Parameters:
        dbEngineVersionArn - The ARN of the custom engine version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        ModifyCustomDbEngineVersionResponse.Builder kmsKeyId​(String kmsKeyId)

        The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

        Parameters:
        kmsKeyId - The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createTime

        ModifyCustomDbEngineVersionResponse.Builder createTime​(Instant createTime)

        The creation time of the DB engine version.

        Parameters:
        createTime - The creation time of the DB engine version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagList

        ModifyCustomDbEngineVersionResponse.Builder tagList​(Collection<Tag> tagList)
        Sets the value of the TagList property for this object.
        Parameters:
        tagList - The new value for the TagList property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagList

        ModifyCustomDbEngineVersionResponse.Builder tagList​(Tag... tagList)
        Sets the value of the TagList property for this object.
        Parameters:
        tagList - The new value for the TagList property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportsBabelfish

        ModifyCustomDbEngineVersionResponse.Builder supportsBabelfish​(Boolean supportsBabelfish)

        Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

        Parameters:
        supportsBabelfish - Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customDBEngineVersionManifest

        ModifyCustomDbEngineVersionResponse.Builder customDBEngineVersionManifest​(String customDBEngineVersionManifest)

        JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.

        Parameters:
        customDBEngineVersionManifest - JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportsCertificateRotationWithoutRestart

        ModifyCustomDbEngineVersionResponse.Builder supportsCertificateRotationWithoutRestart​(Boolean supportsCertificateRotationWithoutRestart)

        Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

        Parameters:
        supportsCertificateRotationWithoutRestart - Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportsLocalWriteForwarding

        ModifyCustomDbEngineVersionResponse.Builder supportsLocalWriteForwarding​(Boolean supportsLocalWriteForwarding)

        Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

        Valid for: Aurora DB clusters only

        Parameters:
        supportsLocalWriteForwarding - Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

        Valid for: Aurora DB clusters only

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportsIntegrations

        ModifyCustomDbEngineVersionResponse.Builder supportsIntegrations​(Boolean supportsIntegrations)

        Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.

        Parameters:
        supportsIntegrations - Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
        Returns:
        Returns a reference to this object so that method calls can be chained together.