@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
221 lines (220 loc) • 7.25 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage ebs snapshot group
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooZones = volcengine.ecs.getZones({});
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-vpc",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-test-subnet",
* cidrBlock: "172.16.0.0/24",
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* vpcId: fooVpc.id,
* });
* const fooSecurityGroup = new volcengine.vpc.SecurityGroup("fooSecurityGroup", {
* securityGroupName: "acc-test-security-group",
* vpcId: fooVpc.id,
* });
* const fooImages = volcengine.ecs.getImages({
* osType: "Linux",
* visibility: "public",
* instanceTypeId: "ecs.g3il.large",
* });
* const fooInstance = new volcengine.ecs.Instance("fooInstance", {
* instanceName: "acc-test-ecs",
* description: "acc-test",
* hostName: "tf-acc-test",
* imageId: fooImages.then(fooImages => fooImages.images?.[0]?.imageId),
* instanceType: "ecs.g3il.large",
* password: "93f0cb0614Aab12",
* instanceChargeType: "PostPaid",
* systemVolumeType: "ESSD_PL0",
* systemVolumeSize: 40,
* subnetId: fooSubnet.id,
* securityGroupIds: [fooSecurityGroup.id],
* projectName: "default",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* const fooVolume = new volcengine.ebs.Volume("fooVolume", {
* volumeName: "acc-test-volume",
* volumeType: "ESSD_PL0",
* description: "acc-test",
* kind: "data",
* size: 500,
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* volumeChargeType: "PostPaid",
* projectName: "default",
* });
* const fooVolumeAttach = new volcengine.ebs.VolumeAttach("fooVolumeAttach", {
* instanceId: fooInstance.id,
* volumeId: fooVolume.id,
* });
* const fooSnapshotGroup = new volcengine.ebs.SnapshotGroup("fooSnapshotGroup", {
* volumeIds: [
* fooInstance.systemVolumeId,
* fooVolume.id,
* ],
* instanceId: fooInstance.id,
* description: "acc-test",
* projectName: "default",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* }, {
* dependsOn: [fooVolumeAttach],
* });
* ```
*
* ## Import
*
* EbsSnapshotGroup can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:ebs/snapshotGroup:SnapshotGroup default resource_id
* ```
*/
export declare class SnapshotGroup extends pulumi.CustomResource {
/**
* Get an existing SnapshotGroup 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 Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SnapshotGroupState, opts?: pulumi.CustomResourceOptions): SnapshotGroup;
/**
* Returns true if the given object is an instance of SnapshotGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is SnapshotGroup;
/**
* The creation time of the snapshot group.
*/
readonly creationTime: pulumi.Output<string>;
/**
* The instance id of the snapshot group.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The image id of the snapshot group.
*/
readonly imageId: pulumi.Output<string>;
/**
* The instance id of the snapshot group.
*/
readonly instanceId: pulumi.Output<string>;
/**
* The name of the snapshot group.
*/
readonly name: pulumi.Output<string>;
/**
* The project name of the snapshot group.
*/
readonly projectName: pulumi.Output<string>;
/**
* The status of the snapshot group.
*/
readonly status: pulumi.Output<string>;
/**
* Tags.
*/
readonly tags: pulumi.Output<outputs.ebs.SnapshotGroupTag[] | undefined>;
/**
* The volume id of the snapshot group. The status of the volume must be `attached`.If multiple volumes are specified, they need to be attached to the same ECS instance.
*/
readonly volumeIds: pulumi.Output<string[]>;
/**
* Create a SnapshotGroup resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: SnapshotGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SnapshotGroup resources.
*/
export interface SnapshotGroupState {
/**
* The creation time of the snapshot group.
*/
creationTime?: pulumi.Input<string>;
/**
* The instance id of the snapshot group.
*/
description?: pulumi.Input<string>;
/**
* The image id of the snapshot group.
*/
imageId?: pulumi.Input<string>;
/**
* The instance id of the snapshot group.
*/
instanceId?: pulumi.Input<string>;
/**
* The name of the snapshot group.
*/
name?: pulumi.Input<string>;
/**
* The project name of the snapshot group.
*/
projectName?: pulumi.Input<string>;
/**
* The status of the snapshot group.
*/
status?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.ebs.SnapshotGroupTag>[]>;
/**
* The volume id of the snapshot group. The status of the volume must be `attached`.If multiple volumes are specified, they need to be attached to the same ECS instance.
*/
volumeIds?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a SnapshotGroup resource.
*/
export interface SnapshotGroupArgs {
/**
* The instance id of the snapshot group.
*/
description?: pulumi.Input<string>;
/**
* The instance id of the snapshot group.
*/
instanceId?: pulumi.Input<string>;
/**
* The name of the snapshot group.
*/
name?: pulumi.Input<string>;
/**
* The project name of the snapshot group.
*/
projectName?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.ebs.SnapshotGroupTag>[]>;
/**
* The volume id of the snapshot group. The status of the volume must be `attached`.If multiple volumes are specified, they need to be attached to the same ECS instance.
*/
volumeIds: pulumi.Input<pulumi.Input<string>[]>;
}