From d401dcbbcf65e01b70c531d12c80e426dcabfda9 Mon Sep 17 00:00:00 2001 From: vet Date: Sun, 24 Nov 2024 12:10:01 +0000 Subject: [PATCH] chore: remove generated docs The docs folders in this repository, which are automatically generated from the JSON schema files, have now partially diverged from the official documentation on the AWS website. Removing these from the repository altogether as they continue to cause confusion to customers who find them included in search results. --- aws-rds-customdbengineversion/docs/README.md | 213 ---- aws-rds-customdbengineversion/docs/tag.md | 51 - aws-rds-dbcluster/docs/README.md | 792 ------------- aws-rds-dbcluster/docs/dbclusterrole.md | 45 - aws-rds-dbcluster/docs/endpoint.md | 19 - aws-rds-dbcluster/docs/masterusersecret.md | 31 - aws-rds-dbcluster/docs/readendpoint.md | 19 - .../docs/scalingconfiguration.md | 104 -- .../docs/serverlessv2scalingconfiguration.md | 45 - aws-rds-dbcluster/docs/tag.md | 51 - aws-rds-dbclusterendpoint/docs/README.md | 129 -- aws-rds-dbclusterendpoint/docs/tag.md | 51 - .../docs/README.md | 93 -- aws-rds-dbclusterparametergroup/docs/tag.md | 51 - aws-rds-dbinstance/docs/README.md | 1052 ----------------- aws-rds-dbinstance/docs/certificatedetails.md | 19 - aws-rds-dbinstance/docs/dbinstancerole.md | 43 - aws-rds-dbinstance/docs/endpoint.md | 19 - aws-rds-dbinstance/docs/masterusersecret.md | 31 - aws-rds-dbinstance/docs/processorfeature.md | 45 - aws-rds-dbinstance/docs/tag.md | 51 - aws-rds-dbparametergroup/docs/README.md | 95 -- aws-rds-dbparametergroup/docs/tag.md | 51 - aws-rds-dbshardgroup/docs/README.md | 139 --- aws-rds-dbshardgroup/docs/tag.md | 51 - aws-rds-dbshardgroup/settings.internal.json | 7 - aws-rds-dbsubnetgroup/docs/README.md | 76 -- aws-rds-dbsubnetgroup/docs/tag.md | 51 - aws-rds-eventsubscription/docs/README.md | 121 -- aws-rds-eventsubscription/docs/tag.md | 51 - aws-rds-globalcluster/docs/README.md | 122 -- aws-rds-integration/docs/README.md | 157 --- .../docs/additionalencryptioncontext.md | 33 - aws-rds-integration/docs/tag.md | 51 - aws-rds-optiongroup/docs/README.md | 106 -- .../docs/optionconfiguration.md | 96 -- aws-rds-optiongroup/docs/optionsetting.md | 45 - aws-rds-optiongroup/docs/tag.md | 51 - 38 files changed, 4257 deletions(-) delete mode 100644 aws-rds-customdbengineversion/docs/README.md delete mode 100644 aws-rds-customdbengineversion/docs/tag.md delete mode 100644 aws-rds-dbcluster/docs/README.md delete mode 100644 aws-rds-dbcluster/docs/dbclusterrole.md delete mode 100644 aws-rds-dbcluster/docs/endpoint.md delete mode 100644 aws-rds-dbcluster/docs/masterusersecret.md delete mode 100644 aws-rds-dbcluster/docs/readendpoint.md delete mode 100644 aws-rds-dbcluster/docs/scalingconfiguration.md delete mode 100644 aws-rds-dbcluster/docs/serverlessv2scalingconfiguration.md delete mode 100644 aws-rds-dbcluster/docs/tag.md delete mode 100644 aws-rds-dbclusterendpoint/docs/README.md delete mode 100644 aws-rds-dbclusterendpoint/docs/tag.md delete mode 100644 aws-rds-dbclusterparametergroup/docs/README.md delete mode 100644 aws-rds-dbclusterparametergroup/docs/tag.md delete mode 100644 aws-rds-dbinstance/docs/README.md delete mode 100644 aws-rds-dbinstance/docs/certificatedetails.md delete mode 100644 aws-rds-dbinstance/docs/dbinstancerole.md delete mode 100644 aws-rds-dbinstance/docs/endpoint.md delete mode 100644 aws-rds-dbinstance/docs/masterusersecret.md delete mode 100644 aws-rds-dbinstance/docs/processorfeature.md delete mode 100644 aws-rds-dbinstance/docs/tag.md delete mode 100644 aws-rds-dbparametergroup/docs/README.md delete mode 100644 aws-rds-dbparametergroup/docs/tag.md delete mode 100644 aws-rds-dbshardgroup/docs/README.md delete mode 100644 aws-rds-dbshardgroup/docs/tag.md delete mode 100644 aws-rds-dbshardgroup/settings.internal.json delete mode 100644 aws-rds-dbsubnetgroup/docs/README.md delete mode 100644 aws-rds-dbsubnetgroup/docs/tag.md delete mode 100644 aws-rds-eventsubscription/docs/README.md delete mode 100644 aws-rds-eventsubscription/docs/tag.md delete mode 100644 aws-rds-globalcluster/docs/README.md delete mode 100644 aws-rds-integration/docs/README.md delete mode 100644 aws-rds-integration/docs/additionalencryptioncontext.md delete mode 100644 aws-rds-integration/docs/tag.md delete mode 100644 aws-rds-optiongroup/docs/README.md delete mode 100644 aws-rds-optiongroup/docs/optionconfiguration.md delete mode 100644 aws-rds-optiongroup/docs/optionsetting.md delete mode 100644 aws-rds-optiongroup/docs/tag.md diff --git a/aws-rds-customdbengineversion/docs/README.md b/aws-rds-customdbengineversion/docs/README.md deleted file mode 100644 index e316cd925..000000000 --- a/aws-rds-customdbengineversion/docs/README.md +++ /dev/null @@ -1,213 +0,0 @@ -# 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 - -
-{
-    "Type" : "AWS::RDS::CustomDBEngineVersion",
-    "Properties" : {
-        "DatabaseInstallationFilesS3BucketName" : String,
-        "DatabaseInstallationFilesS3Prefix" : String,
-        "Description" : String,
-        "Engine" : String,
-        "EngineVersion" : String,
-        "KMSKeyId" : String,
-        "Manifest" : String,
-        "SourceCustomDbEngineVersionIdentifier" : String,
-        "UseAwsProvidedLatestImage" : Boolean,
-        "ImageId" : String,
-        "Status" : String,
-        "Tags" : [ Tag, ... ]
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::CustomDBEngineVersion
-Properties:
-    DatabaseInstallationFilesS3BucketName: String
-    DatabaseInstallationFilesS3Prefix: String
-    Description: String
-    Engine: String
-    EngineVersion: String
-    KMSKeyId: String
-    Manifest: String
-    SourceCustomDbEngineVersionIdentifier: String
-    UseAwsProvidedLatestImage: Boolean
-    ImageId: String
-    Status: String
-    Tags: 
-      - Tag
-
- -## 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_: 3 - -_Maximum Length_: 63 - -_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_: 1 - -_Maximum Length_: 255 - -_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_: 1 - -_Maximum Length_: 1000 - -_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_: 1 - -_Maximum Length_: 35 - -_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_: 1 - -_Maximum Length_: 60 - -_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_: 1 - -_Maximum Length_: 2048 - -_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_: 1 - -_Maximum Length_: 51000 - -_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_: available | inactive | inactive-except-restore - -_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 Tag - -_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. diff --git a/aws-rds-customdbengineversion/docs/tag.md b/aws-rds-customdbengineversion/docs/tag.md deleted file mode 100644 index c89794a01..000000000 --- a/aws-rds-customdbengineversion/docs/tag.md +++ /dev/null @@ -1,51 +0,0 @@ -# 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 - -
-{
-    "Key" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Key: String
-Value: String
-
- -## 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_: 1 - -_Maximum Length_: 128 - -_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_: 256 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbcluster/docs/README.md b/aws-rds-dbcluster/docs/README.md deleted file mode 100644 index 84064fb08..000000000 --- a/aws-rds-dbcluster/docs/README.md +++ /dev/null @@ -1,792 +0,0 @@ -# AWS::RDS::DBCluster - -The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Type" : "AWS::RDS::DBCluster",
-    "Properties" : {
-        "ReadEndpoint" : ReadEndpoint,
-        "AllocatedStorage" : Integer,
-        "AssociatedRoles" : [ DBClusterRole, ... ],
-        "AvailabilityZones" : [ String, ... ],
-        "AutoMinorVersionUpgrade" : Boolean,
-        "BacktrackWindow" : Integer,
-        "BackupRetentionPeriod" : Integer,
-        "ClusterScalabilityType" : String,
-        "CopyTagsToSnapshot" : Boolean,
-        "DatabaseName" : String,
-        "DBClusterInstanceClass" : String,
-        "DBInstanceParameterGroupName" : String,
-        "DBSystemId" : String,
-        "GlobalClusterIdentifier" : String,
-        "DBClusterIdentifier" : String,
-        "DBClusterParameterGroupName" : String,
-        "DBSubnetGroupName" : String,
-        "DeletionProtection" : Boolean,
-        "Domain" : String,
-        "DomainIAMRoleName" : String,
-        "EnableCloudwatchLogsExports" : [ String, ... ],
-        "EnableGlobalWriteForwarding" : Boolean,
-        "EnableHttpEndpoint" : Boolean,
-        "EnableIAMDatabaseAuthentication" : Boolean,
-        "EnableLocalWriteForwarding" : Boolean,
-        "Engine" : String,
-        "EngineLifecycleSupport" : String,
-        "EngineMode" : String,
-        "EngineVersion" : String,
-        "ManageMasterUserPassword" : Boolean,
-        "Iops" : Integer,
-        "KmsKeyId" : String,
-        "MasterUsername" : String,
-        "MasterUserPassword" : String,
-        "MasterUserSecret" : MasterUserSecret,
-        "MonitoringInterval" : Integer,
-        "MonitoringRoleArn" : String,
-        "NetworkType" : String,
-        "PerformanceInsightsEnabled" : Boolean,
-        "PerformanceInsightsKmsKeyId" : String,
-        "PerformanceInsightsRetentionPeriod" : Integer,
-        "Port" : Integer,
-        "PreferredBackupWindow" : String,
-        "PreferredMaintenanceWindow" : String,
-        "PubliclyAccessible" : Boolean,
-        "ReplicationSourceIdentifier" : String,
-        "RestoreToTime" : String,
-        "RestoreType" : String,
-        "ServerlessV2ScalingConfiguration" : ServerlessV2ScalingConfiguration,
-        "ScalingConfiguration" : ScalingConfiguration,
-        "SnapshotIdentifier" : String,
-        "SourceDBClusterIdentifier" : String,
-        "SourceRegion" : String,
-        "StorageEncrypted" : Boolean,
-        "StorageType" : String,
-        "Tags" : [ Tag, ... ],
-        "UseLatestRestorableTime" : Boolean,
-        "VpcSecurityGroupIds" : [ String, ... ]
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::DBCluster
-Properties:
-    ReadEndpoint: ReadEndpoint
-    AllocatedStorage: Integer
-    AssociatedRoles: 
-      - DBClusterRole
-    AvailabilityZones: 
-      - String
-    AutoMinorVersionUpgrade: Boolean
-    BacktrackWindow: Integer
-    BackupRetentionPeriod: Integer
-    ClusterScalabilityType: String
-    CopyTagsToSnapshot: Boolean
-    DatabaseName: String
-    DBClusterInstanceClass: String
-    DBInstanceParameterGroupName: String
-    DBSystemId: String
-    GlobalClusterIdentifier: String
-    DBClusterIdentifier: String
-    DBClusterParameterGroupName: String
-    DBSubnetGroupName: String
-    DeletionProtection: Boolean
-    Domain: String
-    DomainIAMRoleName: String
-    EnableCloudwatchLogsExports: 
-      - String
-    EnableGlobalWriteForwarding: Boolean
-    EnableHttpEndpoint: Boolean
-    EnableIAMDatabaseAuthentication: Boolean
-    EnableLocalWriteForwarding: Boolean
-    Engine: String
-    EngineLifecycleSupport: String
-    EngineMode: String
-    EngineVersion: String
-    ManageMasterUserPassword: Boolean
-    Iops: Integer
-    KmsKeyId: String
-    MasterUsername: String
-    MasterUserPassword: String
-    MasterUserSecret: MasterUserSecret
-    MonitoringInterval: Integer
-    MonitoringRoleArn: String
-    NetworkType: String
-    PerformanceInsightsEnabled: Boolean
-    PerformanceInsightsKmsKeyId: String
-    PerformanceInsightsRetentionPeriod: Integer
-    Port: Integer
-    PreferredBackupWindow: String
-    PreferredMaintenanceWindow: String
-    PubliclyAccessible: Boolean
-    ReplicationSourceIdentifier: String
-    RestoreToTime: String
-    RestoreType: String
-    ServerlessV2ScalingConfiguration: ServerlessV2ScalingConfiguration
-    ScalingConfiguration: ScalingConfiguration
-    SnapshotIdentifier: String
-    SourceDBClusterIdentifier: String
-    SourceRegion: String
-    StorageEncrypted: Boolean
-    StorageType: String
-    Tags: 
-      - Tag
-    UseLatestRestorableTime: Boolean
-    VpcSecurityGroupIds: 
-      - String
-
- -## Properties - -#### ReadEndpoint - -_Required_: No - -_Type_: ReadEndpoint - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### AllocatedStorage - -The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### AssociatedRoles - -Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. - -_Required_: No - -_Type_: List of DBClusterRole - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### AvailabilityZones - -A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. - -_Required_: No - -_Type_: List of String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### AutoMinorVersionUpgrade - -A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### BacktrackWindow - -The target backtrack window, in seconds. To disable backtracking, set this value to 0. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### BackupRetentionPeriod - -The number of days for which automated backups are retained. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### ClusterScalabilityType - -The scalability type for the DB cluster. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### CopyTagsToSnapshot - -A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DatabaseName - -The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### DBClusterInstanceClass - -The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DBInstanceParameterGroupName - -The name of the DB parameter group to apply to all instances of the DB cluster. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DBSystemId - -Reserved for future use. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### GlobalClusterIdentifier - -If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource. - -If you aren't configuring a global database cluster, don't specify this property. - -_Required_: No - -_Type_: String - -_Maximum Length_: 63 - -_Pattern_: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### DBClusterIdentifier - -The DB cluster identifier. This parameter is stored as a lowercase string. - -_Required_: No - -_Type_: String - -_Minimum Length_: 1 - -_Maximum Length_: 63 - -_Pattern_: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### DBClusterParameterGroupName - -The name of the DB cluster parameter group to associate with this DB cluster. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DBSubnetGroupName - -A DB subnet group that you want to associate with this DB cluster. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### DeletionProtection - -A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Domain - -The Active Directory directory ID to create the DB cluster in. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DomainIAMRoleName - -Specify the name of the IAM role to be used when making API calls to the Directory Service. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### EnableCloudwatchLogsExports - -The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. - -_Required_: No - -_Type_: List of String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### EnableGlobalWriteForwarding - -Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### EnableHttpEndpoint - -A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### EnableIAMDatabaseAuthentication - -A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### EnableLocalWriteForwarding - -Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Engine - -The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### EngineLifecycleSupport - -The life cycle type of the DB cluster. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### EngineMode - -The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### EngineVersion - -The version number of the database engine to use. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### ManageMasterUserPassword - -A value that indicates whether to manage the master user password with AWS Secrets Manager. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Iops - -The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### KmsKeyId - -The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### MasterUsername - -The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername. - -_Required_: No - -_Type_: String - -_Minimum Length_: 1 - -_Pattern_: ^[a-zA-Z]{1}[a-zA-Z0-9_]*$ - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### MasterUserPassword - -The master password for the DB instance. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MasterUserSecret - -_Required_: No - -_Type_: MasterUserSecret - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MonitoringInterval - -The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is not to enable Enhanced Monitoring. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MonitoringRoleArn - -The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### NetworkType - -The network type of the DB cluster. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PerformanceInsightsEnabled - -A value that indicates whether to turn on Performance Insights for the DB cluster. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PerformanceInsightsKmsKeyId - -The Amazon Web Services KMS key identifier for encryption of Performance Insights data. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PerformanceInsightsRetentionPeriod - -The amount of time, in days, to retain Performance Insights data. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Port - -The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PreferredBackupWindow - -The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PreferredMaintenanceWindow - -The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PubliclyAccessible - -A value that indicates whether the DB cluster is publicly accessible. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### ReplicationSourceIdentifier - -The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### RestoreToTime - -The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### RestoreType - -The type of restore to be performed. You can specify one of the following values: -full-copy - The new DB cluster is restored as a full copy of the source DB cluster. -copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### ServerlessV2ScalingConfiguration - -Contains the scaling configuration of an Aurora Serverless v2 DB cluster. - -_Required_: No - -_Type_: ServerlessV2ScalingConfiguration - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### ScalingConfiguration - -The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. - -_Required_: No - -_Type_: ScalingConfiguration - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### SnapshotIdentifier - -The identifier for the DB snapshot or DB cluster snapshot to restore from. -You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. -After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### SourceDBClusterIdentifier - -The identifier of the source DB cluster from which to restore. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### SourceRegion - -The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### StorageEncrypted - -Indicates whether the DB instance is encrypted. -If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### StorageType - -Specifies the storage type to be associated with the DB cluster. - -_Required_: No - -_Type_: String - -_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 Tag - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### UseLatestRestorableTime - -A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### VpcSecurityGroupIds - -A list of EC2 VPC security groups to associate with this DB cluster. - -_Required_: No - -_Type_: List of String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -## Return Values - -### Ref - -When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the DBClusterIdentifier. - -### 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). - -#### DBClusterArn - -The Amazon Resource Name (ARN) for the DB cluster. - -#### DBClusterResourceId - -The AWS Region-unique, immutable identifier for the DB cluster. - -#### Endpoint - -Returns the Endpoint value. - -#### Address - -Returns the Address value. - -#### Port - -Returns the Port value. - -#### Port - -Returns the Port value. - -#### Address - -Returns the Address value. - -#### SecretArn - -Returns the SecretArn value. - -#### StorageThroughput - -Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type. diff --git a/aws-rds-dbcluster/docs/dbclusterrole.md b/aws-rds-dbcluster/docs/dbclusterrole.md deleted file mode 100644 index a3075bfd5..000000000 --- a/aws-rds-dbcluster/docs/dbclusterrole.md +++ /dev/null @@ -1,45 +0,0 @@ -# AWS::RDS::DBCluster DBClusterRole - -Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "FeatureName" : String,
-    "RoleArn" : String
-}
-
- -### YAML - -
-FeatureName: String
-RoleArn: String
-
- -## Properties - -#### FeatureName - -The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### RoleArn - -The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. - -_Required_: Yes - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbcluster/docs/endpoint.md b/aws-rds-dbcluster/docs/endpoint.md deleted file mode 100644 index 1bf621527..000000000 --- a/aws-rds-dbcluster/docs/endpoint.md +++ /dev/null @@ -1,19 +0,0 @@ -# AWS::RDS::DBCluster Endpoint - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-}
-
- -### YAML - -
-
- -## Properties diff --git a/aws-rds-dbcluster/docs/masterusersecret.md b/aws-rds-dbcluster/docs/masterusersecret.md deleted file mode 100644 index 65e6b4338..000000000 --- a/aws-rds-dbcluster/docs/masterusersecret.md +++ /dev/null @@ -1,31 +0,0 @@ -# AWS::RDS::DBCluster MasterUserSecret - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "KmsKeyId" : String
-}
-
- -### YAML - -
-KmsKeyId: String
-
- -## Properties - -#### KmsKeyId - -The AWS KMS key identifier that is used to encrypt the secret. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbcluster/docs/readendpoint.md b/aws-rds-dbcluster/docs/readendpoint.md deleted file mode 100644 index 66f44f013..000000000 --- a/aws-rds-dbcluster/docs/readendpoint.md +++ /dev/null @@ -1,19 +0,0 @@ -# AWS::RDS::DBCluster ReadEndpoint - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-}
-
- -### YAML - -
-
- -## Properties diff --git a/aws-rds-dbcluster/docs/scalingconfiguration.md b/aws-rds-dbcluster/docs/scalingconfiguration.md deleted file mode 100644 index 90a80033f..000000000 --- a/aws-rds-dbcluster/docs/scalingconfiguration.md +++ /dev/null @@ -1,104 +0,0 @@ -# AWS::RDS::DBCluster ScalingConfiguration - -The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "AutoPause" : Boolean,
-    "MaxCapacity" : Integer,
-    "MinCapacity" : Integer,
-    "SecondsBeforeTimeout" : Integer,
-    "SecondsUntilAutoPause" : Integer,
-    "TimeoutAction" : String
-}
-
- -### YAML - -
-AutoPause: Boolean
-MaxCapacity: Integer
-MinCapacity: Integer
-SecondsBeforeTimeout: Integer
-SecondsUntilAutoPause: Integer
-TimeoutAction: String
-
- -## Properties - -#### AutoPause - -A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MaxCapacity - -The maximum capacity for an Aurora DB cluster in serverless DB engine mode. -For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. -For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. -The maximum capacity must be greater than or equal to the minimum capacity. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MinCapacity - -The minimum capacity for an Aurora DB cluster in serverless DB engine mode. -For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. -For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. -The minimum capacity must be less than or equal to the maximum capacity. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### SecondsBeforeTimeout - -The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. -The default is 300. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### SecondsUntilAutoPause - -The time, in seconds, before an Aurora DB cluster in serverless mode is paused. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### TimeoutAction - -The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. -ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. -RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. - -For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbcluster/docs/serverlessv2scalingconfiguration.md b/aws-rds-dbcluster/docs/serverlessv2scalingconfiguration.md deleted file mode 100644 index c3a383eb9..000000000 --- a/aws-rds-dbcluster/docs/serverlessv2scalingconfiguration.md +++ /dev/null @@ -1,45 +0,0 @@ -# AWS::RDS::DBCluster ServerlessV2ScalingConfiguration - -Contains the scaling configuration of an Aurora Serverless v2 DB cluster. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "MinCapacity" : Double,
-    "MaxCapacity" : Double
-}
-
- -### YAML - -
-MinCapacity: Double
-MaxCapacity: Double
-
- -## Properties - -#### MinCapacity - -The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. - -_Required_: No - -_Type_: Double - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MaxCapacity - -The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. - -_Required_: No - -_Type_: Double - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbcluster/docs/tag.md b/aws-rds-dbcluster/docs/tag.md deleted file mode 100644 index 00ef00022..000000000 --- a/aws-rds-dbcluster/docs/tag.md +++ /dev/null @@ -1,51 +0,0 @@ -# AWS::RDS::DBCluster 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 - -
-{
-    "Key" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Key: String
-Value: String
-
- -## 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_: 1 - -_Maximum Length_: 128 - -_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_: 256 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbclusterendpoint/docs/README.md b/aws-rds-dbclusterendpoint/docs/README.md deleted file mode 100644 index 1eb5677ea..000000000 --- a/aws-rds-dbclusterendpoint/docs/README.md +++ /dev/null @@ -1,129 +0,0 @@ -# AWS::RDS::DBClusterEndpoint - -The AWS::RDS::DBClusterEndpoint resource allows you to create custom Aurora Cluster endpoint. For more information, see Using custom endpoints in the Amazon RDS Aurora Guide. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Type" : "AWS::RDS::DBClusterEndpoint",
-    "Properties" : {
-        "DBClusterIdentifier" : String,
-        "DBClusterEndpointIdentifier" : String,
-        "EndpointType" : String,
-        "StaticMembers" : [ String, ... ],
-        "ExcludedMembers" : [ String, ... ],
-        "Tags" : [ Tag, ... ]
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::DBClusterEndpoint
-Properties:
-    DBClusterIdentifier: String
-    DBClusterEndpointIdentifier: String
-    EndpointType: String
-    StaticMembers: 
-      - String
-    ExcludedMembers: 
-      - String
-    Tags: 
-      - Tag
-
- -## Properties - -#### DBClusterIdentifier - -The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. - -_Required_: Yes - -_Type_: String - -_Minimum Length_: 1 - -_Maximum Length_: 63 - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### DBClusterEndpointIdentifier - -The identifier to use for the new endpoint. This parameter is stored as a lowercase string. - -_Required_: No - -_Type_: String - -_Minimum Length_: 1 - -_Maximum Length_: 63 - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### EndpointType - -The type of the endpoint, one of: READER , WRITER , ANY - -_Required_: Yes - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### StaticMembers - -List of DB instance identifiers that are part of the custom endpoint group. - -_Required_: No - -_Type_: List of String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### ExcludedMembers - -List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty. - -_Required_: No - -_Type_: List of String - -_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 Tag - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -## Return Values - -### Ref - -When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the DBClusterEndpointIdentifier. - -### 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). - -#### Endpoint - -The DNS address of the endpoint. - -#### DBClusterEndpointArn - -The Amazon Resource Name (ARN) for the endpoint. diff --git a/aws-rds-dbclusterendpoint/docs/tag.md b/aws-rds-dbclusterendpoint/docs/tag.md deleted file mode 100644 index 309af160c..000000000 --- a/aws-rds-dbclusterendpoint/docs/tag.md +++ /dev/null @@ -1,51 +0,0 @@ -# AWS::RDS::DBClusterEndpoint 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 - -
-{
-    "Key" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Key: String
-Value: String
-
- -## 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_: 1 - -_Maximum Length_: 128 - -_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_: 256 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbclusterparametergroup/docs/README.md b/aws-rds-dbclusterparametergroup/docs/README.md deleted file mode 100644 index b521001ff..000000000 --- a/aws-rds-dbclusterparametergroup/docs/README.md +++ /dev/null @@ -1,93 +0,0 @@ -# AWS::RDS::DBClusterParameterGroup - -The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Type" : "AWS::RDS::DBClusterParameterGroup",
-    "Properties" : {
-        "Description" : String,
-        "Family" : String,
-        "Parameters" : Map,
-        "DBClusterParameterGroupName" : String,
-        "Tags" : [ Tag, ... ]
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::DBClusterParameterGroup
-Properties:
-    Description: String
-    Family: String
-    Parameters: Map
-    DBClusterParameterGroupName: String
-    Tags: 
-      - Tag
-
- -## Properties - -#### Description - -A friendly description for this DB cluster parameter group. - -_Required_: Yes - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### Family - -The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family. - -_Required_: Yes - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### Parameters - -An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. - -_Required_: Yes - -_Type_: Map - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DBClusterParameterGroupName - -_Required_: No - -_Type_: String - -_Pattern_: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$ - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### Tags - -The list of tags for the cluster parameter group. - -_Required_: No - -_Type_: List of Tag - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -## Return Values - -### Ref - -When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the DBClusterParameterGroupName. diff --git a/aws-rds-dbclusterparametergroup/docs/tag.md b/aws-rds-dbclusterparametergroup/docs/tag.md deleted file mode 100644 index c1d96e351..000000000 --- a/aws-rds-dbclusterparametergroup/docs/tag.md +++ /dev/null @@ -1,51 +0,0 @@ -# AWS::RDS::DBClusterParameterGroup 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 - -
-{
-    "Key" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Key: String
-Value: String
-
- -## 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_: 1 - -_Maximum Length_: 128 - -_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_: 256 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbinstance/docs/README.md b/aws-rds-dbinstance/docs/README.md deleted file mode 100644 index d05531bc2..000000000 --- a/aws-rds-dbinstance/docs/README.md +++ /dev/null @@ -1,1052 +0,0 @@ -# AWS::RDS::DBInstance - -The AWS::RDS::DBInstance resource creates an Amazon RDS DB instance. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Type" : "AWS::RDS::DBInstance",
-    "Properties" : {
-        "AllocatedStorage" : String,
-        "AllowMajorVersionUpgrade" : Boolean,
-        "AssociatedRoles" : [ DBInstanceRole, ... ],
-        "AutoMinorVersionUpgrade" : Boolean,
-        "AutomaticBackupReplicationRegion" : String,
-        "AutomaticBackupReplicationKmsKeyId" : String,
-        "AvailabilityZone" : String,
-        "BackupRetentionPeriod" : Integer,
-        "CACertificateIdentifier" : String,
-        "CertificateDetails" : CertificateDetails,
-        "CertificateRotationRestart" : Boolean,
-        "CharacterSetName" : String,
-        "CopyTagsToSnapshot" : Boolean,
-        "CustomIAMInstanceProfile" : String,
-        "DBClusterIdentifier" : String,
-        "DBClusterSnapshotIdentifier" : String,
-        "DBInstanceClass" : String,
-        "DBInstanceIdentifier" : String,
-        "DBName" : String,
-        "DBParameterGroupName" : String,
-        "DBSecurityGroups" : [ String, ... ],
-        "DBSnapshotIdentifier" : String,
-        "DBSubnetGroupName" : String,
-        "DBSystemId" : String,
-        "DedicatedLogVolume" : Boolean,
-        "DeleteAutomatedBackups" : Boolean,
-        "DeletionProtection" : Boolean,
-        "Domain" : String,
-        "DomainAuthSecretArn" : String,
-        "DomainDnsIps" : [ String, ... ],
-        "DomainFqdn" : String,
-        "DomainIAMRoleName" : String,
-        "DomainOu" : String,
-        "EnableCloudwatchLogsExports" : [ String, ... ],
-        "EnableIAMDatabaseAuthentication" : Boolean,
-        "EnablePerformanceInsights" : Boolean,
-        "Endpoint" : Endpoint,
-        "Engine" : String,
-        "EngineLifecycleSupport" : String,
-        "EngineVersion" : String,
-        "ManageMasterUserPassword" : Boolean,
-        "Iops" : Integer,
-        "KmsKeyId" : String,
-        "LicenseModel" : String,
-        "MasterUsername" : String,
-        "MasterUserPassword" : String,
-        "MasterUserSecret" : MasterUserSecret,
-        "MaxAllocatedStorage" : Integer,
-        "MonitoringInterval" : Integer,
-        "MonitoringRoleArn" : String,
-        "MultiAZ" : Boolean,
-        "NcharCharacterSetName" : String,
-        "NetworkType" : String,
-        "OptionGroupName" : String,
-        "PerformanceInsightsKMSKeyId" : String,
-        "PerformanceInsightsRetentionPeriod" : Integer,
-        "Port" : String,
-        "PreferredBackupWindow" : String,
-        "PreferredMaintenanceWindow" : String,
-        "ProcessorFeatures" : [ ProcessorFeature, ... ],
-        "PromotionTier" : Integer,
-        "PubliclyAccessible" : Boolean,
-        "ReplicaMode" : String,
-        "RestoreTime" : String,
-        "SourceDBClusterIdentifier" : String,
-        "SourceDbiResourceId" : String,
-        "SourceDBInstanceAutomatedBackupsArn" : String,
-        "SourceDBInstanceIdentifier" : String,
-        "SourceRegion" : String,
-        "StorageEncrypted" : Boolean,
-        "StorageType" : String,
-        "StorageThroughput" : Integer,
-        "Tags" : [ Tag, ... ],
-        "TdeCredentialArn" : String,
-        "TdeCredentialPassword" : String,
-        "Timezone" : String,
-        "UseDefaultProcessorFeatures" : Boolean,
-        "UseLatestRestorableTime" : Boolean,
-        "VPCSecurityGroups" : [ String, ... ]
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::DBInstance
-Properties:
-    AllocatedStorage: String
-    AllowMajorVersionUpgrade: Boolean
-    AssociatedRoles: 
-      - DBInstanceRole
-    AutoMinorVersionUpgrade: Boolean
-    AutomaticBackupReplicationRegion: String
-    AutomaticBackupReplicationKmsKeyId: String
-    AvailabilityZone: String
-    BackupRetentionPeriod: Integer
-    CACertificateIdentifier: String
-    CertificateDetails: CertificateDetails
-    CertificateRotationRestart: Boolean
-    CharacterSetName: String
-    CopyTagsToSnapshot: Boolean
-    CustomIAMInstanceProfile: String
-    DBClusterIdentifier: String
-    DBClusterSnapshotIdentifier: String
-    DBInstanceClass: String
-    DBInstanceIdentifier: String
-    DBName: String
-    DBParameterGroupName: String
-    DBSecurityGroups: 
-      - String
-    DBSnapshotIdentifier: String
-    DBSubnetGroupName: String
-    DBSystemId: String
-    DedicatedLogVolume: Boolean
-    DeleteAutomatedBackups: Boolean
-    DeletionProtection: Boolean
-    Domain: String
-    DomainAuthSecretArn: String
-    DomainDnsIps: 
-      - String
-    DomainFqdn: String
-    DomainIAMRoleName: String
-    DomainOu: String
-    EnableCloudwatchLogsExports: 
-      - String
-    EnableIAMDatabaseAuthentication: Boolean
-    EnablePerformanceInsights: Boolean
-    Endpoint: Endpoint
-    Engine: String
-    EngineLifecycleSupport: String
-    EngineVersion: String
-    ManageMasterUserPassword: Boolean
-    Iops: Integer
-    KmsKeyId: String
-    LicenseModel: String
-    MasterUsername: String
-    MasterUserPassword: String
-    MasterUserSecret: MasterUserSecret
-    MaxAllocatedStorage: Integer
-    MonitoringInterval: Integer
-    MonitoringRoleArn: String
-    MultiAZ: Boolean
-    NcharCharacterSetName: String
-    NetworkType: String
-    OptionGroupName: String
-    PerformanceInsightsKMSKeyId: String
-    PerformanceInsightsRetentionPeriod: Integer
-    Port: String
-    PreferredBackupWindow: String
-    PreferredMaintenanceWindow: String
-    ProcessorFeatures: 
-      - ProcessorFeature
-    PromotionTier: Integer
-    PubliclyAccessible: Boolean
-    ReplicaMode: String
-    RestoreTime: String
-    SourceDBClusterIdentifier: String
-    SourceDbiResourceId: String
-    SourceDBInstanceAutomatedBackupsArn: String
-    SourceDBInstanceIdentifier: String
-    SourceRegion: String
-    StorageEncrypted: Boolean
-    StorageType: String
-    StorageThroughput: Integer
-    Tags: 
-      - Tag
-    TdeCredentialArn: String
-    TdeCredentialPassword: String
-    Timezone: String
-    UseDefaultProcessorFeatures: Boolean
-    UseLatestRestorableTime: Boolean
-    VPCSecurityGroups: 
-      - String
-
- -## Properties - -#### AllocatedStorage - -The amount of storage (in gigabytes) to be initially allocated for the database instance. - -_Required_: No - -_Type_: String - -_Pattern_: ^[0-9]*$ - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### AllowMajorVersionUpgrade - -A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### AssociatedRoles - -The AWS Identity and Access Management (IAM) roles associated with the DB instance. - -_Required_: No - -_Type_: List of DBInstanceRole - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### AutoMinorVersionUpgrade - -A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### AutomaticBackupReplicationRegion - -Enables replication of automated backups to a different Amazon Web Services Region. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### AutomaticBackupReplicationKmsKeyId - -The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE` . - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### AvailabilityZone - -The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### BackupRetentionPeriod - -The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. - -_Required_: No - -_Type_: Integer - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### CACertificateIdentifier - -The identifier of the CA certificate for this DB instance. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### CertificateDetails - -_Required_: No - -_Type_: CertificateDetails - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### CertificateRotationRestart - -A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. -By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. -If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate -This setting doesn't apply to RDS Custom. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### CharacterSetName - -For supported engines, indicates that the DB instance should be associated with the specified character set. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### CopyTagsToSnapshot - -A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### CustomIAMInstanceProfile - -The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: - * The profile must exist in your account. - * The profile must have an IAM role that Amazon EC2 has permissions to assume. - * The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom . -For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide . - -This setting is required for RDS Custom. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### DBClusterIdentifier - -The identifier of the DB cluster that the instance will belong to. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### DBClusterSnapshotIdentifier - -The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide . - -Constraints: - * Must match the identifier of an existing Multi-AZ DB cluster snapshot. - * Can't be specified when DBSnapshotIdentifier is specified. - * Must be specified when DBSnapshotIdentifier isn't specified. - * If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot. - * Can't be the identifier of an Aurora DB cluster snapshot. - * Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### DBInstanceClass - -The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DBInstanceIdentifier - -A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. - -_Required_: No - -_Type_: String - -_Minimum Length_: 1 - -_Maximum Length_: 63 - -_Pattern_: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### DBName - -The meaning of this parameter differs according to the database engine you use. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### DBParameterGroupName - -The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### DBSecurityGroups - -A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. - -_Required_: No - -_Type_: List of String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DBSnapshotIdentifier - -The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### DBSubnetGroupName - -A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### DBSystemId - -The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### DedicatedLogVolume - -Indicates whether the DB instance has a dedicated log volume (DLV) enabled. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DeleteAutomatedBackups - -A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DeletionProtection - -A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Domain - -The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DomainAuthSecretArn - -The ARN for the Secrets Manager secret with the credentials for the user joining the domain. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DomainDnsIps - -The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. - -_Required_: No - -_Type_: List of String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DomainFqdn - -The fully qualified domain name (FQDN) of an Active Directory domain. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DomainIAMRoleName - -Specify the name of the IAM role to be used when making API calls to the Directory Service. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DomainOu - -The Active Directory organizational unit for your DB instance to join. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### EnableCloudwatchLogsExports - -The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. - -_Required_: No - -_Type_: List of String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### EnableIAMDatabaseAuthentication - -A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### EnablePerformanceInsights - -A value that indicates whether to enable Performance Insights for the DB instance. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Endpoint - -_Required_: No - -_Type_: Endpoint - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Engine - -The name of the database engine that you want to use for this DB instance. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### EngineLifecycleSupport - -The life cycle type of the DB instance. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### EngineVersion - -The version number of the database engine to use. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### ManageMasterUserPassword - -A value that indicates whether to manage the master user password with AWS Secrets Manager. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Iops - -The number of I/O operations per second (IOPS) that the database provisions. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### KmsKeyId - -The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### LicenseModel - -License model information for this DB instance. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MasterUsername - -The master user name for the DB instance. - -_Required_: No - -_Type_: String - -_Minimum Length_: 1 - -_Maximum Length_: 128 - -_Pattern_: ^[a-zA-Z][a-zA-Z0-9_]{0,127}$ - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### MasterUserPassword - -The password for the master user. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MasterUserSecret - -_Required_: No - -_Type_: MasterUserSecret - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MaxAllocatedStorage - -The upper limit to which Amazon RDS can automatically scale the storage of the DB instance. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MonitoringInterval - -The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is not to enable Enhanced Monitoring. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MonitoringRoleArn - -The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MultiAZ - -Specifies whether the database instance is a multiple Availability Zone deployment. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### NcharCharacterSetName - -The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### NetworkType - -The network type of the DB cluster. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### OptionGroupName - -Indicates that the DB instance should be associated with the specified option group. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PerformanceInsightsKMSKeyId - -The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### PerformanceInsightsRetentionPeriod - -The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Port - -The port number on which the database accepts connections. - -_Required_: No - -_Type_: String - -_Pattern_: ^\d*$ - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PreferredBackupWindow - -The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PreferredMaintenanceWindow - -he weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### ProcessorFeatures - -The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. - -_Required_: No - -_Type_: List of ProcessorFeature - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PromotionTier - -A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PubliclyAccessible - -Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### ReplicaMode - -The open mode of an Oracle read replica. The default is open-read-only. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### RestoreTime - -The date and time to restore from. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### SourceDBClusterIdentifier - -The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### SourceDbiResourceId - -The resource ID of the source DB instance from which to restore. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### SourceDBInstanceAutomatedBackupsArn - -The Amazon Resource Name (ARN) of the replicated automated backups from which to restore. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### SourceDBInstanceIdentifier - -If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### SourceRegion - -The ID of the region that contains the source DB instance for the Read Replica. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### StorageEncrypted - -A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### StorageType - -Specifies the storage type to be associated with the DB instance. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### StorageThroughput - -Specifies the storage throughput for the DB instance. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Tags - -Tags to assign to the DB instance. - -_Required_: No - -_Type_: List of Tag - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### TdeCredentialArn - -The ARN from the key store with which to associate the instance for TDE encryption. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### TdeCredentialPassword - -The password for the given ARN from the key store in order to access the device. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Timezone - -The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### UseDefaultProcessorFeatures - -A value that indicates whether the DB instance class of the DB instance uses its default processor features. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### UseLatestRestorableTime - -A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### VPCSecurityGroups - -A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. - -_Required_: No - -_Type_: List of String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -## Return Values - -### Ref - -When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the DBInstanceIdentifier. - -### 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). - -#### Address - -Returns the Address value. - -#### Port - -Returns the Port value. - -#### HostedZoneId - -Returns the HostedZoneId value. - -#### DbiResourceId - -The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed. - -#### DBInstanceArn - -The Amazon Resource Name (ARN) for the DB instance. - -#### SecretArn - -Returns the SecretArn value. - -#### CAIdentifier - -Returns the CAIdentifier value. - -#### ValidTill - -Returns the ValidTill value. diff --git a/aws-rds-dbinstance/docs/certificatedetails.md b/aws-rds-dbinstance/docs/certificatedetails.md deleted file mode 100644 index 013fb4385..000000000 --- a/aws-rds-dbinstance/docs/certificatedetails.md +++ /dev/null @@ -1,19 +0,0 @@ -# AWS::RDS::DBInstance CertificateDetails - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-}
-
- -### YAML - -
-
- -## Properties diff --git a/aws-rds-dbinstance/docs/dbinstancerole.md b/aws-rds-dbinstance/docs/dbinstancerole.md deleted file mode 100644 index 53546597c..000000000 --- a/aws-rds-dbinstance/docs/dbinstancerole.md +++ /dev/null @@ -1,43 +0,0 @@ -# AWS::RDS::DBInstance DBInstanceRole - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "FeatureName" : String,
-    "RoleArn" : String
-}
-
- -### YAML - -
-FeatureName: String
-RoleArn: String
-
- -## Properties - -#### FeatureName - -The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. - -_Required_: Yes - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### RoleArn - -The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. - -_Required_: Yes - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbinstance/docs/endpoint.md b/aws-rds-dbinstance/docs/endpoint.md deleted file mode 100644 index 14eb58f9f..000000000 --- a/aws-rds-dbinstance/docs/endpoint.md +++ /dev/null @@ -1,19 +0,0 @@ -# AWS::RDS::DBInstance Endpoint - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-}
-
- -### YAML - -
-
- -## Properties diff --git a/aws-rds-dbinstance/docs/masterusersecret.md b/aws-rds-dbinstance/docs/masterusersecret.md deleted file mode 100644 index 26a92a2bf..000000000 --- a/aws-rds-dbinstance/docs/masterusersecret.md +++ /dev/null @@ -1,31 +0,0 @@ -# AWS::RDS::DBInstance MasterUserSecret - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "KmsKeyId" : String
-}
-
- -### YAML - -
-KmsKeyId: String
-
- -## Properties - -#### KmsKeyId - -The AWS KMS key identifier that is used to encrypt the secret. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbinstance/docs/processorfeature.md b/aws-rds-dbinstance/docs/processorfeature.md deleted file mode 100644 index 8b3fc36f9..000000000 --- a/aws-rds-dbinstance/docs/processorfeature.md +++ /dev/null @@ -1,45 +0,0 @@ -# AWS::RDS::DBInstance ProcessorFeature - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Name" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Name: String
-Value: String
-
- -## Properties - -#### Name - -The name of the processor feature. Valid names are coreCount and threadsPerCore. - -_Required_: No - -_Type_: String - -_Allowed Values_: coreCount | threadsPerCore - -_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 of a processor feature name. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbinstance/docs/tag.md b/aws-rds-dbinstance/docs/tag.md deleted file mode 100644 index d020bf14e..000000000 --- a/aws-rds-dbinstance/docs/tag.md +++ /dev/null @@ -1,51 +0,0 @@ -# AWS::RDS::DBInstance 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 - -
-{
-    "Key" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Key: String
-Value: String
-
- -## 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_: 1 - -_Maximum Length_: 128 - -_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_: 256 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbparametergroup/docs/README.md b/aws-rds-dbparametergroup/docs/README.md deleted file mode 100644 index 3ec855425..000000000 --- a/aws-rds-dbparametergroup/docs/README.md +++ /dev/null @@ -1,95 +0,0 @@ -# AWS::RDS::DBParameterGroup - -The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Type" : "AWS::RDS::DBParameterGroup",
-    "Properties" : {
-        "DBParameterGroupName" : String,
-        "Description" : String,
-        "Family" : String,
-        "Parameters" : Map,
-        "Tags" : [ Tag, ... ]
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::DBParameterGroup
-Properties:
-    DBParameterGroupName: String
-    Description: String
-    Family: String
-    Parameters: Map
-    Tags: 
-      - Tag
-
- -## Properties - -#### DBParameterGroupName - -Specifies the name of the DB parameter group - -_Required_: No - -_Type_: String - -_Pattern_: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$ - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### Description - -Provides the customer-specified description for this DB parameter group. - -_Required_: Yes - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### Family - -The DB parameter group family name. - -_Required_: Yes - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### Parameters - -An array of parameter names and values for the parameter update. - -_Required_: No - -_Type_: Map - -_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 Tag - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -## Return Values - -### Ref - -When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the DBParameterGroupName. diff --git a/aws-rds-dbparametergroup/docs/tag.md b/aws-rds-dbparametergroup/docs/tag.md deleted file mode 100644 index a7fa40fe0..000000000 --- a/aws-rds-dbparametergroup/docs/tag.md +++ /dev/null @@ -1,51 +0,0 @@ -# AWS::RDS::DBParameterGroup 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 - -
-{
-    "Key" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Key: String
-Value: String
-
- -## 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_: 1 - -_Maximum Length_: 128 - -_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_: 256 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbshardgroup/docs/README.md b/aws-rds-dbshardgroup/docs/README.md deleted file mode 100644 index 35650617c..000000000 --- a/aws-rds-dbshardgroup/docs/README.md +++ /dev/null @@ -1,139 +0,0 @@ -# AWS::RDS::DBShardGroup - -The AWS::RDS::DBShardGroup resource creates an Amazon Aurora Limitless DB Shard Group. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Type" : "AWS::RDS::DBShardGroup",
-    "Properties" : {
-        "DBShardGroupIdentifier" : String,
-        "DBClusterIdentifier" : String,
-        "ComputeRedundancy" : Integer,
-        "MaxACU" : Double,
-        "MinACU" : Double,
-        "PubliclyAccessible" : Boolean,
-        "Tags" : [ Tag, ... ]
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::DBShardGroup
-Properties:
-    DBShardGroupIdentifier: String
-    DBClusterIdentifier: String
-    ComputeRedundancy: Integer
-    MaxACU: Double
-    MinACU: Double
-    PubliclyAccessible: Boolean
-    Tags: 
-      - Tag
-
- -## Properties - -#### DBShardGroupIdentifier - -The name of the DB shard group. - -_Required_: No - -_Type_: String - -_Minimum Length_: 1 - -_Maximum Length_: 63 - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### DBClusterIdentifier - -The name of the primary DB cluster for the DB shard group. - -_Required_: Yes - -_Type_: String - -_Minimum Length_: 1 - -_Maximum Length_: 63 - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### ComputeRedundancy - -Specifies whether to create standby instances for the DB shard group. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MaxACU - -The maximum capacity of the DB shard group in Aurora capacity units (ACUs). - -_Required_: Yes - -_Type_: Double - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### MinACU - -The minimum capacity of the DB shard group in Aurora capacity units (ACUs). - -_Required_: No - -_Type_: Double - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### PubliclyAccessible - -Indicates whether the DB shard group is publicly accessible. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### Tags - -An array of key-value pairs to apply to this resource. - -_Required_: No - -_Type_: List of Tag - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -## Return Values - -### Ref - -When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the DBShardGroupIdentifier. - -### 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). - -#### DBShardGroupResourceId - -The Amazon Web Services Region-unique, immutable identifier for the DB shard group. - -#### Endpoint - -The connection endpoint for the DB shard group. diff --git a/aws-rds-dbshardgroup/docs/tag.md b/aws-rds-dbshardgroup/docs/tag.md deleted file mode 100644 index 93c6d90da..000000000 --- a/aws-rds-dbshardgroup/docs/tag.md +++ /dev/null @@ -1,51 +0,0 @@ -# AWS::RDS::DBShardGroup 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 - -
-{
-    "Key" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Key: String
-Value: String
-
- -## 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_: 1 - -_Maximum Length_: 128 - -_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_: 256 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-dbshardgroup/settings.internal.json b/aws-rds-dbshardgroup/settings.internal.json deleted file mode 100644 index ecf3a093a..000000000 --- a/aws-rds-dbshardgroup/settings.internal.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "FasPolicyPath": { - "aws": "/policies/AuthRuntime/authNPolicy/cloudformation/aws-rds-dbshardgroup.2024-09-27-21-08-30", - "aws-iso-e": "/policies/AuthRuntime/authNPolicy/cloudformation/aws-rds-dbshardgroup.2024-09-27-21-10-01", - "aws-iso-f": "/policies/AuthRuntime/authNPolicy/cloudformation/aws-rds-dbshardgroup.2024-09-27-21-12-26" - } -} diff --git a/aws-rds-dbsubnetgroup/docs/README.md b/aws-rds-dbsubnetgroup/docs/README.md deleted file mode 100644 index 0dc39f1f6..000000000 --- a/aws-rds-dbsubnetgroup/docs/README.md +++ /dev/null @@ -1,76 +0,0 @@ -# AWS::RDS::DBSubnetGroup - -The AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Type" : "AWS::RDS::DBSubnetGroup",
-    "Properties" : {
-        "DBSubnetGroupDescription" : String,
-        "DBSubnetGroupName" : String,
-        "SubnetIds" : [ String, ... ],
-        "Tags" : [ Tag, ... ]
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::DBSubnetGroup
-Properties:
-    DBSubnetGroupDescription: String
-    DBSubnetGroupName: String
-    SubnetIds: 
-      - String
-    Tags: 
-      - Tag
-
- -## Properties - -#### DBSubnetGroupDescription - -_Required_: Yes - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DBSubnetGroupName - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### SubnetIds - -_Required_: Yes - -_Type_: List of String - -_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 Tag - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -## Return Values - -### Ref - -When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the DBSubnetGroupName. diff --git a/aws-rds-dbsubnetgroup/docs/tag.md b/aws-rds-dbsubnetgroup/docs/tag.md deleted file mode 100644 index 690803e7c..000000000 --- a/aws-rds-dbsubnetgroup/docs/tag.md +++ /dev/null @@ -1,51 +0,0 @@ -# AWS::RDS::DBSubnetGroup 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 - -
-{
-    "Key" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Key: String
-Value: String
-
- -## 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_: 1 - -_Maximum Length_: 128 - -_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_: 256 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-eventsubscription/docs/README.md b/aws-rds-eventsubscription/docs/README.md deleted file mode 100644 index 6d5b25d76..000000000 --- a/aws-rds-eventsubscription/docs/README.md +++ /dev/null @@ -1,121 +0,0 @@ -# AWS::RDS::EventSubscription - -The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Type" : "AWS::RDS::EventSubscription",
-    "Properties" : {
-        "Tags" : [ Tag, ... ],
-        "SubscriptionName" : String,
-        "Enabled" : Boolean,
-        "EventCategories" : [ String, ... ],
-        "SnsTopicArn" : String,
-        "SourceIds" : [ String, ... ],
-        "SourceType" : String
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::EventSubscription
-Properties:
-    Tags: 
-      - Tag
-    SubscriptionName: String
-    Enabled: Boolean
-    EventCategories: 
-      - String
-    SnsTopicArn: String
-    SourceIds: 
-      - String
-    SourceType: String
-
- -## Properties - -#### Tags - -An array of key-value pairs to apply to this resource. - -_Required_: No - -_Type_: List of Tag - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### SubscriptionName - -The name of the subscription. - -_Required_: No - -_Type_: String - -_Maximum Length_: 255 - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### Enabled - -A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### EventCategories - -A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action. - -_Required_: No - -_Type_: List of String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### SnsTopicArn - -The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. - -_Required_: Yes - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### SourceIds - -The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. - -_Required_: No - -_Type_: List of String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### SourceType - -The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -## Return Values - -### Ref - -When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the SubscriptionName. diff --git a/aws-rds-eventsubscription/docs/tag.md b/aws-rds-eventsubscription/docs/tag.md deleted file mode 100644 index 5ca7e0d16..000000000 --- a/aws-rds-eventsubscription/docs/tag.md +++ /dev/null @@ -1,51 +0,0 @@ -# AWS::RDS::EventSubscription 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 - -
-{
-    "Key" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Key: String
-Value: String
-
- -## 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_: 1 - -_Maximum Length_: 128 - -_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_: 256 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-globalcluster/docs/README.md b/aws-rds-globalcluster/docs/README.md deleted file mode 100644 index 4a7d02a35..000000000 --- a/aws-rds-globalcluster/docs/README.md +++ /dev/null @@ -1,122 +0,0 @@ -# AWS::RDS::GlobalCluster - -Resource Type definition for AWS::RDS::GlobalCluster - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Type" : "AWS::RDS::GlobalCluster",
-    "Properties" : {
-        "Engine" : String,
-        "EngineLifecycleSupport" : String,
-        "EngineVersion" : String,
-        "DeletionProtection" : Boolean,
-        "GlobalClusterIdentifier" : String,
-        "SourceDBClusterIdentifier" : String,
-        "StorageEncrypted" : Boolean
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::GlobalCluster
-Properties:
-    Engine: String
-    EngineLifecycleSupport : String,
-    EngineVersion: String
-    DeletionProtection: Boolean
-    GlobalClusterIdentifier: String
-    SourceDBClusterIdentifier: String
-    StorageEncrypted: Boolean
-
- -## Properties - -#### Engine - -The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora). -If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. - -_Required_: No - -_Type_: String - -_Allowed Values_: aurora | aurora-mysql | aurora-postgresql - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### EngineLifecycleSupport - -The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support. - -_Required_: No - -_Type_: String - -_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) - -#### EngineVersion - -The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DeletionProtection - -The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### GlobalClusterIdentifier - -The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string. - -_Required_: No - -_Type_: String - -_Pattern_: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### SourceDBClusterIdentifier - -The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### StorageEncrypted - - The storage encryption setting for the new global database cluster. -If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. - -_Required_: No - -_Type_: Boolean - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -## Return Values - -### Ref - -When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the GlobalClusterIdentifier. diff --git a/aws-rds-integration/docs/README.md b/aws-rds-integration/docs/README.md deleted file mode 100644 index a8e63e102..000000000 --- a/aws-rds-integration/docs/README.md +++ /dev/null @@ -1,157 +0,0 @@ -# AWS::RDS::Integration - -Creates a zero-ETL integration with Amazon Redshift. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Type" : "AWS::RDS::Integration",
-    "Properties" : {
-        "IntegrationName" : String,
-        "Description" : String,
-        "Tags" : [ Tag, ... ],
-        "DataFilter" : String,
-        "SourceArn" : String,
-        "TargetArn" : String,
-        "KMSKeyId" : String,
-        "AdditionalEncryptionContext" : AdditionalEncryptionContext,
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::Integration
-Properties:
-    IntegrationName: String
-    Description: String
-    Tags: 
-      - Tag
-    DataFilter: String
-    SourceArn: String
-    TargetArn: String
-    KMSKeyId: String
-    AdditionalEncryptionContext: AdditionalEncryptionContext
-
- -## Properties - -#### IntegrationName - -The name of the integration. - -_Required_: No - -_Type_: String - -_Minimum Length_: 1 - -_Maximum Length_: 64 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Description - -The description of the integration. - -_Required_: No - -_Type_: String - -_Minimum Length_: 1 - -_Maximum Length_: 1000 - -_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 Tag - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### DataFilter - -The data filter for the integration. - -_Required_: No - -_Type_: String - -_Minimum Length_: 1 - -_Maximum Length_: 25600 - -_Pattern_: [a-zA-Z0-9_ "\\\-$,*.:?+\/]* - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### SourceArn - -The Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication. - -_Required_: Yes - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### TargetArn - -The ARN of the Redshift data warehouse to use as the target for replication. - -_Required_: Yes - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### KMSKeyId - -An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### AdditionalEncryptionContext - -An optional set of non-secret key–value pairs that contains additional contextual information about the data. - -_Required_: No - -_Type_: AdditionalEncryptionContext - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -## Return Values - -### Ref - -When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the IntegrationArn. - -### 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). - -#### IntegrationArn - -The ARN of the integration. - -#### CreateTime - -Returns the CreateTime value. diff --git a/aws-rds-integration/docs/additionalencryptioncontext.md b/aws-rds-integration/docs/additionalencryptioncontext.md deleted file mode 100644 index c0509f689..000000000 --- a/aws-rds-integration/docs/additionalencryptioncontext.md +++ /dev/null @@ -1,33 +0,0 @@ -# AWS::RDS::Integration AdditionalEncryptionContext - -An optional set of non-secret key–value pairs that contains additional contextual information about the data. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "^[\s\S]*$" : String
-}
-
- -### YAML - -
-^[\s\S]*$: String
-
- -## Properties - -#### \^[\s\S]*$ - -_Required_: No - -_Type_: String - -_Maximum Length_: 131072 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-integration/docs/tag.md b/aws-rds-integration/docs/tag.md deleted file mode 100644 index da7ae8c25..000000000 --- a/aws-rds-integration/docs/tag.md +++ /dev/null @@ -1,51 +0,0 @@ -# AWS::RDS::Integration 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 - -
-{
-    "Key" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Key: String
-Value: String
-
- -## 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_: 1 - -_Maximum Length_: 128 - -_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_: 256 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-optiongroup/docs/README.md b/aws-rds-optiongroup/docs/README.md deleted file mode 100644 index 2f7f5cee8..000000000 --- a/aws-rds-optiongroup/docs/README.md +++ /dev/null @@ -1,106 +0,0 @@ -# AWS::RDS::OptionGroup - -The AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Type" : "AWS::RDS::OptionGroup",
-    "Properties" : {
-        "OptionGroupName" : String,
-        "OptionGroupDescription" : String,
-        "EngineName" : String,
-        "MajorEngineVersion" : String,
-        "OptionConfigurations" : [ OptionConfiguration, ... ],
-        "Tags" : [ Tag, ... ]
-    }
-}
-
- -### YAML - -
-Type: AWS::RDS::OptionGroup
-Properties:
-    OptionGroupName: String
-    OptionGroupDescription: String
-    EngineName: String
-    MajorEngineVersion: String
-    OptionConfigurations: 
-      - OptionConfiguration
-    Tags: 
-      - Tag
-
- -## Properties - -#### OptionGroupName - -Specifies the name of the option group. - -_Required_: No - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### OptionGroupDescription - -Provides a description of the option group. - -_Required_: Yes - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### EngineName - -Indicates the name of the engine that this option group can be applied to. - -_Required_: Yes - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### MajorEngineVersion - -Indicates the major engine version associated with this option group. - -_Required_: Yes - -_Type_: String - -_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) - -#### OptionConfigurations - -Indicates what options are available in the option group. - -_Required_: No - -_Type_: List of OptionConfiguration - -_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 Tag - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -## Return Values - -### Ref - -When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the OptionGroupName. diff --git a/aws-rds-optiongroup/docs/optionconfiguration.md b/aws-rds-optiongroup/docs/optionconfiguration.md deleted file mode 100644 index 64d19baff..000000000 --- a/aws-rds-optiongroup/docs/optionconfiguration.md +++ /dev/null @@ -1,96 +0,0 @@ -# AWS::RDS::OptionGroup OptionConfiguration - -The OptionConfiguration property type specifies an individual option, and its settings, within an AWS::RDS::OptionGroup resource. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "DBSecurityGroupMemberships" : [ String, ... ],
-    "OptionName" : String,
-    "OptionSettings" : [ OptionSetting, ... ],
-    "OptionVersion" : String,
-    "Port" : Integer,
-    "VpcSecurityGroupMemberships" : [ String, ... ]
-}
-
- -### YAML - -
-DBSecurityGroupMemberships: 
-      - String
-OptionName: String
-OptionSettings: 
-      - OptionSetting
-OptionVersion: String
-Port: Integer
-VpcSecurityGroupMemberships: 
-      - String
-
- -## Properties - -#### DBSecurityGroupMemberships - -A list of DBSecurityGroupMembership name strings used for this option. - -_Required_: No - -_Type_: List of String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### OptionName - -The configuration of options to include in a group. - -_Required_: Yes - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### OptionSettings - -The option settings to include in an option group. - -_Required_: No - -_Type_: List of OptionSetting - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### OptionVersion - -The version for the option. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Port - -The optional port for the option. - -_Required_: No - -_Type_: Integer - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### VpcSecurityGroupMemberships - -A list of VpcSecurityGroupMembership name strings used for this option. - -_Required_: No - -_Type_: List of String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-optiongroup/docs/optionsetting.md b/aws-rds-optiongroup/docs/optionsetting.md deleted file mode 100644 index aab44a1bf..000000000 --- a/aws-rds-optiongroup/docs/optionsetting.md +++ /dev/null @@ -1,45 +0,0 @@ -# AWS::RDS::OptionGroup OptionSetting - -The OptionSetting property type specifies the value for an option within an OptionSetting property. - -## Syntax - -To declare this entity in your AWS CloudFormation template, use the following syntax: - -### JSON - -
-{
-    "Name" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Name: String
-Value: String
-
- -## Properties - -#### Name - -The name of the option that has settings that you can set. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) - -#### Value - -The current value of the option setting. - -_Required_: No - -_Type_: String - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) diff --git a/aws-rds-optiongroup/docs/tag.md b/aws-rds-optiongroup/docs/tag.md deleted file mode 100644 index b287470fc..000000000 --- a/aws-rds-optiongroup/docs/tag.md +++ /dev/null @@ -1,51 +0,0 @@ -# AWS::RDS::OptionGroup 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 - -
-{
-    "Key" : String,
-    "Value" : String
-}
-
- -### YAML - -
-Key: String
-Value: String
-
- -## 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_: 1 - -_Maximum Length_: 128 - -_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_: 256 - -_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)