|
| 1 | +# AWS::RDS::CustomDBEngineVersion |
| 2 | + |
| 3 | +The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. |
| 4 | + |
| 5 | +## Syntax |
| 6 | + |
| 7 | +To declare this entity in your AWS CloudFormation template, use the following syntax: |
| 8 | + |
| 9 | +### JSON |
| 10 | + |
| 11 | +<pre> |
| 12 | +{ |
| 13 | + "Type" : "AWS::RDS::CustomDBEngineVersion", |
| 14 | + "Properties" : { |
| 15 | + "<a href="#databaseinstallationfiless3bucketname" title="DatabaseInstallationFilesS3BucketName">DatabaseInstallationFilesS3BucketName</a>" : <i>String</i>, |
| 16 | + "<a href="#databaseinstallationfiless3prefix" title="DatabaseInstallationFilesS3Prefix">DatabaseInstallationFilesS3Prefix</a>" : <i>String</i>, |
| 17 | + "<a href="#description" title="Description">Description</a>" : <i>String</i>, |
| 18 | + "<a href="#engine" title="Engine">Engine</a>" : <i>String</i>, |
| 19 | + "<a href="#engineversion" title="EngineVersion">EngineVersion</a>" : <i>String</i>, |
| 20 | + "<a href="#kmskeyid" title="KMSKeyId">KMSKeyId</a>" : <i>String</i>, |
| 21 | + "<a href="#manifest" title="Manifest">Manifest</a>" : <i>String</i>, |
| 22 | + "<a href="#sourcecustomdbengineversionidentifier" title="SourceCustomDbEngineVersionIdentifier">SourceCustomDbEngineVersionIdentifier</a>" : <i>String</i>, |
| 23 | + "<a href="#useawsprovidedlatestimage" title="UseAwsProvidedLatestImage">UseAwsProvidedLatestImage</a>" : <i>Boolean</i>, |
| 24 | + "<a href="#imageid" title="ImageId">ImageId</a>" : <i>String</i>, |
| 25 | + "<a href="#status" title="Status">Status</a>" : <i>String</i>, |
| 26 | + "<a href="#tags" title="Tags">Tags</a>" : <i>[ <a href="tag.md">Tag</a>, ... ]</i> |
| 27 | + } |
| 28 | +} |
| 29 | +</pre> |
| 30 | + |
| 31 | +### YAML |
| 32 | + |
| 33 | +<pre> |
| 34 | +Type: AWS::RDS::CustomDBEngineVersion |
| 35 | +Properties: |
| 36 | + <a href="#databaseinstallationfiless3bucketname" title="DatabaseInstallationFilesS3BucketName">DatabaseInstallationFilesS3BucketName</a>: <i>String</i> |
| 37 | + <a href="#databaseinstallationfiless3prefix" title="DatabaseInstallationFilesS3Prefix">DatabaseInstallationFilesS3Prefix</a>: <i>String</i> |
| 38 | + <a href="#description" title="Description">Description</a>: <i>String</i> |
| 39 | + <a href="#engine" title="Engine">Engine</a>: <i>String</i> |
| 40 | + <a href="#engineversion" title="EngineVersion">EngineVersion</a>: <i>String</i> |
| 41 | + <a href="#kmskeyid" title="KMSKeyId">KMSKeyId</a>: <i>String</i> |
| 42 | + <a href="#manifest" title="Manifest">Manifest</a>: <i>String</i> |
| 43 | + <a href="#sourcecustomdbengineversionidentifier" title="SourceCustomDbEngineVersionIdentifier">SourceCustomDbEngineVersionIdentifier</a>: <i>String</i> |
| 44 | + <a href="#useawsprovidedlatestimage" title="UseAwsProvidedLatestImage">UseAwsProvidedLatestImage</a>: <i>Boolean</i> |
| 45 | + <a href="#imageid" title="ImageId">ImageId</a>: <i>String</i> |
| 46 | + <a href="#status" title="Status">Status</a>: <i>String</i> |
| 47 | + <a href="#tags" title="Tags">Tags</a>: <i> |
| 48 | + - <a href="tag.md">Tag</a></i> |
| 49 | +</pre> |
| 50 | + |
| 51 | +## Properties |
| 52 | + |
| 53 | +#### DatabaseInstallationFilesS3BucketName |
| 54 | + |
| 55 | +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`. |
| 56 | + |
| 57 | +_Required_: No |
| 58 | + |
| 59 | +_Type_: String |
| 60 | + |
| 61 | +_Minimum Length_: <code>3</code> |
| 62 | + |
| 63 | +_Maximum Length_: <code>63</code> |
| 64 | + |
| 65 | +_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) |
| 66 | + |
| 67 | +#### DatabaseInstallationFilesS3Prefix |
| 68 | + |
| 69 | +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. |
| 70 | + |
| 71 | +_Required_: No |
| 72 | + |
| 73 | +_Type_: String |
| 74 | + |
| 75 | +_Minimum Length_: <code>1</code> |
| 76 | + |
| 77 | +_Maximum Length_: <code>255</code> |
| 78 | + |
| 79 | +_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) |
| 80 | + |
| 81 | +#### Description |
| 82 | + |
| 83 | +An optional description of your CEV. |
| 84 | + |
| 85 | +_Required_: No |
| 86 | + |
| 87 | +_Type_: String |
| 88 | + |
| 89 | +_Minimum Length_: <code>1</code> |
| 90 | + |
| 91 | +_Maximum Length_: <code>1000</code> |
| 92 | + |
| 93 | +_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) |
| 94 | + |
| 95 | +#### Engine |
| 96 | + |
| 97 | +The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. |
| 98 | + |
| 99 | +_Required_: Yes |
| 100 | + |
| 101 | +_Type_: String |
| 102 | + |
| 103 | +_Minimum Length_: <code>1</code> |
| 104 | + |
| 105 | +_Maximum Length_: <code>35</code> |
| 106 | + |
| 107 | +_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) |
| 108 | + |
| 109 | +#### EngineVersion |
| 110 | + |
| 111 | +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. |
| 112 | + |
| 113 | +_Required_: Yes |
| 114 | + |
| 115 | +_Type_: String |
| 116 | + |
| 117 | +_Minimum Length_: <code>1</code> |
| 118 | + |
| 119 | +_Maximum Length_: <code>60</code> |
| 120 | + |
| 121 | +_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) |
| 122 | + |
| 123 | +#### KMSKeyId |
| 124 | + |
| 125 | +The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. |
| 126 | + |
| 127 | +_Required_: No |
| 128 | + |
| 129 | +_Type_: String |
| 130 | + |
| 131 | +_Minimum Length_: <code>1</code> |
| 132 | + |
| 133 | +_Maximum Length_: <code>2048</code> |
| 134 | + |
| 135 | +_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) |
| 136 | + |
| 137 | +#### Manifest |
| 138 | + |
| 139 | +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. |
| 140 | + |
| 141 | +_Required_: No |
| 142 | + |
| 143 | +_Type_: String |
| 144 | + |
| 145 | +_Minimum Length_: <code>1</code> |
| 146 | + |
| 147 | +_Maximum Length_: <code>51000</code> |
| 148 | + |
| 149 | +_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) |
| 150 | + |
| 151 | +#### SourceCustomDbEngineVersionIdentifier |
| 152 | + |
| 153 | +The identifier of the source custom engine version. |
| 154 | + |
| 155 | +_Required_: No |
| 156 | + |
| 157 | +_Type_: String |
| 158 | + |
| 159 | +_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) |
| 160 | + |
| 161 | +#### UseAwsProvidedLatestImage |
| 162 | + |
| 163 | +A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. |
| 164 | + |
| 165 | +_Required_: No |
| 166 | + |
| 167 | +_Type_: Boolean |
| 168 | + |
| 169 | +_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) |
| 170 | + |
| 171 | +#### ImageId |
| 172 | + |
| 173 | +The identifier of Amazon Machine Image (AMI) used for CEV. |
| 174 | + |
| 175 | +_Required_: No |
| 176 | + |
| 177 | +_Type_: String |
| 178 | + |
| 179 | +_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) |
| 180 | + |
| 181 | +#### Status |
| 182 | + |
| 183 | +The availability status to be assigned to the CEV. |
| 184 | + |
| 185 | +_Required_: No |
| 186 | + |
| 187 | +_Type_: String |
| 188 | + |
| 189 | +_Allowed Values_: <code>available</code> | <code>inactive</code> | <code>inactive-except-restore</code> |
| 190 | + |
| 191 | +_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) |
| 192 | + |
| 193 | +#### Tags |
| 194 | + |
| 195 | +An array of key-value pairs to apply to this resource. |
| 196 | + |
| 197 | +_Required_: No |
| 198 | + |
| 199 | +_Type_: List of <a href="tag.md">Tag</a> |
| 200 | + |
| 201 | +_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) |
| 202 | + |
| 203 | +## Return Values |
| 204 | + |
| 205 | +### Fn::GetAtt |
| 206 | + |
| 207 | +The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. |
| 208 | + |
| 209 | +For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). |
| 210 | + |
| 211 | +#### DBEngineVersionArn |
| 212 | + |
| 213 | +The ARN of the custom engine version. |
| 214 | + |
0 commit comments