Skip to content
v2.275.0

CfnDeploymentProps Struct Added in v2.275.0 ​

Properties for defining a CfnDeployment.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
const cfnDeploymentProps: rds.CfnDeploymentProps = {
  blueGreenDeploymentName: 'blueGreenDeploymentName',
  source: 'source',

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetAllocatedStorage: 123,
  targetDbClusterParameterGroupName: 'targetDbClusterParameterGroupName',
  targetDbInstanceClass: 'targetDbInstanceClass',
  targetDbParameterGroupName: 'targetDbParameterGroupName',
  targetEngineVersion: 'targetEngineVersion',
  targetIops: 123,
  targetStorageThroughput: 123,
  targetStorageType: 'targetStorageType',
  upgradeTargetStorageConfig: false,
};

Properties ​

blueGreenDeploymentNamestringblue_green_deployment_namestrblueGreenDeploymentNameStringBlueGreenDeploymentNamestringBlueGreenDeploymentName*stringrequired#
The name of the Blue/Green Deployment.
sourcestringsourcestrsourceStringSourcestringSource*stringrequired#
The ARN of the source production database.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags assigned to the Blue/Green Deployment.
targetAllocatedStorageoptionalnumbertarget_allocated_storageoptionalint | floattargetAllocatedStorageoptionalNumberTargetAllocatedStorageoptionaldoubleTargetAllocatedStorageoptional*float64#
The allocated storage size in GiB for the target DB instance.
targetDbClusterParameterGroupNameoptionalstringtarget_db_cluster_parameter_group_nameoptionalstrtargetDbClusterParameterGroupNameoptionalStringTargetDbClusterParameterGroupNameoptionalstringTargetDbClusterParameterGroupNameoptional*string#
The DB cluster parameter group for the target Aurora DB cluster.
targetDbInstanceClassoptionalstringtarget_db_instance_classoptionalstrtargetDbInstanceClassoptionalStringTargetDbInstanceClassoptionalstringTargetDbInstanceClassoptional*string#
The DB instance class for target RDS DB instances.
targetDbParameterGroupNameoptionalstringtarget_db_parameter_group_nameoptionalstrtargetDbParameterGroupNameoptionalStringTargetDbParameterGroupNameoptionalstringTargetDbParameterGroupNameoptional*string#
The DB parameter group for the target DB instance.
targetEngineVersionoptionalstringtarget_engine_versionoptionalstrtargetEngineVersionoptionalStringTargetEngineVersionoptionalstringTargetEngineVersionoptional*string#
The DB engine version for the target database.
targetIopsoptionalnumbertarget_iopsoptionalint | floattargetIopsoptionalNumberTargetIopsoptionaldoubleTargetIopsoptional*float64#
The Provisioned IOPS value for the target DB instance.
targetStorageThroughputoptionalnumbertarget_storage_throughputoptionalint | floattargetStorageThroughputoptionalNumberTargetStorageThroughputoptionaldoubleTargetStorageThroughputoptional*float64#
The storage throughput value for the target DB instance.
targetStorageTypeoptionalstringtarget_storage_typeoptionalstrtargetStorageTypeoptionalStringTargetStorageTypeoptionalstringTargetStorageTypeoptional*string#
The storage type for the target DB instance.
upgradeTargetStorageConfigoptionalboolean | IResolvableupgrade_target_storage_configoptionaltyping.Union[bool, IResolvable]upgradeTargetStorageConfigoptionalBooleanUpgradeTargetStorageConfigoptionalboolUpgradeTargetStorageConfigoptionalinterface{}#
Whether to upgrade the storage file system configuration on the target database.