samlintegration

package
v11.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 7, 2024 License: MPL-2.0 Imports: 7 Imported by: 0

README

snowflake_saml_integration

Refer to the Terraform Registry for docs: snowflake_saml_integration.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewSamlIntegration_Override 

func NewSamlIntegration_Override(s SamlIntegration, scope constructs.Construct, id *string, config *SamlIntegrationConfig)

Create a new {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.92.0/docs/resources/saml_integration snowflake_saml_integration} Resource.

func SamlIntegration_GenerateConfigForImport 

func SamlIntegration_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a SamlIntegration resource upon running "cdktf plan <stack-name>".

func SamlIntegration_IsConstruct 

func SamlIntegration_IsConstruct(x interface{}) *bool

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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func SamlIntegration_IsTerraformElement 

func SamlIntegration_IsTerraformElement(x interface{}) *bool

Experimental.

func SamlIntegration_IsTerraformResource 

func SamlIntegration_IsTerraformResource(x interface{}) *bool

Experimental.

func SamlIntegration_TfResourceType 

func SamlIntegration_TfResourceType() *string

Types

type SamlIntegration 

type SamlIntegration interface {
	cdktf.TerraformResource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	CreatedOn() *string
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Enabled() interface{}
	SetEnabled(val interface{})
	EnabledInput() interface{}
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	Saml2DigestMethodsUsed() *string
	Saml2EnableSpInitiated() interface{}
	SetSaml2EnableSpInitiated(val interface{})
	Saml2EnableSpInitiatedInput() interface{}
	Saml2ForceAuthn() interface{}
	SetSaml2ForceAuthn(val interface{})
	Saml2ForceAuthnInput() interface{}
	Saml2Issuer() *string
	SetSaml2Issuer(val *string)
	Saml2IssuerInput() *string
	Saml2PostLogoutRedirectUrl() *string
	SetSaml2PostLogoutRedirectUrl(val *string)
	Saml2PostLogoutRedirectUrlInput() *string
	Saml2Provider() *string
	SetSaml2Provider(val *string)
	Saml2ProviderInput() *string
	Saml2RequestedNameidFormat() *string
	SetSaml2RequestedNameidFormat(val *string)
	Saml2RequestedNameidFormatInput() *string
	Saml2SignatureMethodsUsed() *string
	Saml2SignRequest() interface{}
	SetSaml2SignRequest(val interface{})
	Saml2SignRequestInput() interface{}
	Saml2SnowflakeAcsUrl() *string
	SetSaml2SnowflakeAcsUrl(val *string)
	Saml2SnowflakeAcsUrlInput() *string
	Saml2SnowflakeIssuerUrl() *string
	SetSaml2SnowflakeIssuerUrl(val *string)
	Saml2SnowflakeIssuerUrlInput() *string
	Saml2SnowflakeMetadata() *string
	Saml2SnowflakeX509Cert() *string
	SetSaml2SnowflakeX509Cert(val *string)
	Saml2SnowflakeX509CertInput() *string
	Saml2SpInitiatedLoginPageLabel() *string
	SetSaml2SpInitiatedLoginPageLabel(val *string)
	Saml2SpInitiatedLoginPageLabelInput() *string
	Saml2SsoUrl() *string
	SetSaml2SsoUrl(val *string)
	Saml2SsoUrlInput() *string
	Saml2X509Cert() *string
	SetSaml2X509Cert(val *string)
	Saml2X509CertInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
	// Experimental.
	AddMoveTarget(moveTarget *string)
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	HasResourceMove() interface{}
	// Experimental.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// 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.
	// Experimental.
	MoveFromId(id *string)
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Moves this resource to the resource corresponding to "id".
	// Experimental.
	MoveToId(id *string)
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetEnabled()
	ResetId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetSaml2EnableSpInitiated()
	ResetSaml2ForceAuthn()
	ResetSaml2PostLogoutRedirectUrl()
	ResetSaml2RequestedNameidFormat()
	ResetSaml2SignRequest()
	ResetSaml2SnowflakeAcsUrl()
	ResetSaml2SnowflakeIssuerUrl()
	ResetSaml2SnowflakeX509Cert()
	ResetSaml2SpInitiatedLoginPageLabel()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.92.0/docs/resources/saml_integration snowflake_saml_integration}.

func NewSamlIntegration 

func NewSamlIntegration(scope constructs.Construct, id *string, config *SamlIntegrationConfig) SamlIntegration

Create a new {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.92.0/docs/resources/saml_integration snowflake_saml_integration} Resource.

type SamlIntegrationConfig 

type SamlIntegrationConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// 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.92.0/docs/resources/saml_integration#name SamlIntegration#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// The string containing the IdP EntityID / Issuer.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.92.0/docs/resources/saml_integration#saml2_issuer SamlIntegration#saml2_issuer}
	Saml2Issuer *string `field:"required" json:"saml2Issuer" yaml:"saml2Issuer"`
	// 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.92.0/docs/resources/saml_integration#saml2_provider SamlIntegration#saml2_provider}
	Saml2Provider *string `field:"required" json:"saml2Provider" yaml:"saml2Provider"`
	// 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.92.0/docs/resources/saml_integration#saml2_sso_url SamlIntegration#saml2_sso_url}
	Saml2SsoUrl *string `field:"required" json:"saml2SsoUrl" yaml:"saml2SsoUrl"`
	// 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.92.0/docs/resources/saml_integration#saml2_x509_cert SamlIntegration#saml2_x509_cert}
	Saml2X509Cert *string `field:"required" json:"saml2X509Cert" yaml:"saml2X509Cert"`
	// Specifies whether this security integration is enabled or disabled.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.92.0/docs/resources/saml_integration#enabled SamlIntegration#enabled}
	Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.92.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.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// 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.92.0/docs/resources/saml_integration#saml2_enable_sp_initiated SamlIntegration#saml2_enable_sp_initiated}
	Saml2EnableSpInitiated interface{} `field:"optional" json:"saml2EnableSpInitiated" yaml:"saml2EnableSpInitiated"`
	// 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.92.0/docs/resources/saml_integration#saml2_force_authn SamlIntegration#saml2_force_authn}
	Saml2ForceAuthn interface{} `field:"optional" json:"saml2ForceAuthn" yaml:"saml2ForceAuthn"`
	// 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.92.0/docs/resources/saml_integration#saml2_post_logout_redirect_url SamlIntegration#saml2_post_logout_redirect_url}
	Saml2PostLogoutRedirectUrl *string `field:"optional" json:"saml2PostLogoutRedirectUrl" yaml:"saml2PostLogoutRedirectUrl"`
	// 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.92.0/docs/resources/saml_integration#saml2_requested_nameid_format SamlIntegration#saml2_requested_nameid_format}
	Saml2RequestedNameidFormat *string `field:"optional" json:"saml2RequestedNameidFormat" yaml:"saml2RequestedNameidFormat"`
	// 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.92.0/docs/resources/saml_integration#saml2_sign_request SamlIntegration#saml2_sign_request}
	Saml2SignRequest interface{} `field:"optional" json:"saml2SignRequest" yaml:"saml2SignRequest"`
	// 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>.<region>.snowflakecomputing.com/fed/login
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.92.0/docs/resources/saml_integration#saml2_snowflake_acs_url SamlIntegration#saml2_snowflake_acs_url}
	Saml2SnowflakeAcsUrl *string `field:"optional" json:"saml2SnowflakeAcsUrl" yaml:"saml2SnowflakeAcsUrl"`
	// 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.92.0/docs/resources/saml_integration#saml2_snowflake_issuer_url SamlIntegration#saml2_snowflake_issuer_url}
	Saml2SnowflakeIssuerUrl *string `field:"optional" json:"saml2SnowflakeIssuerUrl" yaml:"saml2SnowflakeIssuerUrl"`
	// 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.92.0/docs/resources/saml_integration#saml2_snowflake_x509_cert SamlIntegration#saml2_snowflake_x509_cert}
	Saml2SnowflakeX509Cert *string `field:"optional" json:"saml2SnowflakeX509Cert" yaml:"saml2SnowflakeX509Cert"`
	// 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.92.0/docs/resources/saml_integration#saml2_sp_initiated_login_page_label SamlIntegration#saml2_sp_initiated_login_page_label}
	Saml2SpInitiatedLoginPageLabel *string `field:"optional" json:"saml2SpInitiatedLoginPageLabel" yaml:"saml2SpInitiatedLoginPageLabel"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.