Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. rds
  5. CustomDbEngineVersion

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.79.0 published on Monday, Oct 2, 2023 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.CustomDbEngineVersion

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.79.0 published on Monday, Oct 2, 2023 by Pulumi
pulumi/pulumi-aws-native

    The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.

    Create CustomDbEngineVersion Resource

    new CustomDbEngineVersion(name: string, args: CustomDbEngineVersionArgs, opts?: CustomResourceOptions);
    @overload
def CustomDbEngineVersion(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          database_installation_files_s3_bucket_name: Optional[str] = None,
                          database_installation_files_s3_prefix: Optional[str] = None,
                          description: Optional[str] = None,
                          engine: Optional[str] = None,
                          engine_version: Optional[str] = None,
                          kms_key_id: Optional[str] = None,
                          manifest: Optional[str] = None,
                          status: Optional[CustomDbEngineVersionStatus] = None,
                          tags: Optional[Sequence[CustomDbEngineVersionTagArgs]] = None)
@overload
def CustomDbEngineVersion(resource_name: str,
                          args: CustomDbEngineVersionArgs,
                          opts: Optional[ResourceOptions] = 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.
    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

    The CustomDbEngineVersion resource accepts the following input properties:

    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.

    Engine string

    The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.

    EngineVersion string

    The name of your CEV. The name format is 19.customized_string . For example, a valid 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.

    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.

    KmsKeyId string

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

    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.

    Status Pulumi.AwsNative.Rds.CustomDbEngineVersionStatus

    The availability status to be assigned to the CEV.

    Tags List<Pulumi.AwsNative.Rds.Inputs.CustomDbEngineVersionTag>

    An array of key-value pairs to apply to this resource.

    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.

    Engine string

    The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.

    EngineVersion string

    The name of your CEV. The name format is 19.customized_string . For example, a valid 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.

    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.

    KmsKeyId string

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

    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.

    Status CustomDbEngineVersionStatus

    The availability status to be assigned to the CEV.

    Tags []CustomDbEngineVersionTagArgs

    An array of key-value pairs to apply to this resource.

    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.

    engine String

    The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.

    engineVersion String

    The name of your CEV. The name format is 19.customized_string . For example, a valid 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.

    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.

    kmsKeyId String

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

    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.

    status CustomDbEngineVersionStatus

    The availability status to be assigned to the CEV.

    tags List<CustomDbEngineVersionTag>

    An array of key-value pairs to apply to this resource.

    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.

    engine string

    The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.

    engineVersion string

    The name of your CEV. The name format is 19.customized_string . For example, a valid 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.

    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.

    kmsKeyId string

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

    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.

    status CustomDbEngineVersionStatus

    The availability status to be assigned to the CEV.

    tags CustomDbEngineVersionTag[]

    An array of key-value pairs to apply to this resource.

    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.

    engine str

    The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.

    engine_version str

    The name of your CEV. The name format is 19.customized_string . For example, a valid 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.

    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.

    kms_key_id str

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

    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.

    status CustomDbEngineVersionStatus

    The availability status to be assigned to the CEV.

    tags Sequence[CustomDbEngineVersionTagArgs]

    An array of key-value pairs to apply to this resource.

    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.

    engine String

    The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.

    engineVersion String

    The name of your CEV. The name format is 19.customized_string . For example, a valid 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.

    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.

    kmsKeyId String

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

    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.

    status "available" | "inactive" | "inactive-except-restore"

    The availability status to be assigned to the CEV.

    tags List<Property Map>

    An array of key-value pairs to apply to this resource.

    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

    CustomDbEngineVersionTag, CustomDbEngineVersionTagArgs

    Key string

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    Value string

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    Key string

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    Value string

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    key String

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    value String

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    key string

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    value string

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    key str

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    value str

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    key String

    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    value String

    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.79.0 published on Monday, Oct 2, 2023 by Pulumi
    pulumi/pulumi-aws-native