Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration snowflake_saml_integration}.
import com.hashicorp.cdktf.providers.snowflake.saml_integration.SamlIntegration;
SamlIntegration.Builder.create(Construct scope, java.lang.String id)
// .connection(SSHProvisionerConnection)
// .connection(WinrmProvisionerConnection)
// .count(java.lang.Number)
// .count(TerraformCount)
// .dependsOn(java.util.List<ITerraformDependable>)
// .forEach(ITerraformIterator)
// .lifecycle(TerraformResourceLifecycle)
// .provider(TerraformProvider)
// .provisioners(java.util.List<FileProvisioner)
// .provisioners(LocalExecProvisioner)
// .provisioners(RemoteExecProvisioner>)
.name(java.lang.String)
.saml2Issuer(java.lang.String)
.saml2Provider(java.lang.String)
.saml2SsoUrl(java.lang.String)
.saml2X509Cert(java.lang.String)
// .enabled(java.lang.Boolean)
// .enabled(IResolvable)
// .id(java.lang.String)
// .saml2EnableSpInitiated(java.lang.Boolean)
// .saml2EnableSpInitiated(IResolvable)
// .saml2ForceAuthn(java.lang.Boolean)
// .saml2ForceAuthn(IResolvable)
// .saml2PostLogoutRedirectUrl(java.lang.String)
// .saml2RequestedNameidFormat(java.lang.String)
// .saml2SignRequest(java.lang.Boolean)
// .saml2SignRequest(IResolvable)
// .saml2SnowflakeAcsUrl(java.lang.String)
// .saml2SnowflakeIssuerUrl(java.lang.String)
// .saml2SnowflakeX509Cert(java.lang.String)
// .saml2SpInitiatedLoginPageLabel(java.lang.String)
.build();| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
The scope in which to define this construct. |
id |
java.lang.String |
The scoped construct ID. |
connection |
com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number OR com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<com.hashicorp.cdktf.ITerraformDependable> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
name |
java.lang.String |
Specifies the name of the SAML2 integration. |
saml2Issuer |
java.lang.String |
The string containing the IdP EntityID / Issuer. |
saml2Provider |
java.lang.String |
The string describing the IdP. One of the following: OKTA, ADFS, Custom. |
saml2SsoUrl |
java.lang.String |
The string containing the IdP SSO URL, where the user should be redirected by Snowflake (the Service Provider) with a SAML AuthnRequest message. |
saml2X509Cert |
java.lang.String |
The Base64 encoded IdP signing certificate on a single line without the leading -----BEGIN CERTIFICATE----- and ending -----END CERTIFICATE----- markers. |
enabled |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
Specifies whether this security integration is enabled or disabled. |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#id SamlIntegration#id}. |
saml2EnableSpInitiated |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
The Boolean indicating if the Log In With button will be shown on the login page. |
saml2ForceAuthn |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
The Boolean indicating whether users, during the initial authentication flow, are forced to authenticate again to access Snowflake. |
saml2PostLogoutRedirectUrl |
java.lang.String |
The endpoint to which Snowflake redirects users after clicking the Log Out button in the classic Snowflake web interface. |
saml2RequestedNameidFormat |
java.lang.String |
The SAML NameID format allows Snowflake to set an expectation of the identifying attribute of the user (i.e. SAML Subject) in the SAML assertion from the IdP to ensure a valid authentication to Snowflake. If a value is not specified, Snowflake sends the urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress value in the authentication request to the IdP. NameID must be one of the following values: urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified, urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName, urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName, urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient . |
saml2SignRequest |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
The Boolean indicating whether SAML requests are signed. |
saml2SnowflakeAcsUrl |
java.lang.String |
The string containing the Snowflake Assertion Consumer Service URL to which the IdP will send its SAML authentication response back to Snowflake. |
saml2SnowflakeIssuerUrl |
java.lang.String |
The string containing the EntityID / Issuer for the Snowflake service provider. |
saml2SnowflakeX509Cert |
java.lang.String |
The Base64 encoded self-signed certificate generated by Snowflake for use with Encrypting SAML Assertions and Signed SAML Requests. |
saml2SpInitiatedLoginPageLabel |
java.lang.String |
The string containing the label to display after the Log In With button on the login page. |
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
- Type: com.hashicorp.cdktf.ITerraformIterator
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
- Type: com.hashicorp.cdktf.TerraformProvider
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
- Type: java.lang.String
Specifies the name of the SAML2 integration.
This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#name SamlIntegration#name}
- Type: java.lang.String
The string containing the IdP EntityID / Issuer.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_issuer SamlIntegration#saml2_issuer}
- Type: java.lang.String
The string describing the IdP. One of the following: OKTA, ADFS, Custom.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_provider SamlIntegration#saml2_provider}
- Type: java.lang.String
The string containing the IdP SSO URL, where the user should be redirected by Snowflake (the Service Provider) with a SAML AuthnRequest message.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_sso_url SamlIntegration#saml2_sso_url}
- Type: java.lang.String
The Base64 encoded IdP signing certificate on a single line without the leading -----BEGIN CERTIFICATE----- and ending -----END CERTIFICATE----- markers.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_x509_cert SamlIntegration#saml2_x509_cert}
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
Specifies whether this security integration is enabled or disabled.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#enabled SamlIntegration#enabled}
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#id SamlIntegration#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
The Boolean indicating if the Log In With button will be shown on the login page.
TRUE: displays the Log in WIth button on the login page. FALSE: does not display the Log in With button on the login page.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_enable_sp_initiated SamlIntegration#saml2_enable_sp_initiated}
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
The Boolean indicating whether users, during the initial authentication flow, are forced to authenticate again to access Snowflake.
When set to TRUE, Snowflake sets the ForceAuthn SAML parameter to TRUE in the outgoing request from Snowflake to the identity provider. TRUE: forces users to authenticate again to access Snowflake, even if a valid session with the identity provider exists. FALSE: does not force users to authenticate again to access Snowflake.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_force_authn SamlIntegration#saml2_force_authn}
- Type: java.lang.String
The endpoint to which Snowflake redirects users after clicking the Log Out button in the classic Snowflake web interface.
Snowflake terminates the Snowflake session upon redirecting to the specified endpoint.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_post_logout_redirect_url SamlIntegration#saml2_post_logout_redirect_url}
- Type: java.lang.String
The SAML NameID format allows Snowflake to set an expectation of the identifying attribute of the user (i.e. SAML Subject) in the SAML assertion from the IdP to ensure a valid authentication to Snowflake. If a value is not specified, Snowflake sends the urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress value in the authentication request to the IdP. NameID must be one of the following values: urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified, urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName, urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName, urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient .
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_requested_nameid_format SamlIntegration#saml2_requested_nameid_format}
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
The Boolean indicating whether SAML requests are signed.
TRUE: allows SAML requests to be signed. FALSE: does not allow SAML requests to be signed.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_sign_request SamlIntegration#saml2_sign_request}
- Type: java.lang.String
The string containing the Snowflake Assertion Consumer Service URL to which the IdP will send its SAML authentication response back to Snowflake.
This property will be set in the SAML authentication request generated by Snowflake when initiating a SAML SSO operation with the IdP. If an incorrect value is specified, Snowflake returns an error message indicating the acceptable values to use. Default: https://<account_locator>..snowflakecomputing.com/fed/login
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_snowflake_acs_url SamlIntegration#saml2_snowflake_acs_url}
- Type: java.lang.String
The string containing the EntityID / Issuer for the Snowflake service provider.
If an incorrect value is specified, Snowflake returns an error message indicating the acceptable values to use.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_snowflake_issuer_url SamlIntegration#saml2_snowflake_issuer_url}
- Type: java.lang.String
The Base64 encoded self-signed certificate generated by Snowflake for use with Encrypting SAML Assertions and Signed SAML Requests.
You must have at least one of these features (encrypted SAML assertions or signed SAML responses) enabled in your Snowflake account to access the certificate value.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_snowflake_x509_cert SamlIntegration#saml2_snowflake_x509_cert}
- Type: java.lang.String
The string containing the label to display after the Log In With button on the login page.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_sp_initiated_login_page_label SamlIntegration#saml2_sp_initiated_login_page_label}
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
addOverride |
No description. |
overrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
resetOverrideLogicalId |
Resets a previously passed logical Id to use the auto-generated logical id again. |
toHclTerraform |
No description. |
toMetadata |
No description. |
toTerraform |
Adds this resource to the terraform JSON output. |
addMoveTarget |
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
hasResourceMove |
No description. |
importFrom |
No description. |
interpolationForAttribute |
No description. |
moveFromId |
Move the resource corresponding to "id" to this resource. |
moveTo |
Moves this resource to the target resource given by moveTarget. |
moveToId |
Moves this resource to the resource corresponding to "id". |
resetEnabled |
No description. |
resetId |
No description. |
resetSaml2EnableSpInitiated |
No description. |
resetSaml2ForceAuthn |
No description. |
resetSaml2PostLogoutRedirectUrl |
No description. |
resetSaml2RequestedNameidFormat |
No description. |
resetSaml2SignRequest |
No description. |
resetSaml2SnowflakeAcsUrl |
No description. |
resetSaml2SnowflakeIssuerUrl |
No description. |
resetSaml2SnowflakeX509Cert |
No description. |
resetSaml2SpInitiatedLoginPageLabel |
No description. |
public java.lang.String toString()Returns a string representation of this construct.
public void addOverride(java.lang.String path, java.lang.Object value)- Type: java.lang.String
- Type: java.lang.Object
public void overrideLogicalId(java.lang.String newLogicalId)Overrides the auto-generated logical ID with a specific ID.
- Type: java.lang.String
The new logical ID to use for this stack element.
public void resetOverrideLogicalId()Resets a previously passed logical Id to use the auto-generated logical id again.
public java.lang.Object toHclTerraform()public java.lang.Object toMetadata()public java.lang.Object toTerraform()Adds this resource to the terraform JSON output.
public void addMoveTarget(java.lang.String moveTarget)Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: java.lang.String
The string move target that will correspond to this resource.
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)- Type: java.lang.String
- Type: com.hashicorp.cdktf.TerraformProvider
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public void moveFromId(java.lang.String id)Move the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
- Type: java.lang.String
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)Moves this resource to the target resource given by moveTarget.
- Type: java.lang.String
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: java.lang.String OR java.lang.Number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public void moveToId(java.lang.String id)Moves this resource to the resource corresponding to "id".
- Type: java.lang.String
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public void resetEnabled()public void resetId()public void resetSaml2EnableSpInitiated()public void resetSaml2ForceAuthn()public void resetSaml2PostLogoutRedirectUrl()public void resetSaml2RequestedNameidFormat()public void resetSaml2SignRequest()public void resetSaml2SnowflakeAcsUrl()public void resetSaml2SnowflakeIssuerUrl()public void resetSaml2SnowflakeX509Cert()public void resetSaml2SpInitiatedLoginPageLabel()| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a SamlIntegration resource upon running "cdktf plan ". |
import com.hashicorp.cdktf.providers.snowflake.saml_integration.SamlIntegration;
SamlIntegration.isConstruct(java.lang.Object x)Checks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
- Type: java.lang.Object
Any object.
import com.hashicorp.cdktf.providers.snowflake.saml_integration.SamlIntegration;
SamlIntegration.isTerraformElement(java.lang.Object x)- Type: java.lang.Object
import com.hashicorp.cdktf.providers.snowflake.saml_integration.SamlIntegration;
SamlIntegration.isTerraformResource(java.lang.Object x)- Type: java.lang.Object
import com.hashicorp.cdktf.providers.snowflake.saml_integration.SamlIntegration;
SamlIntegration.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),SamlIntegration.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)Generates CDKTF code for importing a SamlIntegration resource upon running "cdktf plan ".
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The construct id used in the generated config for the SamlIntegration to import.
- Type: java.lang.String
The id of the existing SamlIntegration that should be imported.
Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#import import section} in the documentation of this resource for the id to use
- Type: com.hashicorp.cdktf.TerraformProvider
? Optional instance of the provider where the SamlIntegration to import is found.
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
cdktfStack |
com.hashicorp.cdktf.TerraformStack |
No description. |
fqn |
java.lang.String |
No description. |
friendlyUniqueId |
java.lang.String |
No description. |
terraformMetaArguments |
java.util.Map<java.lang.String, java.lang.Object> |
No description. |
terraformResourceType |
java.lang.String |
No description. |
terraformGeneratorMetadata |
com.hashicorp.cdktf.TerraformProviderGeneratorMetadata |
No description. |
connection |
com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number OR com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<java.lang.String> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
createdOn |
java.lang.String |
No description. |
saml2DigestMethodsUsed |
java.lang.String |
No description. |
saml2SignatureMethodsUsed |
java.lang.String |
No description. |
saml2SnowflakeMetadata |
java.lang.String |
No description. |
enabledInput |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
idInput |
java.lang.String |
No description. |
nameInput |
java.lang.String |
No description. |
saml2EnableSpInitiatedInput |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
saml2ForceAuthnInput |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
saml2IssuerInput |
java.lang.String |
No description. |
saml2PostLogoutRedirectUrlInput |
java.lang.String |
No description. |
saml2ProviderInput |
java.lang.String |
No description. |
saml2RequestedNameidFormatInput |
java.lang.String |
No description. |
saml2SignRequestInput |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
saml2SnowflakeAcsUrlInput |
java.lang.String |
No description. |
saml2SnowflakeIssuerUrlInput |
java.lang.String |
No description. |
saml2SnowflakeX509CertInput |
java.lang.String |
No description. |
saml2SpInitiatedLoginPageLabelInput |
java.lang.String |
No description. |
saml2SsoUrlInput |
java.lang.String |
No description. |
saml2X509CertInput |
java.lang.String |
No description. |
enabled |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
id |
java.lang.String |
No description. |
name |
java.lang.String |
No description. |
saml2EnableSpInitiated |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
saml2ForceAuthn |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
saml2Issuer |
java.lang.String |
No description. |
saml2PostLogoutRedirectUrl |
java.lang.String |
No description. |
saml2Provider |
java.lang.String |
No description. |
saml2RequestedNameidFormat |
java.lang.String |
No description. |
saml2SignRequest |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
saml2SnowflakeAcsUrl |
java.lang.String |
No description. |
saml2SnowflakeIssuerUrl |
java.lang.String |
No description. |
saml2SnowflakeX509Cert |
java.lang.String |
No description. |
saml2SpInitiatedLoginPageLabel |
java.lang.String |
No description. |
saml2SsoUrl |
java.lang.String |
No description. |
saml2X509Cert |
java.lang.String |
No description. |
public Node getNode();- Type: software.constructs.Node
The tree node.
public TerraformStack getCdktfStack();- Type: com.hashicorp.cdktf.TerraformStack
public java.lang.String getFqn();- Type: java.lang.String
public java.lang.String getFriendlyUniqueId();- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();- Type: java.util.Map<java.lang.String, java.lang.Object>
public java.lang.String getTerraformResourceType();- Type: java.lang.String
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();- Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
public java.lang.Object getConnection();- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<java.lang.String> getDependsOn();- Type: java.util.List<java.lang.String>
public ITerraformIterator getForEach();- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public java.lang.String getCreatedOn();- Type: java.lang.String
public java.lang.String getSaml2DigestMethodsUsed();- Type: java.lang.String
public java.lang.String getSaml2SignatureMethodsUsed();- Type: java.lang.String
public java.lang.String getSaml2SnowflakeMetadata();- Type: java.lang.String
public java.lang.Object getEnabledInput();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getIdInput();- Type: java.lang.String
public java.lang.String getNameInput();- Type: java.lang.String
public java.lang.Object getSaml2EnableSpInitiatedInput();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.Object getSaml2ForceAuthnInput();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getSaml2IssuerInput();- Type: java.lang.String
public java.lang.String getSaml2PostLogoutRedirectUrlInput();- Type: java.lang.String
public java.lang.String getSaml2ProviderInput();- Type: java.lang.String
public java.lang.String getSaml2RequestedNameidFormatInput();- Type: java.lang.String
public java.lang.Object getSaml2SignRequestInput();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getSaml2SnowflakeAcsUrlInput();- Type: java.lang.String
public java.lang.String getSaml2SnowflakeIssuerUrlInput();- Type: java.lang.String
public java.lang.String getSaml2SnowflakeX509CertInput();- Type: java.lang.String
public java.lang.String getSaml2SpInitiatedLoginPageLabelInput();- Type: java.lang.String
public java.lang.String getSaml2SsoUrlInput();- Type: java.lang.String
public java.lang.String getSaml2X509CertInput();- Type: java.lang.String
public java.lang.Object getEnabled();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getId();- Type: java.lang.String
public java.lang.String getName();- Type: java.lang.String
public java.lang.Object getSaml2EnableSpInitiated();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.Object getSaml2ForceAuthn();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getSaml2Issuer();- Type: java.lang.String
public java.lang.String getSaml2PostLogoutRedirectUrl();- Type: java.lang.String
public java.lang.String getSaml2Provider();- Type: java.lang.String
public java.lang.String getSaml2RequestedNameidFormat();- Type: java.lang.String
public java.lang.Object getSaml2SignRequest();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getSaml2SnowflakeAcsUrl();- Type: java.lang.String
public java.lang.String getSaml2SnowflakeIssuerUrl();- Type: java.lang.String
public java.lang.String getSaml2SnowflakeX509Cert();- Type: java.lang.String
public java.lang.String getSaml2SpInitiatedLoginPageLabel();- Type: java.lang.String
public java.lang.String getSaml2SsoUrl();- Type: java.lang.String
public java.lang.String getSaml2X509Cert();- Type: java.lang.String
| Name | Type | Description |
|---|---|---|
tfResourceType |
java.lang.String |
No description. |
public java.lang.String getTfResourceType();- Type: java.lang.String
import com.hashicorp.cdktf.providers.snowflake.saml_integration.SamlIntegrationConfig;
SamlIntegrationConfig.builder()
// .connection(SSHProvisionerConnection)
// .connection(WinrmProvisionerConnection)
// .count(java.lang.Number)
// .count(TerraformCount)
// .dependsOn(java.util.List<ITerraformDependable>)
// .forEach(ITerraformIterator)
// .lifecycle(TerraformResourceLifecycle)
// .provider(TerraformProvider)
// .provisioners(java.util.List<FileProvisioner)
// .provisioners(LocalExecProvisioner)
// .provisioners(RemoteExecProvisioner>)
.name(java.lang.String)
.saml2Issuer(java.lang.String)
.saml2Provider(java.lang.String)
.saml2SsoUrl(java.lang.String)
.saml2X509Cert(java.lang.String)
// .enabled(java.lang.Boolean)
// .enabled(IResolvable)
// .id(java.lang.String)
// .saml2EnableSpInitiated(java.lang.Boolean)
// .saml2EnableSpInitiated(IResolvable)
// .saml2ForceAuthn(java.lang.Boolean)
// .saml2ForceAuthn(IResolvable)
// .saml2PostLogoutRedirectUrl(java.lang.String)
// .saml2RequestedNameidFormat(java.lang.String)
// .saml2SignRequest(java.lang.Boolean)
// .saml2SignRequest(IResolvable)
// .saml2SnowflakeAcsUrl(java.lang.String)
// .saml2SnowflakeIssuerUrl(java.lang.String)
// .saml2SnowflakeX509Cert(java.lang.String)
// .saml2SpInitiatedLoginPageLabel(java.lang.String)
.build();| Name | Type | Description |
|---|---|---|
connection |
com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number OR com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<com.hashicorp.cdktf.ITerraformDependable> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
name |
java.lang.String |
Specifies the name of the SAML2 integration. |
saml2Issuer |
java.lang.String |
The string containing the IdP EntityID / Issuer. |
saml2Provider |
java.lang.String |
The string describing the IdP. One of the following: OKTA, ADFS, Custom. |
saml2SsoUrl |
java.lang.String |
The string containing the IdP SSO URL, where the user should be redirected by Snowflake (the Service Provider) with a SAML AuthnRequest message. |
saml2X509Cert |
java.lang.String |
The Base64 encoded IdP signing certificate on a single line without the leading -----BEGIN CERTIFICATE----- and ending -----END CERTIFICATE----- markers. |
enabled |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
Specifies whether this security integration is enabled or disabled. |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#id SamlIntegration#id}. |
saml2EnableSpInitiated |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
The Boolean indicating if the Log In With button will be shown on the login page. |
saml2ForceAuthn |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
The Boolean indicating whether users, during the initial authentication flow, are forced to authenticate again to access Snowflake. |
saml2PostLogoutRedirectUrl |
java.lang.String |
The endpoint to which Snowflake redirects users after clicking the Log Out button in the classic Snowflake web interface. |
saml2RequestedNameidFormat |
java.lang.String |
The SAML NameID format allows Snowflake to set an expectation of the identifying attribute of the user (i.e. SAML Subject) in the SAML assertion from the IdP to ensure a valid authentication to Snowflake. If a value is not specified, Snowflake sends the urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress value in the authentication request to the IdP. NameID must be one of the following values: urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified, urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName, urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName, urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient . |
saml2SignRequest |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
The Boolean indicating whether SAML requests are signed. |
saml2SnowflakeAcsUrl |
java.lang.String |
The string containing the Snowflake Assertion Consumer Service URL to which the IdP will send its SAML authentication response back to Snowflake. |
saml2SnowflakeIssuerUrl |
java.lang.String |
The string containing the EntityID / Issuer for the Snowflake service provider. |
saml2SnowflakeX509Cert |
java.lang.String |
The Base64 encoded self-signed certificate generated by Snowflake for use with Encrypting SAML Assertions and Signed SAML Requests. |
saml2SpInitiatedLoginPageLabel |
java.lang.String |
The string containing the label to display after the Log In With button on the login page. |
public java.lang.Object getConnection();- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<ITerraformDependable> getDependsOn();- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
public ITerraformIterator getForEach();- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public java.lang.String getName();- Type: java.lang.String
Specifies the name of the SAML2 integration.
This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#name SamlIntegration#name}
public java.lang.String getSaml2Issuer();- Type: java.lang.String
The string containing the IdP EntityID / Issuer.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_issuer SamlIntegration#saml2_issuer}
public java.lang.String getSaml2Provider();- Type: java.lang.String
The string describing the IdP. One of the following: OKTA, ADFS, Custom.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_provider SamlIntegration#saml2_provider}
public java.lang.String getSaml2SsoUrl();- Type: java.lang.String
The string containing the IdP SSO URL, where the user should be redirected by Snowflake (the Service Provider) with a SAML AuthnRequest message.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_sso_url SamlIntegration#saml2_sso_url}
public java.lang.String getSaml2X509Cert();- Type: java.lang.String
The Base64 encoded IdP signing certificate on a single line without the leading -----BEGIN CERTIFICATE----- and ending -----END CERTIFICATE----- markers.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_x509_cert SamlIntegration#saml2_x509_cert}
public java.lang.Object getEnabled();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
Specifies whether this security integration is enabled or disabled.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#enabled SamlIntegration#enabled}
public java.lang.String getId();- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#id SamlIntegration#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
public java.lang.Object getSaml2EnableSpInitiated();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
The Boolean indicating if the Log In With button will be shown on the login page.
TRUE: displays the Log in WIth button on the login page. FALSE: does not display the Log in With button on the login page.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_enable_sp_initiated SamlIntegration#saml2_enable_sp_initiated}
public java.lang.Object getSaml2ForceAuthn();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
The Boolean indicating whether users, during the initial authentication flow, are forced to authenticate again to access Snowflake.
When set to TRUE, Snowflake sets the ForceAuthn SAML parameter to TRUE in the outgoing request from Snowflake to the identity provider. TRUE: forces users to authenticate again to access Snowflake, even if a valid session with the identity provider exists. FALSE: does not force users to authenticate again to access Snowflake.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_force_authn SamlIntegration#saml2_force_authn}
public java.lang.String getSaml2PostLogoutRedirectUrl();- Type: java.lang.String
The endpoint to which Snowflake redirects users after clicking the Log Out button in the classic Snowflake web interface.
Snowflake terminates the Snowflake session upon redirecting to the specified endpoint.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_post_logout_redirect_url SamlIntegration#saml2_post_logout_redirect_url}
public java.lang.String getSaml2RequestedNameidFormat();- Type: java.lang.String
The SAML NameID format allows Snowflake to set an expectation of the identifying attribute of the user (i.e. SAML Subject) in the SAML assertion from the IdP to ensure a valid authentication to Snowflake. If a value is not specified, Snowflake sends the urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress value in the authentication request to the IdP. NameID must be one of the following values: urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified, urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName, urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName, urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient .
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_requested_nameid_format SamlIntegration#saml2_requested_nameid_format}
public java.lang.Object getSaml2SignRequest();- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
The Boolean indicating whether SAML requests are signed.
TRUE: allows SAML requests to be signed. FALSE: does not allow SAML requests to be signed.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_sign_request SamlIntegration#saml2_sign_request}
public java.lang.String getSaml2SnowflakeAcsUrl();- Type: java.lang.String
The string containing the Snowflake Assertion Consumer Service URL to which the IdP will send its SAML authentication response back to Snowflake.
This property will be set in the SAML authentication request generated by Snowflake when initiating a SAML SSO operation with the IdP. If an incorrect value is specified, Snowflake returns an error message indicating the acceptable values to use. Default: https://<account_locator>..snowflakecomputing.com/fed/login
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_snowflake_acs_url SamlIntegration#saml2_snowflake_acs_url}
public java.lang.String getSaml2SnowflakeIssuerUrl();- Type: java.lang.String
The string containing the EntityID / Issuer for the Snowflake service provider.
If an incorrect value is specified, Snowflake returns an error message indicating the acceptable values to use.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_snowflake_issuer_url SamlIntegration#saml2_snowflake_issuer_url}
public java.lang.String getSaml2SnowflakeX509Cert();- Type: java.lang.String
The Base64 encoded self-signed certificate generated by Snowflake for use with Encrypting SAML Assertions and Signed SAML Requests.
You must have at least one of these features (encrypted SAML assertions or signed SAML responses) enabled in your Snowflake account to access the certificate value.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_snowflake_x509_cert SamlIntegration#saml2_snowflake_x509_cert}
public java.lang.String getSaml2SpInitiatedLoginPageLabel();- Type: java.lang.String
The string containing the label to display after the Log In With button on the login page.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/saml_integration#saml2_sp_initiated_login_page_label SamlIntegration#saml2_sp_initiated_login_page_label}