1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. rds
  6. Deployment

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
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:

    BlueGreenDeploymentName string
    The name of the Blue/Green Deployment.
    Source string
    The ARN of the source production database.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags assigned to the Blue/Green Deployment.
    TargetAllocatedStorage int
    The allocated storage size in GiB for the target DB instance.
    TargetDbClusterParameterGroupName string
    The DB cluster parameter group for the target Aurora DB cluster.
    TargetDbInstanceClass string
    The DB instance class for target RDS DB instances.
    TargetDbParameterGroupName string
    The DB parameter group for the target DB instance.
    TargetEngineVersion string
    The DB engine version for the target database.
    TargetIops int
    The Provisioned IOPS value for the target DB instance.
    TargetStorageThroughput int
    The storage throughput value for the target DB instance.
    TargetStorageType string
    The storage type for the target DB instance.
    UpgradeTargetStorageConfig bool
    Whether to upgrade the storage file system configuration on the target database.
    BlueGreenDeploymentName string
    The name of the Blue/Green Deployment.
    Source string
    The ARN of the source production database.
    Tags TagArgs
    The tags assigned to the Blue/Green Deployment.
    TargetAllocatedStorage int
    The allocated storage size in GiB for the target DB instance.
    TargetDbClusterParameterGroupName string
    The DB cluster parameter group for the target Aurora DB cluster.
    TargetDbInstanceClass string
    The DB instance class for target RDS DB instances.
    TargetDbParameterGroupName string
    The DB parameter group for the target DB instance.
    TargetEngineVersion string
    The DB engine version for the target database.
    TargetIops int
    The Provisioned IOPS value for the target DB instance.
    TargetStorageThroughput int
    The storage throughput value for the target DB instance.
    TargetStorageType string
    The storage type for the target DB instance.
    UpgradeTargetStorageConfig bool
    Whether to upgrade the storage file system configuration on the target database.
    blue_green_deployment_name string
    The name of the Blue/Green Deployment.
    source string
    The ARN of the source production database.
    tags list(object)
    The tags assigned to the Blue/Green Deployment.
    target_allocated_storage number
    The allocated storage size in GiB for the target DB instance.
    target_db_cluster_parameter_group_name string
    The DB cluster parameter group for the target Aurora DB cluster.
    target_db_instance_class string
    The DB instance class for target RDS DB instances.
    target_db_parameter_group_name string
    The DB parameter group for the target DB instance.
    target_engine_version string
    The DB engine version for the target database.
    target_iops number
    The Provisioned IOPS value for the target DB instance.
    target_storage_throughput number
    The storage throughput value for the target DB instance.
    target_storage_type string
    The storage type for the target DB instance.
    upgrade_target_storage_config bool
    Whether to upgrade the storage file system configuration on the target database.
    blueGreenDeploymentName String
    The name of the Blue/Green Deployment.
    source String
    The ARN of the source production database.
    tags List<Tag>
    The tags assigned to the Blue/Green Deployment.
    targetAllocatedStorage Integer
    The allocated storage size in GiB for the target DB instance.
    targetDbClusterParameterGroupName String
    The DB cluster parameter group for the target Aurora DB cluster.
    targetDbInstanceClass String
    The DB instance class for target RDS DB instances.
    targetDbParameterGroupName String
    The DB parameter group for the target DB instance.
    targetEngineVersion String
    The DB engine version for the target database.
    targetIops Integer
    The Provisioned IOPS value for the target DB instance.
    targetStorageThroughput Integer
    The storage throughput value for the target DB instance.
    targetStorageType String
    The storage type for the target DB instance.
    upgradeTargetStorageConfig Boolean
    Whether to upgrade the storage file system configuration on the target database.
    blueGreenDeploymentName string
    The name of the Blue/Green Deployment.
    source string
    The ARN of the source production database.
    tags Tag[]
    The tags assigned to the Blue/Green Deployment.
    targetAllocatedStorage number
    The allocated storage size in GiB for the target DB instance.
    targetDbClusterParameterGroupName string
    The DB cluster parameter group for the target Aurora DB cluster.
    targetDbInstanceClass string
    The DB instance class for target RDS DB instances.
    targetDbParameterGroupName string
    The DB parameter group for the target DB instance.
    targetEngineVersion string
    The DB engine version for the target database.
    targetIops number
    The Provisioned IOPS value for the target DB instance.
    targetStorageThroughput number
    The storage throughput value for the target DB instance.
    targetStorageType string
    The storage type for the target DB instance.
    upgradeTargetStorageConfig boolean
    Whether to upgrade the storage file system configuration on the target database.
    blue_green_deployment_name str
    The name of the Blue/Green Deployment.
    source str
    The ARN of the source production database.
    tags Sequence[TagArgs]
    The tags assigned to the Blue/Green Deployment.
    target_allocated_storage int
    The allocated storage size in GiB for the target DB instance.
    target_db_cluster_parameter_group_name str
    The DB cluster parameter group for the target Aurora DB cluster.
    target_db_instance_class str
    The DB instance class for target RDS DB instances.
    target_db_parameter_group_name str
    The DB parameter group for the target DB instance.
    target_engine_version str
    The DB engine version for the target database.
    target_iops int
    The Provisioned IOPS value for the target DB instance.
    target_storage_throughput int
    The storage throughput value for the target DB instance.
    target_storage_type str
    The storage type for the target DB instance.
    upgrade_target_storage_config bool
    Whether to upgrade the storage file system configuration on the target database.
    blueGreenDeploymentName String
    The name of the Blue/Green Deployment.
    source String
    The ARN of the source production database.
    tags List<Property Map>
    The tags assigned to the Blue/Green Deployment.
    targetAllocatedStorage Number
    The allocated storage size in GiB for the target DB instance.
    targetDbClusterParameterGroupName String
    The DB cluster parameter group for the target Aurora DB cluster.
    targetDbInstanceClass String
    The DB instance class for target RDS DB instances.
    targetDbParameterGroupName String
    The DB parameter group for the target DB instance.
    targetEngineVersion String
    The DB engine version for the target database.
    targetIops Number
    The Provisioned IOPS value for the target DB instance.
    targetStorageThroughput Number
    The storage throughput value for the target DB instance.
    targetStorageType String
    The storage type for the target DB instance.
    upgradeTargetStorageConfig Boolean
    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.
    BlueGreenDeploymentIdentifier string
    The system-generated identifier of the Blue/Green Deployment.
    CreateTime 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.
    SwitchoverDetails List<Pulumi.AwsNative.Rds.Outputs.DeploymentSwitchoverDetail>
    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.AwsNative.Rds.Outputs.DeploymentTask>
    The provisioning tasks for the Blue/Green Deployment.
    Arn string
    The Amazon Resource Name (ARN) of the Blue/Green Deployment.
    BlueGreenDeploymentIdentifier string
    The system-generated identifier of the Blue/Green Deployment.
    CreateTime 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.
    SwitchoverDetails []DeploymentSwitchoverDetail
    The source and target member mappings in the Blue/Green Deployment.
    Target string
    The ARN of the target database in the green environment.
    Tasks []DeploymentTask
    The provisioning tasks for the Blue/Green Deployment.
    arn string
    The Amazon Resource Name (ARN) of the Blue/Green Deployment.
    blue_green_deployment_identifier string
    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.
    blueGreenDeploymentIdentifier String
    The system-generated identifier of the Blue/Green Deployment.
    createTime 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.
    switchoverDetails List<DeploymentSwitchoverDetail>
    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<DeploymentTask>
    The provisioning tasks for the Blue/Green Deployment.
    arn string
    The Amazon Resource Name (ARN) of the Blue/Green Deployment.
    blueGreenDeploymentIdentifier string
    The system-generated identifier of the Blue/Green Deployment.
    createTime 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.
    switchoverDetails DeploymentSwitchoverDetail[]
    The source and target member mappings in the Blue/Green Deployment.
    target string
    The ARN of the target database in the green environment.
    tasks DeploymentTask[]
    The provisioning tasks for the Blue/Green Deployment.
    arn str
    The Amazon Resource Name (ARN) of the Blue/Green Deployment.
    blue_green_deployment_identifier str
    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[DeploymentSwitchoverDetail]
    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[DeploymentTask]
    The provisioning tasks for the Blue/Green Deployment.
    arn String
    The Amazon Resource Name (ARN) of the Blue/Green Deployment.
    blueGreenDeploymentIdentifier String
    The system-generated identifier of the Blue/Green Deployment.
    createTime 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.
    switchoverDetails 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

    SourceMember string
    The source database member in the Blue/Green Deployment.
    SwitchoverDetailStatus string
    The status of this source and target member pair.
    TargetMember string
    The target database member in the Blue/Green Deployment.
    SourceMember string
    The source database member in the Blue/Green Deployment.
    SwitchoverDetailStatus string
    The status of this source and target member pair.
    TargetMember string
    The target database member in the Blue/Green Deployment.
    source_member string
    The source database member in the Blue/Green Deployment.
    switchover_detail_status string
    The status of this source and target member pair.
    target_member string
    The target database member in the Blue/Green Deployment.
    sourceMember String
    The source database member in the Blue/Green Deployment.
    switchoverDetailStatus String
    The status of this source and target member pair.
    targetMember String
    The target database member in the Blue/Green Deployment.
    sourceMember string
    The source database member in the Blue/Green Deployment.
    switchoverDetailStatus string
    The status of this source and target member pair.
    targetMember string
    The target database member in the Blue/Green Deployment.
    source_member str
    The source database member in the Blue/Green Deployment.
    switchover_detail_status str
    The status of this source and target member pair.
    target_member str
    The target database member in the Blue/Green Deployment.
    sourceMember String
    The source database member in the Blue/Green Deployment.
    switchoverDetailStatus String
    The status of this source and target member pair.
    targetMember String
    The target database member in the Blue/Green Deployment.

    DeploymentTask, DeploymentTaskArgs

    TaskName string
    The name of a Blue/Green Deployment provisioning task.
    TaskStatus string
    The status of a Blue/Green Deployment provisioning task.
    TaskName string
    The name of a Blue/Green Deployment provisioning task.
    TaskStatus 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.
    taskName String
    The name of a Blue/Green Deployment provisioning task.
    taskStatus String
    The status of a Blue/Green Deployment provisioning task.
    taskName string
    The name of a Blue/Green Deployment provisioning task.
    taskStatus 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.
    taskName String
    The name of a Blue/Green Deployment provisioning task.
    taskStatus String
    The status of a Blue/Green Deployment provisioning task.

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.85.0
    published on Monday, Nov 2, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial