com.pulumi.alicloud.hbr.EcsBackupClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of alicloud Show documentation
Show all versions of alicloud Show documentation
A Pulumi package for creating and managing AliCloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.alicloud.hbr;
import com.pulumi.alicloud.Utilities;
import com.pulumi.alicloud.hbr.EcsBackupClientArgs;
import com.pulumi.alicloud.hbr.inputs.EcsBackupClientState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import javax.annotation.Nullable;
/**
* 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](https://www.alibabacloud.com/help/doc-detail/186570.htm).
*
* > **NOTE:** Available in v1.132.0+.
*
* ## Example Usage
*
* Basic Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## 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
*
* ## Import
*
* Hybrid Backup Recovery (HBR) Ecs Backup Client can be imported using the id, e.g.
*
* ```sh
* $ pulumi import alicloud:hbr/ecsBackupClient:EcsBackupClient example <id>
* ```
*
*/
@ResourceType(type="alicloud:hbr/ecsBackupClient:EcsBackupClient")
public class EcsBackupClient extends com.pulumi.resources.CustomResource {
/**
* The data plane access point type. Valid values: `CLASSIC`, `PUBLIC`, `VPC`. **NOTE:** The value of `CLASSIC` has been deprecated in v1.161.0+.
*
*/
@Export(name="dataNetworkType", refs={String.class}, tree="[0]")
private Output dataNetworkType;
/**
* @return The data plane access point type. Valid values: `CLASSIC`, `PUBLIC`, `VPC`. **NOTE:** The value of `CLASSIC` has been deprecated in v1.161.0+.
*
*/
public Output dataNetworkType() {
return this.dataNetworkType;
}
/**
* The data plane proxy settings. Valid values: `CUSTOM`, `DISABLE`, `USE_CONTROL_PROXY`.
*
*/
@Export(name="dataProxySetting", refs={String.class}, tree="[0]")
private Output dataProxySetting;
/**
* @return The data plane proxy settings. Valid values: `CUSTOM`, `DISABLE`, `USE_CONTROL_PROXY`.
*
*/
public Output dataProxySetting() {
return this.dataProxySetting;
}
/**
* The ID of ECS instance.
*
*/
@Export(name="instanceId", refs={String.class}, tree="[0]")
private Output instanceId;
/**
* @return The ID of ECS instance.
*
*/
public Output instanceId() {
return this.instanceId;
}
/**
* The number of CPU cores used by a single backup task, 0 means no restrictions.
*
*/
@Export(name="maxCpuCore", refs={String.class}, tree="[0]")
private Output maxCpuCore;
/**
* @return The number of CPU cores used by a single backup task, 0 means no restrictions.
*
*/
public Output maxCpuCore() {
return this.maxCpuCore;
}
/**
* The number of concurrent jobs for a single backup task, 0 means no restrictions.
*
*/
@Export(name="maxWorker", refs={String.class}, tree="[0]")
private Output maxWorker;
/**
* @return The number of concurrent jobs for a single backup task, 0 means no restrictions.
*
*/
public Output maxWorker() {
return this.maxWorker;
}
/**
* Custom data plane proxy server host address.
*
*/
@Export(name="proxyHost", refs={String.class}, tree="[0]")
private Output proxyHost;
/**
* @return Custom data plane proxy server host address.
*
*/
public Output proxyHost() {
return this.proxyHost;
}
/**
* The password of custom data plane proxy server.
*
*/
@Export(name="proxyPassword", refs={String.class}, tree="[0]")
private Output proxyPassword;
/**
* @return The password of custom data plane proxy server.
*
*/
public Output proxyPassword() {
return this.proxyPassword;
}
/**
* Custom data plane proxy server host port.
*
*/
@Export(name="proxyPort", refs={String.class}, tree="[0]")
private Output proxyPort;
/**
* @return Custom data plane proxy server host port.
*
*/
public Output proxyPort() {
return this.proxyPort;
}
/**
* The username of custom data plane proxy server.
*
*/
@Export(name="proxyUser", refs={String.class}, tree="[0]")
private Output proxyUser;
/**
* @return The username of custom data plane proxy server.
*
*/
public Output proxyUser() {
return this.proxyUser;
}
/**
* Status of client. Valid values: `ACTIVATED`, `STOPPED`. You can start or stop the client by specifying the status.
*
*/
@Export(name="status", refs={String.class}, tree="[0]")
private Output status;
/**
* @return Status of client. Valid values: `ACTIVATED`, `STOPPED`. You can start or stop the client by specifying the status.
*
*/
public Output status() {
return this.status;
}
/**
* Indicates whether to use the HTTPS protocol. Valid values: `true`, `false`.
*
*/
@Export(name="useHttps", refs={Boolean.class}, tree="[0]")
private Output useHttps;
/**
* @return Indicates whether to use the HTTPS protocol. Valid values: `true`, `false`.
*
*/
public Output useHttps() {
return this.useHttps;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public EcsBackupClient(String name) {
this(name, EcsBackupClientArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public EcsBackupClient(String name, EcsBackupClientArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public EcsBackupClient(String name, EcsBackupClientArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("alicloud:hbr/ecsBackupClient:EcsBackupClient", name, args == null ? EcsBackupClientArgs.Empty : args, makeResourceOptions(options, Codegen.empty()));
}
private EcsBackupClient(String name, Output id, @Nullable EcsBackupClientState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("alicloud:hbr/ecsBackupClient:EcsBackupClient", name, state, makeResourceOptions(options, id));
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static EcsBackupClient get(String name, Output id, @Nullable EcsBackupClientState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new EcsBackupClient(name, id, state, options);
}
}