1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. hbr
  5. EcsBackupClient
Alibaba Cloud v3.56.0 published on Friday, May 31, 2024 by Pulumi

alicloud.hbr.EcsBackupClient

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.56.0 published on Friday, May 31, 2024 by Pulumi

    Provides a Hybrid Backup Recovery (HBR) Ecs Backup Client resource.

    For information about Hybrid Backup Recovery (HBR) Ecs Backup Client and how to use it, see What is Ecs Backup Client.

    NOTE: Available in v1.132.0+.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const example = alicloud.getZones({
        availableResourceCreation: "Instance",
    });
    const exampleGetInstanceTypes = example.then(example => alicloud.ecs.getInstanceTypes({
        availabilityZone: example.zones?.[0]?.id,
        cpuCoreCount: 1,
        memorySize: 2,
    }));
    const exampleGetImages = alicloud.ecs.getImages({
        nameRegex: "^ubuntu_[0-9]+_[0-9]+_x64*",
        owners: "system",
    });
    const exampleNetwork = new alicloud.vpc.Network("example", {
        vpcName: "terraform-example",
        cidrBlock: "172.17.3.0/24",
    });
    const exampleSwitch = new alicloud.vpc.Switch("example", {
        vswitchName: "terraform-example",
        cidrBlock: "172.17.3.0/24",
        vpcId: exampleNetwork.id,
        zoneId: example.then(example => example.zones?.[0]?.id),
    });
    const exampleSecurityGroup = new alicloud.ecs.SecurityGroup("example", {
        name: "terraform-example",
        vpcId: exampleNetwork.id,
    });
    const exampleInstance = new alicloud.ecs.Instance("example", {
        imageId: exampleGetImages.then(exampleGetImages => exampleGetImages.images?.[0]?.id),
        instanceType: exampleGetInstanceTypes.then(exampleGetInstanceTypes => exampleGetInstanceTypes.instanceTypes?.[0]?.id),
        availabilityZone: example.then(example => example.zones?.[0]?.id),
        securityGroups: [exampleSecurityGroup.id],
        instanceName: "terraform-example",
        internetChargeType: "PayByBandwidth",
        vswitchId: exampleSwitch.id,
    });
    const exampleEcsBackupClient = new alicloud.hbr.EcsBackupClient("example", {
        instanceId: exampleInstance.id,
        useHttps: false,
        dataNetworkType: "VPC",
        maxCpuCore: "2",
        maxWorker: "4",
        dataProxySetting: "USE_CONTROL_PROXY",
        proxyHost: "192.168.11.101",
        proxyPort: "80",
        proxyUser: "user",
        proxyPassword: "password",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    example = alicloud.get_zones(available_resource_creation="Instance")
    example_get_instance_types = alicloud.ecs.get_instance_types(availability_zone=example.zones[0].id,
        cpu_core_count=1,
        memory_size=2)
    example_get_images = alicloud.ecs.get_images(name_regex="^ubuntu_[0-9]+_[0-9]+_x64*",
        owners="system")
    example_network = alicloud.vpc.Network("example",
        vpc_name="terraform-example",
        cidr_block="172.17.3.0/24")
    example_switch = alicloud.vpc.Switch("example",
        vswitch_name="terraform-example",
        cidr_block="172.17.3.0/24",
        vpc_id=example_network.id,
        zone_id=example.zones[0].id)
    example_security_group = alicloud.ecs.SecurityGroup("example",
        name="terraform-example",
        vpc_id=example_network.id)
    example_instance = alicloud.ecs.Instance("example",
        image_id=example_get_images.images[0].id,
        instance_type=example_get_instance_types.instance_types[0].id,
        availability_zone=example.zones[0].id,
        security_groups=[example_security_group.id],
        instance_name="terraform-example",
        internet_charge_type="PayByBandwidth",
        vswitch_id=example_switch.id)
    example_ecs_backup_client = alicloud.hbr.EcsBackupClient("example",
        instance_id=example_instance.id,
        use_https=False,
        data_network_type="VPC",
        max_cpu_core="2",
        max_worker="4",
        data_proxy_setting="USE_CONTROL_PROXY",
        proxy_host="192.168.11.101",
        proxy_port="80",
        proxy_user="user",
        proxy_password="password")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbr"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
    			AvailableResourceCreation: pulumi.StringRef("Instance"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleGetInstanceTypes, err := ecs.GetInstanceTypes(ctx, &ecs.GetInstanceTypesArgs{
    			AvailabilityZone: pulumi.StringRef(example.Zones[0].Id),
    			CpuCoreCount:     pulumi.IntRef(1),
    			MemorySize:       pulumi.Float64Ref(2),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleGetImages, err := ecs.GetImages(ctx, &ecs.GetImagesArgs{
    			NameRegex: pulumi.StringRef("^ubuntu_[0-9]+_[0-9]+_x64*"),
    			Owners:    pulumi.StringRef("system"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		exampleNetwork, err := vpc.NewNetwork(ctx, "example", &vpc.NetworkArgs{
    			VpcName:   pulumi.String("terraform-example"),
    			CidrBlock: pulumi.String("172.17.3.0/24"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleSwitch, err := vpc.NewSwitch(ctx, "example", &vpc.SwitchArgs{
    			VswitchName: pulumi.String("terraform-example"),
    			CidrBlock:   pulumi.String("172.17.3.0/24"),
    			VpcId:       exampleNetwork.ID(),
    			ZoneId:      pulumi.String(example.Zones[0].Id),
    		})
    		if err != nil {
    			return err
    		}
    		exampleSecurityGroup, err := ecs.NewSecurityGroup(ctx, "example", &ecs.SecurityGroupArgs{
    			Name:  pulumi.String("terraform-example"),
    			VpcId: exampleNetwork.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		exampleInstance, err := ecs.NewInstance(ctx, "example", &ecs.InstanceArgs{
    			ImageId:          pulumi.String(exampleGetImages.Images[0].Id),
    			InstanceType:     pulumi.String(exampleGetInstanceTypes.InstanceTypes[0].Id),
    			AvailabilityZone: pulumi.String(example.Zones[0].Id),
    			SecurityGroups: pulumi.StringArray{
    				exampleSecurityGroup.ID(),
    			},
    			InstanceName:       pulumi.String("terraform-example"),
    			InternetChargeType: pulumi.String("PayByBandwidth"),
    			VswitchId:          exampleSwitch.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = hbr.NewEcsBackupClient(ctx, "example", &hbr.EcsBackupClientArgs{
    			InstanceId:       exampleInstance.ID(),
    			UseHttps:         pulumi.Bool(false),
    			DataNetworkType:  pulumi.String("VPC"),
    			MaxCpuCore:       pulumi.String("2"),
    			MaxWorker:        pulumi.String("4"),
    			DataProxySetting: pulumi.String("USE_CONTROL_PROXY"),
    			ProxyHost:        pulumi.String("192.168.11.101"),
    			ProxyPort:        pulumi.String("80"),
    			ProxyUser:        pulumi.String("user"),
    			ProxyPassword:    pulumi.String("password"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = AliCloud.GetZones.Invoke(new()
        {
            AvailableResourceCreation = "Instance",
        });
    
        var exampleGetInstanceTypes = AliCloud.Ecs.GetInstanceTypes.Invoke(new()
        {
            AvailabilityZone = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            CpuCoreCount = 1,
            MemorySize = 2,
        });
    
        var exampleGetImages = AliCloud.Ecs.GetImages.Invoke(new()
        {
            NameRegex = "^ubuntu_[0-9]+_[0-9]+_x64*",
            Owners = "system",
        });
    
        var exampleNetwork = new AliCloud.Vpc.Network("example", new()
        {
            VpcName = "terraform-example",
            CidrBlock = "172.17.3.0/24",
        });
    
        var exampleSwitch = new AliCloud.Vpc.Switch("example", new()
        {
            VswitchName = "terraform-example",
            CidrBlock = "172.17.3.0/24",
            VpcId = exampleNetwork.Id,
            ZoneId = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        });
    
        var exampleSecurityGroup = new AliCloud.Ecs.SecurityGroup("example", new()
        {
            Name = "terraform-example",
            VpcId = exampleNetwork.Id,
        });
    
        var exampleInstance = new AliCloud.Ecs.Instance("example", new()
        {
            ImageId = exampleGetImages.Apply(getImagesResult => getImagesResult.Images[0]?.Id),
            InstanceType = exampleGetInstanceTypes.Apply(getInstanceTypesResult => getInstanceTypesResult.InstanceTypes[0]?.Id),
            AvailabilityZone = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            SecurityGroups = new[]
            {
                exampleSecurityGroup.Id,
            },
            InstanceName = "terraform-example",
            InternetChargeType = "PayByBandwidth",
            VswitchId = exampleSwitch.Id,
        });
    
        var exampleEcsBackupClient = new AliCloud.Hbr.EcsBackupClient("example", new()
        {
            InstanceId = exampleInstance.Id,
            UseHttps = false,
            DataNetworkType = "VPC",
            MaxCpuCore = "2",
            MaxWorker = "4",
            DataProxySetting = "USE_CONTROL_PROXY",
            ProxyHost = "192.168.11.101",
            ProxyPort = "80",
            ProxyUser = "user",
            ProxyPassword = "password",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.AlicloudFunctions;
    import com.pulumi.alicloud.inputs.GetZonesArgs;
    import com.pulumi.alicloud.ecs.EcsFunctions;
    import com.pulumi.alicloud.ecs.inputs.GetInstanceTypesArgs;
    import com.pulumi.alicloud.ecs.inputs.GetImagesArgs;
    import com.pulumi.alicloud.vpc.Network;
    import com.pulumi.alicloud.vpc.NetworkArgs;
    import com.pulumi.alicloud.vpc.Switch;
    import com.pulumi.alicloud.vpc.SwitchArgs;
    import com.pulumi.alicloud.ecs.SecurityGroup;
    import com.pulumi.alicloud.ecs.SecurityGroupArgs;
    import com.pulumi.alicloud.ecs.Instance;
    import com.pulumi.alicloud.ecs.InstanceArgs;
    import com.pulumi.alicloud.hbr.EcsBackupClient;
    import com.pulumi.alicloud.hbr.EcsBackupClientArgs;
    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 example = AlicloudFunctions.getZones(GetZonesArgs.builder()
                .availableResourceCreation("Instance")
                .build());
    
            final var exampleGetInstanceTypes = EcsFunctions.getInstanceTypes(GetInstanceTypesArgs.builder()
                .availabilityZone(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .cpuCoreCount(1)
                .memorySize(2)
                .build());
    
            final var exampleGetImages = EcsFunctions.getImages(GetImagesArgs.builder()
                .nameRegex("^ubuntu_[0-9]+_[0-9]+_x64*")
                .owners("system")
                .build());
    
            var exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
                .vpcName("terraform-example")
                .cidrBlock("172.17.3.0/24")
                .build());
    
            var exampleSwitch = new Switch("exampleSwitch", SwitchArgs.builder()
                .vswitchName("terraform-example")
                .cidrBlock("172.17.3.0/24")
                .vpcId(exampleNetwork.id())
                .zoneId(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .build());
    
            var exampleSecurityGroup = new SecurityGroup("exampleSecurityGroup", SecurityGroupArgs.builder()
                .name("terraform-example")
                .vpcId(exampleNetwork.id())
                .build());
    
            var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
                .imageId(exampleGetImages.applyValue(getImagesResult -> getImagesResult.images()[0].id()))
                .instanceType(exampleGetInstanceTypes.applyValue(getInstanceTypesResult -> getInstanceTypesResult.instanceTypes()[0].id()))
                .availabilityZone(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .securityGroups(exampleSecurityGroup.id())
                .instanceName("terraform-example")
                .internetChargeType("PayByBandwidth")
                .vswitchId(exampleSwitch.id())
                .build());
    
            var exampleEcsBackupClient = new EcsBackupClient("exampleEcsBackupClient", EcsBackupClientArgs.builder()
                .instanceId(exampleInstance.id())
                .useHttps(false)
                .dataNetworkType("VPC")
                .maxCpuCore(2)
                .maxWorker(4)
                .dataProxySetting("USE_CONTROL_PROXY")
                .proxyHost("192.168.11.101")
                .proxyPort(80)
                .proxyUser("user")
                .proxyPassword("password")
                .build());
    
        }
    }
    
    resources:
      exampleNetwork:
        type: alicloud:vpc:Network
        name: example
        properties:
          vpcName: terraform-example
          cidrBlock: 172.17.3.0/24
      exampleSwitch:
        type: alicloud:vpc:Switch
        name: example
        properties:
          vswitchName: terraform-example
          cidrBlock: 172.17.3.0/24
          vpcId: ${exampleNetwork.id}
          zoneId: ${example.zones[0].id}
      exampleSecurityGroup:
        type: alicloud:ecs:SecurityGroup
        name: example
        properties:
          name: terraform-example
          vpcId: ${exampleNetwork.id}
      exampleInstance:
        type: alicloud:ecs:Instance
        name: example
        properties:
          imageId: ${exampleGetImages.images[0].id}
          instanceType: ${exampleGetInstanceTypes.instanceTypes[0].id}
          availabilityZone: ${example.zones[0].id}
          securityGroups:
            - ${exampleSecurityGroup.id}
          instanceName: terraform-example
          internetChargeType: PayByBandwidth
          vswitchId: ${exampleSwitch.id}
      exampleEcsBackupClient:
        type: alicloud:hbr:EcsBackupClient
        name: example
        properties:
          instanceId: ${exampleInstance.id}
          useHttps: false
          dataNetworkType: VPC
          maxCpuCore: 2
          maxWorker: 4
          dataProxySetting: USE_CONTROL_PROXY
          proxyHost: 192.168.11.101
          proxyPort: 80
          proxyUser: user
          proxyPassword: password
    variables:
      example:
        fn::invoke:
          Function: alicloud:getZones
          Arguments:
            availableResourceCreation: Instance
      exampleGetInstanceTypes:
        fn::invoke:
          Function: alicloud:ecs:getInstanceTypes
          Arguments:
            availabilityZone: ${example.zones[0].id}
            cpuCoreCount: 1
            memorySize: 2
      exampleGetImages:
        fn::invoke:
          Function: alicloud:ecs:getImages
          Arguments:
            nameRegex: ^ubuntu_[0-9]+_[0-9]+_x64*
            owners: system
    

    Notice

    Note: Please read the following precautions carefully before deleting a client:

    1. You cannot delete active clients that have received heartbeat packets within one hour.
    2. You can make the client inactive by change the status of client to STOPPED.
    3. The resources bound to the client will be deleted in cascade, including:
      • Backup plan
      • Backup task (Running in the background)
      • Snapshot

    Create EcsBackupClient Resource

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

    Constructor syntax

    new EcsBackupClient(name: string, args: EcsBackupClientArgs, opts?: CustomResourceOptions);
    @overload
    def EcsBackupClient(resource_name: str,
                        args: EcsBackupClientArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def EcsBackupClient(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        instance_id: Optional[str] = None,
                        data_network_type: Optional[str] = None,
                        data_proxy_setting: Optional[str] = None,
                        max_cpu_core: Optional[str] = None,
                        max_worker: Optional[str] = None,
                        proxy_host: Optional[str] = None,
                        proxy_password: Optional[str] = None,
                        proxy_port: Optional[str] = None,
                        proxy_user: Optional[str] = None,
                        status: Optional[str] = None,
                        use_https: Optional[bool] = None)
    func NewEcsBackupClient(ctx *Context, name string, args EcsBackupClientArgs, opts ...ResourceOption) (*EcsBackupClient, error)
    public EcsBackupClient(string name, EcsBackupClientArgs args, CustomResourceOptions? opts = null)
    public EcsBackupClient(String name, EcsBackupClientArgs args)
    public EcsBackupClient(String name, EcsBackupClientArgs args, CustomResourceOptions options)
    
    type: alicloud:hbr:EcsBackupClient
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

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

    var ecsBackupClientResource = new AliCloud.Hbr.EcsBackupClient("ecsBackupClientResource", new()
    {
        InstanceId = "string",
        DataNetworkType = "string",
        DataProxySetting = "string",
        MaxCpuCore = "string",
        MaxWorker = "string",
        ProxyHost = "string",
        ProxyPassword = "string",
        ProxyPort = "string",
        ProxyUser = "string",
        Status = "string",
        UseHttps = false,
    });
    
    example, err := hbr.NewEcsBackupClient(ctx, "ecsBackupClientResource", &hbr.EcsBackupClientArgs{
    	InstanceId:       pulumi.String("string"),
    	DataNetworkType:  pulumi.String("string"),
    	DataProxySetting: pulumi.String("string"),
    	MaxCpuCore:       pulumi.String("string"),
    	MaxWorker:        pulumi.String("string"),
    	ProxyHost:        pulumi.String("string"),
    	ProxyPassword:    pulumi.String("string"),
    	ProxyPort:        pulumi.String("string"),
    	ProxyUser:        pulumi.String("string"),
    	Status:           pulumi.String("string"),
    	UseHttps:         pulumi.Bool(false),
    })
    
    var ecsBackupClientResource = new EcsBackupClient("ecsBackupClientResource", EcsBackupClientArgs.builder()
        .instanceId("string")
        .dataNetworkType("string")
        .dataProxySetting("string")
        .maxCpuCore("string")
        .maxWorker("string")
        .proxyHost("string")
        .proxyPassword("string")
        .proxyPort("string")
        .proxyUser("string")
        .status("string")
        .useHttps(false)
        .build());
    
    ecs_backup_client_resource = alicloud.hbr.EcsBackupClient("ecsBackupClientResource",
        instance_id="string",
        data_network_type="string",
        data_proxy_setting="string",
        max_cpu_core="string",
        max_worker="string",
        proxy_host="string",
        proxy_password="string",
        proxy_port="string",
        proxy_user="string",
        status="string",
        use_https=False)
    
    const ecsBackupClientResource = new alicloud.hbr.EcsBackupClient("ecsBackupClientResource", {
        instanceId: "string",
        dataNetworkType: "string",
        dataProxySetting: "string",
        maxCpuCore: "string",
        maxWorker: "string",
        proxyHost: "string",
        proxyPassword: "string",
        proxyPort: "string",
        proxyUser: "string",
        status: "string",
        useHttps: false,
    });
    
    type: alicloud:hbr:EcsBackupClient
    properties:
        dataNetworkType: string
        dataProxySetting: string
        instanceId: string
        maxCpuCore: string
        maxWorker: string
        proxyHost: string
        proxyPassword: string
        proxyPort: string
        proxyUser: string
        status: string
        useHttps: false
    

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

    InstanceId string
    The ID of ECS instance.
    DataNetworkType string
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    DataProxySetting string
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    MaxCpuCore string
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    MaxWorker string
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    ProxyHost string
    Custom data plane proxy server host address.
    ProxyPassword string
    The password of custom data plane proxy server.
    ProxyPort string
    Custom data plane proxy server host port.
    ProxyUser string
    The username of custom data plane proxy server.
    Status string
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    UseHttps bool
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    InstanceId string
    The ID of ECS instance.
    DataNetworkType string
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    DataProxySetting string
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    MaxCpuCore string
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    MaxWorker string
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    ProxyHost string
    Custom data plane proxy server host address.
    ProxyPassword string
    The password of custom data plane proxy server.
    ProxyPort string
    Custom data plane proxy server host port.
    ProxyUser string
    The username of custom data plane proxy server.
    Status string
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    UseHttps bool
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    instanceId String
    The ID of ECS instance.
    dataNetworkType String
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    dataProxySetting String
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    maxCpuCore String
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    maxWorker String
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    proxyHost String
    Custom data plane proxy server host address.
    proxyPassword String
    The password of custom data plane proxy server.
    proxyPort String
    Custom data plane proxy server host port.
    proxyUser String
    The username of custom data plane proxy server.
    status String
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    useHttps Boolean
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    instanceId string
    The ID of ECS instance.
    dataNetworkType string
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    dataProxySetting string
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    maxCpuCore string
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    maxWorker string
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    proxyHost string
    Custom data plane proxy server host address.
    proxyPassword string
    The password of custom data plane proxy server.
    proxyPort string
    Custom data plane proxy server host port.
    proxyUser string
    The username of custom data plane proxy server.
    status string
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    useHttps boolean
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    instance_id str
    The ID of ECS instance.
    data_network_type str
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    data_proxy_setting str
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    max_cpu_core str
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    max_worker str
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    proxy_host str
    Custom data plane proxy server host address.
    proxy_password str
    The password of custom data plane proxy server.
    proxy_port str
    Custom data plane proxy server host port.
    proxy_user str
    The username of custom data plane proxy server.
    status str
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    use_https bool
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    instanceId String
    The ID of ECS instance.
    dataNetworkType String
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    dataProxySetting String
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    maxCpuCore String
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    maxWorker String
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    proxyHost String
    Custom data plane proxy server host address.
    proxyPassword String
    The password of custom data plane proxy server.
    proxyPort String
    Custom data plane proxy server host port.
    proxyUser String
    The username of custom data plane proxy server.
    status String
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    useHttps Boolean
    Indicates whether to use the HTTPS protocol. Valid values: true, false.

    Outputs

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

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

    Look up Existing EcsBackupClient Resource

    Get an existing EcsBackupClient 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?: EcsBackupClientState, opts?: CustomResourceOptions): EcsBackupClient
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            data_network_type: Optional[str] = None,
            data_proxy_setting: Optional[str] = None,
            instance_id: Optional[str] = None,
            max_cpu_core: Optional[str] = None,
            max_worker: Optional[str] = None,
            proxy_host: Optional[str] = None,
            proxy_password: Optional[str] = None,
            proxy_port: Optional[str] = None,
            proxy_user: Optional[str] = None,
            status: Optional[str] = None,
            use_https: Optional[bool] = None) -> EcsBackupClient
    func GetEcsBackupClient(ctx *Context, name string, id IDInput, state *EcsBackupClientState, opts ...ResourceOption) (*EcsBackupClient, error)
    public static EcsBackupClient Get(string name, Input<string> id, EcsBackupClientState? state, CustomResourceOptions? opts = null)
    public static EcsBackupClient get(String name, Output<String> id, EcsBackupClientState 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:
    DataNetworkType string
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    DataProxySetting string
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    InstanceId string
    The ID of ECS instance.
    MaxCpuCore string
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    MaxWorker string
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    ProxyHost string
    Custom data plane proxy server host address.
    ProxyPassword string
    The password of custom data plane proxy server.
    ProxyPort string
    Custom data plane proxy server host port.
    ProxyUser string
    The username of custom data plane proxy server.
    Status string
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    UseHttps bool
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    DataNetworkType string
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    DataProxySetting string
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    InstanceId string
    The ID of ECS instance.
    MaxCpuCore string
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    MaxWorker string
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    ProxyHost string
    Custom data plane proxy server host address.
    ProxyPassword string
    The password of custom data plane proxy server.
    ProxyPort string
    Custom data plane proxy server host port.
    ProxyUser string
    The username of custom data plane proxy server.
    Status string
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    UseHttps bool
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    dataNetworkType String
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    dataProxySetting String
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    instanceId String
    The ID of ECS instance.
    maxCpuCore String
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    maxWorker String
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    proxyHost String
    Custom data plane proxy server host address.
    proxyPassword String
    The password of custom data plane proxy server.
    proxyPort String
    Custom data plane proxy server host port.
    proxyUser String
    The username of custom data plane proxy server.
    status String
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    useHttps Boolean
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    dataNetworkType string
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    dataProxySetting string
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    instanceId string
    The ID of ECS instance.
    maxCpuCore string
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    maxWorker string
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    proxyHost string
    Custom data plane proxy server host address.
    proxyPassword string
    The password of custom data plane proxy server.
    proxyPort string
    Custom data plane proxy server host port.
    proxyUser string
    The username of custom data plane proxy server.
    status string
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    useHttps boolean
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    data_network_type str
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    data_proxy_setting str
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    instance_id str
    The ID of ECS instance.
    max_cpu_core str
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    max_worker str
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    proxy_host str
    Custom data plane proxy server host address.
    proxy_password str
    The password of custom data plane proxy server.
    proxy_port str
    Custom data plane proxy server host port.
    proxy_user str
    The username of custom data plane proxy server.
    status str
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    use_https bool
    Indicates whether to use the HTTPS protocol. Valid values: true, false.
    dataNetworkType String
    The data plane access point type. Valid values: CLASSIC, PUBLIC, VPC. NOTE: The value of CLASSIC has been deprecated in v1.161.0+.
    dataProxySetting String
    The data plane proxy settings. Valid values: CUSTOM, DISABLE, USE_CONTROL_PROXY.
    instanceId String
    The ID of ECS instance.
    maxCpuCore String
    The number of CPU cores used by a single backup task, 0 means no restrictions.
    maxWorker String
    The number of concurrent jobs for a single backup task, 0 means no restrictions.
    proxyHost String
    Custom data plane proxy server host address.
    proxyPassword String
    The password of custom data plane proxy server.
    proxyPort String
    Custom data plane proxy server host port.
    proxyUser String
    The username of custom data plane proxy server.
    status String
    Status of client. Valid values: ACTIVATED, STOPPED. You can start or stop the client by specifying the status.
    useHttps Boolean
    Indicates whether to use the HTTPS protocol. Valid values: true, false.

    Import

    Hybrid Backup Recovery (HBR) Ecs Backup Client can be imported using the id, e.g.

    $ pulumi import alicloud:hbr/ecsBackupClient:EcsBackupClient example <id>
    

    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.
    alicloud logo
    Alibaba Cloud v3.56.0 published on Friday, May 31, 2024 by Pulumi