Alibaba Cloud v3.37.0, May 15 23

alicloud.gpdb.DbInstancePlan

Explore with Pulumi AI

Provides a GPDB DB Instance Plan resource.

For information about GPDB DB Instance Plan and how to use it, see What is DB Instance Plan.

NOTE: Available in v1.189.0+.

Create DbInstancePlan Resource

new DbInstancePlan(name: string, args: DbInstancePlanArgs, opts?: CustomResourceOptions);

@overload
def DbInstancePlan(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   db_instance_id: Optional[str] = None,
                   db_instance_plan_name: Optional[str] = None,
                   plan_configs: Optional[Sequence[DbInstancePlanPlanConfigArgs]] = None,
                   plan_desc: Optional[str] = None,
                   plan_end_date: Optional[str] = None,
                   plan_schedule_type: Optional[str] = None,
                   plan_start_date: Optional[str] = None,
                   plan_type: Optional[str] = None,
                   status: Optional[str] = None)
@overload
def DbInstancePlan(resource_name: str,
                   args: DbInstancePlanArgs,
                   opts: Optional[ResourceOptions] = None)

func NewDbInstancePlan(ctx *Context, name string, args DbInstancePlanArgs, opts ...ResourceOption) (*DbInstancePlan, error)

public DbInstancePlan(string name, DbInstancePlanArgs args, CustomResourceOptions? opts = null)

public DbInstancePlan(String name, DbInstancePlanArgs args)
public DbInstancePlan(String name, DbInstancePlanArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args DbInstancePlanArgs: 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 DbInstancePlanArgs: 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 DbInstancePlanArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DbInstancePlanArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DbInstancePlanArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

DbInstancePlan Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DbInstancePlan resource accepts the following input properties:

DbInstanceId string: The ID of the Database instance.
DbInstancePlanName string: The name of the Plan.
PlanConfigs List<Pulumi.AliCloud.Gpdb.Inputs.DbInstancePlanPlanConfigArgs>: The plan config. See the following Block plan_config.
PlanScheduleType string: Plan scheduling type. Valid values: Postpone, Regular.
PlanType string: The type of the Plan. Valid values: PauseResume, Resize.
PlanDesc string: The description of the Plan.
PlanEndDate string: The end time of the Plan.
PlanStartDate string: The start time of the Plan.
Status string: The Status of the Plan. Valid values: active, cancel.

DbInstanceId string: The ID of the Database instance.
DbInstancePlanName string: The name of the Plan.
PlanConfigs []DbInstancePlanPlanConfigArgs: The plan config. See the following Block plan_config.
PlanScheduleType string: Plan scheduling type. Valid values: Postpone, Regular.
PlanType string: The type of the Plan. Valid values: PauseResume, Resize.
PlanDesc string: The description of the Plan.
PlanEndDate string: The end time of the Plan.
PlanStartDate string: The start time of the Plan.
Status string: The Status of the Plan. Valid values: active, cancel.

dbInstanceId String: The ID of the Database instance.
dbInstancePlanName String: The name of the Plan.
planConfigs List<DbInstancePlanPlanConfigArgs>: The plan config. See the following Block plan_config.
planScheduleType String: Plan scheduling type. Valid values: Postpone, Regular.
planType String: The type of the Plan. Valid values: PauseResume, Resize.
planDesc String: The description of the Plan.
planEndDate String: The end time of the Plan.
planStartDate String: The start time of the Plan.
status String: The Status of the Plan. Valid values: active, cancel.

dbInstanceId string: The ID of the Database instance.
dbInstancePlanName string: The name of the Plan.
planConfigs DbInstancePlanPlanConfigArgs[]: The plan config. See the following Block plan_config.
planScheduleType string: Plan scheduling type. Valid values: Postpone, Regular.
planType string: The type of the Plan. Valid values: PauseResume, Resize.
planDesc string: The description of the Plan.
planEndDate string: The end time of the Plan.
planStartDate string: The start time of the Plan.
status string: The Status of the Plan. Valid values: active, cancel.

db_instance_id str: The ID of the Database instance.
db_instance_plan_name str: The name of the Plan.
plan_configs Sequence[DbInstancePlanPlanConfigArgs]: The plan config. See the following Block plan_config.
plan_schedule_type str: Plan scheduling type. Valid values: Postpone, Regular.
plan_type str: The type of the Plan. Valid values: PauseResume, Resize.
plan_desc str: The description of the Plan.
plan_end_date str: The end time of the Plan.
plan_start_date str: The start time of the Plan.
status str: The Status of the Plan. Valid values: active, cancel.

dbInstanceId String: The ID of the Database instance.
dbInstancePlanName String: The name of the Plan.
planConfigs List<Property Map>: The plan config. See the following Block plan_config.
planScheduleType String: Plan scheduling type. Valid values: Postpone, Regular.
planType String: The type of the Plan. Valid values: PauseResume, Resize.
planDesc String: The description of the Plan.
planEndDate String: The end time of the Plan.
planStartDate String: The start time of the Plan.
status String: The Status of the Plan. Valid values: active, cancel.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
PlanId string: The ID of DB Instance Plan.

Id string: The provider-assigned unique ID for this managed resource.
PlanId string: The ID of DB Instance Plan.

id String: The provider-assigned unique ID for this managed resource.
planId String: The ID of DB Instance Plan.

id string: The provider-assigned unique ID for this managed resource.
planId string: The ID of DB Instance Plan.

id str: The provider-assigned unique ID for this managed resource.
plan_id str: The ID of DB Instance Plan.

id String: The provider-assigned unique ID for this managed resource.
planId String: The ID of DB Instance Plan.

Look up Existing DbInstancePlan Resource

Get an existing DbInstancePlan 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?: DbInstancePlanState, opts?: CustomResourceOptions): DbInstancePlan

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        db_instance_id: Optional[str] = None,
        db_instance_plan_name: Optional[str] = None,
        plan_configs: Optional[Sequence[DbInstancePlanPlanConfigArgs]] = None,
        plan_desc: Optional[str] = None,
        plan_end_date: Optional[str] = None,
        plan_id: Optional[str] = None,
        plan_schedule_type: Optional[str] = None,
        plan_start_date: Optional[str] = None,
        plan_type: Optional[str] = None,
        status: Optional[str] = None) -> DbInstancePlan

