1. Packages
  2. Snowflake
  3. API Docs
  4. ScimIntegration
Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi

snowflake.ScimIntegration

Explore with Pulumi AI

snowflake logo
Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as snowflake from "@pulumi/snowflake";
    
    const aad = new snowflake.ScimIntegration("aad", {
        name: "AAD_PROVISIONING",
        networkPolicy: "AAD_NETWORK_POLICY",
        provisionerRole: "AAD_PROVISIONER",
        scimClient: "AZURE",
    });
    
    import pulumi
    import pulumi_snowflake as snowflake
    
    aad = snowflake.ScimIntegration("aad",
        name="AAD_PROVISIONING",
        network_policy="AAD_NETWORK_POLICY",
        provisioner_role="AAD_PROVISIONER",
        scim_client="AZURE")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-snowflake/sdk/go/snowflake"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := snowflake.NewScimIntegration(ctx, "aad", &snowflake.ScimIntegrationArgs{
    			Name:            pulumi.String("AAD_PROVISIONING"),
    			NetworkPolicy:   pulumi.String("AAD_NETWORK_POLICY"),
    			ProvisionerRole: pulumi.String("AAD_PROVISIONER"),
    			ScimClient:      pulumi.String("AZURE"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Snowflake = Pulumi.Snowflake;
    
    return await Deployment.RunAsync(() => 
    {
        var aad = new Snowflake.ScimIntegration("aad", new()
        {
            Name = "AAD_PROVISIONING",
            NetworkPolicy = "AAD_NETWORK_POLICY",
            ProvisionerRole = "AAD_PROVISIONER",
            ScimClient = "AZURE",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.snowflake.ScimIntegration;
    import com.pulumi.snowflake.ScimIntegrationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var aad = new ScimIntegration("aad", ScimIntegrationArgs.builder()
                .name("AAD_PROVISIONING")
                .networkPolicy("AAD_NETWORK_POLICY")
                .provisionerRole("AAD_PROVISIONER")
                .scimClient("AZURE")
                .build());
    
        }
    }
    
    resources:
      aad:
        type: snowflake:ScimIntegration
        properties:
          name: AAD_PROVISIONING
          networkPolicy: AAD_NETWORK_POLICY
          provisionerRole: AAD_PROVISIONER
          scimClient: AZURE
    

    Create ScimIntegration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScimIntegration(name: string, args: ScimIntegrationArgs, opts?: CustomResourceOptions);
    @overload
    def ScimIntegration(resource_name: str,
                        args: ScimIntegrationArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ScimIntegration(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        provisioner_role: Optional[str] = None,
                        scim_client: Optional[str] = None,
                        name: Optional[str] = None,
                        network_policy: Optional[str] = None)
    func NewScimIntegration(ctx *Context, name string, args ScimIntegrationArgs, opts ...ResourceOption) (*ScimIntegration, error)
    public ScimIntegration(string name, ScimIntegrationArgs args, CustomResourceOptions? opts = null)
    public ScimIntegration(String name, ScimIntegrationArgs args)
    public ScimIntegration(String name, ScimIntegrationArgs args, CustomResourceOptions options)
    
    type: snowflake:ScimIntegration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ScimIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScimIntegrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScimIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScimIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScimIntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var scimIntegrationResource = new Snowflake.ScimIntegration("scimIntegrationResource", new()
    {
        ProvisionerRole = "string",
        ScimClient = "string",
        Name = "string",
        NetworkPolicy = "string",
    });
    
    example, err := snowflake.NewScimIntegration(ctx, "scimIntegrationResource", &snowflake.ScimIntegrationArgs{
    	ProvisionerRole: pulumi.String("string"),
    	ScimClient:      pulumi.String("string"),
    	Name:            pulumi.String("string"),
    	NetworkPolicy:   pulumi.String("string"),
    })
    
    var scimIntegrationResource = new ScimIntegration("scimIntegrationResource", ScimIntegrationArgs.builder()
        .provisionerRole("string")
        .scimClient("string")
        .name("string")
        .networkPolicy("string")
        .build());
    
    scim_integration_resource = snowflake.ScimIntegration("scimIntegrationResource",
        provisioner_role="string",
        scim_client="string",
        name="string",
        network_policy="string")
    
    const scimIntegrationResource = new snowflake.ScimIntegration("scimIntegrationResource", {
        provisionerRole: "string",
        scimClient: "string",
        name: "string",
        networkPolicy: "string",
    });
    
    type: snowflake:ScimIntegration
    properties:
        name: string
        networkPolicy: string
        provisionerRole: string
        scimClient: string
    

    ScimIntegration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ScimIntegration resource accepts the following input properties:

    ProvisionerRole string
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    ScimClient string
    Specifies the client type for the scim integration
    Name string
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    NetworkPolicy string
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.
    ProvisionerRole string
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    ScimClient string
    Specifies the client type for the scim integration
    Name string
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    NetworkPolicy string
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.
    provisionerRole String
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    scimClient String
    Specifies the client type for the scim integration
    name String
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    networkPolicy String
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.
    provisionerRole string
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    scimClient string
    Specifies the client type for the scim integration
    name string
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    networkPolicy string
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.
    provisioner_role str
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    scim_client str
    Specifies the client type for the scim integration
    name str
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    network_policy str
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.
    provisionerRole String
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    scimClient String
    Specifies the client type for the scim integration
    name String
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    networkPolicy String
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScimIntegration resource produces the following output properties:

    CreatedOn string
    Date and time when the SCIM integration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedOn string
    Date and time when the SCIM integration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdOn String
    Date and time when the SCIM integration was created.
    id String
    The provider-assigned unique ID for this managed resource.
    createdOn string
    Date and time when the SCIM integration was created.
    id string
    The provider-assigned unique ID for this managed resource.
    created_on str
    Date and time when the SCIM integration was created.
    id str
    The provider-assigned unique ID for this managed resource.
    createdOn String
    Date and time when the SCIM integration was created.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ScimIntegration Resource

    Get an existing ScimIntegration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ScimIntegrationState, opts?: CustomResourceOptions): ScimIntegration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_on: Optional[str] = None,
            name: Optional[str] = None,
            network_policy: Optional[str] = None,
            provisioner_role: Optional[str] = None,
            scim_client: Optional[str] = None) -> ScimIntegration
    func GetScimIntegration(ctx *Context, name string, id IDInput, state *ScimIntegrationState, opts ...ResourceOption) (*ScimIntegration, error)
    public static ScimIntegration Get(string name, Input<string> id, ScimIntegrationState? state, CustomResourceOptions? opts = null)
    public static ScimIntegration get(String name, Output<String> id, ScimIntegrationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedOn string
    Date and time when the SCIM integration was created.
    Name string
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    NetworkPolicy string
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.
    ProvisionerRole string
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    ScimClient string
    Specifies the client type for the scim integration
    CreatedOn string
    Date and time when the SCIM integration was created.
    Name string
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    NetworkPolicy string
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.
    ProvisionerRole string
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    ScimClient string
    Specifies the client type for the scim integration
    createdOn String
    Date and time when the SCIM integration was created.
    name String
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    networkPolicy String
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.
    provisionerRole String
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    scimClient String
    Specifies the client type for the scim integration
    createdOn string
    Date and time when the SCIM integration was created.
    name string
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    networkPolicy string
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.
    provisionerRole string
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    scimClient string
    Specifies the client type for the scim integration
    created_on str
    Date and time when the SCIM integration was created.
    name str
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    network_policy str
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.
    provisioner_role str
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    scim_client str
    Specifies the client type for the scim integration
    createdOn String
    Date and time when the SCIM integration was created.
    name String
    Specifies the name of the SCIM integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account.
    networkPolicy String
    Specifies an existing network policy active for your account. The network policy restricts the list of user IP addresses when exchanging an authorization code for an access or refresh token and when using a refresh token to obtain a new access token. If this parameter is not set, the network policy for the account (if any) is used instead.
    provisionerRole String
    Specify the SCIM role in Snowflake that owns any users and roles that are imported from the identity provider into Snowflake using SCIM.
    scimClient String
    Specifies the client type for the scim integration

    Import

    $ pulumi import snowflake:index/scimIntegration:ScimIntegration example name
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi