Struct aws_sdk_rds::operation::create_custom_db_engine_version::CreateCustomDbEngineVersionInput
source · #[non_exhaustive]pub struct CreateCustomDbEngineVersionInput {
pub engine: Option<String>,
pub engine_version: Option<String>,
pub database_installation_files_s3_bucket_name: Option<String>,
pub database_installation_files_s3_prefix: Option<String>,
pub image_id: Option<String>,
pub kms_key_id: Option<String>,
pub description: Option<String>,
pub manifest: Option<String>,
pub tags: Option<Vec<Tag>>,
pub source_custom_db_engine_version_identifier: Option<String>,
pub use_aws_provided_latest_image: Option<bool>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.engine: Option<String>
The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee
.
engine_version: Option<String>
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.
database_installation_files_s3_bucket_name: Option<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
.
database_installation_files_s3_prefix: Option<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.
image_id: Option<String>
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.
kms_key_id: Option<String>
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: Option<String>
An optional description of your CEV.
manifest: Option<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.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
source_custom_db_engine_version_identifier: Option<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
.
use_aws_provided_latest_image: Option<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
.
Implementations§
source§impl CreateCustomDbEngineVersionInput
impl CreateCustomDbEngineVersionInput
sourcepub fn engine(&self) -> Option<&str>
pub fn engine(&self) -> Option<&str>
The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee
.
sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
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.
sourcepub fn database_installation_files_s3_bucket_name(&self) -> Option<&str>
pub fn database_installation_files_s3_bucket_name(&self) -> Option<&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
.
sourcepub fn database_installation_files_s3_prefix(&self) -> Option<&str>
pub fn database_installation_files_s3_prefix(&self) -> Option<&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.
sourcepub fn image_id(&self) -> Option<&str>
pub fn image_id(&self) -> Option<&str>
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.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
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.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
An optional description of your CEV.
sourcepub fn manifest(&self) -> Option<&str>
pub fn manifest(&self) -> Option<&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.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
sourcepub fn source_custom_db_engine_version_identifier(&self) -> Option<&str>
pub fn source_custom_db_engine_version_identifier(&self) -> Option<&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
.
sourcepub fn use_aws_provided_latest_image(&self) -> Option<bool>
pub fn use_aws_provided_latest_image(&self) -> Option<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
.
source§impl CreateCustomDbEngineVersionInput
impl CreateCustomDbEngineVersionInput
sourcepub fn builder() -> CreateCustomDbEngineVersionInputBuilder
pub fn builder() -> CreateCustomDbEngineVersionInputBuilder
Creates a new builder-style object to manufacture CreateCustomDbEngineVersionInput
.
Trait Implementations§
source§impl Clone for CreateCustomDbEngineVersionInput
impl Clone for CreateCustomDbEngineVersionInput
source§fn clone(&self) -> CreateCustomDbEngineVersionInput
fn clone(&self) -> CreateCustomDbEngineVersionInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for CreateCustomDbEngineVersionInput
impl PartialEq for CreateCustomDbEngineVersionInput
source§fn eq(&self, other: &CreateCustomDbEngineVersionInput) -> bool
fn eq(&self, other: &CreateCustomDbEngineVersionInput) -> bool
self
and other
values to be equal, and is used
by ==
.