@pulumi/snowflake 0.35.0 → 0.35.1-alpha.1696372187

package/types/output.d.ts

@@ -10,7 +10,13 @@ export interface AlertAlertSchedule {
     interval?: number;
 }
 export interface AlertAlertScheduleCron {
+    /**
+     * Specifies the cron expression for the alert. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
+     */
     expression: string;
+    /**
+     * Specifies the time zone for alert refresh.
+     */
     timeZone: string;
 }
 export interface DatabaseReplicationConfiguration {
@@ -94,7 +100,13 @@ export interface FailoverGroupReplicationSchedule {
     interval?: number;
 }
 export interface FailoverGroupReplicationScheduleCron {
+    /**
+     * Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
+     */
     expression: string;
+    /**
+     * Specifies the time zone for secondary group refresh.
+     */
     timeZone: string;
 }
 export interface FunctionArgument {
@@ -157,27 +169,15 @@ export interface GetDatabasesDatabaseReplicationConfiguration {
 }
 export interface GetExternalFunctionsExternalFunction {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     language: string;
     name: string;
-    /**
-     * The schema from which to return the external functions from.
-     */
     schema: string;
 }
 export interface GetExternalTablesExternalTable {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     name: string;
-    /**
-     * The schema from which to return the external tables from.
-     */
     schema: string;
 }
 export interface GetFailoverGroupsFailoverGroup {
@@ -201,29 +201,17 @@ export interface GetFailoverGroupsFailoverGroup {
 }
 export interface GetFileFormatsFileFormat {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     formatType: string;
     name: string;
-    /**
-     * The schema from which to return the file formats from.
-     */
     schema: string;
 }
 export interface GetFunctionsFunction {
     argumentTypes: string[];
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     name: string;
     returnType: string;
-    /**
-     * The schema from which to return the functions from.
-     */
     schema: string;
 }
 export interface GetGrantsFutureGrantsIn {
@@ -237,7 +225,13 @@ export interface GetGrantsFutureGrantsIn {
     schema?: outputs.GetGrantsFutureGrantsInSchema;
 }
 export interface GetGrantsFutureGrantsInSchema {
+    /**
+     * The database in which the scehma resides. Optional when querying a schema in the current database.
+     */
     databaseName?: string;
+    /**
+     * The name of the schema to list all privileges of new (ie. future) objects granted to
+     */
     schemaName: string;
 }
 export interface GetGrantsFutureGrantsTo {
@@ -296,27 +290,15 @@ export interface GetGrantsGrantsTo {
 }
 export interface GetMaskingPoliciesMaskingPolicy {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     kind: string;
     name: string;
-    /**
-     * The schema from which to return the maskingPolicies from.
-     */
     schema: string;
 }
 export interface GetMaterializedViewsMaterializedView {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     name: string;
-    /**
-     * The schema from which to return the views from.
-     */
     schema: string;
 }
 export interface GetParametersParameter {
@@ -328,29 +310,17 @@ export interface GetParametersParameter {
 }
 export interface GetPipesPipe {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     integration: string;
     name: string;
-    /**
-     * The schema from which to return the pipes from.
-     */
     schema: string;
 }
 export interface GetProceduresProcedure {
     argumentTypes: string[];
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     name: string;
     returnType: string;
-    /**
-     * The schema from which to return the procedures from.
-     */
     schema: string;
 }
 export interface GetResourceMonitorsResourceMonitor {
@@ -366,34 +336,19 @@ export interface GetRolesRole {
 }
 export interface GetRowAccessPoliciesRowAccessPolicy {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     name: string;
-    /**
-     * The schema from which to return the row access policyfrom.
-     */
     schema: string;
 }
 export interface GetSchemasSchema {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     name: string;
 }
 export interface GetSequencesSequence {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     name: string;
-    /**
-     * The schema from which to return the sequences from.
-     */
     schema: string;
 }
 export interface GetSharesShare {
@@ -405,14 +360,8 @@ export interface GetSharesShare {
 }
 export interface GetStagesStage {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     name: string;
-    /**
-     * The schema from which to return the stages from.
-     */
     schema: string;
     storageIntegration: string;
 }
@@ -424,39 +373,21 @@ export interface GetStorageIntegrationsStorageIntegration {
 }
 export interface GetStreamsStream {
     comment: string;
-    /**
-     * The database from which to return the streams from.
-     */
     database: string;
     name: string;
-    /**
-     * The schema from which to return the streams from.
-     */
     schema: string;
     table: string;
 }
 export interface GetTablesTable {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     name: string;
-    /**
-     * The schema from which to return the tables from.
-     */
     schema: string;
 }
 export interface GetTasksTask {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     name: string;
-    /**
-     * The schema from which to return the tasks from.
-     */
     schema: string;
     warehouse: string;
 }
@@ -477,14 +408,8 @@ export interface GetUsersUser {
 }
 export interface GetViewsView {
     comment: string;
-    /**
-     * The database from which to return the schemas from.
-     */
     database: string;
     name: string;
-    /**
-     * The schema from which to return the views from.
-     */
     schema: string;
 }
 export interface GetWarehousesWarehouse {
@@ -538,13 +463,31 @@ export interface GrantPrivilegesToRoleOnSchemaObject {
     objectType?: string;
 }
 export interface GrantPrivilegesToRoleOnSchemaObjectAll {
+    /**
+     * The fully qualified name of the database.
+     */
     inDatabase?: string;
+    /**
+     * The fully qualified name of the schema.
+     */
     inSchema?: string;
+    /**
+     * The plural object type of the schema object on which privileges will be granted. Valid values are: ALERTS | DYNAMIC TABLES | EVENT TABLES | FILE FORMATS | FUNCTIONS | PROCEDURES | SECRETS | SEQUENCES | PIPES | MASKING POLICIES | PASSWORD POLICIES | ROW ACCESS POLICIES | SESSION POLICIES | TAGS | STAGES | STREAMS | TABLES | EXTERNAL TABLES | TASKS | VIEWS | MATERIALIZED VIEWS
+     */
     objectTypePlural: string;
 }
 export interface GrantPrivilegesToRoleOnSchemaObjectFuture {
+    /**
+     * The fully qualified name of the database.
+     */
     inDatabase?: string;
+    /**
+     * The fully qualified name of the schema.
+     */
     inSchema?: string;
+    /**
+     * The plural object type of the schema object on which privileges will be granted. Valid values are: ALERTS | DYNAMIC TABLES | EVENT TABLES | FILE FORMATS | FUNCTIONS | PROCEDURES | SECRETS | SEQUENCES | PIPES | MASKING POLICIES | PASSWORD POLICIES | ROW ACCESS POLICIES | SESSION POLICIES | TAGS | STAGES | STREAMS | TABLES | EXTERNAL TABLES | TASKS | VIEWS | MATERIALIZED VIEWS
+     */
     objectTypePlural: string;
 }
 export interface MaskingPolicySignature {
@@ -552,9 +495,12 @@ export interface MaskingPolicySignature {
 }
 export interface MaskingPolicySignatureColumn {
     /**
-     * Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created.
+     * Specifies the column name to mask.
      */
     name: string;
+    /**
+     * Specifies the column type to mask.
+     */
     type: string;
 }
 export interface MaterializedViewTag {
@@ -684,12 +630,27 @@ export interface TableColumn {
     type: string;
 }
 export interface TableColumnDefault {
+    /**
+     * The default constant value for the column
+     */
     constant?: string;
+    /**
+     * The default expression value for the column
+     */
     expression?: string;
+    /**
+     * The default sequence to use for the column
+     */
     sequence?: string;
 }
 export interface TableColumnIdentity {
+    /**
+     * The number to start incrementing at.
+     */
     startNum?: number;
+    /**
+     * Step size to increment by.
+     */
     stepNum?: number;
 }
 export interface TableConstraintForeignKeyProperties {
@@ -712,11 +673,11 @@ export interface TableConstraintForeignKeyProperties {
 }
 export interface TableConstraintForeignKeyPropertiesReferences {
     /**
-     * Columns to use in constraint key
+     * Columns to use in foreign key reference
      */
     columns: string[];
     /**
-     * Idenfifier for table to create constraint on. Must be of the form Note: format must follow: "\n\n"."\n\n"."\n\n" or "\n\n.\n\n.\n\n" or "\n\n|\n\n.\n\n" (snowflake*table.my*table.id)
+     * Name of constraint
      */
     tableId: string;
 }

package/view.d.ts

@@ -55,7 +55,7 @@ export declare class View extends pulumi.CustomResource {
      */
     readonly createdOn: pulumi.Output<string>;
     /**
-     * The database in which to create the view. Don't use the | character.
+     * Name of the database that the tag was created in.
      */
     readonly database: pulumi.Output<string>;
     /**
@@ -63,7 +63,7 @@ export declare class View extends pulumi.CustomResource {
      */
     readonly isSecure: pulumi.Output<boolean | undefined>;
     /**
-     * Specifies the identifier for the view; must be unique for the schema in which the view is created. Don't use the | character.
+     * Tag name, e.g. department.
      */
     readonly name: pulumi.Output<string>;
     /**
@@ -71,7 +71,7 @@ export declare class View extends pulumi.CustomResource {
      */
     readonly orReplace: pulumi.Output<boolean | undefined>;
     /**
-     * The schema in which to create the view. Don't use the | character.
+     * Name of the schema that the tag was created in.
      */
     readonly schema: pulumi.Output<string>;
     /**
@@ -110,7 +110,7 @@ export interface ViewState {
      */
     createdOn?: pulumi.Input<string>;
     /**
-     * The database in which to create the view. Don't use the | character.
+     * Name of the database that the tag was created in.
      */
     database?: pulumi.Input<string>;
     /**
@@ -118,7 +118,7 @@ export interface ViewState {
      */
     isSecure?: pulumi.Input<boolean>;
     /**
-     * Specifies the identifier for the view; must be unique for the schema in which the view is created. Don't use the | character.
+     * Tag name, e.g. department.
      */
     name?: pulumi.Input<string>;
     /**
@@ -126,7 +126,7 @@ export interface ViewState {
      */
     orReplace?: pulumi.Input<boolean>;
     /**
-     * The schema in which to create the view. Don't use the | character.
+     * Name of the schema that the tag was created in.
      */
     schema?: pulumi.Input<string>;
     /**
@@ -153,7 +153,7 @@ export interface ViewArgs {
      */
     copyGrants?: pulumi.Input<boolean>;
     /**
-     * The database in which to create the view. Don't use the | character.
+     * Name of the database that the tag was created in.
      */
     database: pulumi.Input<string>;
     /**
@@ -161,7 +161,7 @@ export interface ViewArgs {
      */
     isSecure?: pulumi.Input<boolean>;
     /**
-     * Specifies the identifier for the view; must be unique for the schema in which the view is created. Don't use the | character.
+     * Tag name, e.g. department.
      */
     name?: pulumi.Input<string>;
     /**
@@ -169,7 +169,7 @@ export interface ViewArgs {
      */
     orReplace?: pulumi.Input<boolean>;
     /**
-     * The schema in which to create the view. Don't use the | character.
+     * Name of the schema that the tag was created in.
      */
     schema: pulumi.Input<string>;
     /**