func GetDbInstancePlan(ctx *Context, name string, id IDInput, state *DbInstancePlanState, opts ...ResourceOption) (*DbInstancePlan, error)

public static DbInstancePlan Get(string name, Input<string> id, DbInstancePlanState? state, CustomResourceOptions? opts = null)

public static DbInstancePlan get(String name, Output<String> id, DbInstancePlanState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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:

DbInstanceId string: The ID of the Database instance.
DbInstancePlanName string: The name of the Plan.
PlanConfigs List<Pulumi.AliCloud.Gpdb.Inputs.DbInstancePlanPlanConfigArgs>: The plan config. See the following Block plan_config.
PlanDesc string: The description of the Plan.
PlanEndDate string: The end time of the Plan.
PlanId string: The ID of DB Instance Plan.
PlanScheduleType string: Plan scheduling type. Valid values: Postpone, Regular.
PlanStartDate string: The start time of the Plan.
PlanType string: The type of the Plan. Valid values: PauseResume, Resize.
Status string: The Status of the Plan. Valid values: active, cancel.

DbInstanceId string: The ID of the Database instance.
DbInstancePlanName string: The name of the Plan.
PlanConfigs []DbInstancePlanPlanConfigArgs: The plan config. See the following Block plan_config.
PlanDesc string: The description of the Plan.
PlanEndDate string: The end time of the Plan.
PlanId string: The ID of DB Instance Plan.
PlanScheduleType string: Plan scheduling type. Valid values: Postpone, Regular.
PlanStartDate string: The start time of the Plan.
PlanType string: The type of the Plan. Valid values: PauseResume, Resize.
Status string: The Status of the Plan. Valid values: active, cancel.

dbInstanceId String: The ID of the Database instance.
dbInstancePlanName String: The name of the Plan.
planConfigs List<DbInstancePlanPlanConfigArgs>: The plan config. See the following Block plan_config.
planDesc String: The description of the Plan.
planEndDate String: The end time of the Plan.
planId String: The ID of DB Instance Plan.
planScheduleType String: Plan scheduling type. Valid values: Postpone, Regular.
planStartDate String: The start time of the Plan.
planType String: The type of the Plan. Valid values: PauseResume, Resize.
status String: The Status of the Plan. Valid values: active, cancel.

dbInstanceId string: The ID of the Database instance.
dbInstancePlanName string: The name of the Plan.
planConfigs DbInstancePlanPlanConfigArgs[]: The plan config. See the following Block plan_config.
planDesc string: The description of the Plan.
planEndDate string: The end time of the Plan.
planId string: The ID of DB Instance Plan.
planScheduleType string: Plan scheduling type. Valid values: Postpone, Regular.
planStartDate string: The start time of the Plan.
planType string: The type of the Plan. Valid values: PauseResume, Resize.
status string: The Status of the Plan. Valid values: active, cancel.

db_instance_id str: The ID of the Database instance.
db_instance_plan_name str: The name of the Plan.
plan_configs Sequence[DbInstancePlanPlanConfigArgs]: The plan config. See the following Block plan_config.
plan_desc str: The description of the Plan.
plan_end_date str: The end time of the Plan.
plan_id str: The ID of DB Instance Plan.
plan_schedule_type str: Plan scheduling type. Valid values: Postpone, Regular.
plan_start_date str: The start time of the Plan.
plan_type str: The type of the Plan. Valid values: PauseResume, Resize.
status str: The Status of the Plan. Valid values: active, cancel.

dbInstanceId String: The ID of the Database instance.
dbInstancePlanName String: The name of the Plan.
planConfigs List<Property Map>: The plan config. See the following Block plan_config.
planDesc String: The description of the Plan.
planEndDate String: The end time of the Plan.
planId String: The ID of DB Instance Plan.
planScheduleType String: Plan scheduling type. Valid values: Postpone, Regular.
planStartDate String: The start time of the Plan.
planType String: The type of the Plan. Valid values: PauseResume, Resize.
status String: The Status of the Plan. Valid values: active, cancel.

Supporting Types

DbInstancePlanPlanConfig

Pause Pulumi.AliCloud.Gpdb.Inputs.DbInstancePlanPlanConfigPause: Pause instance plan config. See the following Block pause.
Resume Pulumi.AliCloud.Gpdb.Inputs.DbInstancePlanPlanConfigResume: Resume instance plan config. See the following Block resume.
ScaleIn Pulumi.AliCloud.Gpdb.Inputs.DbInstancePlanPlanConfigScaleIn: Scale In instance plan config. See the following Block scale_in.
ScaleOut Pulumi.AliCloud.Gpdb.Inputs.DbInstancePlanPlanConfigScaleOut: Scale out instance plan config. See the following Block scale_out.

Pause DbInstancePlanPlanConfigPause: Pause instance plan config. See the following Block pause.
Resume DbInstancePlanPlanConfigResume: Resume instance plan config. See the following Block resume.
ScaleIn DbInstancePlanPlanConfigScaleIn: Scale In instance plan config. See the following Block scale_in.
ScaleOut DbInstancePlanPlanConfigScaleOut: Scale out instance plan config. See the following Block scale_out.

pause DbInstancePlanPlanConfigPause: Pause instance plan config. See the following Block pause.
resume DbInstancePlanPlanConfigResume: Resume instance plan config. See the following Block resume.
scaleIn DbInstancePlanPlanConfigScaleIn: Scale In instance plan config. See the following Block scale_in.
scaleOut DbInstancePlanPlanConfigScaleOut: Scale out instance plan config. See the following Block scale_out.

pause DbInstancePlanPlanConfigPause: Pause instance plan config. See the following Block pause.
resume DbInstancePlanPlanConfigResume: Resume instance plan config. See the following Block resume.
scaleIn DbInstancePlanPlanConfigScaleIn: Scale In instance plan config. See the following Block scale_in.
scaleOut DbInstancePlanPlanConfigScaleOut: Scale out instance plan config. See the following Block scale_out.

pause DbInstancePlanPlanConfigPause: Pause instance plan config. See the following Block pause.
resume DbInstancePlanPlanConfigResume: Resume instance plan config. See the following Block resume.
scale_in DbInstancePlanPlanConfigScaleIn: Scale In instance plan config. See the following Block scale_in.
scale_out DbInstancePlanPlanConfigScaleOut: Scale out instance plan config. See the following Block scale_out.

pause Property Map: Pause instance plan config. See the following Block pause.
resume Property Map: Resume instance plan config. See the following Block resume.
scaleIn Property Map: Scale In instance plan config. See the following Block scale_in.
scaleOut Property Map: Scale out instance plan config. See the following Block scale_out.

DbInstancePlanPlanConfigPause

ExecuteTime string: The executed time of the Plan.
PlanCronTime string: The Cron Time of the plan.

ExecuteTime string: The executed time of the Plan.
PlanCronTime string: The Cron Time of the plan.

executeTime String: The executed time of the Plan.
planCronTime String: The Cron Time of the plan.

executeTime string: The executed time of the Plan.
planCronTime string: The Cron Time of the plan.

execute_time str: The executed time of the Plan.
plan_cron_time str: The Cron Time of the plan.

executeTime String: The executed time of the Plan.
planCronTime String: The Cron Time of the plan.

DbInstancePlanPlanConfigResume

ExecuteTime string: The executed time of the Plan.
PlanCronTime string: The Cron Time of the plan.

ExecuteTime string: The executed time of the Plan.
PlanCronTime string: The Cron Time of the plan.

executeTime String: The executed time of the Plan.
planCronTime String: The Cron Time of the plan.

executeTime string: The executed time of the Plan.
planCronTime string: The Cron Time of the plan.

execute_time str: The executed time of the Plan.
plan_cron_time str: The Cron Time of the plan.

executeTime String: The executed time of the Plan.
planCronTime String: The Cron Time of the plan.

DbInstancePlanPlanConfigScaleIn

ExecuteTime string: The executed time of the Plan.
PlanCronTime string: The Cron Time of the plan.
SegmentNodeNum string: The segment Node Num of the Plan.

ExecuteTime string: The executed time of the Plan.
PlanCronTime string: The Cron Time of the plan.
SegmentNodeNum string: The segment Node Num of the Plan.

executeTime String: The executed time of the Plan.
planCronTime String: The Cron Time of the plan.
segmentNodeNum String: The segment Node Num of the Plan.

executeTime string: The executed time of the Plan.
planCronTime string: The Cron Time of the plan.
segmentNodeNum string: The segment Node Num of the Plan.

execute_time str: The executed time of the Plan.
plan_cron_time str: The Cron Time of the plan.
segment_node_num str: The segment Node Num of the Plan.

executeTime String: The executed time of the Plan.
planCronTime String: The Cron Time of the plan.
segmentNodeNum String: The segment Node Num of the Plan.

DbInstancePlanPlanConfigScaleOut

ExecuteTime string: The executed time of the Plan.
PlanCronTime string: The Cron Time of the plan.
SegmentNodeNum string: The segment Node Num of the Plan.

ExecuteTime string: The executed time of the Plan.
PlanCronTime string: The Cron Time of the plan.
SegmentNodeNum string: The segment Node Num of the Plan.

executeTime String: The executed time of the Plan.
planCronTime String: The Cron Time of the plan.
segmentNodeNum String: The segment Node Num of the Plan.

executeTime string: The executed time of the Plan.
planCronTime string: The Cron Time of the plan.
segmentNodeNum string: The segment Node Num of the Plan.

execute_time str: The executed time of the Plan.
plan_cron_time str: The Cron Time of the plan.
segment_node_num str: The segment Node Num of the Plan.

executeTime String: The executed time of the Plan.
planCronTime String: The Cron Time of the plan.
segmentNodeNum String: The segment Node Num of the Plan.

Import

GPDB DB Instance Plan can be imported using the id, e.g.

 $ pulumi import alicloud:gpdb/dbInstancePlan:DbInstancePlan example <db_instance_id>:<plan_id>

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.