Skip to content

Commit

Permalink
[CFN-27] The 'safeAddTags' method is still c/p but the core change in…
Browse files Browse the repository at this point in the history
… pattern has finished resulting in a trim create step in the create handler (line 103).
  • Loading branch information
Keynan Pratt committed Nov 25, 2024
1 parent 92e1b7a commit 224e54d
Show file tree
Hide file tree
Showing 21 changed files with 2,980 additions and 0 deletions.
214 changes: 214 additions & 0 deletions aws-rds-customdbengineversion/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,214 @@
# AWS::RDS::CustomDBEngineVersion

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

## Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

### JSON

<pre>
{
"Type" : "AWS::RDS::CustomDBEngineVersion",
"Properties" : {
"<a href="#databaseinstallationfiless3bucketname" title="DatabaseInstallationFilesS3BucketName">DatabaseInstallationFilesS3BucketName</a>" : <i>String</i>,
"<a href="#databaseinstallationfiless3prefix" title="DatabaseInstallationFilesS3Prefix">DatabaseInstallationFilesS3Prefix</a>" : <i>String</i>,
"<a href="#description" title="Description">Description</a>" : <i>String</i>,
"<a href="#engine" title="Engine">Engine</a>" : <i>String</i>,
"<a href="#engineversion" title="EngineVersion">EngineVersion</a>" : <i>String</i>,
"<a href="#kmskeyid" title="KMSKeyId">KMSKeyId</a>" : <i>String</i>,
"<a href="#manifest" title="Manifest">Manifest</a>" : <i>String</i>,
"<a href="#sourcecustomdbengineversionidentifier" title="SourceCustomDbEngineVersionIdentifier">SourceCustomDbEngineVersionIdentifier</a>" : <i>String</i>,
"<a href="#useawsprovidedlatestimage" title="UseAwsProvidedLatestImage">UseAwsProvidedLatestImage</a>" : <i>Boolean</i>,
"<a href="#imageid" title="ImageId">ImageId</a>" : <i>String</i>,
"<a href="#status" title="Status">Status</a>" : <i>String</i>,
"<a href="#tags" title="Tags">Tags</a>" : <i>[ <a href="tag.md">Tag</a>, ... ]</i>
}
}
</pre>

### YAML

<pre>
Type: AWS::RDS::CustomDBEngineVersion
Properties:
<a href="#databaseinstallationfiless3bucketname" title="DatabaseInstallationFilesS3BucketName">DatabaseInstallationFilesS3BucketName</a>: <i>String</i>
<a href="#databaseinstallationfiless3prefix" title="DatabaseInstallationFilesS3Prefix">DatabaseInstallationFilesS3Prefix</a>: <i>String</i>
<a href="#description" title="Description">Description</a>: <i>String</i>
<a href="#engine" title="Engine">Engine</a>: <i>String</i>
<a href="#engineversion" title="EngineVersion">EngineVersion</a>: <i>String</i>
<a href="#kmskeyid" title="KMSKeyId">KMSKeyId</a>: <i>String</i>
<a href="#manifest" title="Manifest">Manifest</a>: <i>String</i>
<a href="#sourcecustomdbengineversionidentifier" title="SourceCustomDbEngineVersionIdentifier">SourceCustomDbEngineVersionIdentifier</a>: <i>String</i>
<a href="#useawsprovidedlatestimage" title="UseAwsProvidedLatestImage">UseAwsProvidedLatestImage</a>: <i>Boolean</i>
<a href="#imageid" title="ImageId">ImageId</a>: <i>String</i>
<a href="#status" title="Status">Status</a>: <i>String</i>
<a href="#tags" title="Tags">Tags</a>: <i>
- <a href="tag.md">Tag</a></i>
</pre>

## Properties

#### 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`.

_Required_: No

_Type_: String

_Minimum Length_: <code>3</code>

_Maximum Length_: <code>63</code>

_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

#### 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.

_Required_: No

_Type_: String

_Minimum Length_: <code>1</code>

_Maximum Length_: <code>255</code>

_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

#### Description

An optional description of your CEV.

_Required_: No

_Type_: String

_Minimum Length_: <code>1</code>

_Maximum Length_: <code>1000</code>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### Engine

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

_Required_: Yes

_Type_: String

_Minimum Length_: <code>1</code>

_Maximum Length_: <code>35</code>

_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

#### EngineVersion

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.

_Required_: Yes

_Type_: String

_Minimum Length_: <code>1</code>

_Maximum Length_: <code>60</code>

_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

#### KMSKeyId

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

_Required_: No

_Type_: String

_Minimum Length_: <code>1</code>

_Maximum Length_: <code>2048</code>

_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

#### 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.

_Required_: No

_Type_: String

_Minimum Length_: <code>1</code>

_Maximum Length_: <code>51000</code>

_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

#### SourceCustomDbEngineVersionIdentifier

The identifier of the source custom engine version.

_Required_: No

_Type_: String

_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

#### UseAwsProvidedLatestImage

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.

_Required_: No

_Type_: Boolean

_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

#### ImageId

The identifier of Amazon Machine Image (AMI) used for CEV.

_Required_: No

_Type_: String

_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

#### Status

The availability status to be assigned to the CEV.

_Required_: No

_Type_: String

_Allowed Values_: <code>available</code> | <code>inactive</code> | <code>inactive-except-restore</code>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### Tags

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

_Required_: No

_Type_: List of <a href="tag.md">Tag</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return Values

### Fn::GetAtt

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.

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).

#### DBEngineVersionArn

The ARN of the custom engine version.

52 changes: 52 additions & 0 deletions aws-rds-customdbengineversion/docs/tag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# AWS::RDS::CustomDBEngineVersion Tag

A key-value pair to associate with a resource.

## Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

### JSON

<pre>
{
"<a href="#key" title="Key">Key</a>" : <i>String</i>,
"<a href="#value" title="Value">Value</a>" : <i>String</i>
}
</pre>

### YAML

<pre>
<a href="#key" title="Key">Key</a>: <i>String</i>
<a href="#value" title="Value">Value</a>: <i>String</i>
</pre>

## Properties

#### Key

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

_Required_: Yes

_Type_: String

_Minimum Length_: <code>1</code>

_Maximum Length_: <code>128</code>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### Value

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

_Required_: No

_Type_: String

_Maximum Length_: <code>256</code>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

Loading

0 comments on commit 224e54d

Please sign in to comment.