We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi
Resource Type definition for AWS::RDS::Deployment. Creates and manages an Amazon RDS Blue/Green Deployment.
Create Deployment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);@overload
def Deployment(resource_name: str,
args: DeploymentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Deployment(resource_name: str,
opts: Optional[ResourceOptions] = None,
blue_green_deployment_name: Optional[str] = None,
source: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
target_allocated_storage: Optional[int] = None,
target_db_cluster_parameter_group_name: Optional[str] = None,
target_db_instance_class: Optional[str] = None,
target_db_parameter_group_name: Optional[str] = None,
target_engine_version: Optional[str] = None,
target_iops: Optional[int] = None,
target_storage_throughput: Optional[int] = None,
target_storage_type: Optional[str] = None,
upgrade_target_storage_config: Optional[bool] = None)func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
public Deployment(String name, DeploymentArgs args)
public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)
type: aws-native:rds:Deployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_rds_deployment" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Deployment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Deployment resource accepts the following input properties:
- Blue
Green stringDeployment Name - The name of the Blue/Green Deployment.
- Source string
- The ARN of the source production database.
-
List<Pulumi.
Aws Native. Inputs. Tag> - The tags assigned to the Blue/Green Deployment.
- Target
Allocated intStorage - The allocated storage size in GiB for the target DB instance.
- Target
Db stringCluster Parameter Group Name - The DB cluster parameter group for the target Aurora DB cluster.
- Target
Db stringInstance Class - The DB instance class for target RDS DB instances.
- Target
Db stringParameter Group Name - The DB parameter group for the target DB instance.
- Target
Engine stringVersion - The DB engine version for the target database.
- Target
Iops int - The Provisioned IOPS value for the target DB instance.
- Target
Storage intThroughput - The storage throughput value for the target DB instance.
- Target
Storage stringType - The storage type for the target DB instance.
- Upgrade
Target boolStorage Config - Whether to upgrade the storage file system configuration on the target database.
- Blue
Green stringDeployment Name - The name of the Blue/Green Deployment.
- Source string
- The ARN of the source production database.
-
Tag
Args - The tags assigned to the Blue/Green Deployment.
- Target
Allocated intStorage - The allocated storage size in GiB for the target DB instance.
- Target
Db stringCluster Parameter Group Name - The DB cluster parameter group for the target Aurora DB cluster.
- Target
Db stringInstance Class - The DB instance class for target RDS DB instances.
- Target
Db stringParameter Group Name - The DB parameter group for the target DB instance.
- Target
Engine stringVersion - The DB engine version for the target database.
- Target
Iops int - The Provisioned IOPS value for the target DB instance.
- Target
Storage intThroughput - The storage throughput value for the target DB instance.
- Target
Storage stringType - The storage type for the target DB instance.
- Upgrade
Target boolStorage Config - Whether to upgrade the storage file system configuration on the target database.
- blue_
green_ stringdeployment_ name - The name of the Blue/Green Deployment.
- source string
- The ARN of the source production database.
- list(object)
- The tags assigned to the Blue/Green Deployment.
- target_
allocated_ numberstorage - The allocated storage size in GiB for the target DB instance.
- target_
db_ stringcluster_ parameter_ group_ name - The DB cluster parameter group for the target Aurora DB cluster.
- target_
db_ stringinstance_ class - The DB instance class for target RDS DB instances.
- target_
db_ stringparameter_ group_ name - The DB parameter group for the target DB instance.
- target_
engine_ stringversion - The DB engine version for the target database.
- target_
iops number - The Provisioned IOPS value for the target DB instance.
- target_
storage_ numberthroughput - The storage throughput value for the target DB instance.
- target_
storage_ stringtype - The storage type for the target DB instance.
- upgrade_
target_ boolstorage_ config - Whether to upgrade the storage file system configuration on the target database.
- blue
Green StringDeployment Name - The name of the Blue/Green Deployment.
- source String
- The ARN of the source production database.
- List<Tag>
- The tags assigned to the Blue/Green Deployment.
- target
Allocated IntegerStorage - The allocated storage size in GiB for the target DB instance.
- target
Db StringCluster Parameter Group Name - The DB cluster parameter group for the target Aurora DB cluster.
- target
Db StringInstance Class - The DB instance class for target RDS DB instances.
- target
Db StringParameter Group Name - The DB parameter group for the target DB instance.
- target
Engine StringVersion - The DB engine version for the target database.
- target
Iops Integer - The Provisioned IOPS value for the target DB instance.
- target
Storage IntegerThroughput - The storage throughput value for the target DB instance.
- target
Storage StringType - The storage type for the target DB instance.
- upgrade
Target BooleanStorage Config - Whether to upgrade the storage file system configuration on the target database.
- blue
Green stringDeployment Name - The name of the Blue/Green Deployment.
- source string
- The ARN of the source production database.
- Tag[]
- The tags assigned to the Blue/Green Deployment.
- target
Allocated numberStorage - The allocated storage size in GiB for the target DB instance.
- target
Db stringCluster Parameter Group Name - The DB cluster parameter group for the target Aurora DB cluster.
- target
Db stringInstance Class - The DB instance class for target RDS DB instances.
- target
Db stringParameter Group Name - The DB parameter group for the target DB instance.
- target
Engine stringVersion - The DB engine version for the target database.
- target
Iops number - The Provisioned IOPS value for the target DB instance.
- target
Storage numberThroughput - The storage throughput value for the target DB instance.
- target
Storage stringType - The storage type for the target DB instance.
- upgrade
Target booleanStorage Config - Whether to upgrade the storage file system configuration on the target database.
- blue_
green_ strdeployment_ name - The name of the Blue/Green Deployment.
- source str
- The ARN of the source production database.
-
Sequence[Tag
Args] - The tags assigned to the Blue/Green Deployment.
- target_
allocated_ intstorage - The allocated storage size in GiB for the target DB instance.
- target_
db_ strcluster_ parameter_ group_ name - The DB cluster parameter group for the target Aurora DB cluster.
- target_
db_ strinstance_ class - The DB instance class for target RDS DB instances.
- target_
db_ strparameter_ group_ name - The DB parameter group for the target DB instance.
- target_
engine_ strversion - The DB engine version for the target database.
- target_
iops int - The Provisioned IOPS value for the target DB instance.
- target_
storage_ intthroughput - The storage throughput value for the target DB instance.
- target_
storage_ strtype - The storage type for the target DB instance.
- upgrade_
target_ boolstorage_ config - Whether to upgrade the storage file system configuration on the target database.
- blue
Green StringDeployment Name - The name of the Blue/Green Deployment.
- source String
- The ARN of the source production database.
- List<Property Map>
- The tags assigned to the Blue/Green Deployment.
- target
Allocated NumberStorage - The allocated storage size in GiB for the target DB instance.
- target
Db StringCluster Parameter Group Name - The DB cluster parameter group for the target Aurora DB cluster.
- target
Db StringInstance Class - The DB instance class for target RDS DB instances.
- target
Db StringParameter Group Name - The DB parameter group for the target DB instance.
- target
Engine StringVersion - The DB engine version for the target database.
- target
Iops Number - The Provisioned IOPS value for the target DB instance.
- target
Storage NumberThroughput - The storage throughput value for the target DB instance.
- target
Storage StringType - The storage type for the target DB instance.
- upgrade
Target BooleanStorage Config - Whether to upgrade the storage file system configuration on the target database.
Outputs
All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the Blue/Green Deployment.
- Blue
Green stringDeployment Identifier - The system-generated identifier of the Blue/Green Deployment.
- Create
Time string - The time when the Blue/Green Deployment was created in UTC.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The status of the Blue/Green Deployment.
- Switchover
Details List<Pulumi.Aws Native. Rds. Outputs. Deployment Switchover Detail> - The source and target member mappings in the Blue/Green Deployment.
- Target string
- The ARN of the target database in the green environment.
- Tasks
List<Pulumi.
Aws Native. Rds. Outputs. Deployment Task> - The provisioning tasks for the Blue/Green Deployment.
- Arn string
- The Amazon Resource Name (ARN) of the Blue/Green Deployment.
- Blue
Green stringDeployment Identifier - The system-generated identifier of the Blue/Green Deployment.
- Create
Time string - The time when the Blue/Green Deployment was created in UTC.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The status of the Blue/Green Deployment.
- Switchover
Details []DeploymentSwitchover Detail - The source and target member mappings in the Blue/Green Deployment.
- Target string
- The ARN of the target database in the green environment.
- Tasks
[]Deployment
Task - The provisioning tasks for the Blue/Green Deployment.
- arn string
- The Amazon Resource Name (ARN) of the Blue/Green Deployment.
- blue_
green_ stringdeployment_ identifier - The system-generated identifier of the Blue/Green Deployment.
- create_
time string - The time when the Blue/Green Deployment was created in UTC.
- id string
- The provider-assigned unique ID for this managed resource.
- status string
- The status of the Blue/Green Deployment.
- switchover_
details list(object) - The source and target member mappings in the Blue/Green Deployment.
- target string
- The ARN of the target database in the green environment.
- tasks list(object)
- The provisioning tasks for the Blue/Green Deployment.
- arn String
- The Amazon Resource Name (ARN) of the Blue/Green Deployment.
- blue
Green StringDeployment Identifier - The system-generated identifier of the Blue/Green Deployment.
- create
Time String - The time when the Blue/Green Deployment was created in UTC.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The status of the Blue/Green Deployment.
- switchover
Details List<DeploymentSwitchover Detail> - The source and target member mappings in the Blue/Green Deployment.
- target String
- The ARN of the target database in the green environment.
- tasks
List<Deployment
Task> - The provisioning tasks for the Blue/Green Deployment.
- arn string
- The Amazon Resource Name (ARN) of the Blue/Green Deployment.
- blue
Green stringDeployment Identifier - The system-generated identifier of the Blue/Green Deployment.
- create
Time string - The time when the Blue/Green Deployment was created in UTC.
- id string
- The provider-assigned unique ID for this managed resource.
- status string
- The status of the Blue/Green Deployment.
- switchover
Details DeploymentSwitchover Detail[] - The source and target member mappings in the Blue/Green Deployment.
- target string
- The ARN of the target database in the green environment.
- tasks
Deployment
Task[] - The provisioning tasks for the Blue/Green Deployment.
- arn str
- The Amazon Resource Name (ARN) of the Blue/Green Deployment.
- blue_
green_ strdeployment_ identifier - The system-generated identifier of the Blue/Green Deployment.
- create_
time str - The time when the Blue/Green Deployment was created in UTC.
- id str
- The provider-assigned unique ID for this managed resource.
- status str
- The status of the Blue/Green Deployment.
- switchover_
details Sequence[DeploymentSwitchover Detail] - The source and target member mappings in the Blue/Green Deployment.
- target str
- The ARN of the target database in the green environment.
- tasks
Sequence[Deployment
Task] - The provisioning tasks for the Blue/Green Deployment.
- arn String
- The Amazon Resource Name (ARN) of the Blue/Green Deployment.
- blue
Green StringDeployment Identifier - The system-generated identifier of the Blue/Green Deployment.
- create
Time String - The time when the Blue/Green Deployment was created in UTC.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The status of the Blue/Green Deployment.
- switchover
Details List<Property Map> - The source and target member mappings in the Blue/Green Deployment.
- target String
- The ARN of the target database in the green environment.
- tasks List<Property Map>
- The provisioning tasks for the Blue/Green Deployment.
Supporting Types
DeploymentSwitchoverDetail, DeploymentSwitchoverDetailArgs
- Source
Member string - The source database member in the Blue/Green Deployment.
- Switchover
Detail stringStatus - The status of this source and target member pair.
- Target
Member string - The target database member in the Blue/Green Deployment.
- Source
Member string - The source database member in the Blue/Green Deployment.
- Switchover
Detail stringStatus - The status of this source and target member pair.
- Target
Member string - The target database member in the Blue/Green Deployment.
- source_
member string - The source database member in the Blue/Green Deployment.
- switchover_
detail_ stringstatus - The status of this source and target member pair.
- target_
member string - The target database member in the Blue/Green Deployment.
- source
Member String - The source database member in the Blue/Green Deployment.
- switchover
Detail StringStatus - The status of this source and target member pair.
- target
Member String - The target database member in the Blue/Green Deployment.
- source
Member string - The source database member in the Blue/Green Deployment.
- switchover
Detail stringStatus - The status of this source and target member pair.
- target
Member string - The target database member in the Blue/Green Deployment.
- source_
member str - The source database member in the Blue/Green Deployment.
- switchover_
detail_ strstatus - The status of this source and target member pair.
- target_
member str - The target database member in the Blue/Green Deployment.
- source
Member String - The source database member in the Blue/Green Deployment.
- switchover
Detail StringStatus - The status of this source and target member pair.
- target
Member String - The target database member in the Blue/Green Deployment.
DeploymentTask, DeploymentTaskArgs
- Task
Name string - The name of a Blue/Green Deployment provisioning task.
- Task
Status string - The status of a Blue/Green Deployment provisioning task.
- Task
Name string - The name of a Blue/Green Deployment provisioning task.
- Task
Status string - The status of a Blue/Green Deployment provisioning task.
- task_
name string - The name of a Blue/Green Deployment provisioning task.
- task_
status string - The status of a Blue/Green Deployment provisioning task.
- task
Name String - The name of a Blue/Green Deployment provisioning task.
- task
Status String - The status of a Blue/Green Deployment provisioning task.
- task
Name string - The name of a Blue/Green Deployment provisioning task.
- task
Status string - The status of a Blue/Green Deployment provisioning task.
- task_
name str - The name of a Blue/Green Deployment provisioning task.
- task_
status str - The status of a Blue/Green Deployment provisioning task.
- task
Name String - The name of a Blue/Green Deployment provisioning task.
- task
Status String - The status of a Blue/Green Deployment provisioning task.
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi