@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
116 lines (115 loc) • 5.33 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## yandex\_kms\_symmetric\_key\_iam\_binding
*
* Allows creation and management of a single binding within IAM policy for
* an existing Yandex KMS Symmetric Key.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const your_key = new yandex.KmsSymmetricKey("your-key", {folderId: "your-folder-id"});
* const viewer = new yandex.KmsSymmetricKeyIamBinding("viewer", {
* symmetricKeyId: your_key.id,
* role: "viewer",
* members: ["userAccount:foo_user_id"],
* });
* ```
*
* ## Import
*
* IAM binding imports use space-delimited identifiers; first the resource in question and then the role. These bindings can be imported using the `symmetric_key_id` and role, e.g.
*
* ```sh
* $ pulumi import yandex:index/kmsSymmetricKeyIamBinding:KmsSymmetricKeyIamBinding viewer "symmetric_key_id viewer"
* ```
*/
export declare class KmsSymmetricKeyIamBinding extends pulumi.CustomResource {
/**
* Get an existing KmsSymmetricKeyIamBinding 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?: KmsSymmetricKeyIamBindingState, opts?: pulumi.CustomResourceOptions): KmsSymmetricKeyIamBinding;
/**
* Returns true if the given object is an instance of KmsSymmetricKeyIamBinding. 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 KmsSymmetricKeyIamBinding;
/**
* 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.
* * **system:{allUsers|allAuthenticatedUsers}**: see [system groups](https://cloud.yandex.com/docs/iam/concepts/access-control/system-group)
*/
readonly members: pulumi.Output<string[]>;
/**
* The role that should be applied. See [roles](https://cloud.yandex.com/docs/kms/security/).
*/
readonly role: pulumi.Output<string>;
readonly sleepAfter: pulumi.Output<number | undefined>;
/**
* The [Yandex Key Management Service](https://cloud.yandex.com/docs/kms/) Symmetric Key ID to apply a binding to.
*/
readonly symmetricKeyId: pulumi.Output<string>;
/**
* Create a KmsSymmetricKeyIamBinding 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: KmsSymmetricKeyIamBindingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering KmsSymmetricKeyIamBinding resources.
*/
export interface KmsSymmetricKeyIamBindingState {
/**
* 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.
* * **system:{allUsers|allAuthenticatedUsers}**: see [system groups](https://cloud.yandex.com/docs/iam/concepts/access-control/system-group)
*/
members?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The role that should be applied. See [roles](https://cloud.yandex.com/docs/kms/security/).
*/
role?: pulumi.Input<string>;
sleepAfter?: pulumi.Input<number>;
/**
* The [Yandex Key Management Service](https://cloud.yandex.com/docs/kms/) Symmetric Key ID to apply a binding to.
*/
symmetricKeyId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a KmsSymmetricKeyIamBinding resource.
*/
export interface KmsSymmetricKeyIamBindingArgs {
/**
* 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.
* * **system:{allUsers|allAuthenticatedUsers}**: see [system groups](https://cloud.yandex.com/docs/iam/concepts/access-control/system-group)
*/
members: pulumi.Input<pulumi.Input<string>[]>;
/**
* The role that should be applied. See [roles](https://cloud.yandex.com/docs/kms/security/).
*/
role: pulumi.Input<string>;
sleepAfter?: pulumi.Input<number>;
/**
* The [Yandex Key Management Service](https://cloud.yandex.com/docs/kms/) Symmetric Key ID to apply a binding to.
*/
symmetricKeyId: pulumi.Input<string>;
}