@microsoft/terraform-cdk-constructs 0.0.3-pre.6 → 0.0.3-pre.7

package/lib/azure-keyvault/lib/secret.js

@@ -6,6 +6,37 @@ const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
 const key_vault_secret_1 = require("@cdktf/provider-azurerm/lib/key-vault-secret");
 const constructs_1 = require("constructs");
 class Secret extends constructs_1.Construct {
+    /**
+     * Constructs a new Azure Key Vault Secret within a specified Key Vault.
+     *
+     * This class facilitates the creation and management of a secret, allowing sensitive information to be stored securely
+     * and accessed as needed while maintaining confidentiality and control through defined access policies.
+     *
+     * @param scope - The scope in which to define this construct, typically representing the Cloud Development Kit (CDK) stack.
+     * @param id - The unique identifier for this instance of the secret.
+     * @param props - The properties for creating the secret as defined in SecretProps. These include:
+     *                - `keyVaultId`: The ID of the Key Vault in which to store the secret.
+     *                - `name`: The name of the secret.
+     *                - `value`: The confidential data to be stored as the secret.
+     *                - `expirationDate`: Optional. The expiration date of the secret.
+     *                - `contentType`: Optional. A label hinting at the content type of the secret's value.
+     *                - `accessPolicies`: Access policies that dictate permissions for the secret.
+     *
+     * Example usage:
+     * ```typescript
+     * new Secret(this, 'mySecret', {
+     *   keyVaultId: myKeyVault,
+     *   name: 'dbPassword',
+     *   value: 'p@ssw0rd!',
+     *   expirationDate: '2030-01-01T00:00:00Z',
+     *   contentType: 'password',
+     *   accessPolicies: [{
+     *     objectId: '12345-user-object-id',
+     *     permissions: ['get', 'list']
+     *   }]
+     * });
+     * ```
+     */
     constructor(scope, id, props) {
         super(scope, id);
         // Logic to add the secret to the provided keyVault instance
@@ -29,5 +60,5 @@ class Secret extends constructs_1.Construct {
 }
 exports.Secret = Secret;
 _a = JSII_RTTI_SYMBOL_1;
-Secret[_a] = { fqn: "@microsoft/terraform-cdk-constructs.azure_keyvault.Secret", version: "0.0.3-pre.6" };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VjcmV0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2F6dXJlLWtleXZhdWx0L2xpYi9zZWNyZXQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSxtRkFBOEU7QUFDOUUsMkNBQXVDO0FBMEN2QyxNQUFhLE1BQU8sU0FBUSxzQkFBUztJQUduQyxZQUFZLEtBQWdCLEVBQUUsRUFBVSxFQUFFLEtBQWtCO1FBQzFELEtBQUssQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFFakIsNERBQTREO1FBQzVELGVBQWU7UUFDZixNQUFNLE1BQU0sR0FBRyxJQUFJLGlDQUFjLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxJQUFJLEVBQUU7WUFDbEQsVUFBVSxFQUFFLEtBQUssQ0FBQyxVQUFVLENBQUMsRUFBRTtZQUMvQixJQUFJLEVBQUUsS0FBSyxDQUFDLElBQUk7WUFDaEIsS0FBSyxFQUFFLEtBQUssQ0FBQyxLQUFLO1lBQ2xCLFdBQVcsRUFBRSxLQUFLLENBQUMsV0FBVztZQUM5QixjQUFjLEVBQUUsS0FBSyxDQUFDLGNBQWM7U0FDckMsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLFFBQVEsR0FBRyxNQUFNLENBQUMsRUFBRSxDQUFDO1FBRTFCLGlDQUFpQztRQUNqQyxNQUFNLFlBQVksR0FBYSxFQUFFLENBQUM7UUFDbEMsS0FBSyxNQUFNLE1BQU0sSUFBSSxLQUFLLENBQUMsY0FBYyxFQUFFO1lBQ3pDLFlBQVksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDO1NBQ2hDO1FBRUQsd0NBQXdDO1FBQ3hDLE1BQU0sQ0FBQyxXQUFXLENBQUMsWUFBWSxFQUFFLFlBQVksQ0FBQyxDQUFDO0lBQ2pELENBQUM7O0FBMUJILHdCQTJCQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEtleVZhdWx0U2VjcmV0IH0gZnJvbSBcIkBjZGt0Zi9wcm92aWRlci1henVyZXJtL2xpYi9rZXktdmF1bHQtc2VjcmV0XCI7XG5pbXBvcnQgeyBDb25zdHJ1Y3QgfSBmcm9tIFwiY29uc3RydWN0c1wiO1xuaW1wb3J0IHsgQWNjZXNzUG9saWN5IH0gZnJvbSBcIi4vcG9saWN5XCI7XG5pbXBvcnQgeyBWYXVsdCB9IGZyb20gXCIuL3ZhdWx0XCI7XG5cbi8qKlxuICogUHJvcGVydGllcyBmb3IgZGVmaW5pbmcgYW4gQXp1cmUgS2V5IFZhdWx0IFNlY3JldC5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBTZWNyZXRQcm9wcyB7XG4gIC8qKlxuICAgKiBUaGUgS2V5IFZhdWx0IGluc3RhbmNlIHdoZXJlIHRoZSBzZWNyZXQgd2lsbCBiZSBzdG9yZWQuXG4gICAqL1xuICByZWFkb25seSBrZXlWYXVsdElkOiBWYXVsdDtcblxuICAvKipcbiAgICogVGhlIG5hbWUgb2YgdGhlIHNlY3JldC4gVGhpcyBuYW1lIHNob3VsZCBiZSB1bmlxdWUgd2l0aGluIHRoZSBLZXkgVmF1bHQgaW5zdGFuY2UuXG4gICAqL1xuICByZWFkb25seSBuYW1lOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFRoZSB2YWx1ZSBvZiB0aGUgc2VjcmV0LiBUaGlzIGNvdWxkIGJlIGFueSBzdHJpbmcsIGluY2x1ZGluZyB0b2tlbnMgb3IgcGFzc3dvcmRzLlxuICAgKi9cbiAgcmVhZG9ubHkgdmFsdWU6IHN0cmluZztcblxuICAvKipcbiAgICogT3B0aW9uYWwgZXhwaXJhdGlvbiBkYXRlIGZvciB0aGUgc2VjcmV0LiBUaGlzIHNob3VsZCBiZSBpbiBhbiBhcHByb3ByaWF0ZSBkYXRlIHN0cmluZyBmb3JtYXQuXG4gICAqIElmIHByb3ZpZGVkLCB0aGUgc2VjcmV0IHdpbGwgYmVjb21lIGludmFsaWQgYWZ0ZXIgdGhpcyBkYXRlLlxuICAgKi9cbiAgcmVhZG9ubHkgZXhwaXJhdGlvbkRhdGU/OiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIE9wdGlvbmFsIGNvbnRlbnQgdHlwZSBmb3IgdGhlIHNlY3JldC4gVGhpcyBjYW4gYmUgdXNlZCB0byBkZXNjcmliZSB0aGUgdHlwZSBvZiBpbmZvcm1hdGlvblxuICAgKiB0aGUgc2VjcmV0IGNvbnRhaW5zLCBvciBob3cgaXQgY2FuIGJlIHVzZWQuXG4gICAqL1xuICByZWFkb25seSBjb250ZW50VHlwZT86IHN0cmluZztcblxuICAvKipcbiAgICogQSBsaXN0IG9mIGFjY2VzcyBwb2xpY2llcyB0aGF0IGRpY3RhdGUgd2hpY2ggaWRlbnRpdGllcyBoYXZlIHdoYXQga2luZCBvZiBhY2Nlc3MgdG8gdGhlIHNlY3JldC5cbiAgICogRWFjaCBwb2xpY3kgc2hvdWxkIGRldGFpbCB0aGUgcGVybWlzc2lvbnMgYW5kIHRoZSBpZGVudGl0eSBpdCBhcHBsaWVzIHRvLlxuICAgKi9cbiAgcmVhZG9ubHkgYWNjZXNzUG9saWNpZXM6IEFjY2Vzc1BvbGljeVtdO1xufVxuXG5leHBvcnQgY2xhc3MgU2VjcmV0IGV4dGVuZHMgQ29uc3RydWN0IHtcbiAgcHVibGljIHNlY3JldElkOiBzdHJpbmc7XG5cbiAgY29uc3RydWN0b3Ioc2NvcGU6IENvbnN0cnVjdCwgaWQ6IHN0cmluZywgcHJvcHM6IFNlY3JldFByb3BzKSB7XG4gICAgc3VwZXIoc2NvcGUsIGlkKTtcblxuICAgIC8vIExvZ2ljIHRvIGFkZCB0aGUgc2VjcmV0IHRvIHRoZSBwcm92aWRlZCBrZXlWYXVsdCBpbnN0YW5jZVxuICAgIC8vIEZvciBleGFtcGxlOlxuICAgIGNvbnN0IHNlY3JldCA9IG5ldyBLZXlWYXVsdFNlY3JldCh0aGlzLCBwcm9wcy5uYW1lLCB7XG4gICAgICBrZXlWYXVsdElkOiBwcm9wcy5rZXlWYXVsdElkLmlkLFxuICAgICAgbmFtZTogcHJvcHMubmFtZSxcbiAgICAgIHZhbHVlOiBwcm9wcy52YWx1ZSxcbiAgICAgIGNvbnRlbnRUeXBlOiBwcm9wcy5jb250ZW50VHlwZSxcbiAgICAgIGV4cGlyYXRpb25EYXRlOiBwcm9wcy5leHBpcmF0aW9uRGF0ZSxcbiAgICB9KTtcblxuICAgIHRoaXMuc2VjcmV0SWQgPSBzZWNyZXQuaWQ7XG5cbiAgICAvLyBBY2N1bXVsYXRlIGFsbCB0aGUgZnFkbiB2YWx1ZXNcbiAgICBjb25zdCBkZXBlbmRlbmNpZXM6IHN0cmluZ1tdID0gW107XG4gICAgZm9yIChjb25zdCBwb2xpY3kgb2YgcHJvcHMuYWNjZXNzUG9saWNpZXMpIHtcbiAgICAgIGRlcGVuZGVuY2llcy5wdXNoKHBvbGljeS5mcWRuKTtcbiAgICB9XG5cbiAgICAvLyBBZGQgZGVwZW5kZW5jeSBvbiBhbGwgYWNjZXNzIHBvbGljaWVzXG4gICAgc2VjcmV0LmFkZE92ZXJyaWRlKFwiZGVwZW5kc19vblwiLCBkZXBlbmRlbmNpZXMpO1xuICB9XG59XG4iXX0=
+Secret[_a] = { fqn: "@microsoft/terraform-cdk-constructs.azure_keyvault.Secret", version: "0.0.3-pre.7" };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VjcmV0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2F6dXJlLWtleXZhdWx0L2xpYi9zZWNyZXQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSxtRkFBOEU7QUFDOUUsMkNBQXVDO0FBMEN2QyxNQUFhLE1BQU8sU0FBUSxzQkFBUztJQUduQzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O09BOEJHO0lBQ0gsWUFBWSxLQUFnQixFQUFFLEVBQVUsRUFBRSxLQUFrQjtRQUMxRCxLQUFLLENBQUMsS0FBSyxFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBRWpCLDREQUE0RDtRQUM1RCxlQUFlO1FBQ2YsTUFBTSxNQUFNLEdBQUcsSUFBSSxpQ0FBYyxDQUFDLElBQUksRUFBRSxLQUFLLENBQUMsSUFBSSxFQUFFO1lBQ2xELFVBQVUsRUFBRSxLQUFLLENBQUMsVUFBVSxDQUFDLEVBQUU7WUFDL0IsSUFBSSxFQUFFLEtBQUssQ0FBQyxJQUFJO1lBQ2hCLEtBQUssRUFBRSxLQUFLLENBQUMsS0FBSztZQUNsQixXQUFXLEVBQUUsS0FBSyxDQUFDLFdBQVc7WUFDOUIsY0FBYyxFQUFFLEtBQUssQ0FBQyxjQUFjO1NBQ3JDLENBQUMsQ0FBQztRQUVILElBQUksQ0FBQyxRQUFRLEdBQUcsTUFBTSxDQUFDLEVBQUUsQ0FBQztRQUUxQixpQ0FBaUM7UUFDakMsTUFBTSxZQUFZLEdBQWEsRUFBRSxDQUFDO1FBQ2xDLEtBQUssTUFBTSxNQUFNLElBQUksS0FBSyxDQUFDLGNBQWMsRUFBRTtZQUN6QyxZQUFZLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUNoQztRQUVELHdDQUF3QztRQUN4QyxNQUFNLENBQUMsV0FBVyxDQUFDLFlBQVksRUFBRSxZQUFZLENBQUMsQ0FBQztJQUNqRCxDQUFDOztBQXpESCx3QkEwREMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBLZXlWYXVsdFNlY3JldCB9IGZyb20gXCJAY2RrdGYvcHJvdmlkZXItYXp1cmVybS9saWIva2V5LXZhdWx0LXNlY3JldFwiO1xuaW1wb3J0IHsgQ29uc3RydWN0IH0gZnJvbSBcImNvbnN0cnVjdHNcIjtcbmltcG9ydCB7IEFjY2Vzc1BvbGljeSB9IGZyb20gXCIuL3BvbGljeVwiO1xuaW1wb3J0IHsgVmF1bHQgfSBmcm9tIFwiLi92YXVsdFwiO1xuXG4vKipcbiAqIFByb3BlcnRpZXMgZm9yIGRlZmluaW5nIGFuIEF6dXJlIEtleSBWYXVsdCBTZWNyZXQuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgU2VjcmV0UHJvcHMge1xuICAvKipcbiAgICogVGhlIEtleSBWYXVsdCBpbnN0YW5jZSB3aGVyZSB0aGUgc2VjcmV0IHdpbGwgYmUgc3RvcmVkLlxuICAgKi9cbiAgcmVhZG9ubHkga2V5VmF1bHRJZDogVmF1bHQ7XG5cbiAgLyoqXG4gICAqIFRoZSBuYW1lIG9mIHRoZSBzZWNyZXQuIFRoaXMgbmFtZSBzaG91bGQgYmUgdW5pcXVlIHdpdGhpbiB0aGUgS2V5IFZhdWx0IGluc3RhbmNlLlxuICAgKi9cbiAgcmVhZG9ubHkgbmFtZTogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBUaGUgdmFsdWUgb2YgdGhlIHNlY3JldC4gVGhpcyBjb3VsZCBiZSBhbnkgc3RyaW5nLCBpbmNsdWRpbmcgdG9rZW5zIG9yIHBhc3N3b3Jkcy5cbiAgICovXG4gIHJlYWRvbmx5IHZhbHVlOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIE9wdGlvbmFsIGV4cGlyYXRpb24gZGF0ZSBmb3IgdGhlIHNlY3JldC4gVGhpcyBzaG91bGQgYmUgaW4gYW4gYXBwcm9wcmlhdGUgZGF0ZSBzdHJpbmcgZm9ybWF0LlxuICAgKiBJZiBwcm92aWRlZCwgdGhlIHNlY3JldCB3aWxsIGJlY29tZSBpbnZhbGlkIGFmdGVyIHRoaXMgZGF0ZS5cbiAgICovXG4gIHJlYWRvbmx5IGV4cGlyYXRpb25EYXRlPzogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBPcHRpb25hbCBjb250ZW50IHR5cGUgZm9yIHRoZSBzZWNyZXQuIFRoaXMgY2FuIGJlIHVzZWQgdG8gZGVzY3JpYmUgdGhlIHR5cGUgb2YgaW5mb3JtYXRpb25cbiAgICogdGhlIHNlY3JldCBjb250YWlucywgb3IgaG93IGl0IGNhbiBiZSB1c2VkLlxuICAgKi9cbiAgcmVhZG9ubHkgY29udGVudFR5cGU/OiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIEEgbGlzdCBvZiBhY2Nlc3MgcG9saWNpZXMgdGhhdCBkaWN0YXRlIHdoaWNoIGlkZW50aXRpZXMgaGF2ZSB3aGF0IGtpbmQgb2YgYWNjZXNzIHRvIHRoZSBzZWNyZXQuXG4gICAqIEVhY2ggcG9saWN5IHNob3VsZCBkZXRhaWwgdGhlIHBlcm1pc3Npb25zIGFuZCB0aGUgaWRlbnRpdHkgaXQgYXBwbGllcyB0by5cbiAgICovXG4gIHJlYWRvbmx5IGFjY2Vzc1BvbGljaWVzOiBBY2Nlc3NQb2xpY3lbXTtcbn1cblxuZXhwb3J0IGNsYXNzIFNlY3JldCBleHRlbmRzIENvbnN0cnVjdCB7XG4gIHB1YmxpYyBzZWNyZXRJZDogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBDb25zdHJ1Y3RzIGEgbmV3IEF6dXJlIEtleSBWYXVsdCBTZWNyZXQgd2l0aGluIGEgc3BlY2lmaWVkIEtleSBWYXVsdC5cbiAgICpcbiAgICogVGhpcyBjbGFzcyBmYWNpbGl0YXRlcyB0aGUgY3JlYXRpb24gYW5kIG1hbmFnZW1lbnQgb2YgYSBzZWNyZXQsIGFsbG93aW5nIHNlbnNpdGl2ZSBpbmZvcm1hdGlvbiB0byBiZSBzdG9yZWQgc2VjdXJlbHlcbiAgICogYW5kIGFjY2Vzc2VkIGFzIG5lZWRlZCB3aGlsZSBtYWludGFpbmluZyBjb25maWRlbnRpYWxpdHkgYW5kIGNvbnRyb2wgdGhyb3VnaCBkZWZpbmVkIGFjY2VzcyBwb2xpY2llcy5cbiAgICpcbiAgICogQHBhcmFtIHNjb3BlIC0gVGhlIHNjb3BlIGluIHdoaWNoIHRvIGRlZmluZSB0aGlzIGNvbnN0cnVjdCwgdHlwaWNhbGx5IHJlcHJlc2VudGluZyB0aGUgQ2xvdWQgRGV2ZWxvcG1lbnQgS2l0IChDREspIHN0YWNrLlxuICAgKiBAcGFyYW0gaWQgLSBUaGUgdW5pcXVlIGlkZW50aWZpZXIgZm9yIHRoaXMgaW5zdGFuY2Ugb2YgdGhlIHNlY3JldC5cbiAgICogQHBhcmFtIHByb3BzIC0gVGhlIHByb3BlcnRpZXMgZm9yIGNyZWF0aW5nIHRoZSBzZWNyZXQgYXMgZGVmaW5lZCBpbiBTZWNyZXRQcm9wcy4gVGhlc2UgaW5jbHVkZTpcbiAgICogICAgICAgICAgICAgICAgLSBga2V5VmF1bHRJZGA6IFRoZSBJRCBvZiB0aGUgS2V5IFZhdWx0IGluIHdoaWNoIHRvIHN0b3JlIHRoZSBzZWNyZXQuXG4gICAqICAgICAgICAgICAgICAgIC0gYG5hbWVgOiBUaGUgbmFtZSBvZiB0aGUgc2VjcmV0LlxuICAgKiAgICAgICAgICAgICAgICAtIGB2YWx1ZWA6IFRoZSBjb25maWRlbnRpYWwgZGF0YSB0byBiZSBzdG9yZWQgYXMgdGhlIHNlY3JldC5cbiAgICogICAgICAgICAgICAgICAgLSBgZXhwaXJhdGlvbkRhdGVgOiBPcHRpb25hbC4gVGhlIGV4cGlyYXRpb24gZGF0ZSBvZiB0aGUgc2VjcmV0LlxuICAgKiAgICAgICAgICAgICAgICAtIGBjb250ZW50VHlwZWA6IE9wdGlvbmFsLiBBIGxhYmVsIGhpbnRpbmcgYXQgdGhlIGNvbnRlbnQgdHlwZSBvZiB0aGUgc2VjcmV0J3MgdmFsdWUuXG4gICAqICAgICAgICAgICAgICAgIC0gYGFjY2Vzc1BvbGljaWVzYDogQWNjZXNzIHBvbGljaWVzIHRoYXQgZGljdGF0ZSBwZXJtaXNzaW9ucyBmb3IgdGhlIHNlY3JldC5cbiAgICpcbiAgICogRXhhbXBsZSB1c2FnZTpcbiAgICogYGBgdHlwZXNjcmlwdFxuICAgKiBuZXcgU2VjcmV0KHRoaXMsICdteVNlY3JldCcsIHtcbiAgICogICBrZXlWYXVsdElkOiBteUtleVZhdWx0LFxuICAgKiAgIG5hbWU6ICdkYlBhc3N3b3JkJyxcbiAgICogICB2YWx1ZTogJ3BAc3N3MHJkIScsXG4gICAqICAgZXhwaXJhdGlvbkRhdGU6ICcyMDMwLTAxLTAxVDAwOjAwOjAwWicsXG4gICAqICAgY29udGVudFR5cGU6ICdwYXNzd29yZCcsXG4gICAqICAgYWNjZXNzUG9saWNpZXM6IFt7XG4gICAqICAgICBvYmplY3RJZDogJzEyMzQ1LXVzZXItb2JqZWN0LWlkJyxcbiAgICogICAgIHBlcm1pc3Npb25zOiBbJ2dldCcsICdsaXN0J11cbiAgICogICB9XVxuICAgKiB9KTtcbiAgICogYGBgXG4gICAqL1xuICBjb25zdHJ1Y3RvcihzY29wZTogQ29uc3RydWN0LCBpZDogc3RyaW5nLCBwcm9wczogU2VjcmV0UHJvcHMpIHtcbiAgICBzdXBlcihzY29wZSwgaWQpO1xuXG4gICAgLy8gTG9naWMgdG8gYWRkIHRoZSBzZWNyZXQgdG8gdGhlIHByb3ZpZGVkIGtleVZhdWx0IGluc3RhbmNlXG4gICAgLy8gRm9yIGV4YW1wbGU6XG4gICAgY29uc3Qgc2VjcmV0ID0gbmV3IEtleVZhdWx0U2VjcmV0KHRoaXMsIHByb3BzLm5hbWUsIHtcbiAgICAgIGtleVZhdWx0SWQ6IHByb3BzLmtleVZhdWx0SWQuaWQsXG4gICAgICBuYW1lOiBwcm9wcy5uYW1lLFxuICAgICAgdmFsdWU6IHByb3BzLnZhbHVlLFxuICAgICAgY29udGVudFR5cGU6IHByb3BzLmNvbnRlbnRUeXBlLFxuICAgICAgZXhwaXJhdGlvbkRhdGU6IHByb3BzLmV4cGlyYXRpb25EYXRlLFxuICAgIH0pO1xuXG4gICAgdGhpcy5zZWNyZXRJZCA9IHNlY3JldC5pZDtcblxuICAgIC8vIEFjY3VtdWxhdGUgYWxsIHRoZSBmcWRuIHZhbHVlc1xuICAgIGNvbnN0IGRlcGVuZGVuY2llczogc3RyaW5nW10gPSBbXTtcbiAgICBmb3IgKGNvbnN0IHBvbGljeSBvZiBwcm9wcy5hY2Nlc3NQb2xpY2llcykge1xuICAgICAgZGVwZW5kZW5jaWVzLnB1c2gocG9saWN5LmZxZG4pO1xuICAgIH1cblxuICAgIC8vIEFkZCBkZXBlbmRlbmN5IG9uIGFsbCBhY2Nlc3MgcG9saWNpZXNcbiAgICBzZWNyZXQuYWRkT3ZlcnJpZGUoXCJkZXBlbmRzX29uXCIsIGRlcGVuZGVuY2llcyk7XG4gIH1cbn1cbiJdfQ==

package/lib/azure-keyvault/lib/vault.d.ts

@@ -78,17 +78,205 @@ export declare class Vault extends AzureResource {
     resourceGroup: ResourceGroup;
     id: string;
     private accessPolicies;
+    /**
+     * Constructs a new Azure Key Vault resource.
+     *
+     * This class creates and configures an Azure Key Vault, a secure store for managing secrets, keys, certificates, and other sensitive data.
+     * It supports advanced configurations such as access policies, network rules, and data retention policies.
+     *
+     * @param scope - The scope in which to define this construct, usually representing the Cloud Development Kit (CDK) stack.
+     * @param id - The unique identifier for this instance of the Key Vault.
+     * @param props - The properties for creating the Key Vault as defined in VaultProps. These include settings for location, SKU, tenant ID, etc.
+     *
+     * Example usage:
+     * ```typescript
+     * new Vault(this, 'MyKeyVault', {
+     *   name: 'mySecureVault',
+     *   location: 'East US',
+     *   resourceGroup: myResourceGroup,
+     *   sku: 'premium',
+     *   tenantId: 'my-tenant-id',
+     *   softDeleteRetentionDays: 90,
+     *   purgeProtection: true,
+     *   tags: {
+     *     project: 'My Application'
+     *   }
+     * });
+     * ```
+     */
     constructor(scope: Construct, id: string, props: VaultProps);
+    /**
+     * Grants read-only access to secrets stored in the Key Vault to a specified Azure AD group.
+     *
+     * @param azureAdGroupId - The Azure Active Directory group ID that will receive read access to secrets.
+     */
     grantSecretReaderAccess(azureAdGroupId: string): void;
+    /**
+     * Grants administrative access to secrets stored in the Key Vault to a specified Azure AD group.
+     *
+     * @param azureAdGroupId - The Azure Active Directory group ID that will receive administrative access to secrets.
+     */
     grantSecretAdminAccess(azureAdGroupId: string): void;
+    /**
+     * Grants administrative access to certificates stored in the Key Vault to a specified Azure AD group.
+     *
+     * @param azureAdGroupId - The Azure Active Directory group ID that will receive administrative access to certificates.
+     */
     grantCertAdminAccess(azureAdGroupId: string): void;
+    /**
+     * Grants read-only access to certificates stored in the Key Vault to a specified Azure AD group.
+     *
+     * @param azureAdGroupId - The Azure Active Directory group ID that will receive read access to certificates.
+     */
     grantCertReaderAccess(azureAdGroupId: string): void;
+    /**
+     * Grants administrative access to keys stored in the Key Vault to a specified Azure AD group.
+     *
+     * @param azureAdGroupId - The Azure Active Directory group ID that will receive administrative access to keys.
+     */
     grantKeyAdminAccess(azureAdGroupId: string): void;
+    /**
+     * Grants read-only access to keys stored in the Key Vault to a specified Azure AD group.
+     *
+     * @param azureAdGroupId - The Azure Active Directory group ID that will receive read access to keys.
+     */
     grantKeyReaderAccess(azureAdGroupId: string): void;
+    /**
+     * Grants custom access based on specified options to an Azure AD group in the Key Vault.
+     *
+     * @param azureAdGroupId - The Azure Active Directory group ID that will receive the custom access.
+     * @param options - Custom access options specifying various permissions for secrets, keys, certificates, and storage.
+     */
     grantCustomAccess(azureAdGroupId: string, options: GrantCustomAccessOptions): void;
+    /**
+     * Creates a new secret within the Azure Key Vault.
+     *
+     * This method facilitates the storage of sensitive information in the form of a secret within the Key Vault.
+     * Secrets are protected items such as passwords, database connection strings, or any other piece of information
+     * that needs to be securely stored and accessed. This method allows setting additional properties such as
+     * expiration date and content type for better management and compliance.
+     *
+     * @param keyVaultSecretName - The unique name for the secret within the Key Vault.
+     * @param secretValue - The sensitive information or data that needs to be securely stored as a secret.
+     * @param expirationDate - Optional. The expiration date of the secret in ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
+     *                         If provided, the secret will no longer be valid after this date.
+     * @param contentType - Optional. A description of the type of information the secret contains (e.g., 'password', 'connectionString').
+     *                      This can be used by applications to handle the secret appropriately.
+     *
+     * Example usage:
+     * ```typescript
+     * vault.addSecret(
+     *   'myDatabasePassword',
+     *   'p@ssw0rd123!',
+     *   '2030-01-01',
+     *   'databasePassword'
+     * );
+     * ```
+     * This method does not return a value. It creates a secret within the Key Vault with the specified properties.
+     */
     addSecret(keyVaultSecretName: string, secretValue: string, expirationDate?: string, contentType?: string): void;
+    /**
+     * Creates an RSA cryptographic key within the Azure Key Vault.
+     *
+     * This method facilitates the creation of an RSA key, which is useful for a variety of cryptographic operations such as
+     * encryption, decryption, digital signature verification, and more. The RSA key created by this method is configurable
+     * with an optional expiration date and a default key size of 2048 bits. The key operations allowed include decryption,
+     * encryption, signing, verifying signatures, and key wrapping/unwrapping.
+     *
+     * @param keyVaultKeyName - The unique name for the RSA key within the Key Vault.
+     * @param expirationDate - Optional. The expiration date of the key in ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
+     *                         If provided, the key will no longer be valid after this date.
+     * @returns A KeyVaultKey object representing the newly created RSA key within the vault.
+     *
+     * Example usage:
+     * ```typescript
+     * const rsaKey = vault.addRSAKey(
+     *   'myRSAKey',
+     *   '2030-01-01'
+     * );
+     * ```
+     * This method returns the created KeyVaultKey object, allowing further operations or references to the key.
+     */
     addRSAKey(keyVaultKeyName: string, expirationDate?: string): KeyVaultKey;
+    /**
+     * Creates a cryptographic key within the Azure Key Vault.
+     *
+     * This method allows the creation of a cryptographic key of specified type and size within the Key Vault. The key can be
+     * configured with specific operations it can perform, such as encryption, decryption, signing, etc. An optional expiration
+     * date can also be set to control the key's lifecycle. This method is flexible, supporting various key types and sizes,
+     * making it suitable for a wide range of cryptographic needs.
+     *
+     * @param keyVaultKeyName - The unique name for the cryptographic key within the Key Vault.
+     * @param keyType - The type of cryptographic key to create (e.g., 'RSA', 'EC', 'oct-HSM').
+     * @param keySize - The size of the cryptographic key in bits (e.g., 2048, 3072, 4096 for RSA).
+     * @param keyOpts - A list of cryptographic operations that the key is allowed to perform. Possible values might include
+     *                  'encrypt', 'decrypt', 'sign', 'verify', 'wrapKey', 'unwrapKey'.
+     * @param expirationDate - Optional. The expiration date of the key in ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
+     *                         If provided, the key will no longer be valid after this date, aligning with best practices for key management.
+     * @returns A KeyVaultKey object representing the newly created cryptographic key within the vault.
+     *
+     * Example usage:
+     * ```typescript
+     * const myKey = vault.addKey(
+     *   'myKey',
+     *   'RSA',
+     *   2048,
+     *   ['encrypt', 'decrypt', 'sign', 'verify'],
+     *   '2030-12-31'
+     * );
+     * ```
+     * This method returns the created KeyVaultKey object, enabling immediate use within the application for cryptographic operations.
+     */
     addKey(keyVaultKeyName: string, keyType: string, keySize: number, keyOpts: string[], expirationDate?: string): KeyVaultKey;
+    /**
+     * Creates a self-signed certificate within the Azure Key Vault.
+     *
+     * This method facilitates the creation of a self-signed certificate, which is a digital certificate that is signed by
+     * its own creator rather than a trusted authority. Self-signed certificates can be useful for testing, internal
+     * communications, or any scenario where public trust is not required. The method allows specifying subject details,
+     * DNS names for the certificate, and managing its lifecycle with action types and expiry.
+     *
+     * @param certName - The unique name for the certificate within the Key Vault.
+     * @param subject - The subject name of the certificate, typically formatted as an X.500 Distinguished Name (e.g., "CN=example.com").
+     * @param dnsNames - An array of DNS names that should be associated with this certificate. This is useful for certificates
+     *                   that need to be valid for multiple hostnames.
+     * @param actionType - Optional. Specifies the action to be performed with the certificate, such as 'create' or 'renew'.
+     * @param daysBeforeExpiry - Optional. Number of days before expiry when an action should be taken, useful for auto-renewal scenarios.
+     * @returns A KeyVaultCertificate object representing the newly created self-signed certificate.
+     *
+     * Example usage:
+     * ```typescript
+     * const myCertificate = vault.addSelfSignedCert(
+     *   'myCert',
+     *   'CN=mydomain.com',
+     *   ['mydomain.com', 'www.mydomain.com'],
+     *   'create',
+     *   30
+     * );
+     * ```
+     * This method returns the KeyVaultCertificate object, enabling it to be used immediately within the application or stored for future use.
+     */
     addSelfSignedCert(certName: string, subject: string, dnsNames: string[], actionType?: string, daysBeforeExpiry?: number): KeyVaultCertificate;
+    /**
+     * Adds a certificate issuer to the Azure Key Vault.
+     *
+     * This method configures a certificate issuer within the Key Vault, allowing the Key Vault to issue certificates
+     * through external providers. Configuring an issuer is essential for enabling automated certificate management
+     * processes, such as issuance and renewal, directly through the Key Vault with a specified Certificate Authority (CA).
+     *
+     * @param name - The unique name for the certificate issuer within the Key Vault.
+     * @param provider - The name of the external provider that will issue the certificates, such as 'DigiCert' or 'GlobalSign'.
+     *
+     * Example usage:
+     * ```typescript
+     * vault.addCertIssuer(
+     *   'myCertIssuer',
+     *   'DigiCert'
+     * );
+     * ```
+     * This method configures a certificate issuer but does not return any value. The issuer details, including provider name
+     * and any necessary credentials (managed externally or through additional method parameters), are set up in the Key Vault
+     * for future certificate operations.
+     */
     addCertIssuer(name: string, provider: string): void;
 }