JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.rds.model

Class CreateCustomDBEngineVersionRequest

    • Constructor Detail

      • CreateCustomDBEngineVersionRequest

        public CreateCustomDBEngineVersionRequest()
    • Method Detail

      • setEngine

        public void setEngine(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

      • getEngine

        public String getEngine()

        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

      • withEngine

        public CreateCustomDBEngineVersionRequest withEngine(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.
      • setEngineVersion

        public void setEngineVersion(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.
      • getEngineVersion

        public String getEngineVersion()

        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.
      • withEngineVersion

        public CreateCustomDBEngineVersionRequest withEngineVersion(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.
      • setDatabaseInstallationFilesS3BucketName

        public void setDatabaseInstallationFilesS3BucketName(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.
      • getDatabaseInstallationFilesS3BucketName

        public String getDatabaseInstallationFilesS3BucketName()

        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.
      • withDatabaseInstallationFilesS3BucketName

        public CreateCustomDBEngineVersionRequest withDatabaseInstallationFilesS3BucketName(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.
      • setDatabaseInstallationFilesS3Prefix

        public void setDatabaseInstallationFilesS3Prefix(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.
      • getDatabaseInstallationFilesS3Prefix

        public String getDatabaseInstallationFilesS3Prefix()

        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.
      • withDatabaseInstallationFilesS3Prefix

        public CreateCustomDBEngineVersionRequest withDatabaseInstallationFilesS3Prefix(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.
      • setImageId

        public void setImageId(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.
      • getImageId

        public String getImageId()

        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.
      • withImageId

        public CreateCustomDBEngineVersionRequest withImageId(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.
      • setKMSKeyId

        public void setKMSKeyId(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.

      • getKMSKeyId

        public String getKMSKeyId()

        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.

      • withKMSKeyId

        public CreateCustomDBEngineVersionRequest withKMSKeyId(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.
      • setDescription

        public void setDescription(String description)

        An optional description of your CEV.

        Parameters:
        description - An optional description of your CEV.
      • getDescription

        public String getDescription()

        An optional description of your CEV.

        Returns:
        An optional description of your CEV.
      • withDescription

        public CreateCustomDBEngineVersionRequest withDescription(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.
      • setManifest

        public void setManifest(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.

      • getManifest

        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.

        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.

      • withManifest

        public CreateCustomDBEngineVersionRequest withManifest(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.
      • getTags

        public List<Tag> getTags()
        Returns:
      • setTags

        public void setTags(Collection<Tag> tags)
        Parameters:
        tags -
      • setSourceCustomDbEngineVersionIdentifier

        public void setSourceCustomDbEngineVersionIdentifier(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.
      • getSourceCustomDbEngineVersionIdentifier

        public String getSourceCustomDbEngineVersionIdentifier()

        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.
      • withSourceCustomDbEngineVersionIdentifier

        public CreateCustomDBEngineVersionRequest withSourceCustomDbEngineVersionIdentifier(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.
      • setUseAwsProvidedLatestImage

        public void setUseAwsProvidedLatestImage(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.
      • getUseAwsProvidedLatestImage

        public Boolean getUseAwsProvidedLatestImage()

        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.
      • withUseAwsProvidedLatestImage

        public CreateCustomDBEngineVersionRequest withUseAwsProvidedLatestImage(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.
      • isUseAwsProvidedLatestImage

        public Boolean isUseAwsProvidedLatestImage()

        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 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
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /