Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. rds
  5. CustomDeploymentSet
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.rds.CustomDeploymentSet

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

Provides a RDS Custom Deployment Set resource.

Custom Deployment set.

For information about RDS Custom Deployment Set and how to use it, see What is Custom Deployment Set.

NOTE: Available since v1.235.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = new alicloud.rds.CustomDeploymentSet("default", {
    onUnableToRedeployFailedInstance: "CancelMembershipAndStart",
    customDeploymentSetName: name,
    description: "2024:11:19 1010:1111:0808",
    groupCount: 3,
    strategy: "Availability",
});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.rds.CustomDeploymentSet("default",
    on_unable_to_redeploy_failed_instance="CancelMembershipAndStart",
    custom_deployment_set_name=name,
    description="2024:11:19 1010:1111:0808",
    group_count=3,
    strategy="Availability")
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_, err := rds.NewCustomDeploymentSet(ctx, "default", &rds.CustomDeploymentSetArgs{
			OnUnableToRedeployFailedInstance: pulumi.String("CancelMembershipAndStart"),
			CustomDeploymentSetName:          pulumi.String(name),
			Description:                      pulumi.String("2024:11:19 1010:1111:0808"),
			GroupCount:                       pulumi.Int(3),
			Strategy:                         pulumi.String("Availability"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = new AliCloud.Rds.CustomDeploymentSet("default", new()
    {
        OnUnableToRedeployFailedInstance = "CancelMembershipAndStart",
        CustomDeploymentSetName = name,
        Description = "2024:11:19 1010:1111:0808",
        GroupCount = 3,
        Strategy = "Availability",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.rds.CustomDeploymentSet;
import com.pulumi.alicloud.rds.CustomDeploymentSetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        var default_ = new CustomDeploymentSet("default", CustomDeploymentSetArgs.builder()
            .onUnableToRedeployFailedInstance("CancelMembershipAndStart")
            .customDeploymentSetName(name)
            .description("2024:11:19 1010:1111:0808")
            .groupCount("3")
            .strategy("Availability")
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: terraform-example
resources:
  default:
    type: alicloud:rds:CustomDeploymentSet
    properties:
      onUnableToRedeployFailedInstance: CancelMembershipAndStart
      customDeploymentSetName: ${name}
      description: 2024:11:19 1010:1111:0808
      groupCount: '3'
      strategy: Availability
Copy

Create CustomDeploymentSet Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CustomDeploymentSet(name: string, args?: CustomDeploymentSetArgs, opts?: CustomResourceOptions);
@overload
def CustomDeploymentSet(resource_name: str,
                        args: Optional[CustomDeploymentSetArgs] = None,
                        opts: Optional[ResourceOptions] = None)

@overload
def CustomDeploymentSet(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        custom_deployment_set_name: Optional[str] = None,
                        description: Optional[str] = None,
                        group_count: Optional[int] = None,
                        on_unable_to_redeploy_failed_instance: Optional[str] = None,
                        strategy: Optional[str] = None)
func NewCustomDeploymentSet(ctx *Context, name string, args *CustomDeploymentSetArgs, opts ...ResourceOption) (*CustomDeploymentSet, error)
public CustomDeploymentSet(string name, CustomDeploymentSetArgs? args = null, CustomResourceOptions? opts = null)
public CustomDeploymentSet(String name, CustomDeploymentSetArgs args)
public CustomDeploymentSet(String name, CustomDeploymentSetArgs args, CustomResourceOptions options)

type: alicloud:rds:CustomDeploymentSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args CustomDeploymentSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args CustomDeploymentSetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args CustomDeploymentSetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args CustomDeploymentSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CustomDeploymentSetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var customDeploymentSetResource = new AliCloud.Rds.CustomDeploymentSet("customDeploymentSetResource", new()
{
    CustomDeploymentSetName = "string",
    Description = "string",
    GroupCount = 0,
    OnUnableToRedeployFailedInstance = "string",
    Strategy = "string",
});
Copy
example, err := rds.NewCustomDeploymentSet(ctx, "customDeploymentSetResource", &rds.CustomDeploymentSetArgs{
	CustomDeploymentSetName:          pulumi.String("string"),
	Description:                      pulumi.String("string"),
	GroupCount:                       pulumi.Int(0),
	OnUnableToRedeployFailedInstance: pulumi.String("string"),
	Strategy:                         pulumi.String("string"),
})
Copy
var customDeploymentSetResource = new CustomDeploymentSet("customDeploymentSetResource", CustomDeploymentSetArgs.builder()
    .customDeploymentSetName("string")
    .description("string")
    .groupCount(0)
    .onUnableToRedeployFailedInstance("string")
    .strategy("string")
    .build());
Copy
custom_deployment_set_resource = alicloud.rds.CustomDeploymentSet("customDeploymentSetResource",
    custom_deployment_set_name="string",
    description="string",
    group_count=0,
    on_unable_to_redeploy_failed_instance="string",
    strategy="string")
Copy
const customDeploymentSetResource = new alicloud.rds.CustomDeploymentSet("customDeploymentSetResource", {
    customDeploymentSetName: "string",
    description: "string",
    groupCount: 0,
    onUnableToRedeployFailedInstance: "string",
    strategy: "string",
});
Copy
type: alicloud:rds:CustomDeploymentSet
properties:
    customDeploymentSetName: string
    description: string
    groupCount: 0
    onUnableToRedeployFailedInstance: string
    strategy: string
Copy

CustomDeploymentSet 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 CustomDeploymentSet resource accepts the following input properties:

CustomDeploymentSetName Changes to this property will trigger replacement. string
The name of the resource
Description Changes to this property will trigger replacement. string
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
GroupCount int

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

OnUnableToRedeployFailedInstance string

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

Strategy Changes to this property will trigger replacement. string

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

CustomDeploymentSetName Changes to this property will trigger replacement. string
The name of the resource
Description Changes to this property will trigger replacement. string
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
GroupCount int

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

OnUnableToRedeployFailedInstance string

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

Strategy Changes to this property will trigger replacement. string

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

customDeploymentSetName Changes to this property will trigger replacement. String
The name of the resource
description Changes to this property will trigger replacement. String
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
groupCount Integer

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

onUnableToRedeployFailedInstance String

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

strategy Changes to this property will trigger replacement. String

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

customDeploymentSetName Changes to this property will trigger replacement. string
The name of the resource
description Changes to this property will trigger replacement. string
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
groupCount number

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

onUnableToRedeployFailedInstance string

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

strategy Changes to this property will trigger replacement. string

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

custom_deployment_set_name Changes to this property will trigger replacement. str
The name of the resource
description Changes to this property will trigger replacement. str
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
group_count int

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

on_unable_to_redeploy_failed_instance str

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

strategy Changes to this property will trigger replacement. str

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

customDeploymentSetName Changes to this property will trigger replacement. String
The name of the resource
description Changes to this property will trigger replacement. String
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
groupCount Number

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

onUnableToRedeployFailedInstance String

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

strategy Changes to this property will trigger replacement. String

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

Outputs

All input properties are implicitly available as output properties. Additionally, the CustomDeploymentSet resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the resource
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the resource
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the resource
id string
The provider-assigned unique ID for this managed resource.
status string
The status of the resource
id str
The provider-assigned unique ID for this managed resource.
status str
The status of the resource
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the resource

Look up Existing CustomDeploymentSet Resource

Get an existing CustomDeploymentSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CustomDeploymentSetState, opts?: CustomResourceOptions): CustomDeploymentSet
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_deployment_set_name: Optional[str] = None,
        description: Optional[str] = None,
        group_count: Optional[int] = None,
        on_unable_to_redeploy_failed_instance: Optional[str] = None,
        status: Optional[str] = None,
        strategy: Optional[str] = None) -> CustomDeploymentSet
func GetCustomDeploymentSet(ctx *Context, name string, id IDInput, state *CustomDeploymentSetState, opts ...ResourceOption) (*CustomDeploymentSet, error)
public static CustomDeploymentSet Get(string name, Input<string> id, CustomDeploymentSetState? state, CustomResourceOptions? opts = null)
public static CustomDeploymentSet get(String name, Output<String> id, CustomDeploymentSetState state, CustomResourceOptions options)
resources:  _:    type: alicloud:rds:CustomDeploymentSet    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CustomDeploymentSetName Changes to this property will trigger replacement. string
The name of the resource
Description Changes to this property will trigger replacement. string
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
GroupCount int

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

OnUnableToRedeployFailedInstance string

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

Status string
The status of the resource
Strategy Changes to this property will trigger replacement. string

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

CustomDeploymentSetName Changes to this property will trigger replacement. string
The name of the resource
Description Changes to this property will trigger replacement. string
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
GroupCount int

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

OnUnableToRedeployFailedInstance string

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

Status string
The status of the resource
Strategy Changes to this property will trigger replacement. string

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

customDeploymentSetName Changes to this property will trigger replacement. String
The name of the resource
description Changes to this property will trigger replacement. String
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
groupCount Integer

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

onUnableToRedeployFailedInstance String

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

status String
The status of the resource
strategy Changes to this property will trigger replacement. String

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

customDeploymentSetName Changes to this property will trigger replacement. string
The name of the resource
description Changes to this property will trigger replacement. string
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
groupCount number

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

onUnableToRedeployFailedInstance string

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

status string
The status of the resource
strategy Changes to this property will trigger replacement. string

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

custom_deployment_set_name Changes to this property will trigger replacement. str
The name of the resource
description Changes to this property will trigger replacement. str
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
group_count int

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

on_unable_to_redeploy_failed_instance str

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

status str
The status of the resource
strategy Changes to this property will trigger replacement. str

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

customDeploymentSetName Changes to this property will trigger replacement. String
The name of the resource
description Changes to this property will trigger replacement. String
Deployment set description information. It must be 2 to 256 characters in length and cannot start with http:// or https.
groupCount Number

Set the number of groups for the deployment set group high availability policy. Value range: 1~7.

Default value: 3

NOTE: This parameter takes effect only when 'Strategy = AvailabilityGroup.

onUnableToRedeployFailedInstance String

After the instance in the deployment set is down and migrated, there is no emergency solution for the scattered instance inventory. Value range:

  • CancelMembershipAndStart: removes the instance from the deployment set and starts the instance immediately after the instance is down and migrated.
  • KeepStopped: The deployment set of the instance is maintained. The instance remains in the stopped state.

Default value: CancelMembershipAndStart.

status String
The status of the resource
strategy Changes to this property will trigger replacement. String

Deployment strategy. Value range:

  • Availability: High Availability policy.
  • AvailabilityGroup: the high availability policy of the deployment set group.
  • LowLatency: Network low latency policy.

Default value: Availability.

Import

RDS Custom Deployment Set can be imported using the id, e.g.

$ pulumi import alicloud:rds/customDeploymentSet:CustomDeploymentSet example <id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud