@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
135 lines (134 loc) • 5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage mongodb ssl state
* ## 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 fooInstance = new volcengine.mongodb.Instance("fooInstance", {
* dbEngineVersion: "MongoDB_4_0",
* instanceType: "ReplicaSet",
* superAccountPassword: "@acc-test-123",
* nodeSpec: "mongo.2c4g",
* mongosNodeSpec: "mongo.mongos.2c4g",
* instanceName: "acc-test-mongo-replica",
* chargeType: "PostPaid",
* projectName: "default",
* mongosNodeNumber: 2,
* shardNumber: 3,
* storageSpaceGb: 20,
* subnetId: fooSubnet.id,
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* const fooSslState = new volcengine.mongodb.SslState("fooSslState", {instanceId: fooInstance.id});
* ```
*
* ## Import
*
* mongodb ssl state can be imported using the ssl:instanceId, e.g.
*
* ```sh
* $ pulumi import volcengine:mongodb/sslState:SslState default ssl:mongo-shard-d050db19xxx
* ```
*/
export declare class SslState extends pulumi.CustomResource {
/**
* Get an existing SslState 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?: SslStateState, opts?: pulumi.CustomResourceOptions): SslState;
/**
* Returns true if the given object is an instance of SslState. 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 SslState;
/**
* The ID of mongodb instance.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Whetehr SSL is valid.
*/
readonly isValid: pulumi.Output<boolean>;
/**
* The action of ssl, valid value contains `Update`. Set `sslAction` to `Update` will will trigger an SSL update operation when executing `pulumi up`.When the current time is less than 30 days from the `sslExpiredTime`, executing `pulumi up` will automatically renew the SSL.
*/
readonly sslAction: pulumi.Output<string | undefined>;
/**
* Whether SSL is enabled.
*/
readonly sslEnable: pulumi.Output<boolean>;
/**
* The expire time of SSL.
*/
readonly sslExpiredTime: pulumi.Output<string>;
/**
* Create a SslState 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: SslStateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SslState resources.
*/
export interface SslStateState {
/**
* The ID of mongodb instance.
*/
instanceId?: pulumi.Input<string>;
/**
* Whetehr SSL is valid.
*/
isValid?: pulumi.Input<boolean>;
/**
* The action of ssl, valid value contains `Update`. Set `sslAction` to `Update` will will trigger an SSL update operation when executing `pulumi up`.When the current time is less than 30 days from the `sslExpiredTime`, executing `pulumi up` will automatically renew the SSL.
*/
sslAction?: pulumi.Input<string>;
/**
* Whether SSL is enabled.
*/
sslEnable?: pulumi.Input<boolean>;
/**
* The expire time of SSL.
*/
sslExpiredTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SslState resource.
*/
export interface SslStateArgs {
/**
* The ID of mongodb instance.
*/
instanceId: pulumi.Input<string>;
/**
* The action of ssl, valid value contains `Update`. Set `sslAction` to `Update` will will trigger an SSL update operation when executing `pulumi up`.When the current time is less than 30 days from the `sslExpiredTime`, executing `pulumi up` will automatically renew the SSL.
*/
sslAction?: pulumi.Input<string>;
}