@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
184 lines (183 loc) • 5.85 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 organization account
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooUnit = new volcengine.organization.Unit("fooUnit", {
* parentId: "730671013833632****",
* description: "acc-test",
* });
* const fooAccount = new volcengine.organization.Account("fooAccount", {
* accountName: "acc-test-account",
* showName: "acc-test-account",
* description: "acc-test",
* orgUnitId: fooUnit.id,
* verificationRelationId: "210026****",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* ```
*
* ## Import
*
* OrganizationAccount can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:organization/account:Account default resource_id
* ```
*/
export declare class Account extends pulumi.CustomResource {
/**
* Get an existing Account 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?: AccountState, opts?: pulumi.CustomResourceOptions): Account;
/**
* Returns true if the given object is an instance of Account. 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 Account;
/**
* The name of the account.
*/
readonly accountName: pulumi.Output<string>;
/**
* The description of the account.
*/
readonly description: pulumi.Output<string>;
/**
* The name of the iam role.
*/
readonly iamRole: pulumi.Output<string>;
/**
* The id of the organization.
*/
readonly orgId: pulumi.Output<string>;
/**
* The id of the organization unit. Default is root organization.
*/
readonly orgUnitId: pulumi.Output<string>;
/**
* The name of the organization unit.
*/
readonly orgUnitName: pulumi.Output<string>;
/**
* The id of the organization verification.
*/
readonly orgVerificationId: pulumi.Output<string>;
/**
* The owner id of the account.
*/
readonly owner: pulumi.Output<string>;
/**
* The show name of the account.
*/
readonly showName: pulumi.Output<string>;
/**
* Tags.
*/
readonly tags: pulumi.Output<outputs.organization.AccountTag[] | undefined>;
/**
* The verification relation id of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly verificationRelationId: pulumi.Output<string | undefined>;
/**
* Create a Account 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: AccountArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Account resources.
*/
export interface AccountState {
/**
* The name of the account.
*/
accountName?: pulumi.Input<string>;
/**
* The description of the account.
*/
description?: pulumi.Input<string>;
/**
* The name of the iam role.
*/
iamRole?: pulumi.Input<string>;
/**
* The id of the organization.
*/
orgId?: pulumi.Input<string>;
/**
* The id of the organization unit. Default is root organization.
*/
orgUnitId?: pulumi.Input<string>;
/**
* The name of the organization unit.
*/
orgUnitName?: pulumi.Input<string>;
/**
* The id of the organization verification.
*/
orgVerificationId?: pulumi.Input<string>;
/**
* The owner id of the account.
*/
owner?: pulumi.Input<string>;
/**
* The show name of the account.
*/
showName?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.organization.AccountTag>[]>;
/**
* The verification relation id of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
verificationRelationId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Account resource.
*/
export interface AccountArgs {
/**
* The name of the account.
*/
accountName: pulumi.Input<string>;
/**
* The description of the account.
*/
description?: pulumi.Input<string>;
/**
* The id of the organization unit. Default is root organization.
*/
orgUnitId?: pulumi.Input<string>;
/**
* The show name of the account.
*/
showName: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.organization.AccountTag>[]>;
/**
* The verification relation id of the account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
verificationRelationId?: pulumi.Input<string>;
}