Skip to content

AWS.RDS.DBInstance

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html

Index

Fields

fn new

new(errorOnEmptyProp)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html

fn creationPolicy

creationPolicy(policy)

Associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded. To signal a resource, you can use the cfn-signal helper script or SignalResource API. CloudFormation publishes valid signals to the stack events so that you track the number of signals sent. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html

fn creationPolicyMixin

creationPolicyMixin(policy)

cf creationPolicy(), but return a merged object

fn deletionPolicy

deletionPolicy(policy)

With the DeletionPolicy attribute you can preserve, and in some cases, backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html

fn deletionPolicyMixin

deletionPolicyMixin(policy)

cf deletionPolicy(), but return a merged object

fn dependsOn

dependsOn(dependencies)

With the DependsOn attribute you can specify that the creation of a specific resource follows another. When you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource specified in the DependsOn attribute. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html

fn dependsOnMixin

dependsOnMixin(dependencies)

cf dependsOn(), but return a merged array

fn metadata

metadata(metadatas)

The metadata attribute enables you to associate structured data with a resource. By adding a metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the metadata attribute to add those interpreted values. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html

fn metadataMixin

metadataMixin(metadatas)

cf metadata(), but return a merged object

fn updatePolicy

updatePolicy(policy)

Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AppStream::Fleet, AWS::AutoScaling::AutoScalingGroup, AWS::ElastiCache::ReplicationGroup, AWS::OpenSearchService::Domain, AWS::Elasticsearch::Domain, or AWS::Lambda::Alias resources. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html

fn updatePolicyMixin

updatePolicyMixin(policy)

