Package software.amazon.awscdk.services.rds

Class CfnCustomDBEngineVersion

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.rds.CfnCustomDBEngineVersion
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, ICustomDBEngineVersionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:13.116Z") @Stability(Stable) public class CfnCustomDBEngineVersion extends CfnResource implements IInspectable, ICustomDBEngineVersionRef, ITaggableV2
Creates a custom DB engine version (CEV).

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rds.*;
 CfnCustomDBEngineVersion cfnCustomDBEngineVersion = CfnCustomDBEngineVersion.Builder.create(this, "MyCfnCustomDBEngineVersion")
         .engine("engine")
         .engineVersion("engineVersion")
         // the properties below are optional
         .databaseInstallationFilesS3BucketName("databaseInstallationFilesS3BucketName")
         .databaseInstallationFilesS3Prefix("databaseInstallationFilesS3Prefix")
         .description("description")
         .imageId("imageId")
         .kmsKeyId("kmsKeyId")
         .manifest("manifest")
         .sourceCustomDbEngineVersionIdentifier("sourceCustomDbEngineVersionIdentifier")
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useAwsProvidedLatestImage(false)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCustomDBEngineVersion

      protected CfnCustomDBEngineVersion(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCustomDBEngineVersion

      protected CfnCustomDBEngineVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCustomDBEngineVersion

      @Stability(Stable) public CfnCustomDBEngineVersion(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCustomDBEngineVersionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDbEngineVersionArn

      @Stability(Stable) @NotNull public String getAttrDbEngineVersionArn()
      The ARN of the custom engine version.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCustomDbEngineVersionRef

      @Stability(Stable) @NotNull public CustomDBEngineVersionReference getCustomDbEngineVersionRef()
      A reference to a CustomDBEngineVersion resource.
      Specified by:
      getCustomDbEngineVersionRef in interface ICustomDBEngineVersionRef

    • getEngine

      @Stability(Stable) @NotNull public String getEngine()
      The database engine to use for your custom engine version (CEV).

    • setEngine

      @Stability(Stable) public void setEngine(@NotNull String value)
      The database engine to use for your custom engine version (CEV).

    • getEngineVersion

      @Stability(Stable) @NotNull public String getEngineVersion()
      The name of your CEV.

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@NotNull String value)
      The name of your CEV.

    • getDatabaseInstallationFilesS3BucketName

      @Stability(Stable) @Nullable public String getDatabaseInstallationFilesS3BucketName()
      The name of an Amazon S3 bucket that contains database installation files for your CEV.

    • setDatabaseInstallationFilesS3BucketName

      @Stability(Stable) public void setDatabaseInstallationFilesS3BucketName(@Nullable String value)
      The name of an Amazon S3 bucket that contains database installation files for your CEV.

    • getDatabaseInstallationFilesS3Prefix

      @Stability(Stable) @Nullable public String getDatabaseInstallationFilesS3Prefix()
      The Amazon S3 directory that contains the database installation files for your CEV.

    • setDatabaseInstallationFilesS3Prefix

      @Stability(Stable) public void setDatabaseInstallationFilesS3Prefix(@Nullable String value)
      The Amazon S3 directory that contains the database installation files for your CEV.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      An optional description of your CEV.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      An optional description of your CEV.

    • getImageId

      @Stability(Stable) @Nullable public String getImageId()
      A value that indicates the ID of the AMI.

    • setImageId

      @Stability(Stable) public void setImageId(@Nullable String value)
      A value that indicates the ID of the AMI.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The AWS KMS key identifier for an encrypted CEV.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The AWS KMS key identifier for an encrypted CEV.

    • getManifest

      @Stability(Stable) @Nullable public String getManifest()
      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.

    • setManifest

      @Stability(Stable) public void setManifest(@Nullable String value)
      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.

    • getSourceCustomDbEngineVersionIdentifier

      @Stability(Stable) @Nullable public String getSourceCustomDbEngineVersionIdentifier()
      The ARN of a CEV to use as a source for creating a new CEV.

    • setSourceCustomDbEngineVersionIdentifier

      @Stability(Stable) public void setSourceCustomDbEngineVersionIdentifier(@Nullable String value)
      The ARN of a CEV to use as a source for creating a new CEV.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      A value that indicates the status of a custom engine version (CEV).

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      A value that indicates the status of a custom engine version (CEV).

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tags.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tags.

    • getUseAwsProvidedLatestImage

      @Stability(Stable) @Nullable public Object getUseAwsProvidedLatestImage()
      Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.

      Returns union: either Boolean or IResolvable

    • setUseAwsProvidedLatestImage

      @Stability(Stable) public void setUseAwsProvidedLatestImage(@Nullable Boolean value)
      Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.

    • setUseAwsProvidedLatestImage

      @Stability(Stable) public void setUseAwsProvidedLatestImage(@Nullable IResolvable value)
      Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.