Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. CustomDbEngineVersion

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.CustomDbEngineVersion

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Creates a custom DB engine version (CEV).

    Create CustomDbEngineVersion Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CustomDbEngineVersion(name: string, args: CustomDbEngineVersionArgs, opts?: CustomResourceOptions);
    @overload
def CustomDbEngineVersion(resource_name: str,
                          args: CustomDbEngineVersionArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def CustomDbEngineVersion(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          engine: Optional[str] = None,
                          engine_version: Optional[str] = None,
                          database_installation_files_s3_bucket_name: Optional[str] = None,
                          database_installation_files_s3_prefix: Optional[str] = None,
                          description: Optional[str] = None,
                          image_id: Optional[str] = None,
                          kms_key_id: Optional[str] = None,
                          manifest: Optional[str] = None,
                          source_custom_db_engine_version_identifier: Optional[str] = None,
                          status: Optional[CustomDbEngineVersionStatus] = None,
                          tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                          use_aws_provided_latest_image: Optional[bool] = None)
    func NewCustomDbEngineVersion(ctx *Context, name string, args CustomDbEngineVersionArgs, opts ...ResourceOption) (*CustomDbEngineVersion, error)
    public CustomDbEngineVersion(string name, CustomDbEngineVersionArgs args, CustomResourceOptions? opts = null)
    public CustomDbEngineVersion(String name, CustomDbEngineVersionArgs args)
public CustomDbEngineVersion(String name, CustomDbEngineVersionArgs args, CustomResourceOptions options)

    type: aws-native:rds:CustomDbEngineVersion
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CustomDbEngineVersionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CustomDbEngineVersionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CustomDbEngineVersionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomDbEngineVersionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomDbEngineVersionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    CustomDbEngineVersion Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CustomDbEngineVersion resource accepts the following input properties:

    Engine string
    The database engine to use for your custom engine version (CEV). Valid values:

    • custom-oracle-ee
    • custom-oracle-ee-cdb
    EngineVersion string
    The name of your CEV. The name format is major version.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. Constraints: Minimum length is 1. Maximum length is 60. Pattern: ^[a-z0-9_.-]{1,60$}
    DatabaseInstallationFilesS3BucketName string
    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.
    DatabaseInstallationFilesS3Prefix string
    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.
    Description string
    An optional description of your CEV.
    ImageId string
    A value that indicates the ID of the AMI.
    KmsKeyId string
    The AWS 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 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.
    Manifest string
    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.
    SourceCustomDbEngineVersionIdentifier string
    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.
    Status Pulumi.AwsNative.Rds.CustomDbEngineVersionStatus
    A value that indicates the status of a custom engine version (CEV).
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
    UseAwsProvidedLatestImage bool
    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.
    Engine string
    The database engine to use for your custom engine version (CEV). Valid values:

    • custom-oracle-ee
    • custom-oracle-ee-cdb
    EngineVersion string
    The name of your CEV. The name format is major version.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. Constraints: Minimum length is 1. Maximum length is 60. Pattern: ^[a-z0-9_.-]{1,60$}
    DatabaseInstallationFilesS3BucketName string
    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.
    DatabaseInstallationFilesS3Prefix string
    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.
    Description string
    An optional description of your CEV.
    ImageId string
    A value that indicates the ID of the AMI.
    KmsKeyId string
    The AWS 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 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.
    Manifest string
    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.
    SourceCustomDbEngineVersionIdentifier string
    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.
    Status CustomDbEngineVersionStatus
    A value that indicates the status of a custom engine version (CEV).
    Tags TagArgs
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
    UseAwsProvidedLatestImage bool
    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.
    engine String
    The database engine to use for your custom engine version (CEV). Valid values:

    • custom-oracle-ee
    • custom-oracle-ee-cdb
    engineVersion String
    The name of your CEV. The name format is major version.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. Constraints: Minimum length is 1. Maximum length is 60. Pattern: ^[a-z0-9_.-]{1,60$}
    databaseInstallationFilesS3BucketName String
    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.
    databaseInstallationFilesS3Prefix String
    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.
    description String
    An optional description of your CEV.
    imageId String
    A value that indicates the ID of the AMI.
    kmsKeyId String
    The AWS 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 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.
    manifest String
    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.
    sourceCustomDbEngineVersionIdentifier String
    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.
    status CustomDbEngineVersionStatus
    A value that indicates the status of a custom engine version (CEV).
    tags List<Tag>
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
    useAwsProvidedLatestImage Boolean
    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.
    engine string
    The database engine to use for your custom engine version (CEV). Valid values:

    • custom-oracle-ee
    • custom-oracle-ee-cdb
    engineVersion string
    The name of your CEV. The name format is major version.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. Constraints: Minimum length is 1. Maximum length is 60. Pattern: ^[a-z0-9_.-]{1,60$}
    databaseInstallationFilesS3BucketName string
    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.
    databaseInstallationFilesS3Prefix string
    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.
    description string
    An optional description of your CEV.
    imageId string
    A value that indicates the ID of the AMI.
    kmsKeyId string
    The AWS 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 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.
    manifest string
    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.
    sourceCustomDbEngineVersionIdentifier string
    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.
    status CustomDbEngineVersionStatus
    A value that indicates the status of a custom engine version (CEV).
    tags Tag[]
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
    useAwsProvidedLatestImage boolean
    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.
    engine str
    The database engine to use for your custom engine version (CEV). Valid values:

    • custom-oracle-ee
    • custom-oracle-ee-cdb
    engine_version str
    The name of your CEV. The name format is major version.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. Constraints: Minimum length is 1. Maximum length is 60. Pattern: ^[a-z0-9_.-]{1,60$}
    database_installation_files_s3_bucket_name str
    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.
    database_installation_files_s3_prefix str
    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.
    description str
    An optional description of your CEV.
    image_id str
    A value that indicates the ID of the AMI.
    kms_key_id str
    The AWS 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 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.
    manifest str
    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.
    source_custom_db_engine_version_identifier str
    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.
    status CustomDbEngineVersionStatus
    A value that indicates the status of a custom engine version (CEV).
    tags Sequence[TagArgs]
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
    use_aws_provided_latest_image bool
    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.
    engine String
    The database engine to use for your custom engine version (CEV). Valid values:

    • custom-oracle-ee
    • custom-oracle-ee-cdb
    engineVersion String
    The name of your CEV. The name format is major version.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. Constraints: Minimum length is 1. Maximum length is 60. Pattern: ^[a-z0-9_.-]{1,60$}
    databaseInstallationFilesS3BucketName String
    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.
    databaseInstallationFilesS3Prefix String
    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.
    description String
    An optional description of your CEV.
    imageId String
    A value that indicates the ID of the AMI.
    kmsKeyId String
    The AWS 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 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.
    manifest String
    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.
    sourceCustomDbEngineVersionIdentifier String
    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.
    status "available" | "inactive" | "inactive-except-restore"
    A value that indicates the status of a custom engine version (CEV).
    tags List<Property Map>
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
    useAwsProvidedLatestImage Boolean
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomDbEngineVersion resource produces the following output properties:

    DbEngineVersionArn string
    The ARN of the custom engine version.
    Id string
    The provider-assigned unique ID for this managed resource.
    DbEngineVersionArn string
    The ARN of the custom engine version.
    Id string
    The provider-assigned unique ID for this managed resource.
    dbEngineVersionArn String
    The ARN of the custom engine version.
    id String
    The provider-assigned unique ID for this managed resource.
    dbEngineVersionArn string
    The ARN of the custom engine version.
    id string
    The provider-assigned unique ID for this managed resource.
    db_engine_version_arn str
    The ARN of the custom engine version.
    id str
    The provider-assigned unique ID for this managed resource.
    dbEngineVersionArn String
    The ARN of the custom engine version.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    CustomDbEngineVersionStatus, CustomDbEngineVersionStatusArgs

    Available
    available
    Inactive
    inactive
    InactiveExceptRestore
    inactive-except-restore
    CustomDbEngineVersionStatusAvailable
    available
    CustomDbEngineVersionStatusInactive
    inactive
    CustomDbEngineVersionStatusInactiveExceptRestore
    inactive-except-restore
    Available
    available
    Inactive
    inactive
    InactiveExceptRestore
    inactive-except-restore
    Available
    available
    Inactive
    inactive
    InactiveExceptRestore
    inactive-except-restore
    AVAILABLE
    available
    INACTIVE
    inactive
    INACTIVE_EXCEPT_RESTORE
    inactive-except-restore
    "available"
    available
    "inactive"
    inactive
    "inactive-except-restore"
    inactive-except-restore

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native