class CfnDBInstancePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.RDS.Mixins.CfnDBInstancePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsrds/mixins#CfnDBInstancePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.rds.mixins.CfnDBInstancePropsMixin
Python	aws_cdk.mixins_preview.aws_rds.mixins.CfnDBInstancePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_rds » mixins » CfnDBInstancePropsMixin

Implements IMixin

Extends Mixin

The AWS::RDS::DBInstance resource creates an Amazon DB instance.

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.

For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide .

For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide .

If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.

If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see Prevent Updates to Stack Resources .

Updating DB instances

When properties labeled " Update requires: Replacement " are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.

We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:

• Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
• Create a snapshot of the DB instance. For more information, see Creating a DB Snapshot .
• If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use.

After you restore a DB instance with a DBSnapshotIdentifier property, you can delete the DBSnapshotIdentifier property. 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.

• Update the stack.

For more information about updating other properties of this resource, see [ModifyDBInstance](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) . For more information about updating stacks, see AWS CloudFormation Stacks Updates .

Deleting DB instances

For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to retain the DB instance, to delete the DB instance, or to create a snapshot of the DB instance. The default AWS CloudFormation behavior depends on the DBClusterIdentifier property:

• For AWS::RDS::DBInstance resources that don't specify the DBClusterIdentifier property, AWS CloudFormation saves a snapshot of the DB instance.
• For AWS::RDS::DBInstance resources that do specify the DBClusterIdentifier property, AWS CloudFormation deletes the DB instance.

For more information, see DeletionPolicy Attribute .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as rds_mixins } from '@aws-cdk/mixins-preview/aws-rds';
const cfnDBInstancePropsMixin = new rds_mixins.CfnDBInstancePropsMixin({
  allocatedStorage: 'allocatedStorage',
  allowMajorVersionUpgrade: false,
  applyImmediately: false,
  associatedRoles: [{
    featureName: 'featureName',
    roleArn: 'roleArn',
  }],
  automaticBackupReplicationKmsKeyId: 'automaticBackupReplicationKmsKeyId',
  automaticBackupReplicationRegion: 'automaticBackupReplicationRegion',
  automaticBackupReplicationRetentionPeriod: 123,
  autoMinorVersionUpgrade: false,
  availabilityZone: 'availabilityZone',
  backupRetentionPeriod: 123,
  backupTarget: 'backupTarget',
  caCertificateIdentifier: 'caCertificateIdentifier',
  certificateRotationRestart: false,
  characterSetName: 'characterSetName',
  copyTagsToSnapshot: false,
  customIamInstanceProfile: 'customIamInstanceProfile',
  databaseInsightsMode: 'databaseInsightsMode',
  dbClusterIdentifier: 'dbClusterIdentifier',
  dbClusterSnapshotIdentifier: 'dbClusterSnapshotIdentifier',
  dbInstanceClass: 'dbInstanceClass',
  dbInstanceIdentifier: 'dbInstanceIdentifier',
  dbName: 'dbName',
  dbParameterGroupName: 'dbParameterGroupName',
  dbSecurityGroups: ['dbSecurityGroups'],
  dbSnapshotIdentifier: 'dbSnapshotIdentifier',
  dbSubnetGroupName: 'dbSubnetGroupName',
  dbSystemId: 'dbSystemId',
  dedicatedLogVolume: false,
  deleteAutomatedBackups: false,
  deletionProtection: false,
  domain: 'domain',
  domainAuthSecretArn: 'domainAuthSecretArn',
  domainDnsIps: ['domainDnsIps'],
  domainFqdn: 'domainFqdn',
  domainIamRoleName: 'domainIamRoleName',
  domainOu: 'domainOu',
  enableCloudwatchLogsExports: ['enableCloudwatchLogsExports'],
  enableIamDatabaseAuthentication: false,
  enablePerformanceInsights: false,
  engine: 'engine',
  engineLifecycleSupport: 'engineLifecycleSupport',
  engineVersion: 'engineVersion',
  iops: 123,
  kmsKeyId: 'kmsKeyId',
  licenseModel: 'licenseModel',
  manageMasterUserPassword: false,
  masterUserAuthenticationType: 'masterUserAuthenticationType',
  masterUsername: 'masterUsername',
  masterUserPassword: 'masterUserPassword',
  masterUserSecret: {
    kmsKeyId: 'kmsKeyId',
    secretArn: 'secretArn',
  },
  maxAllocatedStorage: 123,
  monitoringInterval: 123,
  monitoringRoleArn: 'monitoringRoleArn',
  multiAz: false,
  ncharCharacterSetName: 'ncharCharacterSetName',
  networkType: 'networkType',
  optionGroupName: 'optionGroupName',
  performanceInsightsKmsKeyId: 'performanceInsightsKmsKeyId',
  performanceInsightsRetentionPeriod: 123,
  port: 'port',
  preferredBackupWindow: 'preferredBackupWindow',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  processorFeatures: [{
    name: 'name',
    value: 'value',
  }],
  promotionTier: 123,
  publiclyAccessible: false,
  replicaMode: 'replicaMode',
  restoreTime: 'restoreTime',
  sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
  sourceDbInstanceAutomatedBackupsArn: 'sourceDbInstanceAutomatedBackupsArn',
  sourceDbInstanceIdentifier: 'sourceDbInstanceIdentifier',
  sourceDbiResourceId: 'sourceDbiResourceId',
  sourceRegion: 'sourceRegion',
  storageEncrypted: false,
  storageThroughput: 123,
  storageType: 'storageType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tdeCredentialArn: 'tdeCredentialArn',
  tdeCredentialPassword: 'tdeCredentialPassword',
  timezone: 'timezone',
  useDefaultProcessorFeatures: false,
  useLatestRestorableTime: false,
  vpcSecurityGroups: ['vpcSecurityGroups'],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDBInstancePropsMixin(props: CfnDBInstanceMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDBInstanceMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::RDS::DBInstance.

Properties

Name	Type	Description
props	CfnDBInstanceMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDBInstanceMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.