@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
125 lines (124 loc) • 5.92 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* When managing IAM roles, you can treat a service account either as a resource or as an identity.
* This resource is used to add IAM policy bindings to a service account resource to configure permissions
* that define who can edit the service account.
*
* There are three different resources that help you manage your IAM policy for a service account.
* Each of these resources is used for a different use case:
*
* * yandex_iam_service_account_iam_policy: Authoritative. Sets the IAM policy for the service account and replaces any existing policy already attached.
* * yandex_iam_service_account_iam_binding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the service account are preserved.
* * yandex_iam_service_account_iam_member: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role of the service account are preserved.
*
* > **Note:** `yandex.IamServiceAccountIamPolicy` **cannot** be used in conjunction with `yandex.IamServiceAccountIamBinding` and `yandex.IamServiceAccountIamMember` or they will conflict over what your policy should be.
*
* > **Note:** `yandex.IamServiceAccountIamBinding` resources **can be** used in conjunction with `yandex.IamServiceAccountIamMember` resources **only if** they do not grant privileges to the same role.
*
* ## yandex\_service\_account\_iam\_binding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const admin_account_iam = new yandex.IamServiceAccountIamBinding("admin-account-iam", {
* members: ["userAccount:foo_user_id"],
* role: "admin",
* serviceAccountId: "your-service-account-id",
* });
* ```
*
* ## Import
*
* Service account IAM binding resources can be imported using the service account ID and role.
*
* ```sh
* $ pulumi import yandex:index/iamServiceAccountIamBinding:IamServiceAccountIamBinding admin-account-iam "service_account_id roles/editor"
* ```
*/
export declare class IamServiceAccountIamBinding extends pulumi.CustomResource {
/**
* Get an existing IamServiceAccountIamBinding 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?: IamServiceAccountIamBindingState, opts?: pulumi.CustomResourceOptions): IamServiceAccountIamBinding;
/**
* Returns true if the given object is an instance of IamServiceAccountIamBinding. 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 IamServiceAccountIamBinding;
/**
* Identities that will be granted the privilege in `role`.
* Each entry can have one of the following values:
* * **userAccount:{user_id}**: A unique user ID that represents a specific Yandex account.
* * **serviceAccount:{service_account_id}**: A unique service account ID.
*/
readonly members: pulumi.Output<string[]>;
/**
* The role that should be applied. Only one
* `yandex.IamServiceAccountIamBinding` can be used per role.
*/
readonly role: pulumi.Output<string>;
/**
* The service account ID to apply a binding to.
*/
readonly serviceAccountId: pulumi.Output<string>;
readonly sleepAfter: pulumi.Output<number | undefined>;
/**
* Create a IamServiceAccountIamBinding 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: IamServiceAccountIamBindingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IamServiceAccountIamBinding resources.
*/
export interface IamServiceAccountIamBindingState {
/**
* Identities that will be granted the privilege in `role`.
* Each entry can have one of the following values:
* * **userAccount:{user_id}**: A unique user ID that represents a specific Yandex account.
* * **serviceAccount:{service_account_id}**: A unique service account ID.
*/
members?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The role that should be applied. Only one
* `yandex.IamServiceAccountIamBinding` can be used per role.
*/
role?: pulumi.Input<string>;
/**
* The service account ID to apply a binding to.
*/
serviceAccountId?: pulumi.Input<string>;
sleepAfter?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a IamServiceAccountIamBinding resource.
*/
export interface IamServiceAccountIamBindingArgs {
/**
* Identities that will be granted the privilege in `role`.
* Each entry can have one of the following values:
* * **userAccount:{user_id}**: A unique user ID that represents a specific Yandex account.
* * **serviceAccount:{service_account_id}**: A unique service account ID.
*/
members: pulumi.Input<pulumi.Input<string>[]>;
/**
* The role that should be applied. Only one
* `yandex.IamServiceAccountIamBinding` can be used per role.
*/
role: pulumi.Input<string>;
/**
* The service account ID to apply a binding to.
*/
serviceAccountId: pulumi.Input<string>;
sleepAfter?: pulumi.Input<number>;
}