cf `updatePolicy(), but return a merged object

fn updateReplacePolicy

updateReplacePolicy(policy)

Use the UpdateReplacePolicy attribute to retain or, in some cases, backup the existing physical instance of a resource when it's replaced during a stack update operation. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html

fn updateReplacePolicyMixin

updateReplacePolicyMixin(policy)

cf updateReplacePolicy, but return a merged object

fn withAllocatedStorage

withAllocatedStorage(allocatedStorage)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allocatedstorage

fn withAllowMajorVersionUpgrade

withAllowMajorVersionUpgrade(allowMajorVersionUpgrade)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allowmajorversionupgrade

fn withAssociatedRoles

withAssociatedRoles(associatedRoles)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-associatedroles

fn withAssociatedRolesMixin

withAssociatedRolesMixin(associatedRoles)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-associatedroles

fn withAutoMinorVersionUpgrade

withAutoMinorVersionUpgrade(autoMinorVersionUpgrade)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-autominorversionupgrade

fn withAvailabilityZone

withAvailabilityZone(availabilityZone)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-availabilityzone

fn withBackupRetentionPeriod

withBackupRetentionPeriod(backupRetentionPeriod)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-backupretentionperiod

fn withCACertificateIdentifier

withCACertificateIdentifier(cacertificateIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-cacertificateidentifier

fn withCharacterSetName

withCharacterSetName(characterSetName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-charactersetname

fn withCopyTagsToSnapshot

withCopyTagsToSnapshot(copyTagsToSnapshot)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-copytagstosnapshot

fn withDBClusterIdentifier

withDBClusterIdentifier(dbclusterIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbclusteridentifier

fn withDBInstanceClass

withDBInstanceClass(dbinstanceClass)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbinstanceclass

fn withDBInstanceIdentifier

withDBInstanceIdentifier(dbinstanceIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbinstanceidentifier

fn withDBName

withDBName(dbname)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbname

fn withDBParameterGroupName

withDBParameterGroupName(dbparameterGroupName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbparametergroupname

fn withDBSecurityGroups

withDBSecurityGroups(dbsecurityGroups)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups

fn withDBSecurityGroupsMixin

withDBSecurityGroupsMixin(dbsecurityGroups)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups

fn withDBSnapshotIdentifier

withDBSnapshotIdentifier(dbsnapshotIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier

fn withDBSubnetGroupName

withDBSubnetGroupName(dbsubnetGroupName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsubnetgroupname

fn withDeleteAutomatedBackups

withDeleteAutomatedBackups(deleteAutomatedBackups)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-deleteautomatedbackups

fn withDeletionProtection

withDeletionProtection(deletionProtection)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-deletionprotection

fn withDomain

withDomain(domain)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-domain

fn withDomainIAMRoleName

withDomainIAMRoleName(domainIamroleName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-domainiamrolename

fn withEnableCloudwatchLogsExports

withEnableCloudwatchLogsExports(enableCloudwatchLogsExports)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enablecloudwatchlogsexports

fn withEnableCloudwatchLogsExportsMixin

withEnableCloudwatchLogsExportsMixin(enableCloudwatchLogsExports)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enablecloudwatchlogsexports

fn withEnableIAMDatabaseAuthentication

withEnableIAMDatabaseAuthentication(enableIamdatabaseAuthentication)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableiamdatabaseauthentication

fn withEnablePerformanceInsights

withEnablePerformanceInsights(enablePerformanceInsights)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights

fn withEngine

withEngine(engine)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engine

fn withEngineVersion

withEngineVersion(engineVersion)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engineversion

fn withIops

withIops(iops)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-iops

fn withKmsKeyId

withKmsKeyId(kmsKeyId)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-kmskeyid

fn withLicenseModel

withLicenseModel(licenseModel)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-licensemodel

fn withMasterUserPassword

withMasterUserPassword(masterUserPassword)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-masteruserpassword

fn withMasterUsername

withMasterUsername(masterUsername)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-masterusername

fn withMaxAllocatedStorage

withMaxAllocatedStorage(maxAllocatedStorage)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-maxallocatedstorage

fn withMonitoringInterval

withMonitoringInterval(monitoringInterval)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-monitoringinterval

fn withMonitoringRoleArn

withMonitoringRoleArn(monitoringRoleArn)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-monitoringrolearn

fn withMultiAZ

withMultiAZ(multiAz)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-multiaz

fn withOptionGroupName

withOptionGroupName(optionGroupName)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-optiongroupname

fn withPerformanceInsightsKMSKeyId

withPerformanceInsightsKMSKeyId(performanceInsightsKmskeyId)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-performanceinsightskmskeyid

fn withPerformanceInsightsRetentionPeriod

withPerformanceInsightsRetentionPeriod(performanceInsightsRetentionPeriod)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-performanceinsightsretentionperiod

fn withPort

withPort(port)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port

fn withPreferredBackupWindow

withPreferredBackupWindow(preferredBackupWindow)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-preferredbackupwindow

fn withPreferredMaintenanceWindow

withPreferredMaintenanceWindow(preferredMaintenanceWindow)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-preferredmaintenancewindow

fn withProcessorFeatures

withProcessorFeatures(processorFeatures)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-processorfeatures

fn withProcessorFeaturesMixin

withProcessorFeaturesMixin(processorFeatures)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-processorfeatures

fn withPromotionTier

withPromotionTier(promotionTier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-promotiontier

fn withPubliclyAccessible

withPubliclyAccessible(publiclyAccessible)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-publiclyaccessible

fn withSourceDBInstanceIdentifier

withSourceDBInstanceIdentifier(sourceDbinstanceIdentifier)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-sourcedbinstanceidentifier

fn withSourceRegion

withSourceRegion(sourceRegion)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-sourceregion

fn withStorageEncrypted

withStorageEncrypted(storageEncrypted)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-storageencrypted

fn withStorageType

withStorageType(storageType)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-storagetype

fn withTags

withTags(tags)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-tags

fn withTagsMixin

withTagsMixin(tags)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-tags

fn withTimezone

withTimezone(timezone)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-timezone

fn withUseDefaultProcessorFeatures

withUseDefaultProcessorFeatures(useDefaultProcessorFeatures)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-usedefaultprocessorfeatures

fn withVPCSecurityGroups

withVPCSecurityGroups(vpcsecurityGroups)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-vpcsecuritygroups

fn withVPCSecurityGroupsMixin

withVPCSecurityGroupsMixin(vpcsecurityGroups)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-vpcsecuritygroups