@Stability(value=Stable) @Internal public static final class CfnDBInstanceProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnDBInstanceProps
CfnDBInstancePropssoftware.amazon.jsii.JsiiObject.InitializationModeCfnDBInstanceProps.Builder, CfnDBInstanceProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CfnDBInstanceProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CfnDBInstanceProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
String |
getAllocatedStorage()
The amount of storage (in gigabytes) to be initially allocated for the database instance.
|
Object |
getAllowMajorVersionUpgrade()
A value that indicates whether major version upgrades are allowed.
|
Object |
getAssociatedRoles()
The AWS Identity and Access Management (IAM) roles associated with the DB instance.
|
Object |
getAutoMinorVersionUpgrade()
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.
|
String |
getAvailabilityZone()
The Availability Zone (AZ) where the database will be created.
|
Number |
getBackupRetentionPeriod()
The number of days for which automated backups are retained.
|
String |
getCaCertificateIdentifier()
The identifier of the CA certificate for this DB instance.
|
String |
getCharacterSetName()
For supported engines, indicates that the DB instance should be associated with the specified character set.
|
Object |
getCopyTagsToSnapshot()
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
|
String |
getDbClusterIdentifier()
The identifier of the DB cluster that the instance will belong to.
|
String |
getDbInstanceClass()
The compute and memory capacity of the DB instance, for example, `db.m4.large` .
|
String |
getDbInstanceIdentifier()
A name for the DB instance.
|
String |
getDbName()
The meaning of this parameter differs according to the database engine you use.
|
String |
getDbParameterGroupName()
The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
|
List<String> |
getDbSecurityGroups()
A list of the DB security groups to assign to the DB instance.
|
String |
getDbSnapshotIdentifier()
The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.
|
String |
getDbSubnetGroupName()
A DB subnet group to associate with the DB instance.
|
Object |
getDeleteAutomatedBackups()
A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
|
Object |
getDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
String |
getDomain()
The Active Directory directory ID to create the DB instance in.
|
String |
getDomainIamRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
Object |
getEnableIamDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
|
Object |
getEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB instance.
|
String |
getEngine()
The name of the database engine that you want to use for this DB instance.
|
String |
getEngineVersion()
The version number of the database engine to use.
|
Number |
getIops()
The number of I/O operations per second (IOPS) that the database provisions.
|
String |
getKmsKeyId()
The ARN of the AWS KMS key that's used to encrypt the DB instance, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
|
String |
getLicenseModel()
License model information for this DB instance.
|
String |
getMasterUsername()
The master user name for the DB instance.
|
String |
getMasterUserPassword()
The password for the master user.
|
Number |
getMaxAllocatedStorage()
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
|
Number |
getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
String |
getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
Object |
getMultiAz()
Specifies whether the database instance is a Multi-AZ DB instance deployment.
|
String |
getOptionGroupName()
Indicates that the DB instance should be associated with the specified option group.
|
String |
getPerformanceInsightsKmsKeyId()
The AWS KMS key identifier for encryption of Performance Insights data.
|
Number |
getPerformanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data.
|
String |
getPort()
The port number on which the database accepts connections.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.
|
String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
Object |
getProcessorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
Number |
getPromotionTier()
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.
|
Object |
getPubliclyAccessible()
Indicates whether the DB instance is an internet-facing instance.
|
String |
getSourceDbInstanceIdentifier()
If you want to create a read replica DB instance, specify the ID of the source DB instance.
|
String |
getSourceRegion()
The ID of the region that contains the source DB instance for the read replica.
|
Object |
getStorageEncrypted()
A value that indicates whether the DB instance is encrypted.
|
String |
getStorageType()
Specifies the storage type to be associated with the DB instance.
|
List<CfnTag> |
getTags()
Tags to assign to the DB instance.
|
String |
getTimezone()
The time zone of the DB instance.
|
Object |
getUseDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
List<String> |
getVpcSecurityGroups()
A list of the VPC security group IDs to assign to the DB instance.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnDBInstanceProps.Builder builder)
CfnDBInstanceProps.Builder.public final String getAllocatedStorage()
CfnDBInstanceProps
If any value is set in the
Iopsparameter,AllocatedStoragemust be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIopsvalue (in 1,000 IOPS increments), then you must also increase theAllocatedStoragevalue (in 100-GiB increments).
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
MariaDB
Constraints to the amount of storage for each storage type are the following:
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
Oracle
Constraints to the amount of storage for each storage type are the following:
SQL Server
Constraints to the amount of storage for each storage type are the following:
getAllocatedStorage in interface CfnDBInstancePropspublic final Object getAllowMajorVersionUpgrade()
CfnDBInstancePropsChanging 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.
getAllowMajorVersionUpgrade in interface CfnDBInstancePropspublic final Object getAssociatedRoles()
CfnDBInstancePropsAmazon Aurora
Not applicable. The associated roles are managed by the DB cluster.
getAssociatedRoles in interface CfnDBInstancePropspublic final Object getAutoMinorVersionUpgrade()
CfnDBInstancePropsBy default, minor engine upgrades are applied automatically.
getAutoMinorVersionUpgrade in interface CfnDBInstancePropspublic final String getAvailabilityZone()
CfnDBInstancePropsFor information on AWS Regions and Availability Zones, see Regions and Availability Zones .
Amazon Aurora
Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
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.
getAvailabilityZone in interface CfnDBInstancePropspublic final Number getBackupRetentionPeriod()
CfnDBInstancePropsSetting 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:
getBackupRetentionPeriod in interface CfnDBInstancePropspublic final String getCaCertificateIdentifier()
CfnDBInstanceProps
Specifying or updating this property triggers a reboot.
For more information about CA certificate identifiers for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide .
For more information about CA certificate identifiers for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide .
getCaCertificateIdentifier in interface CfnDBInstancePropspublic final String getCharacterSetName()
CfnDBInstancePropsAmazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster .
getCharacterSetName in interface CfnDBInstancePropspublic final Object getCopyTagsToSnapshot()
CfnDBInstancePropsBy 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.
getCopyTagsToSnapshot in interface CfnDBInstancePropspublic final String getDbClusterIdentifier()
CfnDBInstancePropsgetDbClusterIdentifier in interface CfnDBInstancePropspublic final String getDbInstanceClass()
CfnDBInstancePropsFor the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. For more information about DB instance class pricing and AWS Region support for DB instance classes, see Amazon RDS Pricing .
getDbInstanceClass in interface CfnDBInstancePropspublic final String getDbInstanceIdentifier()
CfnDBInstancePropsIf 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 .
For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide .
If you specify a name, you can't 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.
getDbInstanceIdentifier in interface CfnDBInstancePropspublic final String getDbName()
CfnDBInstanceProps
If you specify the
[DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)property, this property only applies to RDS for Oracle.
Amazon Aurora
Not applicable. The database name is managed by the DB cluster.
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
MariaDB
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default postgres database is created in the DB instance.
Constraints:
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null , the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName .
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
getDbName in interface CfnDBInstancePropspublic final String getDbParameterGroupName()
CfnDBInstancePropsTo list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
If you don't specify a value for the DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
getDbParameterGroupName in interface CfnDBInstancePropspublic final List<String> getDbSecurityGroups()
CfnDBInstancePropsThe 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 DBSecurityGroups 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.
If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:
AllocatedStorageAutoMinorVersionUpgradeAvailabilityZoneBackupRetentionPeriodCharacterSetNameDBInstanceClassDBNameDBParameterGroupNameDBSecurityGroupsDBSubnetGroupNameEngineEngineVersionIopsLicenseModelMasterUsernameMasterUserPasswordMultiAZOptionGroupNamePreferredBackupWindowPreferredMaintenanceWindowAll other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as
StorageType,StorageEncrypted, orKmsKeyId. If you're already using theDBSecurityGroupsproperty, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
getDbSecurityGroups in interface CfnDBInstancePropspublic final String getDbSnapshotIdentifier()
CfnDBInstancePropsIf 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.
If you specify the DBSnapshotIdentifier property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:
CharacterSetNameDBClusterIdentifierDBNameDeleteAutomatedBackupsEnablePerformanceInsightsKmsKeyIdMasterUsernameMasterUserPasswordPerformanceInsightsKMSKeyIdPerformanceInsightsRetentionPeriodPromotionTierSourceDBInstanceIdentifierSourceRegionStorageEncrypted (for an encrypted snapshot)TimezoneAmazon Aurora
Not applicable. Snapshot restore is managed by the DB cluster.
getDbSnapshotIdentifier in interface CfnDBInstancePropspublic final String getDbSubnetGroupName()
CfnDBInstancePropsIf 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.
For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide .
Amazon Aurora
Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
getDbSubnetGroupName in interface CfnDBInstancePropspublic final Object getDeleteAutomatedBackups()
CfnDBInstancePropsThis parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
getDeleteAutomatedBackups in interface CfnDBInstancePropspublic final Object getDeletionProtection()
CfnDBInstancePropsThe database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance .
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster . DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
getDeletionProtection in interface CfnDBInstancePropspublic final String getDomain()
CfnDBInstancePropsCurrently, only Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
getDomain in interface CfnDBInstancePropspublic final String getDomainIamRoleName()
CfnDBInstancePropsThis setting doesn't apply to RDS Custom.
getDomainIamRoleName in interface CfnDBInstancePropspublic final List<String> getEnableCloudwatchLogsExports()
CfnDBInstancePropsThe 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 .
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
MariaDB
Valid values: audit , error , general , slowquery
Microsoft SQL Server
Valid values: agent , error
MySQL
Valid values: audit , error , general , slowquery
Oracle
Valid values: alert , audit , listener , trace
PostgreSQL
Valid values: postgresql , upgrade
getEnableCloudwatchLogsExports in interface CfnDBInstancePropspublic final Object getEnableIamDatabaseAuthentication()
CfnDBInstancePropsBy default, mapping is disabled.
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
getEnableIamDatabaseAuthentication in interface CfnDBInstancePropspublic final Object getEnablePerformanceInsights()
CfnDBInstancePropsFor more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
getEnablePerformanceInsights in interface CfnDBInstancePropspublic final String getEngine()
CfnDBInstanceProps
When you are creating a DB instance, the
Engineproperty is required.
Valid Values:
aurora (for MySQL 5.6-compatible Aurora)aurora-mysql (for MySQL 5.7-compatible Aurora)aurora-postgresqlmariadbmysqloracle-eeoracle-se2oracle-se1oracle-sepostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webgetEngine in interface CfnDBInstancePropspublic final String getEngineVersion()
CfnDBInstanceProps
For a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
MariaDB
See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
getEngineVersion in interface CfnDBInstancePropspublic final Number getIops()
CfnDBInstancePropsThe 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 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB 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 .
If you specify
io1for theStorageTypeproperty, then you must also specify theIopsproperty.
getIops in interface CfnDBInstancePropspublic final String getKmsKeyId()
CfnDBInstancePropsIf you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS 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 the SnapshotIdentifier property, the StorageEncrypted property value is inherited from the snapshot, and if the DB instance is encrypted, the specified KmsKeyId property is used.
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 .
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster.
getKmsKeyId in interface CfnDBInstancePropspublic final String getLicenseModel()
CfnDBInstancePropsValid values:
general-public-licensepostgresql-licensegeneral-public-licenselicense-includedgeneral-public-licensebring-your-own-license or license-includedpostgresql-license
If you've specified
DBSecurityGroupsand then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.
getLicenseModel in interface CfnDBInstancePropspublic final String getMasterUsername()
CfnDBInstanceProps
If you specify the
SourceDBInstanceIdentifierorDBSnapshotIdentifierproperty, don't specify this property. The value is inherited from the source DB instance or snapshot.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
MariaDB
Constraints:
Microsoft SQL Server
Constraints:
MySQL
Constraints:
Oracle
Constraints:
PostgreSQL
Constraints:
getMasterUsername in interface CfnDBInstancePropspublic final String getMasterUserPassword()
CfnDBInstancePropsAmazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
getMasterUserPassword in interface CfnDBInstancePropspublic final Number getMaxAllocatedStorage()
CfnDBInstancePropsFor more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
getMaxAllocatedStorage in interface CfnDBInstancePropspublic final Number getMonitoringInterval()
CfnDBInstancePropsTo disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
getMonitoringInterval in interface CfnDBInstancePropspublic final String getMonitoringRoleArn()
CfnDBInstanceProps
For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see 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.
This setting doesn't apply to RDS Custom.
getMonitoringRoleArn in interface CfnDBInstancePropspublic final Object getMultiAz()
CfnDBInstanceProps
You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Currently, you can't use AWS CloudFormation to create a Multi-AZ DB cluster deployment.
For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide .
Amazon Aurora
Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the MultiAZ option to be set.
getMultiAz in interface CfnDBInstancePropspublic final String getOptionGroupName()
CfnDBInstancePropsPermanent 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.
getOptionGroupName in interface CfnDBInstancePropspublic final String getPerformanceInsightsKmsKeyId()
CfnDBInstancePropsThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.
For information about enabling Performance Insights, see EnablePerformanceInsights .
getPerformanceInsightsKmsKeyId in interface CfnDBInstancePropspublic final Number getPerformanceInsightsRetentionPeriod()
CfnDBInstancePropsFor information about enabling Performance Insights, see EnablePerformanceInsights .
getPerformanceInsightsRetentionPeriod in interface CfnDBInstancePropspublic final String getPort()
CfnDBInstancePropsAmazon Aurora
Not applicable. The port number is managed by the DB cluster.
getPort in interface CfnDBInstancePropspublic final String getPreferredBackupWindow()
CfnDBInstancePropsFor more information, see Backup Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi .Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
getPreferredBackupWindow in interface CfnDBInstancePropspublic final String getPreferredMaintenanceWindow()
CfnDBInstanceProps
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.
This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.
Constraints: Minimum 30-minute window.
getPreferredMaintenanceWindow in interface CfnDBInstancePropspublic final Object getProcessorFeatures()
CfnDBInstancePropsThis setting doesn't apply to RDS Custom.
getProcessorFeatures in interface CfnDBInstancePropspublic final Number getPromotionTier()
CfnDBInstancePropsFor more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
This setting doesn't apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
getPromotionTier in interface CfnDBInstancePropspublic final Object getPubliclyAccessible()
CfnDBInstanceProps
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 .
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 .
getPubliclyAccessible in interface CfnDBInstancePropspublic final String getSourceDbInstanceIdentifier()
CfnDBInstancePropsEach DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide .
For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User 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).
- If you specify a source DB instance that uses VPC security groups, we recommend that you specify the
VPCSecurityGroupsproperty. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroupsproperty from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroupsproperty to the default value because it's not defined in the stack's template. This change might cause unexpected issues.- Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.
- If you specify
SourceDBInstanceIdentifier, don't specify theDBSnapshotIdentifierproperty. You can't create a read replica from a snapshot.- Don't set the
BackupRetentionPeriod,DBName,MasterUsername,MasterUserPassword, andPreferredBackupWindowproperties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.- If the source DB instance is in a different region than the read replica, specify the source region in
SourceRegion, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide .- For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.
getSourceDbInstanceIdentifier in interface CfnDBInstancePropspublic final String getSourceRegion()
CfnDBInstancePropsgetSourceRegion in interface CfnDBInstancePropspublic final Object getStorageEncrypted()
CfnDBInstanceProps
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified KmsKeyId property is used.
If you specify the SnapshotIdentifier and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the KmsKeyId property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to false .
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
getStorageEncrypted in interface CfnDBInstancePropspublic final String getStorageType()
CfnDBInstanceProps
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
For more information, see Amazon RDS DB Instance Storage in the Amazon RDS User Guide .
Amazon Aurora
Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).
getStorageType in interface CfnDBInstancePropspublic final List<CfnTag> getTags()
CfnDBInstancePropsgetTags in interface CfnDBInstancePropspublic final String getTimezone()
CfnDBInstancePropsThe time zone parameter is currently supported only by Microsoft SQL Server .
getTimezone in interface CfnDBInstancePropspublic final Object getUseDefaultProcessorFeatures()
CfnDBInstancePropsThis setting doesn't apply to RDS Custom.
getUseDefaultProcessorFeatures in interface CfnDBInstancePropspublic final List<String> getVpcSecurityGroups()
CfnDBInstancePropsThe 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.
You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:
- You can't revert to using an RDS security group after you establish a VPC security group membership.
- When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
- To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the
DBSecurityGroupsproperty.
To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
getVpcSecurityGroups in interface CfnDBInstanceProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.