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

Interface CreateCustomDbEngineVersionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateCustomDbEngineVersionRequest.Builder,CreateCustomDbEngineVersionRequest>, RdsRequest.Builder, SdkBuilder<CreateCustomDbEngineVersionRequest.Builder,CreateCustomDbEngineVersionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateCustomDbEngineVersionRequest
public static interface CreateCustomDbEngineVersionRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<CreateCustomDbEngineVersionRequest.Builder,CreateCustomDbEngineVersionRequest>

  • Method Details

    • engine

      CreateCustomDbEngineVersionRequest.Builder engine(String engine)

      The database engine. RDS Custom for Oracle supports the following values:

      • custom-oracle-ee

      • custom-oracle-ee-cdb

      • custom-oracle-se2

      • custom-oracle-se2-cdb

      Parameters:
      engine - The database engine. RDS Custom for Oracle supports the following values:

      • custom-oracle-ee

      • custom-oracle-ee-cdb

      • custom-oracle-se2

      • custom-oracle-se2-cdb

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

    • engineVersion

      CreateCustomDbEngineVersionRequest.Builder engineVersion(String engineVersion)

      The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.

      Parameters:
      engineVersion - The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databaseInstallationFilesS3BucketName

      CreateCustomDbEngineVersionRequest.Builder databaseInstallationFilesS3BucketName(String databaseInstallationFilesS3BucketName)

      The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.

      Parameters:
      databaseInstallationFilesS3BucketName - The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databaseInstallationFilesS3Prefix

      CreateCustomDbEngineVersionRequest.Builder databaseInstallationFilesS3Prefix(String databaseInstallationFilesS3Prefix)

      The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.

      Parameters:
      databaseInstallationFilesS3Prefix - The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageId

      CreateCustomDbEngineVersionRequest.Builder imageId(String imageId)

      The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.

      Parameters:
      imageId - The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      CreateCustomDbEngineVersionRequest.Builder kmsKeyId(String kmsKeyId)

      The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.

      If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.

      You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

      Parameters:
      kmsKeyId - The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.

      If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.

      You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

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

    • description

      CreateCustomDbEngineVersionRequest.Builder description(String description)

      An optional description of your CEV.

      Parameters:
      description - An optional description of your CEV.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • manifest

      CreateCustomDbEngineVersionRequest.Builder manifest(String manifest)

      The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.

      The following JSON fields are valid:

      MediaImportTemplateVersion

      Version of the CEV manifest. The date is in the format YYYY-MM-DD.

      databaseInstallationFileNames

      Ordered list of installation files for the CEV.

      opatchFileNames

      Ordered list of OPatch installers used for the Oracle DB engine.

      psuRuPatchFileNames

      The PSU and RU patches for this CEV.

      OtherPatchFileNames

      The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.

      For more information, see Creating the CEV manifest in the Amazon RDS User Guide.

      Parameters:
      manifest - The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.

      The following JSON fields are valid:

      MediaImportTemplateVersion

      Version of the CEV manifest. The date is in the format YYYY-MM-DD.

      databaseInstallationFileNames

      Ordered list of installation files for the CEV.

      opatchFileNames

      Ordered list of OPatch installers used for the Oracle DB engine.

      psuRuPatchFileNames

      The PSU and RU patches for this CEV.

      OtherPatchFileNames

      The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.

      For more information, see Creating the CEV manifest in the Amazon RDS User Guide.

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

    • tags

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

    • tags

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

    • tags

      CreateCustomDbEngineVersionRequest.Builder tags(Consumer<Tag.Builder>... tags)
      Sets the value of the Tags property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceCustomDbEngineVersionIdentifier

      CreateCustomDbEngineVersionRequest.Builder sourceCustomDbEngineVersionIdentifier(String sourceCustomDbEngineVersionIdentifier)

      The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either Source or UseAwsProvidedLatestImage. You can't specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier.

      Parameters:
      sourceCustomDbEngineVersionIdentifier - The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either Source or UseAwsProvidedLatestImage. You can't specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • useAwsProvidedLatestImage

      CreateCustomDbEngineVersionRequest.Builder useAwsProvidedLatestImage(Boolean useAwsProvidedLatestImage)

      Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify ImageId.

      Parameters:
      useAwsProvidedLatestImage - Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify ImageId.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateCustomDbEngineVersionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateCustomDbEngineVersionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.