Created
September 12, 2020 19:04
-
-
Save GavinRay97/c8faa0b75567725d8f09cd110e2ed6e6 to your computer and use it in GitHub Desktop.
CloudFormation RDS type
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // This file was generated from Typescript using quicktype, do not modify it directly. | |
| // To parse and unparse this JSON data, add this code to your project and do: | |
| // | |
| // cloudFormationRDSDBInstance, err := UnmarshalCloudFormationRDSDBInstance(bytes) | |
| // bytes, err = cloudFormationRDSDBInstance.Marshal() | |
| // | |
| // dBEngine, err := UnmarshalDBEngine(bytes) | |
| // bytes, err = dBEngine.Marshal() | |
| // | |
| // dBInstanceProperties, err := UnmarshalDBInstanceProperties(bytes) | |
| // bytes, err = dBInstanceProperties.Marshal() | |
| // | |
| // dBInstanceRole, err := UnmarshalDBInstanceRole(bytes) | |
| // bytes, err = dBInstanceRole.Marshal() | |
| // | |
| // processorFeature, err := UnmarshalProcessorFeature(bytes) | |
| // bytes, err = processorFeature.Marshal() | |
| // | |
| // tag, err := UnmarshalTag(bytes) | |
| // bytes, err = tag.Marshal() | |
| package main | |
| import "encoding/json" | |
| func UnmarshalCloudFormationRDSDBInstance(data []byte) (CloudFormationRDSDBInstance, error) { | |
| var r CloudFormationRDSDBInstance | |
| err := json.Unmarshal(data, &r) | |
| return r, err | |
| } | |
| func (r *CloudFormationRDSDBInstance) Marshal() ([]byte, error) { | |
| return json.Marshal(r) | |
| } | |
| func UnmarshalDBEngine(data []byte) (DBEngine, error) { | |
| var r DBEngine | |
| err := json.Unmarshal(data, &r) | |
| return r, err | |
| } | |
| func (r *DBEngine) Marshal() ([]byte, error) { | |
| return json.Marshal(r) | |
| } | |
| func UnmarshalDBInstanceProperties(data []byte) (DBInstanceProperties, error) { | |
| var r DBInstanceProperties | |
| err := json.Unmarshal(data, &r) | |
| return r, err | |
| } | |
| func (r *DBInstanceProperties) Marshal() ([]byte, error) { | |
| return json.Marshal(r) | |
| } | |
| func UnmarshalDBInstanceRole(data []byte) (DBInstanceRole, error) { | |
| var r DBInstanceRole | |
| err := json.Unmarshal(data, &r) | |
| return r, err | |
| } | |
| func (r *DBInstanceRole) Marshal() ([]byte, error) { | |
| return json.Marshal(r) | |
| } | |
| func UnmarshalProcessorFeature(data []byte) (ProcessorFeature, error) { | |
| var r ProcessorFeature | |
| err := json.Unmarshal(data, &r) | |
| return r, err | |
| } | |
| func (r *ProcessorFeature) Marshal() ([]byte, error) { | |
| return json.Marshal(r) | |
| } | |
| func UnmarshalTag(data []byte) (Tag, error) { | |
| var r Tag | |
| err := json.Unmarshal(data, &r) | |
| return r, err | |
| } | |
| func (r *Tag) Marshal() ([]byte, error) { | |
| return json.Marshal(r) | |
| } | |
| type CloudFormationRDSDBInstance struct { | |
| Properties DBInstanceProperties `json:"Properties" yaml:"Properties,omitempty"` | |
| Type string `json:"Type" yaml:"Type,omitempty"` | |
| } | |
| type DBInstanceProperties struct { | |
| AllocatedStorage string `json:"AllocatedStorage" yaml:"AllocatedStorage,omitempty"` // The amount of storage (in gigabytes) to be initially allocated for the database instance.; Note: If any value is set in the Iops parameter, AllocatedStorage must be at least 100; GB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value; (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in; 100-GB increments).; ; Required: Conditional; Type: String; Update requires: No interruption | |
| AllowMajorVersionUpgrade bool `json:"AllowMajorVersionUpgrade" yaml:"AllowMajorVersionUpgrade,omitempty"` // 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.; Constraints: Major version upgrades must be allowed when specifying a value for the; EngineVersion parameter that is a different major version than the DB instance's current; version.; ; Required: No; Type: Boolean; Update requires: No interruption | |
| AssociatedRoles []DBInstanceRole `json:"AssociatedRoles" yaml:"AssociatedRoles,omitempty"` // The AWS Identity and Access Management (IAM) roles associated with the DB instance.; ; Required: No; Type: List of DBInstanceRole; Update requires: No interruption | |
| AutoMinorVersionUpgrade bool `json:"AutoMinorVersionUpgrade" yaml:"AutoMinorVersionUpgrade,omitempty"` // 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 | |
| AvailabilityZone string `json:"AvailabilityZone" yaml:"AvailabilityZone,omitempty"` // The Availability Zone (AZ) where the database will be created. For information on AWS; Regions and Availability Zones, see Regions and Availability Zones.; ; Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.; Example: us-east-1d; Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a; Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as; the current endpoint.; ; Required: No; Type: String; Update requires: Replacement | |
| BackupRetentionPeriod float64 `json:"BackupRetentionPeriod" yaml:"BackupRetentionPeriod,omitempty"` // 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.; ; Amazon Aurora:; Not applicable. The retention period for automated backups is managed by the DB cluster.; ; Default: 1; ; Constraints:; - Must be a value from 0 to 35; - Can't be set to 0 if the DB instance is a source to Read Replicas; ; Required: No; Type: Integer; Update requires: Some interruptions | |
| CACertificateIdentifier string `json:"CACertificateIdentifier" yaml:"CACertificateIdentifier,omitempty"` // The identifier of the CA certificate for this DB instance.; Note: Specifying or updating this property triggers a reboot.; ; Required: No; Type: String; Update requires: No interruptions | |
| CharacterSetName string `json:"CharacterSetName" yaml:"CharacterSetName,omitempty"` // For supported engines, indicates that the DB instance should be associated with the; specified character set.; ; Amazon Aurora:; Not applicable. The character set is managed by the DB cluster. For more information, see; AWS::RDS::DBCluster.; ; Required: No; Type: String; Update requires: Replacement | |
| CopyTagsToSnapshot bool `json:"CopyTagsToSnapshot" yaml:"CopyTagsToSnapshot,omitempty"` // A value that indicates whether to copy tags from the DB instance to snapshots of the DB; instance. By default, tags are not copied.; ; Amazon Aurora:; Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this; value for an Aurora DB instance has no effect on the DB cluster setting.; ; Required: No; Type: Boolean; Update requires: No Replacement | |
| DBClusterIdentifier string `json:"DBClusterIdentifier" yaml:"DBClusterIdentifier,omitempty"` // The identifier of the DB cluster that the instance will belong to.; ; Required: No; Type: String; Update requires: Replacement | |
| DBInstanceClass string `json:"DBInstanceClass" yaml:"DBInstanceClass,omitempty"` // 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: Yes; Type: String; Update requires: No interruption | |
| DBInstanceIdentifier string `json:"DBInstanceIdentifier" yaml:"DBInstanceIdentifier,omitempty"` // 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. For more information, see Name Type.; IMPORTANT: If you specify a name, you cannot perform updates that require replacement of; this resource. You can perform updates that require no or some interruption. If you must; replace the resource, specify a new name.; ; Required: No; Type: String; Update requires: Replacement | |
| DBName string `json:"DBName" yaml:"DBName,omitempty"` // The meaning of this parameter differs according to the database engine you use.; IMPORTANT: If you specify the DBSnapshotIdentifier property, AWS CloudFormation ignores; this property.; IMPORTANT: If you restore DB instances from snapshots, this property doesn't apply to the; MySQL, PostgreSQL, or MariaDB engines.; ; Required: No; Type: String; Update requires: Replacement | |
| DBParameterGroupName string `json:"DBParameterGroupName" yaml:"DBParameterGroupName,omitempty"` // The name of an existing DB parameter group or a reference to an; AWS::RDS::DBParameterGroup resource created in the template.; To list all of the available DB parameter group names, use the following command:; aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName"; --output text; ; Required: No; Type: String; Update requires: Some interruptions | |
| DBSecurityGroups []string `json:"DBSecurityGroups" yaml:"DBSecurityGroups,omitempty"` // 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.; If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also,; note that the EC2VpcId property exists only for backwards compatibility with older; regions and is no longer recommended for providing security information to an RDS DB; instance. Instead, use VPCSecurityGroups.; ; Required: No; Type: List of String; Update requires: No interruption | |
| DBSnapshotIdentifier string `json:"DBSnapshotIdentifier" yaml:"DBSnapshotIdentifier,omitempty"` // 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.; By specifying this property, you can create a DB instance from the specified DB snapshot.; If the DBSnapshotIdentifier property is an empty string or the AWS::RDS::DBInstance; declaration has no DBSnapshotIdentifier property, AWS CloudFormation creates a new; database. If the property contains a value (other than an empty string), AWS; CloudFormation creates a database from the specified snapshot. If a snapshot with the; specified name doesn't exist, AWS CloudFormation can't create the database and it rolls; back the stack.; Some DB instance properties aren't valid when you restore from a snapshot, such as the; MasterUsername and MasterUserPassword properties. For information about the properties; that you can specify, see the RestoreDBInstanceFromDBSnapshot action in the Amazon RDS; API Reference.; After you restore a DB instance with a DBSnapshotIdentifier property, you must specify; the same DBSnapshotIdentifier property for any future updates to the DB instance. When; you specify this property for an update, the DB instance is not restored from the DB; snapshot again, and the data in the database is not changed. However, if you don't; specify the DBSnapshotIdentifier property, an empty DB instance is created, and the; original DB instance is deleted. If you specify a property that is different from the; previous snapshot restore property, a new DB instance is restored from the specified; DBSnapshotIdentifier property, and the original DB instance is deleted.; ; IMPORTANT: If you specify this property, you can't specify the DBName property.; ; Required: No; Type: String; Update requires: Replacement | |
| DBSubnetGroupName string `json:"DBSubnetGroupName" yaml:"DBSubnetGroupName,omitempty"` // 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.; If there's no DB subnet group, then the DB instance isn't a VPC DB instance.; ; Required: No; Type: String; Update requires: Replacement | |
| DeleteAutomatedBackups bool `json:"DeleteAutomatedBackups" yaml:"DeleteAutomatedBackups,omitempty"` // 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 | |
| DeletionProtection bool `json:"DeletionProtection" yaml:"DeletionProtection,omitempty"` // 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. For more information, see Deleting a DB Instance.; ; Required: No; Type: Boolean; Update requires: No interruption | |
| Domain string `json:"Domain" yaml:"Domain,omitempty"` // 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 | |
| DomainIAMRoleName string `json:"DomainIAMRoleName" yaml:"DomainIAMRoleName,omitempty"` // 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 | |
| EnableCloudwatchLogsExports []string `json:"EnableCloudwatchLogsExports" yaml:"EnableCloudwatchLogsExports,omitempty"` // 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 Relational Database; Service User Guide.; ; Required: No; Type: List of String; Update requires: No interruption | |
| EnableIAMDatabaseAuthentication bool `json:"EnableIAMDatabaseAuthentication" yaml:"EnableIAMDatabaseAuthentication,omitempty"` // 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 | |
| EnablePerformanceInsights bool `json:"EnablePerformanceInsights" yaml:"EnablePerformanceInsights,omitempty"` // A value that indicates whether to enable Performance Insights for the DB instance.; ; Required: No; Type: Boolean; Update requires: No interruption | |
| Engine DBEngine `json:"Engine" yaml:"Engine,omitempty"` // The name of the database engine that you want to use for this DB instance.; Note: If you don't specify a value for the DBParameterGroupName property, the default; DBParameterGroup for the specified engine is used.; ; Required: No; Type: String; Update requires: Replacement | |
| EngineVersion string `json:"EngineVersion" yaml:"EngineVersion,omitempty"` // The version number of the database engine to use.; For a list of valid engine versions, use the DescribeDBEngineVersions action.; ; Required: No; Type: String; Update requires: Some interruptions | |
| Iops float64 `json:"Iops" yaml:"Iops,omitempty"` // The number of I/O operations per second (IOPS) that the database provisions. The value; must be equal to or greater than 1000.; If you specify this property, you must follow the range of allowed ratios of your; requested IOPS rate to the amount of storage that you allocate (IOPS to allocated; storage). For example, you can provision an Oracle database instance with 1000 IOPS and; 200 GB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GB of storage (a ratio; of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve; Performance in the Amazon RDS User Guide.; Note: If you specify io1 for the StorageType property, then you must also specify the; Iops property.; ; Required: No; Type: Integer; Update requires: No interruption | |
| KmsKeyID string `json:"KmsKeyId" yaml:"KmsKeyId,omitempty"` // The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the; DB instance, 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, AWS CloudFormation; uses the default master key. If you specify this property, you must set the; StorageEncrypted property to true.; If you specify the SourceDBInstanceIdentifier property, the value is inherited from the; source DB instance if the Read Replica is created in the same region.; If you create an encrypted Read Replica in a different AWS Region, then you must specify; a KMS key for the destination AWS Region. KMS encryption keys are specific to the region; that they're created in, and you can't use encryption keys from one region in another; region.; If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify; both a security group and this property, you must use a VPC security group. For more; information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon; RDS User Guide.; ; Required: No; Type: String; Update requires: Replacement | |
| LicenseModel LicenseModel `json:"LicenseModel" yaml:"LicenseModel,omitempty"` // License model information for this DB instance.; Note: If you've specified DBSecurityGroups and then you update the license model, AWS; CloudFormation replaces the underlying DB instance. This will incur some interruptions to; database availability.; ; Required: No; Type: String; Update requires: No interruption | |
| MasterUsername string `json:"MasterUsername" yaml:"MasterUsername,omitempty"` // The master user name for the DB instance.; Note: If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property,; don't specify this property. The value is inherited from the source DB instance or; snapshot.; ; Required: No; Type: String; Update requires: Replacement | |
| MasterUserPassword string `json:"MasterUserPassword" yaml:"MasterUserPassword,omitempty"` // The password for the master user. The password can include any printable ASCII character; except "/", """, or "@".; ; Required: No; Type: String; Update requires: No interruption | |
| MaxAllocatedStorage float64 `json:"MaxAllocatedStorage" yaml:"MaxAllocatedStorage,omitempty"` // The upper limit to which Amazon RDS can automatically scale the storage of the DB; instance.; ; Required: No; Type: Integer; Update requires: No interruption | |
| MonitoringInterval float64 `json:"MonitoringInterval" yaml:"MonitoringInterval,omitempty"` // 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 0.; If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value; other than 0.; ; Required: No; Type: List of DBInstanceRole; Update requires: Some interruptions | |
| MonitoringRoleArn string `json:"MonitoringRoleArn" yaml:"MonitoringRoleArn,omitempty"` // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon; CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on; creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the; Amazon RDS User Guide.; If MonitoringInterval is set to a value other than 0, then you must supply a; MonitoringRoleArn value.; ; Required: No; Type: String; Update requires: No interruption | |
| MultiAZ bool `json:"MultiAZ" yaml:"MultiAZ,omitempty"` // Specifies whether the database instance is a multiple Availability Zone deployment. You; can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Amazon; Aurora storage is replicated across all the Availability Zones and doesn't require the; MultiAZ option to be set.; ; Required: No; Type: Boolean; Update requires: Some interruptions | |
| OptionGroupName string `json:"OptionGroupName" yaml:"OptionGroupName,omitempty"` // Indicates that the DB instance should be associated with the specified option group.; Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be; removed from an option group. Also, that option group can't be removed from a DB instance; once it is associated with a DB instance.; ; Required: No; Type: String; Update requires: No interruption | |
| PerformanceInsightsKMSKeyID string `json:"PerformanceInsightsKMSKeyId" yaml:"PerformanceInsightsKMSKeyId,omitempty"` // 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.; If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your; default encryption key. AWS KMS creates the default encryption key for your AWS account.; Your AWS account has a different default encryption key for each AWS Region.; ; Required: No; Type: String; Update requires: Some interruptions | |
| PerformanceInsightsRetentionPeriod float64 `json:"PerformanceInsightsRetentionPeriod" yaml:"PerformanceInsightsRetentionPeriod,omitempty"` // 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 | |
| Port string `json:"Port" yaml:"Port,omitempty"` // The port number on which the database accepts connections.; ; Required: No; Type: String; Update requires: Replacement | |
| PreferredBackupWindow string `json:"PreferredBackupWindow" yaml:"PreferredBackupWindow,omitempty"` // The daily time range during which automated backups are created if automated backups are; enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup; Window in the Amazon RDS User Guide.; ; Required: No; Type: String; Update requires: No interruption | |
| PreferredMaintenanceWindow string `json:"PreferredMaintenanceWindow" yaml:"PreferredMaintenanceWindow,omitempty"` // The weekly time range during which system maintenance can occur, in Universal Coordinated; Time (UTC).; Format: ddd:hh24:mi-ddd:hh24:mi; 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 Instance Maintenance Window in the Amazon RDS User Guide.; Constraints: Minimum 30-minute window.; ; Required: No; Type: String; Update requires: Some interruptions | |
| ProcessorFeatures []ProcessorFeature `json:"ProcessorFeatures" yaml:"ProcessorFeatures,omitempty"` // 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 | |
| PromotionTier float64 `json:"PromotionTier" yaml:"PromotionTier,omitempty"` // 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. For more information, see; Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.; Default: 1; Valid Values: 0 - 15; ; Required: No; Type: Integer; Update requires: No interruption | |
| PubliclyAccessible bool `json:"PubliclyAccessible" yaml:"PubliclyAccessible,omitempty"` // 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.; The default behavior value depends on your VPC setup and the database subnet group. For; more information, see the PubliclyAccessible parameter in CreateDBInstance in the Amazon; RDS API Reference.; If this resource has a public IP address and is also in a VPC that is defined in the same; template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway; attachment. For more information, see DependsOn Attribute.; Note: If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To; specify a security group and this property, you must use a VPC security group. For more; information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon; RDS User Guide.; ; Required: No; Type: Boolean; Update requires: Replacement | |
| SourceDBInstanceIdentifier string `json:"SourceDBInstanceIdentifier" yaml:"SourceDBInstanceIdentifier,omitempty"` // 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. For more; information, see Working with Read Replicas in the Amazon Relational Database Service; Developer Guide.; The SourceDBInstanceIdentifier property determines whether a DB instance is a Read; Replica. If you remove the SourceDBInstanceIdentifier property from your template and; then update your stack, AWS CloudFormation deletes the Read Replica and creates a new DB; instance (not a Read Replica).; ; Required: No; Type: String; Update requires: Replacement | |
| SourceRegion string `json:"SourceRegion" yaml:"SourceRegion,omitempty"` // The ID of the region that contains the source DB instance for the Read Replica.; ; Required: No; Type: String; Update requires: Replacement | |
| StorageEncrypted bool `json:"StorageEncrypted" yaml:"StorageEncrypted,omitempty"` // A value that indicates whether the DB instance is encrypted. By default, it isn't; encrypted.; ; Required: No; Type: Boolean; Update requires: Replacement | |
| StorageType StorageType `json:"StorageType" yaml:"StorageType,omitempty"` // Specifies the storage type to be associated with the DB instance.; Valid values: standard | gp2 | io1; The standard value is also known as magnetic.; If you specify io1, you must also include a value for the Iops parameter.; ; Default: io1 if the Iops parameter is specified, otherwise standard; Required: No; Type: String; Update requires: Some interruptions | |
| Tags []Tag `json:"Tags" yaml:"Tags,omitempty"` // Tags to assign to the DB instance.; ; Required: No; Type: List of Tags; Update requires: No interruption | |
| Timezone string `json:"Timezone" yaml:"Timezone,omitempty"` // 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 | |
| UseDefaultProcessorFeatures bool `json:"UseDefaultProcessorFeatures" yaml:"UseDefaultProcessorFeatures,omitempty"` // 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 | |
| VPCSecurityGroups []string `json:"VPCSecurityGroups" yaml:"VPCSecurityGroups,omitempty"` // 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.; If you plan to update the resource, don't specify VPC security groups in a shared VPC.; If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa.; ; Required: No; Type: List of String; Update requires: No interruption | |
| } | |
| // Describes an AWS Identity and Access Management (IAM) role that is associated with a DB | |
| // instance. | |
| type DBInstanceRole struct { | |
| FeatureName string `json:"FeatureName" yaml:"FeatureName,omitempty"` // 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. For the list of supported feature; names, see DBEngineVersion in the Amazon RDS API Reference.; ; Required: Yes; Type: String; Update requires: No interruptions | |
| RoleArn string `json:"RoleArn" yaml:"RoleArn,omitempty"` // The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.; ; Required: Yes; Type: String; Update requires: No interruptions | |
| } | |
| // The ProcessorFeature property type specifies the processor features of a DB instance | |
| // class status. | |
| type ProcessorFeature struct { | |
| Name string `json:"Name" yaml:"Name,omitempty"` // The name of the processor feature. Valid names are coreCount and threadsPerCore.; ; Required: No; Type: String; Update requires: No interruptions | |
| Value string `json:"Value" yaml:"Value,omitempty"` // The value of a processor feature name.; ; Required: No; Type: String; Update requires: No interruptions | |
| } | |
| // You can use the Resource Tags property to apply tags to resources, which can help you | |
| // identify and categorize those resources. You can tag only resources for which AWS | |
| // CloudFormation supports tagging. For information about which resources you can tag with | |
| // AWS CloudFormation, see the individual resources in AWS resource and property types | |
| // reference. | |
| type Tag struct { | |
| Key string `json:"Key" yaml:"Key,omitempty"` // 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 | |
| Value string `json:"Value" yaml:"Value,omitempty"` // 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: Yes; Type: String | |
| } | |
| // The name of the database engine that you want to use for this DB instance. | |
| // Note: If you don't specify a value for the DBParameterGroupName property, the default | |
| // DBParameterGroup for the specified engine is used. | |
| // | |
| // Required: No | |
| // Type: String | |
| // Update requires: Replacement | |
| type DBEngine string | |
| const ( | |
| Aurora DBEngine = "aurora" | |
| AuroraMysql DBEngine = "aurora-mysql" | |
| AuroraPostgresql DBEngine = "aurora-postgresql" | |
| Mariadb DBEngine = "mariadb" | |
| Mysql DBEngine = "mysql" | |
| OracleEe DBEngine = "oracle-ee" | |
| OracleSE DBEngine = "oracle-se" | |
| OracleSe1 DBEngine = "oracle-se1" | |
| OracleSe2 DBEngine = "oracle-se2" | |
| Postgres DBEngine = "postgres" | |
| SqlserverEe DBEngine = "sqlserver_ee" | |
| SqlserverEx DBEngine = "sqlserver_ex" | |
| SqlserverSE DBEngine = "sqlserver_se" | |
| SqlserverWeb DBEngine = "sqlserver_web" | |
| ) | |
| // License model information for this DB instance. | |
| // Note: If you've specified DBSecurityGroups and then you update the license model, AWS | |
| // CloudFormation replaces the underlying DB instance. This will incur some interruptions to | |
| // database availability. | |
| // | |
| // Required: No | |
| // Type: String | |
| // Update requires: No interruption | |
| type LicenseModel string | |
| const ( | |
| BringYourOwnLicense LicenseModel = "bring-your-own-license" | |
| GeneralPublicLicense LicenseModel = "general-public-license" | |
| LicenseIncluded LicenseModel = "license-included" | |
| ) | |
| // Specifies the storage type to be associated with the DB instance. | |
| // Valid values: standard | gp2 | io1 | |
| // The standard value is also known as magnetic. | |
| // If you specify io1, you must also include a value for the Iops parameter. | |
| // | |
| // Default: io1 if the Iops parameter is specified, otherwise standard | |
| // Required: No | |
| // Type: String | |
| // Update requires: Some interruptions | |
| type StorageType string | |
| const ( | |
| Gp2 StorageType = "gp2" | |
| Io1 StorageType = "io1" | |
| Standard StorageType = "standard" | |
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| export interface CloudFormationRDSDBInstance { | |
| Type: string | |
| Properties: DBInstanceProperties | |
| } | |
| enum DBEngine { | |
| AURORA = "aurora", | |
| AURORA_MYQSL = "aurora-mysql", | |
| AURORA_POSTGRESQL = "aurora-postgresql", | |
| MARIADB = "mariadb", | |
| MYSQL = "mysql", | |
| ORACLE_EE = "oracle-ee", | |
| ORACLE_SE2 = "oracle-se2", | |
| ORACLE_SE1 = "oracle-se1", | |
| ORACLE_SE = "oracle-se", | |
| POSTGRES = "postgres", | |
| SQL_SERVER_EE = "sqlserver_ee", | |
| SQL_SERVER_SE = "sqlserver_se", | |
| SQL_SERVER_EX = "sqlserver_ex", | |
| SQL_SERVER_WEB = "sqlserver_web", | |
| } | |
| export interface DBInstanceProperties { | |
| /** | |
| * The amount of storage (in gigabytes) to be initially allocated for the database instance. | |
| * Note: If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GB increments). | |
| * | |
| * Required: Conditional | |
| * Type: String | |
| * Update requires: No interruption | |
| */ | |
| AllocatedStorage: string | |
| /** | |
| * 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. | |
| * Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. | |
| * | |
| * Required: No | |
| * Type: Boolean | |
| * Update requires: No interruption | |
| */ | |
| AllowMajorVersionUpgrade: boolean | |
| /** | |
| * The AWS Identity and Access Management (IAM) roles associated with the DB instance. | |
| * | |
| * Required: No | |
| * Type: List of DBInstanceRole | |
| * Update requires: No interruption | |
| */ | |
| AssociatedRoles: DBInstanceRole[] | |
| /** | |
| * 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 | |
| */ | |
| AutoMinorVersionUpgrade: boolean | |
| /** | |
| * The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones. | |
| * | |
| * Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. | |
| * Example: us-east-1d | |
| * Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| AvailabilityZone: string | |
| /** | |
| * 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. | |
| * | |
| * Amazon Aurora: | |
| * Not applicable. The retention period for automated backups is managed by the DB cluster. | |
| * | |
| * Default: 1 | |
| * | |
| * Constraints: | |
| * - Must be a value from 0 to 35 | |
| * - Can't be set to 0 if the DB instance is a source to Read Replicas | |
| * | |
| * Required: No | |
| * Type: Integer | |
| * Update requires: Some interruptions | |
| */ | |
| BackupRetentionPeriod: number | |
| /** | |
| * The identifier of the CA certificate for this DB instance. | |
| * Note: Specifying or updating this property triggers a reboot. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: No interruptions | |
| */ | |
| CACertificateIdentifier: string | |
| /** | |
| * For supported engines, indicates that the DB instance should be associated with the specified character set. | |
| * | |
| * Amazon Aurora: | |
| * Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| CharacterSetName: string | |
| /** | |
| * A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. | |
| * | |
| * Amazon Aurora: | |
| * Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. | |
| * | |
| * Required: No | |
| * Type: Boolean | |
| * Update requires: No Replacement | |
| */ | |
| CopyTagsToSnapshot: boolean | |
| /** | |
| * The identifier of the DB cluster that the instance will belong to. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| DBClusterIdentifier: string | |
| /** | |
| * 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: Yes | |
| * Type: String | |
| * Update requires: No interruption | |
| */ | |
| DBInstanceClass: string | |
| /** | |
| * 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. For more information, see Name Type. | |
| * IMPORTANT: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| DBInstanceIdentifier: string | |
| /** | |
| * The meaning of this parameter differs according to the database engine you use. | |
| * IMPORTANT: If you specify the DBSnapshotIdentifier property, AWS CloudFormation ignores this property. | |
| * IMPORTANT: If you restore DB instances from snapshots, this property doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| DBName: string | |
| /** | |
| * The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. | |
| * To list all of the available DB parameter group names, use the following command: | |
| * aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Some interruptions | |
| */ | |
| DBParameterGroupName: string | |
| /** | |
| * 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. | |
| * If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the EC2VpcId property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. | |
| * | |
| * Required: No | |
| * Type: List of String | |
| * Update requires: No interruption | |
| */ | |
| DBSecurityGroups: string[] | |
| /** | |
| * 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. | |
| * By specifying this property, you can create a DB instance from the specified DB snapshot. If the DBSnapshotIdentifier property is an empty string or the AWS::RDS::DBInstance declaration has no DBSnapshotIdentifier property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. | |
| * Some DB instance properties aren't valid when you restore from a snapshot, such as the MasterUsername and MasterUserPassword properties. For information about the properties that you can specify, see the RestoreDBInstanceFromDBSnapshot action in the Amazon RDS API Reference. | |
| * After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted. | |
| * | |
| * IMPORTANT: If you specify this property, you can't specify the DBName property. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| DBSnapshotIdentifier: string | |
| /** | |
| * 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. | |
| * If there's no DB subnet group, then the DB instance isn't a VPC DB instance. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| DBSubnetGroupName: string | |
| /** | |
| * 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 | |
| */ | |
| DeleteAutomatedBackups: boolean | |
| /** | |
| * 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. For more information, see Deleting a DB Instance. | |
| * | |
| * Required: No | |
| * Type: Boolean | |
| * Update requires: No interruption | |
| */ | |
| DeletionProtection: boolean | |
| /** | |
| * 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 | |
| */ | |
| Domain: string | |
| /** | |
| * 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 | |
| */ | |
| DomainIAMRoleName: string | |
| /** | |
| * 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 Relational Database Service User Guide. | |
| * | |
| * Required: No | |
| * Type: List of String | |
| * Update requires: No interruption | |
| */ | |
| EnableCloudwatchLogsExports: string[] | |
| /** | |
| * 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 | |
| */ | |
| EnableIAMDatabaseAuthentication: boolean | |
| /** | |
| * A value that indicates whether to enable Performance Insights for the DB instance. | |
| * | |
| * Required: No | |
| * Type: Boolean | |
| * Update requires: No interruption | |
| */ | |
| EnablePerformanceInsights: boolean | |
| /** | |
| * The name of the database engine that you want to use for this DB instance. | |
| * Note: If you don't specify a value for the DBParameterGroupName property, the default DBParameterGroup for the specified engine is used. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| Engine: DBEngine | |
| /** | |
| * The version number of the database engine to use. | |
| * For a list of valid engine versions, use the DescribeDBEngineVersions action. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Some interruptions | |
| */ | |
| EngineVersion: string | |
| /** | |
| * The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. | |
| * If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. | |
| * Note: If you specify io1 for the StorageType property, then you must also specify the Iops property. | |
| * | |
| * Required: No | |
| * Type: Integer | |
| * Update requires: No interruption | |
| */ | |
| Iops: number | |
| /** | |
| * The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance, 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, AWS CloudFormation uses the default master key. If you specify this property, you must set the StorageEncrypted property to true. | |
| * If you specify the SourceDBInstanceIdentifier property, the value is inherited from the source DB instance if the Read Replica is created in the same region. | |
| * If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. | |
| * If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| KmsKeyId: string | |
| /** | |
| * License model information for this DB instance. | |
| * Note: If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: No interruption | |
| */ | |
| LicenseModel: | |
| | "license-included" | |
| | "bring-your-own-license" | |
| | "general-public-license" | |
| /** | |
| * The master user name for the DB instance. | |
| * Note: If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| MasterUsername: string | |
| /** | |
| * The password for the master user. The password can include any printable ASCII character except "/", """, or "@". | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: No interruption | |
| */ | |
| MasterUserPassword: string | |
| /** | |
| * The upper limit to which Amazon RDS can automatically scale the storage of the DB instance. | |
| * | |
| * Required: No | |
| * Type: Integer | |
| * Update requires: No interruption | |
| */ | |
| MaxAllocatedStorage: number | |
| /** | |
| * 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 0. | |
| * If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. | |
| * | |
| * Required: No | |
| * Type: List of DBInstanceRole | |
| * Update requires: Some interruptions | |
| */ | |
| MonitoringInterval: 0 | 1 | 5 | 10 | 15 | 30 | 60 | |
| /** | |
| * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. | |
| * If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: No interruption | |
| */ | |
| MonitoringRoleArn: string | |
| /** | |
| * Specifies whether the database instance is a multiple Availability Zone deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Amazon Aurora storage is replicated across all the Availability Zones and doesn't require the MultiAZ option to be set. | |
| * | |
| * Required: No | |
| * Type: Boolean | |
| * Update requires: Some interruptions | |
| */ | |
| MultiAZ: boolean | |
| /** | |
| * Indicates that the DB instance should be associated with the specified option group. | |
| * Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: No interruption | |
| */ | |
| OptionGroupName: string | |
| /** | |
| * 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. | |
| * If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Some interruptions | |
| */ | |
| PerformanceInsightsKMSKeyId: string | |
| /** | |
| * 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 | |
| */ | |
| PerformanceInsightsRetentionPeriod: 7 | 731 | |
| /** | |
| * The port number on which the database accepts connections. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| Port: string | |
| /** | |
| * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: No interruption | |
| */ | |
| PreferredBackupWindow: string | |
| /** | |
| * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). | |
| * Format: ddd:hh24:mi-ddd:hh24:mi | |
| * 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 Instance Maintenance Window in the Amazon RDS User Guide. | |
| * Constraints: Minimum 30-minute window. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Some interruptions | |
| */ | |
| PreferredMaintenanceWindow: string | |
| /** | |
| * 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 | |
| */ | |
| ProcessorFeatures: ProcessorFeature[] | |
| /** | |
| * 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. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. | |
| * Default: 1 | |
| * Valid Values: 0 - 15 | |
| * | |
| * Required: No | |
| * Type: Integer | |
| * Update requires: No interruption | |
| */ | |
| PromotionTier: number | |
| /** | |
| * 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. | |
| * The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in CreateDBInstance in the Amazon RDS API Reference. | |
| * If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment. For more information, see DependsOn Attribute. | |
| * Note: If you specify DBSecurityGroups, AWS CloudFormation ignores this property. To specify a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. | |
| * | |
| * Required: No | |
| * Type: Boolean | |
| * Update requires: Replacement | |
| */ | |
| PubliclyAccessible: boolean | |
| /** | |
| * 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. For more information, see Working with Read Replicas in the Amazon Relational Database Service Developer Guide. | |
| * The SourceDBInstanceIdentifier property determines whether a DB instance is a Read Replica. If you remove the SourceDBInstanceIdentifier property from your template and then update your stack, AWS CloudFormation deletes the Read Replica and creates a new DB instance (not a Read Replica). | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| SourceDBInstanceIdentifier: string | |
| /** | |
| * The ID of the region that contains the source DB instance for the Read Replica. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: Replacement | |
| */ | |
| SourceRegion: string | |
| /** | |
| * A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. | |
| * | |
| * Required: No | |
| * Type: Boolean | |
| * Update requires: Replacement | |
| */ | |
| StorageEncrypted: boolean | |
| /** | |
| * Specifies the storage type to be associated with the DB instance. | |
| * Valid values: standard | gp2 | io1 | |
| * The standard value is also known as magnetic. | |
| * If you specify io1, you must also include a value for the Iops parameter. | |
| * | |
| * Default: io1 if the Iops parameter is specified, otherwise standard | |
| * Required: No | |
| * Type: String | |
| * Update requires: Some interruptions | |
| */ | |
| StorageType: "standard" | "gp2" | "io1" | |
| /** | |
| * Tags to assign to the DB instance. | |
| * | |
| * Required: No | |
| * Type: List of Tags | |
| * Update requires: No interruption | |
| */ | |
| Tags: Tag[] | |
| /** | |
| * 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 | |
| */ | |
| Timezone: string | |
| /** | |
| * 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 | |
| */ | |
| UseDefaultProcessorFeatures: boolean | |
| /** | |
| * 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. | |
| * If you plan to update the resource, don't specify VPC security groups in a shared VPC. | |
| * If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. | |
| * | |
| * Required: No | |
| * Type: List of String | |
| * Update requires: No interruption | |
| */ | |
| VPCSecurityGroups: string[] | |
| } | |
| /** | |
| * Describes an AWS Identity and Access Management (IAM) role that is associated with a DB instance. | |
| */ | |
| export interface DBInstanceRole { | |
| /** | |
| * 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. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference. | |
| * | |
| * Required: Yes | |
| * Type: String | |
| * Update requires: No interruptions | |
| */ | |
| FeatureName: string | |
| /** | |
| * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. | |
| * | |
| * Required: Yes | |
| * Type: String | |
| * Update requires: No interruptions | |
| */ | |
| RoleArn: string | |
| } | |
| /** | |
| * The ProcessorFeature property type specifies the processor features of a DB instance class status. | |
| */ | |
| export interface ProcessorFeature { | |
| /** | |
| * The name of the processor feature. Valid names are coreCount and threadsPerCore. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: No interruptions | |
| */ | |
| Name: string | |
| /** | |
| * The value of a processor feature name. | |
| * | |
| * Required: No | |
| * Type: String | |
| * Update requires: No interruptions | |
| */ | |
| Value: string | |
| } | |
| /** | |
| * You can use the Resource Tags property to apply tags to resources, which can help you identify and categorize those resources. You can tag only resources for which AWS CloudFormation supports tagging. For information about which resources you can tag with AWS CloudFormation, see the individual resources in AWS resource and property types reference. | |
| * | |
| */ | |
| export interface Tag { | |
| /** | |
| * 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 | |
| */ | |
| Key: string | |
| /** | |
| * 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: Yes | |
| * Type: String | |
| */ | |
| Value: string | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment