@drunk-pulumi/azure 1.0.23 → 1.0.24

package/Builder/types/resourceBuilder.d.ts

@@ -5,54 +5,218 @@ import { BuilderProps, IBuilder, IBuilderAsync, IEncryptable, ILockable } from '
 import { CertBuilderType, VaultBuilderSecretType } from './vaultBuilder';
 import { IVnetBuilder, IVnetBuilderStart, VnetBuilderResults } from './vnetBuilder';
 import { Input } from '@pulumi/pulumi';
+/**
+ * Type for the results of the resource builder.
+ */
 export type ResourceBuilderResults = BuilderProps & WithEncryptionInfo & WithLogInfo & {
     vnetInstance?: VnetBuilderResults;
     otherInstances: Record<string, any>;
 };
-export type BuilderFunctionType = (props: ResourceBuilderResults) => IBuilder<any>;
-export type BuilderAsyncFunctionType = (props: ResourceBuilderResults) => IBuilderAsync<any>;
-export type ResourceVnetBuilderType = (builder: IVnetBuilderStart) => IVnetBuilder;
-export type ResourceFunction = (props: BuilderProps) => ResourceInfo;
+/**
+ * Type for a synchronous builder function.
+ */
+export type BuilderFunctionType = (
+/**
+ * The properties of the resource builder results.
+ */
+props: ResourceBuilderResults) => IBuilder<any>;
+/**
+ * Type for an asynchronous builder function.
+ */
+export type BuilderAsyncFunctionType = (
+/**
+ * The properties of the resource builder results.
+ */
+props: ResourceBuilderResults) => IBuilderAsync<any>;
+/**
+ * Type for a VNet builder function.
+ */
+export type ResourceVnetBuilderType = (
+/**
+ * The starting point for the VNet builder.
+ */
+builder: IVnetBuilderStart) => IVnetBuilder;
+/**
+ * Type for a resource function.
+ */
+export type ResourceFunction = (
+/**
+ * The properties of the builder.
+ */
+props: BuilderProps) => ResourceInfo;
+/**
+ * Type for linking a resource vault.
+ */
 export type ResourceVaultLinkingBuilderType = {
+    /**
+     * List of subnet names to link to the resource vault.
+     */
     subnetNames?: string[];
+    /**
+     * List of IP addresses to link to the resource vault.
+     */
     ipAddresses?: Input<string>[];
+    /**
+     * Whether to link the resource vault as a private link.
+     */
     asPrivateLink?: boolean;
 };
+/**
+ * Interface for building resource roles.
+ */
 export interface IResourceRoleBuilder {
+    /**
+     * Creates roles for the resource.
+     * @returns An instance of IResourceGroupBuilder.
+     */
     createRoles(): IResourceGroupBuilder;
+    /**
+     * Sets the roles properties for the resource.
+     * @param props - The roles properties.
+     * @returns An instance of IResourceGroupBuilder.
+     */
     withRoles(props: EnvRolesInfo): IResourceGroupBuilder;
+    /**
+     * Sets the roles properties from the vault.
+     * @returns An instance of IResourceGroupBuilder.
+     */
     withRolesFromVault(): IResourceGroupBuilder;
 }
+/**
+ * Interface for building resource groups.
+ */
 export interface IResourceGroupBuilder {
+    /**
+     * Creates a resource group.
+     * @param props - The role enable types.
+     * @returns An instance of IResourceVaultBuilder.
+     */
     createRG(props?: RoleEnableTypes): IResourceVaultBuilder;
+    /**
+     * Sets the resource group properties.
+     * @param props - The resource group properties.
+     * @returns An instance of IResourceVaultBuilder.
+     */
     withRG(props: ResourceGroupInfo): IResourceVaultBuilder;
 }
-/** Key Vault is compulsory for resource builder*/
+/**
+ * Interface for building resource vaults.
+ * Key Vault is compulsory for resource builder.
+ */
 export interface IResourceVaultBuilder {
+    /**
+     * Creates a vault for the resource.
+     * @param name - The name of the vault.
+     * @returns An instance of IResourceBuilder.
+     */
     createVault(name?: string): IResourceBuilder;
+    /**
+     * Sets the vault properties.
+     * @param props - The vault properties.
+     * @returns An instance of IResourceBuilder.
+     */
     withVault(props: KeyVaultInfo): IResourceBuilder;
+    /**
+     * Sets the vault properties from the given name.
+     * @param name - The name of the vault.
+     * @returns An instance of IResourceBuilder.
+     */
     withVaultFrom(name: string): IResourceBuilder;
 }
+/**
+ * Interface for building resource vault items.
+ */
 export interface IResourceVaultItemsBuilder {
+    /**
+     * Adds secrets to the resource vault.
+     * @param items - The secrets to add.
+     * @returns An instance of IResourceBuilder.
+     */
     addSecrets(items: VaultBuilderSecretType): IResourceBuilder;
+    /**
+     * Adds certificates to the resource vault.
+     * @param props - The certificate properties.
+     * @returns An instance of IResourceBuilder.
+     */
     addCerts(props: CertBuilderType): IResourceBuilder;
 }
+/**
+ * Interface for building environment user-assigned identities.
+ */
 export interface IEnvUserAssignedIdentityBuilder {
-    /** Create User Assigned Identity for encryption purposes*/
+    /**
+     * Creates a User Assigned Identity for encryption purposes.
+     * @returns An instance of IResourceBuilder.
+     */
     createEnvUID(): IResourceBuilder;
-    /** Create User Assigned Identity for encryption purposes*/
+    /**
+     * Sets the User Assigned Identity properties from the vault.
+     * @returns An instance of IResourceBuilder.
+     */
     withEnvUIDFromVault(): IResourceBuilder;
 }
+/**
+ * Interface for building resource VNets.
+ */
 export interface IResourceVnetBuilder {
+    /**
+     * Sets the VNet properties for the resource.
+     * @param props - The VNet builder properties.
+     * @returns An instance of IResourceBuilder.
+     */
     withVnet(props: ResourceVnetBuilderType): IResourceBuilder;
+    /**
+     * Links the resource vault to the specified properties.
+     * @param props - The vault linking properties.
+     * @returns An instance of IResourceBuilder.
+     */
     linkVaultTo(props: ResourceVaultLinkingBuilderType): IResourceBuilder;
 }
+/**
+ * Interface for building resources.
+ */
 export interface IResourceBuilder extends IResourceVnetBuilder, IEnvUserAssignedIdentityBuilder, IResourceVaultItemsBuilder, ILockable<IResourceBuilder>, IEncryptable<IResourceBuilder> {
+    /**
+     * Sets the log properties from the given name.
+     * @param name - The name of the log.
+     * @returns An instance of IResourceBuilder.
+     */
     withLogFrom(name: string): IResourceBuilder;
+    /**
+     * Sets the builder properties.
+     * @param props - The builder function properties.
+     * @returns An instance of IResourceBuilder.
+     */
     withBuilder(props: BuilderFunctionType): IResourceBuilder;
+    /**
+     * Conditionally sets the builder properties.
+     * @param condition - The condition to check.
+     * @param props - The builder function properties.
+     * @returns An instance of IResourceBuilder.
+     */
     withBuilderIf(condition: boolean, props: BuilderFunctionType): IResourceBuilder;
+    /**
+     * Sets the asynchronous builder properties.
+     * @param props - The asynchronous builder function properties.
+     * @returns An instance of IResourceBuilder.
+     */
     withBuilderAsync(props: BuilderAsyncFunctionType): IResourceBuilder;
+    /**
+     * Conditionally sets the asynchronous builder properties.
+     * @param condition - The condition to check.
+     * @param props - The asynchronous builder function properties.
+     * @returns An instance of IResourceBuilder.
+     */
     withBuilderAsyncIf(condition: boolean, props: BuilderAsyncFunctionType): IResourceBuilder;
+    /**
+     * Sets the resource properties.
+     * @param builder - The resource function.
+     * @returns An instance of IResourceBuilder.
+     */
     withResource(builder: ResourceFunction): IResourceBuilder;
+    /**
+     * Builds the resource and returns the resource builder results.
+     * @returns A promise that resolves to the resource builder results.
+     */
     build(): Promise<ResourceBuilderResults>;
 }

package/Builder/types/serviceBusBuilder.d.ts

@@ -1,23 +1,78 @@
 import { BuilderProps, IBuilder } from './genericBuilder';
 import { NetworkPropsType, ResourceInfo, WithEncryption, WithEnvRoles } from '../../types';
 import * as bus from '@pulumi/azure-native/servicebus/v20230101preview';
+/**
+ * Arguments required for building a Service Bus resource.
+ */
 export type ServiceBusBuilderArgs = BuilderProps & WithEnvRoles & WithEncryption;
+/**
+ * Types of SKU available for Service Bus.
+ */
 export type ServiceBusSkuTypes = bus.SkuTier;
+/**
+ * Arguments for defining a Service Bus Queue.
+ */
 export type ServiceBusQueueArgs = Omit<bus.QueueArgs, 'namespaceName' | 'queueName' | 'resourceGroupName' | 'status'>;
+/**
+ * Arguments for defining a Service Bus Subscription.
+ */
 export type ServiceBusSubArgs = Omit<bus.SubscriptionArgs, 'namespaceName' | 'topicName' | 'resourceGroupName' | 'status' | 'subscriptionName'> & {
     rules?: Omit<bus.RuleArgs, 'namespaceName' | 'subscriptionName' | 'topicName' | 'ruleName' | 'resourceGroupName'>;
 };
+/**
+ * Arguments for defining a Service Bus Topic.
+ */
 export type ServiceBusTopicArgs = Omit<bus.TopicArgs, 'namespaceName' | 'topicName' | 'resourceGroupName' | 'status'> & {
     subscriptions?: Record<string, ServiceBusSubArgs>;
 };
+/**
+ * Options for configuring a Service Bus Namespace.
+ */
 export type ServiceBusOptions = Pick<bus.NamespaceArgs, 'disableLocalAuth'>;
+/**
+ * Interface for building the SKU of a Service Bus.
+ */
 export interface IServiceBusSkuBuilder {
+    /**
+     * Sets the SKU properties for the Service Bus.
+     * @param sku - The SKU type.
+     * @returns An instance of IServiceBusBuilder.
+     */
     withSku(sku: ServiceBusSkuTypes): IServiceBusBuilder;
 }
+/**
+ * Interface for building a Service Bus.
+ */
 export interface IServiceBusBuilder extends IBuilder<ResourceInfo> {
+    /**
+     * Sets the network properties for the Service Bus.
+     * @param props - The network properties.
+     * @returns An instance of IServiceBusBuilder.
+     */
     withNetwork(props: NetworkPropsType): IServiceBusBuilder;
+    /**
+     * Conditionally sets the network properties for the Service Bus.
+     * @param condition - The condition to check.
+     * @param props - The network properties.
+     * @returns An instance of IServiceBusBuilder.
+     */
     withNetworkIf(condition: boolean, props: NetworkPropsType): IServiceBusBuilder;
+    /**
+     * Sets additional options for the Service Bus.
+     * @param props - The options properties.
+     * @returns An instance of IServiceBusBuilder.
+     */
     withOptions(props: ServiceBusOptions): IServiceBusBuilder;
+    /**
+     * Adds queues to the Service Bus.
+     * @param props - The properties of the queues.
+     * @returns An instance of IServiceBusBuilder.
+     */
     withQueues(props: Record<string, ServiceBusQueueArgs>): IServiceBusBuilder;
+    /**
+     * Adds topics to the Service Bus.
+     * @param props - The properties of the topics.
+     * @returns An instance of IServiceBusBuilder.
+     */
     withTopics(props: Record<string, ServiceBusTopicArgs>): IServiceBusBuilder;
 }

package/Builder/types/signalRBuilder.d.ts

@@ -2,37 +2,96 @@ import * as ss from '@pulumi/azure-native/signalrservice';
 import { BuilderProps, IBuilder } from './genericBuilder';
 import { PrivateLinkPropsType, ResourceInfo, WithEncryptionInfo } from '../../types';
 import * as pulumi from '@pulumi/pulumi';
+/**
+ * Arguments required for building a SignalR resource.
+ */
 export type SignalRBuilderArgs = BuilderProps & WithEncryptionInfo;
+/**
+ * Arguments for defining the SKU of a SignalR service.
+ */
 export type SignalRSkuBuilderType = {
+    /**
+     * The capacity of the SKU.
+     */
     capacity?: 1 | 2 | 5 | 10 | 20 | 50 | 100;
+    /**
+     * The name of the SKU.
+     */
     name: 'Standard_S1' | 'Free_F1';
+    /**
+     * The tier of the SKU.
+     */
     tier?: 'Standard' | 'Free';
 };
+/**
+ * Arguments for defining the kind of a SignalR service.
+ */
 export type SignalRKindBuilderType = ss.ServiceKind | string;
