Class CreateCustomDbEngineVersionRequest

    • Method Detail

      • engine

        public final 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

        Returns:
        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

      • engineVersion

        public final 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.

        Returns:
        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.
      • databaseInstallationFilesS3BucketName

        public final 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.

        Returns:
        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

        public final 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.

        Returns:
        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.
      • imageId

        public final 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.

        Returns:
        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.
      • kmsKeyId

        public final 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.

        Returns:
        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.

      • description

        public final String description()

        An optional description of your CEV.

        Returns:
        An optional description of your CEV.
      • manifest

        public final 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.

        Returns:
        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.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final List<Tag> tags()
        Returns the value of the Tags property for this object.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The value of the Tags property for this object.
      • sourceCustomDbEngineVersionIdentifier

        public final 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.

        Returns:
        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.
      • useAwsProvidedLatestImage

        public final 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.

        Returns:
        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.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object