@pulumi/snowflake 0.61.0-alpha.1731393894 → 0.61.0-alpha.1731504398
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/accountAuthenticationPolicyAttachment.d.ts +48 -0
- package/accountAuthenticationPolicyAttachment.js +52 -0
- package/accountAuthenticationPolicyAttachment.js.map +1 -0
- package/authenticationPolicy.d.ts +177 -0
- package/authenticationPolicy.js +84 -0
- package/authenticationPolicy.js.map +1 -0
- package/config/vars.d.ts +79 -36
- package/config/vars.js +46 -4
- package/config/vars.js.map +1 -1
- package/externalVolume.d.ts +113 -0
- package/externalVolume.js +67 -0
- package/externalVolume.js.map +1 -0
- package/getConnections.d.ts +91 -0
- package/getConnections.js +76 -0
- package/getConnections.js.map +1 -0
- package/getGrants.d.ts +4 -0
- package/getGrants.js +4 -0
- package/getGrants.js.map +1 -1
- package/getSecrets.d.ts +140 -0
- package/getSecrets.js +104 -0
- package/getSecrets.js.map +1 -0
- package/getStreams.d.ts +58 -37
- package/getStreams.js +16 -24
- package/getStreams.js.map +1 -1
- package/grantAccountRole.d.ts +1 -1
- package/grantAccountRole.js +1 -1
- package/grantApplicationRole.d.ts +1 -1
- package/grantApplicationRole.js +1 -1
- package/grantDatabaseRole.d.ts +1 -1
- package/grantDatabaseRole.js +1 -1
- package/grantOwnership.d.ts +7 -7
- package/grantOwnership.js +7 -7
- package/grantPrivilegesToAccountRole.d.ts +4 -4
- package/grantPrivilegesToAccountRole.js +4 -4
- package/grantPrivilegesToDatabaseRole.d.ts +4 -4
- package/grantPrivilegesToDatabaseRole.js +4 -4
- package/grantPrivilegesToShare.d.ts +1 -1
- package/grantPrivilegesToShare.js +1 -1
- package/index.d.ts +42 -0
- package/index.js +70 -4
- package/index.js.map +1 -1
- package/legacyServiceUser.d.ts +2 -0
- package/legacyServiceUser.js +2 -0
- package/legacyServiceUser.js.map +1 -1
- package/package.json +2 -2
- package/primaryConnection.d.ts +99 -0
- package/primaryConnection.js +66 -0
- package/primaryConnection.js.map +1 -0
- package/provider.d.ts +158 -54
- package/provider.js +11 -4
- package/provider.js.map +1 -1
- package/secondaryConnection.d.ts +105 -0
- package/secondaryConnection.js +69 -0
- package/secondaryConnection.js.map +1 -0
- package/secretWithAuthorizationCodeGrant.d.ts +152 -0
- package/secretWithAuthorizationCodeGrant.js +93 -0
- package/secretWithAuthorizationCodeGrant.js.map +1 -0
- package/secretWithBasicAuthentication.d.ts +140 -0
- package/secretWithBasicAuthentication.js +88 -0
- package/secretWithBasicAuthentication.js.map +1 -0
- package/secretWithClientCredentials.d.ts +149 -0
- package/secretWithClientCredentials.js +86 -0
- package/secretWithClientCredentials.js.map +1 -0
- package/secretWithGenericString.d.ts +128 -0
- package/secretWithGenericString.js +83 -0
- package/secretWithGenericString.js.map +1 -0
- package/streamOnDirectoryTable.d.ts +151 -0
- package/streamOnDirectoryTable.js +85 -0
- package/streamOnDirectoryTable.js.map +1 -0
- package/streamOnExternalTable.d.ts +10 -0
- package/streamOnExternalTable.js +4 -0
- package/streamOnExternalTable.js.map +1 -1
- package/streamOnTable.d.ts +10 -0
- package/streamOnTable.js +4 -0
- package/streamOnTable.js.map +1 -1
- package/streamOnView.d.ts +172 -0
- package/streamOnView.js +93 -0
- package/streamOnView.js.map +1 -0
- package/tagAssociation.d.ts +3 -3
- package/types/input.d.ts +407 -4
- package/types/output.d.ts +448 -7
- package/user.d.ts +2 -0
- package/user.js +2 -0
- package/user.js.map +1 -1
- package/userAuthenticationPolicyAttachment.d.ts +60 -0
- package/userAuthenticationPolicyAttachment.js +57 -0
- package/userAuthenticationPolicyAttachment.js.map +1 -0
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import * as pulumi from "@pulumi/pulumi";
|
|
2
|
+
export declare class AccountAuthenticationPolicyAttachment extends pulumi.CustomResource {
|
|
3
|
+
/**
|
|
4
|
+
* Get an existing AccountAuthenticationPolicyAttachment resource's state with the given name, ID, and optional extra
|
|
5
|
+
* properties used to qualify the lookup.
|
|
6
|
+
*
|
|
7
|
+
* @param name The _unique_ name of the resulting resource.
|
|
8
|
+
* @param id The _unique_ provider ID of the resource to lookup.
|
|
9
|
+
* @param state Any extra arguments used during the lookup.
|
|
10
|
+
* @param opts Optional settings to control the behavior of the CustomResource.
|
|
11
|
+
*/
|
|
12
|
+
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccountAuthenticationPolicyAttachmentState, opts?: pulumi.CustomResourceOptions): AccountAuthenticationPolicyAttachment;
|
|
13
|
+
/**
|
|
14
|
+
* Returns true if the given object is an instance of AccountAuthenticationPolicyAttachment. This is designed to work even
|
|
15
|
+
* when multiple copies of the Pulumi SDK have been loaded into the same process.
|
|
16
|
+
*/
|
|
17
|
+
static isInstance(obj: any): obj is AccountAuthenticationPolicyAttachment;
|
|
18
|
+
/**
|
|
19
|
+
* Qualified name (`"db"."schema"."policyName"`) of the authentication policy to apply to the current account.
|
|
20
|
+
*/
|
|
21
|
+
readonly authenticationPolicy: pulumi.Output<string>;
|
|
22
|
+
/**
|
|
23
|
+
* Create a AccountAuthenticationPolicyAttachment resource with the given unique name, arguments, and options.
|
|
24
|
+
*
|
|
25
|
+
* @param name The _unique_ name of the resource.
|
|
26
|
+
* @param args The arguments to use to populate this resource's properties.
|
|
27
|
+
* @param opts A bag of options that control this resource's behavior.
|
|
28
|
+
*/
|
|
29
|
+
constructor(name: string, args: AccountAuthenticationPolicyAttachmentArgs, opts?: pulumi.CustomResourceOptions);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Input properties used for looking up and filtering AccountAuthenticationPolicyAttachment resources.
|
|
33
|
+
*/
|
|
34
|
+
export interface AccountAuthenticationPolicyAttachmentState {
|
|
35
|
+
/**
|
|
36
|
+
* Qualified name (`"db"."schema"."policyName"`) of the authentication policy to apply to the current account.
|
|
37
|
+
*/
|
|
38
|
+
authenticationPolicy?: pulumi.Input<string>;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* The set of arguments for constructing a AccountAuthenticationPolicyAttachment resource.
|
|
42
|
+
*/
|
|
43
|
+
export interface AccountAuthenticationPolicyAttachmentArgs {
|
|
44
|
+
/**
|
|
45
|
+
* Qualified name (`"db"."schema"."policyName"`) of the authentication policy to apply to the current account.
|
|
46
|
+
*/
|
|
47
|
+
authenticationPolicy: pulumi.Input<string>;
|
|
48
|
+
}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
|
|
3
|
+
// *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.AccountAuthenticationPolicyAttachment = void 0;
|
|
6
|
+
const pulumi = require("@pulumi/pulumi");
|
|
7
|
+
const utilities = require("./utilities");
|
|
8
|
+
class AccountAuthenticationPolicyAttachment extends pulumi.CustomResource {
|
|
9
|
+
/**
|
|
10
|
+
* Get an existing AccountAuthenticationPolicyAttachment resource's state with the given name, ID, and optional extra
|
|
11
|
+
* properties used to qualify the lookup.
|
|
12
|
+
*
|
|
13
|
+
* @param name The _unique_ name of the resulting resource.
|
|
14
|
+
* @param id The _unique_ provider ID of the resource to lookup.
|
|
15
|
+
* @param state Any extra arguments used during the lookup.
|
|
16
|
+
* @param opts Optional settings to control the behavior of the CustomResource.
|
|
17
|
+
*/
|
|
18
|
+
static get(name, id, state, opts) {
|
|
19
|
+
return new AccountAuthenticationPolicyAttachment(name, state, Object.assign(Object.assign({}, opts), { id: id }));
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Returns true if the given object is an instance of AccountAuthenticationPolicyAttachment. This is designed to work even
|
|
23
|
+
* when multiple copies of the Pulumi SDK have been loaded into the same process.
|
|
24
|
+
*/
|
|
25
|
+
static isInstance(obj) {
|
|
26
|
+
if (obj === undefined || obj === null) {
|
|
27
|
+
return false;
|
|
28
|
+
}
|
|
29
|
+
return obj['__pulumiType'] === AccountAuthenticationPolicyAttachment.__pulumiType;
|
|
30
|
+
}
|
|
31
|
+
constructor(name, argsOrState, opts) {
|
|
32
|
+
let resourceInputs = {};
|
|
33
|
+
opts = opts || {};
|
|
34
|
+
if (opts.id) {
|
|
35
|
+
const state = argsOrState;
|
|
36
|
+
resourceInputs["authenticationPolicy"] = state ? state.authenticationPolicy : undefined;
|
|
37
|
+
}
|
|
38
|
+
else {
|
|
39
|
+
const args = argsOrState;
|
|
40
|
+
if ((!args || args.authenticationPolicy === undefined) && !opts.urn) {
|
|
41
|
+
throw new Error("Missing required property 'authenticationPolicy'");
|
|
42
|
+
}
|
|
43
|
+
resourceInputs["authenticationPolicy"] = args ? args.authenticationPolicy : undefined;
|
|
44
|
+
}
|
|
45
|
+
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
|
|
46
|
+
super(AccountAuthenticationPolicyAttachment.__pulumiType, name, resourceInputs, opts);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
exports.AccountAuthenticationPolicyAttachment = AccountAuthenticationPolicyAttachment;
|
|
50
|
+
/** @internal */
|
|
51
|
+
AccountAuthenticationPolicyAttachment.__pulumiType = 'snowflake:index/accountAuthenticationPolicyAttachment:AccountAuthenticationPolicyAttachment';
|
|
52
|
+
//# sourceMappingURL=accountAuthenticationPolicyAttachment.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"accountAuthenticationPolicyAttachment.js","sourceRoot":"","sources":["../accountAuthenticationPolicyAttachment.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,MAAa,qCAAsC,SAAQ,MAAM,CAAC,cAAc;IAC5E;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAkD,EAAE,IAAmC;QAChJ,OAAO,IAAI,qCAAqC,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC5F,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,qCAAqC,CAAC,YAAY,CAAC;IACtF,CAAC;IAeD,YAAY,IAAY,EAAE,WAAoG,EAAE,IAAmC;QAC/J,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAqE,CAAC;YACpF,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3F;aAAM;YACH,MAAM,IAAI,GAAG,WAAoE,CAAC;YAClF,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACjE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;aACvE;YACD,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;SACzF;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,qCAAqC,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC1F,CAAC;;AAxDL,sFAyDC;AA3CG,gBAAgB;AACO,kDAAY,GAAG,6FAA6F,CAAC"}
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
import * as pulumi from "@pulumi/pulumi";
|
|
2
|
+
import * as inputs from "./types/input";
|
|
3
|
+
import * as outputs from "./types/output";
|
|
4
|
+
/**
|
|
5
|
+
* ## Import
|
|
6
|
+
*
|
|
7
|
+
* ```sh
|
|
8
|
+
* $ pulumi import snowflake:index/authenticationPolicy:AuthenticationPolicy example '"<database_name>"."<schema_name>"."<authentication_policy_name>"'
|
|
9
|
+
* ```
|
|
10
|
+
*/
|
|
11
|
+
export declare class AuthenticationPolicy extends pulumi.CustomResource {
|
|
12
|
+
/**
|
|
13
|
+
* Get an existing AuthenticationPolicy resource's state with the given name, ID, and optional extra
|
|
14
|
+
* properties used to qualify the lookup.
|
|
15
|
+
*
|
|
16
|
+
* @param name The _unique_ name of the resulting resource.
|
|
17
|
+
* @param id The _unique_ provider ID of the resource to lookup.
|
|
18
|
+
* @param state Any extra arguments used during the lookup.
|
|
19
|
+
* @param opts Optional settings to control the behavior of the CustomResource.
|
|
20
|
+
*/
|
|
21
|
+
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthenticationPolicyState, opts?: pulumi.CustomResourceOptions): AuthenticationPolicy;
|
|
22
|
+
/**
|
|
23
|
+
* Returns true if the given object is an instance of AuthenticationPolicy. This is designed to work even
|
|
24
|
+
* when multiple copies of the Pulumi SDK have been loaded into the same process.
|
|
25
|
+
*/
|
|
26
|
+
static isInstance(obj: any): obj is AuthenticationPolicy;
|
|
27
|
+
/**
|
|
28
|
+
* A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: `ALL` | `SAML` | `PASSWORD` | `OAUTH` | `KEYPAIR`
|
|
29
|
+
*/
|
|
30
|
+
readonly authenticationMethods: pulumi.Output<string[] | undefined>;
|
|
31
|
+
/**
|
|
32
|
+
* A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENT*TYPES, then the login attempt fails. Allowed values are `ALL` | `SNOWFLAKE_UI` | `DRIVERS` | `SNOWSQL`. The CLIENT*TYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
|
|
33
|
+
*/
|
|
34
|
+
readonly clientTypes: pulumi.Output<string[] | undefined>;
|
|
35
|
+
/**
|
|
36
|
+
* Specifies a comment for the authentication policy.
|
|
37
|
+
*/
|
|
38
|
+
readonly comment: pulumi.Output<string | undefined>;
|
|
39
|
+
/**
|
|
40
|
+
* The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `(`, `)`, `"`
|
|
41
|
+
*/
|
|
42
|
+
readonly database: pulumi.Output<string>;
|
|
43
|
+
/**
|
|
44
|
+
* Outputs the result of `DESCRIBE AUTHENTICATION POLICY` for the given policy.
|
|
45
|
+
*/
|
|
46
|
+
readonly describeOutputs: pulumi.Output<outputs.AuthenticationPolicyDescribeOutput[]>;
|
|
47
|
+
/**
|
|
48
|
+
* Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
|
|
49
|
+
*/
|
|
50
|
+
readonly fullyQualifiedName: pulumi.Output<string>;
|
|
51
|
+
/**
|
|
52
|
+
* A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are `ALL` | `SAML` | `PASSWORD`.
|
|
53
|
+
*/
|
|
54
|
+
readonly mfaAuthenticationMethods: pulumi.Output<string[] | undefined>;
|
|
55
|
+
/**
|
|
56
|
+
* Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENT*TYPES parameter must include SNOWFLAKE*UI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
|
|
57
|
+
*/
|
|
58
|
+
readonly mfaEnrollment: pulumi.Output<string | undefined>;
|
|
59
|
+
/**
|
|
60
|
+
* Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `(`, `)`, `"`
|
|
61
|
+
*/
|
|
62
|
+
readonly name: pulumi.Output<string>;
|
|
63
|
+
/**
|
|
64
|
+
* The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `(`, `)`, `"`
|
|
65
|
+
*/
|
|
66
|
+
readonly schema: pulumi.Output<string>;
|
|
67
|
+
/**
|
|
68
|
+
* A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATION*METHODS list. All values in the SECURITY*INTEGRATIONS list must be compatible with the values in the AUTHENTICATION*METHODS list. For example, if SECURITY*INTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
|
|
69
|
+
*/
|
|
70
|
+
readonly securityIntegrations: pulumi.Output<string[] | undefined>;
|
|
71
|
+
/**
|
|
72
|
+
* Outputs the result of `SHOW AUTHENTICATION POLICIES` for the given policy.
|
|
73
|
+
*/
|
|
74
|
+
readonly showOutputs: pulumi.Output<outputs.AuthenticationPolicyShowOutput[]>;
|
|
75
|
+
/**
|
|
76
|
+
* Create a AuthenticationPolicy resource with the given unique name, arguments, and options.
|
|
77
|
+
*
|
|
78
|
+
* @param name The _unique_ name of the resource.
|
|
79
|
+
* @param args The arguments to use to populate this resource's properties.
|
|
80
|
+
* @param opts A bag of options that control this resource's behavior.
|
|
81
|
+
*/
|
|
82
|
+
constructor(name: string, args: AuthenticationPolicyArgs, opts?: pulumi.CustomResourceOptions);
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Input properties used for looking up and filtering AuthenticationPolicy resources.
|
|
86
|
+
*/
|
|
87
|
+
export interface AuthenticationPolicyState {
|
|
88
|
+
/**
|
|
89
|
+
* A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: `ALL` | `SAML` | `PASSWORD` | `OAUTH` | `KEYPAIR`
|
|
90
|
+
*/
|
|
91
|
+
authenticationMethods?: pulumi.Input<pulumi.Input<string>[]>;
|
|
92
|
+
/**
|
|
93
|
+
* A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENT*TYPES, then the login attempt fails. Allowed values are `ALL` | `SNOWFLAKE_UI` | `DRIVERS` | `SNOWSQL`. The CLIENT*TYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
|
|
94
|
+
*/
|
|
95
|
+
clientTypes?: pulumi.Input<pulumi.Input<string>[]>;
|
|
96
|
+
/**
|
|
97
|
+
* Specifies a comment for the authentication policy.
|
|
98
|
+
*/
|
|
99
|
+
comment?: pulumi.Input<string>;
|
|
100
|
+
/**
|
|
101
|
+
* The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `(`, `)`, `"`
|
|
102
|
+
*/
|
|
103
|
+
database?: pulumi.Input<string>;
|
|
104
|
+
/**
|
|
105
|
+
* Outputs the result of `DESCRIBE AUTHENTICATION POLICY` for the given policy.
|
|
106
|
+
*/
|
|
107
|
+
describeOutputs?: pulumi.Input<pulumi.Input<inputs.AuthenticationPolicyDescribeOutput>[]>;
|
|
108
|
+
/**
|
|
109
|
+
* Fully qualified name of the resource. For more information, see [object name resolution](https://docs.snowflake.com/en/sql-reference/name-resolution).
|
|
110
|
+
*/
|
|
111
|
+
fullyQualifiedName?: pulumi.Input<string>;
|
|
112
|
+
/**
|
|
113
|
+
* A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are `ALL` | `SAML` | `PASSWORD`.
|
|
114
|
+
*/
|
|
115
|
+
mfaAuthenticationMethods?: pulumi.Input<pulumi.Input<string>[]>;
|
|
116
|
+
/**
|
|
117
|
+
* Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENT*TYPES parameter must include SNOWFLAKE*UI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
|
|
118
|
+
*/
|
|
119
|
+
mfaEnrollment?: pulumi.Input<string>;
|
|
120
|
+
/**
|
|
121
|
+
* Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `(`, `)`, `"`
|
|
122
|
+
*/
|
|
123
|
+
name?: pulumi.Input<string>;
|
|
124
|
+
/**
|
|
125
|
+
* The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `(`, `)`, `"`
|
|
126
|
+
*/
|
|
127
|
+
schema?: pulumi.Input<string>;
|
|
128
|
+
/**
|
|
129
|
+
* A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATION*METHODS list. All values in the SECURITY*INTEGRATIONS list must be compatible with the values in the AUTHENTICATION*METHODS list. For example, if SECURITY*INTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
|
|
130
|
+
*/
|
|
131
|
+
securityIntegrations?: pulumi.Input<pulumi.Input<string>[]>;
|
|
132
|
+
/**
|
|
133
|
+
* Outputs the result of `SHOW AUTHENTICATION POLICIES` for the given policy.
|
|
134
|
+
*/
|
|
135
|
+
showOutputs?: pulumi.Input<pulumi.Input<inputs.AuthenticationPolicyShowOutput>[]>;
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* The set of arguments for constructing a AuthenticationPolicy resource.
|
|
139
|
+
*/
|
|
140
|
+
export interface AuthenticationPolicyArgs {
|
|
141
|
+
/**
|
|
142
|
+
* A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: `ALL` | `SAML` | `PASSWORD` | `OAUTH` | `KEYPAIR`
|
|
143
|
+
*/
|
|
144
|
+
authenticationMethods?: pulumi.Input<pulumi.Input<string>[]>;
|
|
145
|
+
/**
|
|
146
|
+
* A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENT*TYPES, then the login attempt fails. Allowed values are `ALL` | `SNOWFLAKE_UI` | `DRIVERS` | `SNOWSQL`. The CLIENT*TYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
|
|
147
|
+
*/
|
|
148
|
+
clientTypes?: pulumi.Input<pulumi.Input<string>[]>;
|
|
149
|
+
/**
|
|
150
|
+
* Specifies a comment for the authentication policy.
|
|
151
|
+
*/
|
|
152
|
+
comment?: pulumi.Input<string>;
|
|
153
|
+
/**
|
|
154
|
+
* The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `(`, `)`, `"`
|
|
155
|
+
*/
|
|
156
|
+
database: pulumi.Input<string>;
|
|
157
|
+
/**
|
|
158
|
+
* A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are `ALL` | `SAML` | `PASSWORD`.
|
|
159
|
+
*/
|
|
160
|
+
mfaAuthenticationMethods?: pulumi.Input<pulumi.Input<string>[]>;
|
|
161
|
+
/**
|
|
162
|
+
* Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENT*TYPES parameter must include SNOWFLAKE*UI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
|
|
163
|
+
*/
|
|
164
|
+
mfaEnrollment?: pulumi.Input<string>;
|
|
165
|
+
/**
|
|
166
|
+
* Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `(`, `)`, `"`
|
|
167
|
+
*/
|
|
168
|
+
name?: pulumi.Input<string>;
|
|
169
|
+
/**
|
|
170
|
+
* The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: `|`, `.`, `(`, `)`, `"`
|
|
171
|
+
*/
|
|
172
|
+
schema: pulumi.Input<string>;
|
|
173
|
+
/**
|
|
174
|
+
* A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATION*METHODS list. All values in the SECURITY*INTEGRATIONS list must be compatible with the values in the AUTHENTICATION*METHODS list. For example, if SECURITY*INTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
|
|
175
|
+
*/
|
|
176
|
+
securityIntegrations?: pulumi.Input<pulumi.Input<string>[]>;
|
|
177
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
|
|
3
|
+
// *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.AuthenticationPolicy = void 0;
|
|
6
|
+
const pulumi = require("@pulumi/pulumi");
|
|
7
|
+
const utilities = require("./utilities");
|
|
8
|
+
/**
|
|
9
|
+
* ## Import
|
|
10
|
+
*
|
|
11
|
+
* ```sh
|
|
12
|
+
* $ pulumi import snowflake:index/authenticationPolicy:AuthenticationPolicy example '"<database_name>"."<schema_name>"."<authentication_policy_name>"'
|
|
13
|
+
* ```
|
|
14
|
+
*/
|
|
15
|
+
class AuthenticationPolicy extends pulumi.CustomResource {
|
|
16
|
+
/**
|
|
17
|
+
* Get an existing AuthenticationPolicy resource's state with the given name, ID, and optional extra
|
|
18
|
+
* properties used to qualify the lookup.
|
|
19
|
+
*
|
|
20
|
+
* @param name The _unique_ name of the resulting resource.
|
|
21
|
+
* @param id The _unique_ provider ID of the resource to lookup.
|
|
22
|
+
* @param state Any extra arguments used during the lookup.
|
|
23
|
+
* @param opts Optional settings to control the behavior of the CustomResource.
|
|
24
|
+
*/
|
|
25
|
+
static get(name, id, state, opts) {
|
|
26
|
+
return new AuthenticationPolicy(name, state, Object.assign(Object.assign({}, opts), { id: id }));
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Returns true if the given object is an instance of AuthenticationPolicy. This is designed to work even
|
|
30
|
+
* when multiple copies of the Pulumi SDK have been loaded into the same process.
|
|
31
|
+
*/
|
|
32
|
+
static isInstance(obj) {
|
|
33
|
+
if (obj === undefined || obj === null) {
|
|
34
|
+
return false;
|
|
35
|
+
}
|
|
36
|
+
return obj['__pulumiType'] === AuthenticationPolicy.__pulumiType;
|
|
37
|
+
}
|
|
38
|
+
constructor(name, argsOrState, opts) {
|
|
39
|
+
let resourceInputs = {};
|
|
40
|
+
opts = opts || {};
|
|
41
|
+
if (opts.id) {
|
|
42
|
+
const state = argsOrState;
|
|
43
|
+
resourceInputs["authenticationMethods"] = state ? state.authenticationMethods : undefined;
|
|
44
|
+
resourceInputs["clientTypes"] = state ? state.clientTypes : undefined;
|
|
45
|
+
resourceInputs["comment"] = state ? state.comment : undefined;
|
|
46
|
+
resourceInputs["database"] = state ? state.database : undefined;
|
|
47
|
+
resourceInputs["describeOutputs"] = state ? state.describeOutputs : undefined;
|
|
48
|
+
resourceInputs["fullyQualifiedName"] = state ? state.fullyQualifiedName : undefined;
|
|
49
|
+
resourceInputs["mfaAuthenticationMethods"] = state ? state.mfaAuthenticationMethods : undefined;
|
|
50
|
+
resourceInputs["mfaEnrollment"] = state ? state.mfaEnrollment : undefined;
|
|
51
|
+
resourceInputs["name"] = state ? state.name : undefined;
|
|
52
|
+
resourceInputs["schema"] = state ? state.schema : undefined;
|
|
53
|
+
resourceInputs["securityIntegrations"] = state ? state.securityIntegrations : undefined;
|
|
54
|
+
resourceInputs["showOutputs"] = state ? state.showOutputs : undefined;
|
|
55
|
+
}
|
|
56
|
+
else {
|
|
57
|
+
const args = argsOrState;
|
|
58
|
+
if ((!args || args.database === undefined) && !opts.urn) {
|
|
59
|
+
throw new Error("Missing required property 'database'");
|
|
60
|
+
}
|
|
61
|
+
if ((!args || args.schema === undefined) && !opts.urn) {
|
|
62
|
+
throw new Error("Missing required property 'schema'");
|
|
63
|
+
}
|
|
64
|
+
resourceInputs["authenticationMethods"] = args ? args.authenticationMethods : undefined;
|
|
65
|
+
resourceInputs["clientTypes"] = args ? args.clientTypes : undefined;
|
|
66
|
+
resourceInputs["comment"] = args ? args.comment : undefined;
|
|
67
|
+
resourceInputs["database"] = args ? args.database : undefined;
|
|
68
|
+
resourceInputs["mfaAuthenticationMethods"] = args ? args.mfaAuthenticationMethods : undefined;
|
|
69
|
+
resourceInputs["mfaEnrollment"] = args ? args.mfaEnrollment : undefined;
|
|
70
|
+
resourceInputs["name"] = args ? args.name : undefined;
|
|
71
|
+
resourceInputs["schema"] = args ? args.schema : undefined;
|
|
72
|
+
resourceInputs["securityIntegrations"] = args ? args.securityIntegrations : undefined;
|
|
73
|
+
resourceInputs["describeOutputs"] = undefined /*out*/;
|
|
74
|
+
resourceInputs["fullyQualifiedName"] = undefined /*out*/;
|
|
75
|
+
resourceInputs["showOutputs"] = undefined /*out*/;
|
|
76
|
+
}
|
|
77
|
+
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
|
|
78
|
+
super(AuthenticationPolicy.__pulumiType, name, resourceInputs, opts);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
exports.AuthenticationPolicy = AuthenticationPolicy;
|
|
82
|
+
/** @internal */
|
|
83
|
+
AuthenticationPolicy.__pulumiType = 'snowflake:index/authenticationPolicy:AuthenticationPolicy';
|
|
84
|
+
//# sourceMappingURL=authenticationPolicy.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"authenticationPolicy.js","sourceRoot":"","sources":["../authenticationPolicy.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;GAMG;AACH,MAAa,oBAAqB,SAAQ,MAAM,CAAC,cAAc;IAC3D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAiC,EAAE,IAAmC;QAC/H,OAAO,IAAI,oBAAoB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC3E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,oBAAoB,CAAC,YAAY,CAAC;IACrE,CAAC;IA2DD,YAAY,IAAY,EAAE,WAAkE,EAAE,IAAmC;QAC7H,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAoD,CAAC;YACnE,cAAc,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1F,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,0BAA0B,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;SACzE;aAAM;YACH,MAAM,IAAI,GAAG,WAAmD,CAAC;YACjE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACrD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,cAAc,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9F,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACtD,cAAc,CAAC,oBAAoB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACzD,cAAc,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACrD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,oBAAoB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACzE,CAAC;;AA7HL,oDA8HC;AAhHG,gBAAgB;AACO,iCAAY,GAAG,2DAA2D,CAAC"}
|
package/config/vars.d.ts
CHANGED
|
@@ -1,15 +1,24 @@
|
|
|
1
1
|
import * as outputs from "../types/output";
|
|
2
2
|
/**
|
|
3
|
-
* Specifies your Snowflake account identifier assigned, by Snowflake.
|
|
4
|
-
* [
|
|
5
|
-
*
|
|
3
|
+
* Use `accountName` and `organizationName` instead. Specifies your Snowflake account identifier assigned, by Snowflake.
|
|
4
|
+
* The [account
|
|
5
|
+
* locator](https://docs.snowflake.com/en/user-guide/admin-account-identifier#format-2-account-locator-in-a-region) format
|
|
6
|
+
* is not supported. For information about account identifiers, see the [Snowflake
|
|
7
|
+
* documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html). Required unless using `profile`.
|
|
8
|
+
* Can also be sourced from the `SNOWFLAKE_ACCOUNT` environment variable.
|
|
6
9
|
*/
|
|
7
10
|
export declare const account: string | undefined;
|
|
11
|
+
/**
|
|
12
|
+
* Specifies your Snowflake account name assigned by Snowflake. For information about account identifiers, see the
|
|
13
|
+
* [Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#account-name). Required
|
|
14
|
+
* unless using `profile`. Can also be sourced from the `SNOWFLAKE_ACCOUNT_NAME` environment variable.
|
|
15
|
+
*/
|
|
16
|
+
export declare const accountName: string | undefined;
|
|
8
17
|
/**
|
|
9
18
|
* Specifies the [authentication type](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#AuthType) to use when
|
|
10
|
-
* connecting to Snowflake. Valid
|
|
11
|
-
*
|
|
12
|
-
*
|
|
19
|
+
* connecting to Snowflake. Valid options are: `SNOWFLAKE` | `OAUTH` | `EXTERNALBROWSER` | `OKTA` | `JWT` | `SNOWFLAKE_JWT`
|
|
20
|
+
* | `TOKENACCESSOR` | `USERNAMEPASSWORDMFA`. Value `JWT` is deprecated and will be removed in future releases. Can also be
|
|
21
|
+
* sourced from the `SNOWFLAKE_AUTHENTICATOR` environment variable.
|
|
13
22
|
*/
|
|
14
23
|
export declare const authenticator: string | undefined;
|
|
15
24
|
/**
|
|
@@ -24,36 +33,51 @@ export declare const clientIp: string | undefined;
|
|
|
24
33
|
* When true the MFA token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also
|
|
25
34
|
* be sourced from the `SNOWFLAKE_CLIENT_REQUEST_MFA_TOKEN` environment variable.
|
|
26
35
|
*/
|
|
27
|
-
export declare const clientRequestMfaToken:
|
|
36
|
+
export declare const clientRequestMfaToken: string | undefined;
|
|
28
37
|
/**
|
|
29
38
|
* When true the ID token is cached in the credential manager. True by default in Windows/OSX. False for Linux. Can also be
|
|
30
39
|
* sourced from the `SNOWFLAKE_CLIENT_STORE_TEMPORARY_CREDENTIAL` environment variable.
|
|
31
40
|
*/
|
|
32
|
-
export declare const clientStoreTemporaryCredential:
|
|
41
|
+
export declare const clientStoreTemporaryCredential: string | undefined;
|
|
33
42
|
/**
|
|
34
|
-
* The timeout in seconds for the client to complete the authentication.
|
|
35
|
-
*
|
|
43
|
+
* The timeout in seconds for the client to complete the authentication. Can also be sourced from the
|
|
44
|
+
* `SNOWFLAKE_CLIENT_TIMEOUT` environment variable.
|
|
36
45
|
*/
|
|
37
46
|
export declare const clientTimeout: number | undefined;
|
|
38
47
|
/**
|
|
39
|
-
*
|
|
48
|
+
* Indicates whether console login should be disabled in the driver. Can also be sourced from the
|
|
49
|
+
* `SNOWFLAKE_DISABLE_CONSOLE_LOGIN` environment variable.
|
|
50
|
+
*/
|
|
51
|
+
export declare const disableConsoleLogin: string | undefined;
|
|
52
|
+
/**
|
|
53
|
+
* Disables HTAP query context cache in the driver. Can also be sourced from the `SNOWFLAKE_DISABLE_QUERY_CONTEXT_CACHE`
|
|
40
54
|
* environment variable.
|
|
41
55
|
*/
|
|
42
56
|
export declare const disableQueryContextCache: boolean | undefined;
|
|
43
57
|
/**
|
|
44
|
-
*
|
|
58
|
+
* Disables telemetry in the driver. Can also be sourced from the `DISABLE_TELEMETRY` environment variable.
|
|
45
59
|
*/
|
|
46
60
|
export declare const disableTelemetry: boolean | undefined;
|
|
47
61
|
/**
|
|
48
|
-
*
|
|
49
|
-
* sourced from the `
|
|
62
|
+
* Specifies the logging level to be used by the driver. Valid options are: `trace` | `debug` | `info` | `print` |
|
|
63
|
+
* `warning` | `error` | `fatal` | `panic`. Can also be sourced from the `SNOWFLAKE_DRIVER_TRACING` environment variable.
|
|
64
|
+
*/
|
|
65
|
+
export declare const driverTracing: string | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* The timeout in seconds for the external browser to complete the authentication. Can also be sourced from the
|
|
68
|
+
* `SNOWFLAKE_EXTERNAL_BROWSER_TIMEOUT` environment variable.
|
|
50
69
|
*/
|
|
51
70
|
export declare const externalBrowserTimeout: number | undefined;
|
|
52
71
|
/**
|
|
53
|
-
*
|
|
54
|
-
*
|
|
72
|
+
* Specifies a custom host value used by the driver for privatelink connections. Can also be sourced from the
|
|
73
|
+
* `SNOWFLAKE_HOST` environment variable.
|
|
55
74
|
*/
|
|
56
75
|
export declare const host: string | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* Should retried request contain retry reason. Can also be sourced from the `SNOWFLAKE_INCLUDE_RETRY_REASON` environment
|
|
78
|
+
* variable.
|
|
79
|
+
*/
|
|
80
|
+
export declare const includeRetryReason: string | undefined;
|
|
57
81
|
/**
|
|
58
82
|
* If true, bypass the Online Certificate Status Protocol (OCSP) certificate revocation check. IMPORTANT: Change the
|
|
59
83
|
* default value for testing or emergency situations only. Can also be sourced from the `SNOWFLAKE_INSECURE_MODE`
|
|
@@ -61,8 +85,8 @@ export declare const host: string | undefined;
|
|
|
61
85
|
*/
|
|
62
86
|
export declare const insecureMode: boolean | undefined;
|
|
63
87
|
/**
|
|
64
|
-
* The timeout in seconds for the JWT client to complete the authentication.
|
|
65
|
-
*
|
|
88
|
+
* The timeout in seconds for the JWT client to complete the authentication. Can also be sourced from the
|
|
89
|
+
* `SNOWFLAKE_JWT_CLIENT_TIMEOUT` environment variable.
|
|
66
90
|
*/
|
|
67
91
|
export declare const jwtClientTimeout: number | undefined;
|
|
68
92
|
/**
|
|
@@ -75,10 +99,15 @@ export declare const jwtExpireTimeout: number | undefined;
|
|
|
75
99
|
*/
|
|
76
100
|
export declare const keepSessionAlive: boolean | undefined;
|
|
77
101
|
/**
|
|
78
|
-
* Login retry timeout EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
102
|
+
* Login retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
79
103
|
* `SNOWFLAKE_LOGIN_TIMEOUT` environment variable.
|
|
80
104
|
*/
|
|
81
105
|
export declare const loginTimeout: number | undefined;
|
|
106
|
+
/**
|
|
107
|
+
* Specifies how many times non-periodic HTTP request can be retried by the driver. Can also be sourced from the
|
|
108
|
+
* `SNOWFLAKE_MAX_RETRY_COUNT` environment variable.
|
|
109
|
+
*/
|
|
110
|
+
export declare const maxRetryCount: number | undefined;
|
|
82
111
|
/**
|
|
83
112
|
* Token for use with OAuth. Generating the token is left to other tools. Cannot be used with `browserAuth`,
|
|
84
113
|
* `privateKeyPath`, `oauthRefreshToken` or `password`. Can also be sourced from `SNOWFLAKE_OAUTH_ACCESS_TOKEN` environment
|
|
@@ -113,14 +142,22 @@ export declare const oauthRefreshToken: string | undefined;
|
|
|
113
142
|
* True represents OCSP fail open mode. False represents OCSP fail closed mode. Fail open true by default. Can also be
|
|
114
143
|
* sourced from the `SNOWFLAKE_OCSP_FAIL_OPEN` environment variable.
|
|
115
144
|
*/
|
|
116
|
-
export declare const ocspFailOpen:
|
|
145
|
+
export declare const ocspFailOpen: string | undefined;
|
|
117
146
|
/**
|
|
118
|
-
* The URL of the Okta server. e.g. https://example.okta.com.
|
|
119
|
-
*
|
|
147
|
+
* The URL of the Okta server. e.g. https://example.okta.com. Okta URL host needs to to have a suffix `okta.com`. Read more
|
|
148
|
+
* in Snowflake [docs](https://docs.snowflake.com/en/user-guide/oauth-okta). Can also be sourced from the
|
|
149
|
+
* `SNOWFLAKE_OKTA_URL` environment variable.
|
|
120
150
|
*/
|
|
121
151
|
export declare const oktaUrl: string | undefined;
|
|
122
152
|
/**
|
|
123
|
-
*
|
|
153
|
+
* Specifies your Snowflake organization name assigned by Snowflake. For information about account identifiers, see the
|
|
154
|
+
* [Snowflake documentation](https://docs.snowflake.com/en/user-guide/admin-account-identifier#organization-name). Required
|
|
155
|
+
* unless using `profile`. Can also be sourced from the `SNOWFLAKE_ORGANIZATION_NAME` environment variable.
|
|
156
|
+
*/
|
|
157
|
+
export declare const organizationName: string | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* Sets other connection (i.e. session) parameters. [Parameters](https://docs.snowflake.com/en/sql-reference/parameters).
|
|
160
|
+
* This field can not be set with environmental variables.
|
|
124
161
|
*/
|
|
125
162
|
export declare const params: {
|
|
126
163
|
[key: string]: string;
|
|
@@ -131,28 +168,28 @@ export declare const params: {
|
|
|
131
168
|
*/
|
|
132
169
|
export declare const passcode: string | undefined;
|
|
133
170
|
/**
|
|
134
|
-
* False by default. Set to true if the MFA passcode is embedded
|
|
135
|
-
*
|
|
171
|
+
* False by default. Set to true if the MFA passcode is embedded to the configured password. Can also be sourced from the
|
|
172
|
+
* `SNOWFLAKE_PASSCODE_IN_PASSWORD` environment variable.
|
|
136
173
|
*/
|
|
137
174
|
export declare const passcodeInPassword: boolean | undefined;
|
|
138
175
|
/**
|
|
139
|
-
* Password for
|
|
176
|
+
* Password for user + password auth. Cannot be used with `browserAuth` or `privateKeyPath`. Can also be sourced from the
|
|
140
177
|
* `SNOWFLAKE_PASSWORD` environment variable.
|
|
141
178
|
*/
|
|
142
179
|
export declare const password: string | undefined;
|
|
143
180
|
/**
|
|
144
|
-
*
|
|
181
|
+
* Specifies a custom port value used by the driver for privatelink connections. Can also be sourced from the
|
|
145
182
|
* `SNOWFLAKE_PORT` environment variable.
|
|
146
183
|
*/
|
|
147
184
|
export declare const port: number | undefined;
|
|
148
185
|
/**
|
|
149
|
-
* Private Key for username+private-key auth. Cannot be used with `browserAuth` or `password`. Can also be sourced from
|
|
186
|
+
* Private Key for username+private-key auth. Cannot be used with `browserAuth` or `password`. Can also be sourced from the
|
|
150
187
|
* `SNOWFLAKE_PRIVATE_KEY` environment variable.
|
|
151
188
|
*/
|
|
152
189
|
export declare const privateKey: string | undefined;
|
|
153
190
|
/**
|
|
154
191
|
* Supports the encryption ciphers aes-128-cbc, aes-128-gcm, aes-192-cbc, aes-192-gcm, aes-256-cbc, aes-256-gcm, and
|
|
155
|
-
* des-ede3-cbc. Can also be sourced from `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
192
|
+
* des-ede3-cbc. Can also be sourced from the `SNOWFLAKE_PRIVATE_KEY_PASSPHRASE` environment variable.
|
|
156
193
|
*/
|
|
157
194
|
export declare const privateKeyPassphrase: string | undefined;
|
|
158
195
|
/**
|
|
@@ -166,7 +203,8 @@ export declare const privateKeyPath: string | undefined;
|
|
|
166
203
|
*/
|
|
167
204
|
export declare const profile: string | undefined;
|
|
168
205
|
/**
|
|
169
|
-
*
|
|
206
|
+
* A protocol used in the connection. Valid options are: `http` | `https`. Can also be sourced from the
|
|
207
|
+
* `SNOWFLAKE_PROTOCOL` environment variable.
|
|
170
208
|
*/
|
|
171
209
|
export declare const protocol: string | undefined;
|
|
172
210
|
/**
|
|
@@ -179,13 +217,13 @@ export declare const protocol: string | undefined;
|
|
|
179
217
|
*/
|
|
180
218
|
export declare const region: string | undefined;
|
|
181
219
|
/**
|
|
182
|
-
* request retry timeout EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
220
|
+
* request retry timeout in seconds EXCLUDING network roundtrip and read out http response. Can also be sourced from the
|
|
183
221
|
* `SNOWFLAKE_REQUEST_TIMEOUT` environment variable.
|
|
184
222
|
*/
|
|
185
223
|
export declare const requestTimeout: number | undefined;
|
|
186
224
|
/**
|
|
187
225
|
* Specifies the role to use by default for accessing Snowflake objects in the client session. Can also be sourced from the
|
|
188
|
-
* `SNOWFLAKE_ROLE` environment variable.
|
|
226
|
+
* `SNOWFLAKE_ROLE` environment variable.
|
|
189
227
|
*/
|
|
190
228
|
export declare const role: string | undefined;
|
|
191
229
|
/**
|
|
@@ -194,6 +232,11 @@ export declare const role: string | undefined;
|
|
|
194
232
|
export declare const sessionParams: {
|
|
195
233
|
[key: string]: string;
|
|
196
234
|
} | undefined;
|
|
235
|
+
/**
|
|
236
|
+
* Sets temporary directory used by the driver for operations like encrypting, compressing etc. Can also be sourced from
|
|
237
|
+
* the `SNOWFLAKE_TMP_DIRECTORY_PATH` environment variable.
|
|
238
|
+
*/
|
|
239
|
+
export declare const tmpDirectoryPath: string | undefined;
|
|
197
240
|
/**
|
|
198
241
|
* Token to use for OAuth and other forms of token based auth. Can also be sourced from the `SNOWFLAKE_TOKEN` environment
|
|
199
242
|
* variable.
|
|
@@ -201,19 +244,19 @@ export declare const sessionParams: {
|
|
|
201
244
|
export declare const token: string | undefined;
|
|
202
245
|
export declare const tokenAccessor: outputs.config.TokenAccessor | undefined;
|
|
203
246
|
/**
|
|
204
|
-
* Username. Can also be sourced from the `SNOWFLAKE_USER` environment variable.
|
|
247
|
+
* Username. Required unless using `profile`. Can also be sourced from the `SNOWFLAKE_USER` environment variable.
|
|
205
248
|
*/
|
|
206
249
|
export declare const user: string | undefined;
|
|
207
250
|
/**
|
|
208
|
-
* Username for
|
|
209
|
-
*
|
|
251
|
+
* Username for user + password authentication. Required unless using `profile`. Can also be sourced from the
|
|
252
|
+
* `SNOWFLAKE_USERNAME` environment variable.
|
|
210
253
|
*/
|
|
211
254
|
export declare const username: string | undefined;
|
|
212
255
|
/**
|
|
213
256
|
* True by default. If false, disables the validation checks for Database, Schema, Warehouse and Role at the time a
|
|
214
257
|
* connection is established. Can also be sourced from the `SNOWFLAKE_VALIDATE_DEFAULT_PARAMETERS` environment variable.
|
|
215
258
|
*/
|
|
216
|
-
export declare const validateDefaultParameters:
|
|
259
|
+
export declare const validateDefaultParameters: string | undefined;
|
|
217
260
|
/**
|
|
218
261
|
* Specifies the virtual warehouse to use by default for queries, loading, etc. in the client session. Can also be sourced
|
|
219
262
|
* from the `SNOWFLAKE_WAREHOUSE` environment variable.
|