+/**
+ * Options for configuring a SignalR service.
+ */
 export type SignalROptionsBuilder = {
+    /**
+     * Whether client certificate authentication is enabled.
+     */
     clientCertEnabled?: pulumi.Input<boolean>;
     /**
-     * DisableLocalAuth
-     * Enable or disable aad auth
-     * When set as true, connection with AuthType=aad won't work.
+     * Enable or disable AAD authentication.
+     * When set to true, connection with AuthType=aad won't work.
      */
     disableAadAuth?: pulumi.Input<boolean>;
     /**
-     * DisableLocalAuth
-     * Enable or disable local auth with AccessKey
-     * When set as true, connection with AccessKey=xxx won't work.
+     * Enable or disable local authentication with AccessKey.
+     * When set to true, connection with AccessKey=xxx won't work.
      */
     disableLocalAuth?: pulumi.Input<boolean>;
+    /**
+     * Whether public network access is enabled.
+     */
     publicNetworkAccess?: pulumi.Input<boolean>;
 };
+/**
+ * Interface for building the kind of a SignalR service.
+ */
 export interface ISignalRKindBuilder {
+    /**
+     * Sets the kind properties for the SignalR service.
+     * @param props - The kind properties.
+     * @returns An instance of ISignalRSkuBuilder.
+     */
     withKind(props: SignalRKindBuilderType): ISignalRSkuBuilder;
 }
+/**
+ * Interface for building the SKU of a SignalR service.
+ */
 export interface ISignalRSkuBuilder {
+    /**
+     * Sets the SKU properties for the SignalR service.
+     * @param props - The SKU properties.
+     * @returns An instance of ISignalRBuilder.
+     */
     withSku(props: SignalRSkuBuilderType): ISignalRBuilder;
 }
+/**
+ * Interface for building a SignalR service.
+ */
 export interface ISignalRBuilder extends IBuilder<ResourceInfo> {
+    /**
+     * Sets the allowed origins for the SignalR service.
+     * @param props - The allowed origins.
+     * @returns An instance of ISignalRBuilder.
+     */
     allowsOrigins(...props: pulumi.Input<string>[]): ISignalRBuilder;
+    /**
+     * Sets the private link properties for the SignalR service.
+     * @param props - The private link properties.
+     * @returns An instance of ISignalRBuilder.
+     */
     withPrivateLink(props: PrivateLinkPropsType): ISignalRBuilder;
+    /**
+     * Sets additional options for the SignalR service.
+     * @param props - The options properties.
+     * @returns An instance of ISignalRBuilder.
+     */
     withOptions(props: SignalROptionsBuilder): ISignalRBuilder;
 }

package/Builder/types/sqlBuilder.d.ts

@@ -3,34 +3,121 @@ import { BuilderProps, IBuilder, IIgnoreChanges, ILockable, ILoginBuilder } from
 import { SqlAuthType, SqlElasticPoolType, SqlNetworkType, SqlResults, SqlVulnerabilityAssessmentType } from '../../Sql';
 import { SqlDbProps, SqlDbSku } from '../../Sql/SqlDb';
 import { WithEnvRoles, WithLockable, WithLogInfo } from '../../types';
+/**
+ * Arguments required for building a SQL resource.
+ */
 export type SqlBuilderArgs = BuilderProps & WithEnvRoles & WithLogInfo & WithLockable;
+/**
+ * Options for SQL authentication, excluding sensitive fields.
+ */
 export type SqlBuilderAuthOptionsType = Omit<SqlAuthType, 'password' | 'adminLogin' | 'envRoles'>;
+/**
+ * Arguments for defining a SQL database.
+ */
 export type SqlDbBuilderType = {
+    /**
+     * The name of the database.
+     */
     name: string;
+    /**
+     * The SKU of the database.
+     */
     sku?: SqlDbSku;
 };
+/**
+ * Arguments for defining a SQL database from an existing database ID.
+ */
 export type SqlFromDbType = SqlDbBuilderType & {
+    /**
+     * The ID of the existing database.
+     */
     fromDbId: Input<string>;
 };
+/**
+ * Full properties for a SQL database, excluding certain fields.
+ */
 export type FullSqlDbPropsType = Omit<SqlDbProps, 'dependsOn' | 'importUri' | 'ignoreChanges' | 'group' | 'elasticPoolId' | 'sqlServerName'>;
+/**
+ * Vulnerability assessment properties for a SQL database.
+ */
 export type SqlBuilderVulnerabilityAssessmentType = Pick<SqlVulnerabilityAssessmentType, 'alertEmails'>;
+/**
+ * Interface for building SQL login credentials.
+ */
 export interface ISqlLoginBuilder extends ILoginBuilder<ISqlAuthBuilder> {
 }
+/**
+ * Interface for building SQL authentication options.
+ */
 export interface ISqlAuthBuilder {
+    /**
+     * Sets the authentication options for the SQL server.
+     * @param props - The authentication options.
+     * @returns An instance of ISqlNetworkBuilder.
+     */
     withAuthOptions(props: SqlBuilderAuthOptionsType): ISqlNetworkBuilder;
 }
+/**
+ * Interface for building SQL network properties.
+ */
 export interface ISqlNetworkBuilder {
+    /**
+     * Sets the network properties for the SQL server.
+     * @param props - The network properties.
+     * @returns An instance of ISqlTierBuilder.
+     */
     withNetwork(props: SqlNetworkType): ISqlTierBuilder;
 }
+/**
+ * Interface for building SQL tier and elastic pool properties.
+ */
 export interface ISqlTierBuilder {
+    /**
+     * Sets the elastic pool properties for the SQL server.
+     * @param props - The elastic pool properties.
+     * @returns An instance of ISqlBuilder.
+     */
     withElasticPool(props: SqlElasticPoolType): ISqlBuilder;
+    /**
+     * Sets the tier properties for the SQL server.
+     * @param sku - The SKU of the database.
+     * @returns An instance of ISqlBuilder.
+     */
     withTier(sku: SqlDbSku): ISqlBuilder;
 }
+/**
+ * Interface for building a SQL server.
+ */
 export interface ISqlBuilder extends IBuilder<SqlResults>, ILockable<ISqlBuilder>, IIgnoreChanges<ISqlBuilder> {
+    /**
+     * Adds databases to the SQL server.
+     * @param props - The properties of the databases.
+     * @returns An instance of ISqlBuilder.
+     */
     withDatabases(props: SqlDbBuilderType): ISqlBuilder;
+    /**
+     * Copies an existing database to the SQL server.
+     * @param props - The properties of the database to copy.
+     * @returns An instance of ISqlBuilder.
+     */
     copyDb(props: SqlFromDbType): ISqlBuilder;
+    /**
+     * Creates a replica of an existing database on the SQL server.
+     * @param props - The properties of the database to replicate.
+     * @returns An instance of ISqlBuilder.
+     */
     replicaDb(props: SqlFromDbType): ISqlBuilder;
+    /**
+     * Sets the vulnerability assessment properties for the SQL server.
+     * @param props - The vulnerability assessment properties.
+     * @returns An instance of ISqlBuilder.
+     */
     withVulnerabilityAssessment(props: SqlBuilderVulnerabilityAssessmentType): ISqlBuilder;
-    /** Allows to on/off the Assessment based on environment condition */
+    /**
+     * Conditionally sets the vulnerability assessment properties for the SQL server.
+     * @param condition - The condition to check.
+     * @param props - The vulnerability assessment properties.
+     * @returns An instance of ISqlBuilder.
+     */
     withVulnerabilityAssessmentIf(condition: boolean, props: SqlBuilderVulnerabilityAssessmentType): ISqlBuilder;
 }

package/Builder/types/storageBuilder.d.ts

@@ -3,24 +3,87 @@ import { CdnSecurityHeaderTypes } from '../../Cdn/CdnRules';
 import { ContainerProps, StorageFeatureType, StorageNetworkType, StoragePolicyType } from '../../Storage';
 import { ResourceInfo, WithEncryptionInfo } from '../../types';
 import { BuilderProps, IBuilder, ILockable } from './genericBuilder';
+/**
+ * Arguments required for building a Storage resource.
+ */
 export type StorageBuilderArgs = BuilderProps & WithEncryptionInfo;
+/**
+ * Type for defining CDN properties for a Storage resource.
+ */
 export type StorageCdnType = Pick<CdnEndpointProps, 'cdnProfileInfo' | 'cors' | 'domainNames'> & {
+    /**
+     * Security response headers for the CDN.
+     */
     securityResponse?: CdnSecurityHeaderTypes;
 };
+/**
+ * Type for defining storage features, excluding static website enablement.
+ */
 export type StorageFeatureBuilderType = Omit<StorageFeatureType, 'enableStaticWebsite'>;
+/**
+ * Interface for starting the building of a Storage resource.
+ */
 export interface IStorageStarterBuilder {
+    /**
+     * Initializes the builder as a standard storage resource.
+     * @param props - The storage feature properties.
+     * @returns An instance of IStorageBuilder.
+     */
     asStorage(props?: StorageFeatureBuilderType): IStorageBuilder;
+    /**
+     * Initializes the builder as a static web storage resource.
+     * @returns An instance of IStaticWebStorageBuilder.
+     */
     asStaticWebStorage(): IStaticWebStorageBuilder;
 }
+/**
+ * Interface for shared storage builder methods.
+ */
 export interface IStorageSharedBuilder extends IBuilder<ResourceInfo>, ILockable<IStorageSharedBuilder> {
+    /**
+     * Sets the network properties for the storage resource.
+     * @param props - The network properties.
+     * @returns An instance of IStorageSharedBuilder.
+     */
     withNetwork(props: StorageNetworkType): IStorageSharedBuilder;
 }
+/**
+ * Interface for building a standard Storage resource.
+ */
 export interface IStorageBuilder extends IBuilder<ResourceInfo>, IStorageSharedBuilder {
+    /**
+     * Adds a container to the storage resource.
+     * @param props - The container properties.
+     * @returns An instance of IStorageBuilder.
+     */
     withContainer(props: ContainerProps): IStorageBuilder;
+    /**
+     * Adds a queue to the storage resource.
+     * @param name - The name of the queue.
+     * @returns An instance of IStorageBuilder.
+     */
     withQueue(name: string): IStorageBuilder;
+    /**
+     * Adds a file share to the storage resource.
+     * @param name - The name of the file share.
+     * @returns An instance of IStorageBuilder.
+     */
     withFileShare(name: string): IStorageBuilder;
+    /**
+     * Sets the policies for the storage resource.
+     * @param props - The policy properties.
+     * @returns An instance of IStorageBuilder.
+     */
     withPolicies(props: StoragePolicyType): IStorageBuilder;
 }
+/**
+ * Interface for building a static web Storage resource.
+ */
 export interface IStaticWebStorageBuilder extends IBuilder<ResourceInfo>, IStorageSharedBuilder {
+    /**
+     * Sets the CDN properties for the static web storage resource.
+     * @param props - The CDN properties.
+     * @returns An instance of IStaticWebStorageBuilder.
+     */
     withCdn(props: StorageCdnType): IStaticWebStorageBuilder;
 }

package/Builder/types/vaultBuilder.d.ts

@@ -2,22 +2,64 @@ import { CertArgs } from '@drunk-pulumi/azure-providers';
 import { KeyVaultInfo, WithNamedType } from '../../types';
 import { Input } from '@pulumi/pulumi';
 import { BuilderProps } from './genericBuilder';
+/**
+ * Arguments required for building a Vault resource.
+ */
 export type VaultBuilderArgs = Omit<BuilderProps, 'vaultInfo'>;
+/**
+ * Type for defining secrets to be added to the vault.
+ */
 export type VaultBuilderSecretType = Record<string, Input<string>> | string;
+/**
+ * Type for defining certificates to be added to the vault.
+ */
 export type CertBuilderType = WithNamedType & {
     cert: CertArgs;
 };
+/**
+ * Interface for the results of the vault builder.
+ */
 export interface IVaultBuilderResults extends KeyVaultInfo {
+    /**
+     * Retrieves the KeyVault information.
+     * @returns The KeyVault information.
+     */
     info(): KeyVaultInfo;
-    /**Add secrets to vault. If parameter is a string the secret will be loaded from project secret*/
+    /**
+     * Adds secrets to the vault. If the parameter is a string, the secret will be loaded from the project secret.
+     * @param items - The secrets to add.
+     * @returns An instance of IVaultBuilderResults.
+     */
     addSecrets(items: VaultBuilderSecretType): IVaultBuilderResults;
+    /**
+     * Adds certificates to the vault.
+     * @param items - The certificates to add.
+     * @returns An instance of IVaultBuilderResults.
+     */
     addCerts(items: Record<string, CertBuilderType>): IVaultBuilderResults;
+    /**
+     * Links the vault to the specified subnets via a private link.
+     * @param subnetIds - The IDs of the subnets to link to.
+     * @returns An instance of IVaultBuilderResults.
+     */
     privateLinkTo(subnetIds: Input<string>[]): IVaultBuilderResults;
+    /**
+     * Links the vault to the specified subnets and IP addresses.
+     * @param props - The linking properties.
+     * @returns An instance of IVaultBuilderResults.
+     */
     linkTo(props: {
         subnetIds: Input<string>[];
         ipAddresses: Input<string>[];
     }): IVaultBuilderResults;
 }
+/**
+ * Interface for building a vault.
+ */
 export interface IVaultBuilder {
+    /**
+     * Builds the vault and returns the vault builder results.
+     * @returns The vault builder results.
+     */
     build(): IVaultBuilderResults;
 }