@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
130 lines (129 loc) • 3.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage iam role
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.iam.Role("foo", {
* description: "acc-test",
* displayName: "acc-test",
* maxSessionDuration: 3600,
* roleName: "acc-test-role",
* trustPolicyDocument: "{\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"sts:AssumeRole\"],\"Principal\":{\"Service\":[\"auto_scaling\"]}}]}",
* });
* ```
*
* ## Import
*
* Iam role can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:iam/role:Role default TerraformTestRole
* ```
*/
export declare class Role extends pulumi.CustomResource {
/**
* Get an existing Role 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?: RoleState, opts?: pulumi.CustomResourceOptions): Role;
/**
* Returns true if the given object is an instance of Role. 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 Role;
/**
* The description of the Role.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The display name of the Role.
*/
readonly displayName: pulumi.Output<string>;
/**
* The max session duration of the Role.
*/
readonly maxSessionDuration: pulumi.Output<number | undefined>;
/**
* The name of the Role.
*/
readonly roleName: pulumi.Output<string>;
/**
* The resource name of the Role.
*/
readonly trn: pulumi.Output<string>;
/**
* The trust policy document of the Role.
*/
readonly trustPolicyDocument: pulumi.Output<string>;
/**
* Create a Role 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: RoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Role resources.
*/
export interface RoleState {
/**
* The description of the Role.
*/
description?: pulumi.Input<string>;
/**
* The display name of the Role.
*/
displayName?: pulumi.Input<string>;
/**
* The max session duration of the Role.
*/
maxSessionDuration?: pulumi.Input<number>;
/**
* The name of the Role.
*/
roleName?: pulumi.Input<string>;
/**
* The resource name of the Role.
*/
trn?: pulumi.Input<string>;
/**
* The trust policy document of the Role.
*/
trustPolicyDocument?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Role resource.
*/
export interface RoleArgs {
/**
* The description of the Role.
*/
description?: pulumi.Input<string>;
/**
* The display name of the Role.
*/
displayName: pulumi.Input<string>;
/**
* The max session duration of the Role.
*/
maxSessionDuration?: pulumi.Input<number>;
/**
* The name of the Role.
*/
roleName: pulumi.Input<string>;
/**
* The trust policy document of the Role.
*/
trustPolicyDocument: pulumi.Input<string>;
}