1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. getCsbsBackupPolicyV1
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

flexibleengine.getCsbsBackupPolicyV1

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

    The FlexibleEngine CSBS Backup Policy data source allows access of backup Policy resources.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as flexibleengine from "@pulumi/flexibleengine";
    
    const config = new pulumi.Config();
    const policyId = config.requireObject("policyId");
    const csbsPolicy = flexibleengine.getCsbsBackupPolicyV1({
        id: policyId,
    });
    
    import pulumi
    import pulumi_flexibleengine as flexibleengine
    
    config = pulumi.Config()
    policy_id = config.require_object("policyId")
    csbs_policy = flexibleengine.get_csbs_backup_policy_v1(id=policy_id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
    	"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, "")
    		policyId := cfg.RequireObject("policyId")
    		_, err := flexibleengine.LookupCsbsBackupPolicyV1(ctx, &flexibleengine.LookupCsbsBackupPolicyV1Args{
    			Id: pulumi.StringRef(policyId),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Flexibleengine = Pulumi.Flexibleengine;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var policyId = config.RequireObject<dynamic>("policyId");
        var csbsPolicy = Flexibleengine.GetCsbsBackupPolicyV1.Invoke(new()
        {
            Id = policyId,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.flexibleengine.FlexibleengineFunctions;
    import com.pulumi.flexibleengine.inputs.GetCsbsBackupPolicyV1Args;
    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 policyId = config.get("policyId");
            final var csbsPolicy = FlexibleengineFunctions.getCsbsBackupPolicyV1(GetCsbsBackupPolicyV1Args.builder()
                .id(policyId)
                .build());
    
        }
    }
    
    configuration:
      policyId:
        type: dynamic
    variables:
      csbsPolicy:
        fn::invoke:
          function: flexibleengine:getCsbsBackupPolicyV1
          arguments:
            id: ${policyId}
    

    Using getCsbsBackupPolicyV1

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCsbsBackupPolicyV1(args: GetCsbsBackupPolicyV1Args, opts?: InvokeOptions): Promise<GetCsbsBackupPolicyV1Result>
    function getCsbsBackupPolicyV1Output(args: GetCsbsBackupPolicyV1OutputArgs, opts?: InvokeOptions): Output<GetCsbsBackupPolicyV1Result>
    def get_csbs_backup_policy_v1(id: Optional[str] = None,
                                  name: Optional[str] = None,
                                  region: Optional[str] = None,
                                  status: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetCsbsBackupPolicyV1Result
    def get_csbs_backup_policy_v1_output(id: Optional[pulumi.Input[str]] = None,
                                  name: Optional[pulumi.Input[str]] = None,
                                  region: Optional[pulumi.Input[str]] = None,
                                  status: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetCsbsBackupPolicyV1Result]
    func LookupCsbsBackupPolicyV1(ctx *Context, args *LookupCsbsBackupPolicyV1Args, opts ...InvokeOption) (*LookupCsbsBackupPolicyV1Result, error)
    func LookupCsbsBackupPolicyV1Output(ctx *Context, args *LookupCsbsBackupPolicyV1OutputArgs, opts ...InvokeOption) LookupCsbsBackupPolicyV1ResultOutput

    > Note: This function is named LookupCsbsBackupPolicyV1 in the Go SDK.

    public static class GetCsbsBackupPolicyV1 
    {
        public static Task<GetCsbsBackupPolicyV1Result> InvokeAsync(GetCsbsBackupPolicyV1Args args, InvokeOptions? opts = null)
        public static Output<GetCsbsBackupPolicyV1Result> Invoke(GetCsbsBackupPolicyV1InvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCsbsBackupPolicyV1Result> getCsbsBackupPolicyV1(GetCsbsBackupPolicyV1Args args, InvokeOptions options)
    public static Output<GetCsbsBackupPolicyV1Result> getCsbsBackupPolicyV1(GetCsbsBackupPolicyV1Args args, InvokeOptions options)
    
    fn::invoke:
      function: flexibleengine:index/getCsbsBackupPolicyV1:getCsbsBackupPolicyV1
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Specifies the ID of backup policy.
    Name string
    Specifies the backup policy name.
    Region string
    The region in which to query the data source. If omitted, the provider-level region will be used.
    Status string
    Specifies the backup policy status.
    Id string
    Specifies the ID of backup policy.
    Name string
    Specifies the backup policy name.
    Region string
    The region in which to query the data source. If omitted, the provider-level region will be used.
    Status string
    Specifies the backup policy status.
    id String
    Specifies the ID of backup policy.
    name String
    Specifies the backup policy name.
    region String
    The region in which to query the data source. If omitted, the provider-level region will be used.
    status String
    Specifies the backup policy status.
    id string
    Specifies the ID of backup policy.
    name string
    Specifies the backup policy name.
    region string
    The region in which to query the data source. If omitted, the provider-level region will be used.
    status string
    Specifies the backup policy status.
    id str
    Specifies the ID of backup policy.
    name str
    Specifies the backup policy name.
    region str
    The region in which to query the data source. If omitted, the provider-level region will be used.
    status str
    Specifies the backup policy status.
    id String
    Specifies the ID of backup policy.
    name String
    Specifies the backup policy name.
    region String
    The region in which to query the data source. If omitted, the provider-level region will be used.
    status String
    Specifies the backup policy status.

    getCsbsBackupPolicyV1 Result

    The following output properties are available:

    Common Dictionary<string, string>
    General backup policy parameters, which are blank by default.
    Description string
    Specifies Scheduling period description.
    Id string
    Specifies the ID of the object to be backed up.
    Name string
    Specifies backup object name.
    ProviderId string
    Provides the Backup provider ID.
    Region string
    Resources List<GetCsbsBackupPolicyV1Resource>
    Backup Object. The resource object structure is documented below.
    ScheduledOperations List<GetCsbsBackupPolicyV1ScheduledOperation>
    Backup plan information. The scheduled_operation object structure is documented below.
    Status string
    Common map[string]string
    General backup policy parameters, which are blank by default.
    Description string
    Specifies Scheduling period description.
    Id string
    Specifies the ID of the object to be backed up.
    Name string
    Specifies backup object name.
    ProviderId string
    Provides the Backup provider ID.
    Region string
    Resources []GetCsbsBackupPolicyV1Resource
    Backup Object. The resource object structure is documented below.
    ScheduledOperations []GetCsbsBackupPolicyV1ScheduledOperation
    Backup plan information. The scheduled_operation object structure is documented below.
    Status string
    common Map<String,String>
    General backup policy parameters, which are blank by default.
    description String
    Specifies Scheduling period description.
    id String
    Specifies the ID of the object to be backed up.
    name String
    Specifies backup object name.
    providerId String
    Provides the Backup provider ID.
    region String
    resources List<GetCsbsBackupPolicyV1Resource>
    Backup Object. The resource object structure is documented below.
    scheduledOperations List<GetCsbsBackupPolicyV1ScheduledOperation>
    Backup plan information. The scheduled_operation object structure is documented below.
    status String
    common {[key: string]: string}
    General backup policy parameters, which are blank by default.
    description string
    Specifies Scheduling period description.
    id string
    Specifies the ID of the object to be backed up.
    name string
    Specifies backup object name.
    providerId string
    Provides the Backup provider ID.
    region string
    resources GetCsbsBackupPolicyV1Resource[]
    Backup Object. The resource object structure is documented below.
    scheduledOperations GetCsbsBackupPolicyV1ScheduledOperation[]
    Backup plan information. The scheduled_operation object structure is documented below.
    status string
    common Mapping[str, str]
    General backup policy parameters, which are blank by default.
    description str
    Specifies Scheduling period description.
    id str
    Specifies the ID of the object to be backed up.
    name str
    Specifies backup object name.
    provider_id str
    Provides the Backup provider ID.
    region str
    resources Sequence[GetCsbsBackupPolicyV1Resource]
    Backup Object. The resource object structure is documented below.
    scheduled_operations Sequence[GetCsbsBackupPolicyV1ScheduledOperation]
    Backup plan information. The scheduled_operation object structure is documented below.
    status str
    common Map<String>
    General backup policy parameters, which are blank by default.
    description String
    Specifies Scheduling period description.
    id String
    Specifies the ID of the object to be backed up.
    name String
    Specifies backup object name.
    providerId String
    Provides the Backup provider ID.
    region String
    resources List<Property Map>
    Backup Object. The resource object structure is documented below.
    scheduledOperations List<Property Map>
    Backup plan information. The scheduled_operation object structure is documented below.
    status String

    Supporting Types

    GetCsbsBackupPolicyV1Resource

    Id string
    Specifies the ID of backup policy.
    Name string
    Specifies the backup policy name.
    Type string
    Entity object type of the backup object.
    Id string
    Specifies the ID of backup policy.
    Name string
    Specifies the backup policy name.
    Type string
    Entity object type of the backup object.
    id String
    Specifies the ID of backup policy.
    name String
    Specifies the backup policy name.
    type String
    Entity object type of the backup object.
    id string
    Specifies the ID of backup policy.
    name string
    Specifies the backup policy name.
    type string
    Entity object type of the backup object.
    id str
    Specifies the ID of backup policy.
    name str
    Specifies the backup policy name.
    type str
    Entity object type of the backup object.
    id String
    Specifies the ID of backup policy.
    name String
    Specifies the backup policy name.
    type String
    Entity object type of the backup object.

    GetCsbsBackupPolicyV1ScheduledOperation

    Description string
    Specifies Scheduling period description.
    Enabled bool
    Specifies whether the scheduling period is enabled.
    Id string
    Specifies the ID of backup policy.
    MaxBackups double
    Specifies maximum number of backups that can be automatically created for a backup object.
    Name string
    Specifies the backup policy name.
    OperationType string
    Specifies Operation type, which can be backup.
    Permanent bool
    Specifies whether backups are permanently retained.
    RetentionDurationDays double
    Specifies duration of retaining a backup, in days.
    TriggerId string
    Specifies Scheduler ID.
    TriggerName string
    Specifies Scheduler name.
    TriggerPattern string
    Specifies Scheduling policy of the scheduler.
    TriggerType string
    Specifies Scheduler type.
    Description string
    Specifies Scheduling period description.
    Enabled bool
    Specifies whether the scheduling period is enabled.
    Id string
    Specifies the ID of backup policy.
    MaxBackups float64
    Specifies maximum number of backups that can be automatically created for a backup object.
    Name string
    Specifies the backup policy name.
    OperationType string
    Specifies Operation type, which can be backup.
    Permanent bool
    Specifies whether backups are permanently retained.
    RetentionDurationDays float64
    Specifies duration of retaining a backup, in days.
    TriggerId string
    Specifies Scheduler ID.
    TriggerName string
    Specifies Scheduler name.
    TriggerPattern string
    Specifies Scheduling policy of the scheduler.
    TriggerType string
    Specifies Scheduler type.
    description String
    Specifies Scheduling period description.
    enabled Boolean
    Specifies whether the scheduling period is enabled.
    id String
    Specifies the ID of backup policy.
    maxBackups Double
    Specifies maximum number of backups that can be automatically created for a backup object.
    name String
    Specifies the backup policy name.
    operationType String
    Specifies Operation type, which can be backup.
    permanent Boolean
    Specifies whether backups are permanently retained.
    retentionDurationDays Double
    Specifies duration of retaining a backup, in days.
    triggerId String
    Specifies Scheduler ID.
    triggerName String
    Specifies Scheduler name.
    triggerPattern String
    Specifies Scheduling policy of the scheduler.
    triggerType String
    Specifies Scheduler type.
    description string
    Specifies Scheduling period description.
    enabled boolean
    Specifies whether the scheduling period is enabled.
    id string
    Specifies the ID of backup policy.
    maxBackups number
    Specifies maximum number of backups that can be automatically created for a backup object.
    name string
    Specifies the backup policy name.
    operationType string
    Specifies Operation type, which can be backup.
    permanent boolean
    Specifies whether backups are permanently retained.
    retentionDurationDays number
    Specifies duration of retaining a backup, in days.
    triggerId string
    Specifies Scheduler ID.
    triggerName string
    Specifies Scheduler name.
    triggerPattern string
    Specifies Scheduling policy of the scheduler.
    triggerType string
    Specifies Scheduler type.
    description str
    Specifies Scheduling period description.
    enabled bool
    Specifies whether the scheduling period is enabled.
    id str
    Specifies the ID of backup policy.
    max_backups float
    Specifies maximum number of backups that can be automatically created for a backup object.
    name str
    Specifies the backup policy name.
    operation_type str
    Specifies Operation type, which can be backup.
    permanent bool
    Specifies whether backups are permanently retained.
    retention_duration_days float
    Specifies duration of retaining a backup, in days.
    trigger_id str
    Specifies Scheduler ID.
    trigger_name str
    Specifies Scheduler name.
    trigger_pattern str
    Specifies Scheduling policy of the scheduler.
    trigger_type str
    Specifies Scheduler type.
    description String
    Specifies Scheduling period description.
    enabled Boolean
    Specifies whether the scheduling period is enabled.
    id String
    Specifies the ID of backup policy.
    maxBackups Number
    Specifies maximum number of backups that can be automatically created for a backup object.
    name String
    Specifies the backup policy name.
    operationType String
    Specifies Operation type, which can be backup.
    permanent Boolean
    Specifies whether backups are permanently retained.
    retentionDurationDays Number
    Specifies duration of retaining a backup, in days.
    triggerId String
    Specifies Scheduler ID.
    triggerName String
    Specifies Scheduler name.
    triggerPattern String
    Specifies Scheduling policy of the scheduler.
    triggerType String
    Specifies Scheduler type.

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud