snowflake.StorageIntegration

!> Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to preview_features_enabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

Note This resource manages storage integrations for AWS, Azure, and GCS storage providers. Make sure you use only fields that are supported for the storage provider you are using, as they are not validated by the provider. In the future, we are planning to implement separate resources for each storage provider.

Note Currently, describe_output field is not used in all the relevant fields (only storage_aws_external_id is supported). This will be addressed during the resource rework.

Deprecation This resource is deprecated and will be removed in a future major version release. Please use one of the new resources instead: snowflake.StorageIntegrationAws | snowflake.StorageIntegrationAzure | snowflake.StorageIntegrationGcs.

Create StorageIntegration Resource

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

Constructor syntax

new StorageIntegration(name: string, args: StorageIntegrationArgs, opts?: CustomResourceOptions);

@overload
def StorageIntegration(resource_name: str,
                       args: StorageIntegrationArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def StorageIntegration(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       storage_allowed_locations: Optional[Sequence[str]] = None,
                       storage_provider: Optional[str] = None,
                       azure_tenant_id: Optional[str] = None,
                       comment: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       name: Optional[str] = None,
                       storage_aws_external_id: Optional[str] = None,
                       storage_aws_object_acl: Optional[str] = None,
                       storage_aws_role_arn: Optional[str] = None,
                       storage_blocked_locations: Optional[Sequence[str]] = None,
                       type: Optional[str] = None,
                       use_privatelink_endpoint: Optional[str] = None)

func NewStorageIntegration(ctx *Context, name string, args StorageIntegrationArgs, opts ...ResourceOption) (*StorageIntegration, error)

public StorageIntegration(string name, StorageIntegrationArgs args, CustomResourceOptions? opts = null)

public StorageIntegration(String name, StorageIntegrationArgs args)
public StorageIntegration(String name, StorageIntegrationArgs args, CustomResourceOptions options)

type: snowflake:StorageIntegration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

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

var storageIntegrationResource = new Snowflake.StorageIntegration("storageIntegrationResource", new()
{
    StorageAllowedLocations = new[]
    {
        "string",
    },
    StorageProvider = "string",
    AzureTenantId = "string",
    Comment = "string",
    Enabled = false,
    Name = "string",
    StorageAwsExternalId = "string",
    StorageAwsObjectAcl = "string",
    StorageAwsRoleArn = "string",
    StorageBlockedLocations = new[]
    {
        "string",
    },
    Type = "string",
    UsePrivatelinkEndpoint = "string",
});

example, err := snowflake.NewStorageIntegration(ctx, "storageIntegrationResource", &snowflake.StorageIntegrationArgs{
	StorageAllowedLocations: pulumi.StringArray{
		pulumi.String("string"),
	},
	StorageProvider:      pulumi.String("string"),
	AzureTenantId:        pulumi.String("string"),
	Comment:              pulumi.String("string"),
	Enabled:              pulumi.Bool(false),
	Name:                 pulumi.String("string"),
	StorageAwsExternalId: pulumi.String("string"),
	StorageAwsObjectAcl:  pulumi.String("string"),
	StorageAwsRoleArn:    pulumi.String("string"),
	StorageBlockedLocations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Type:                   pulumi.String("string"),
	UsePrivatelinkEndpoint: pulumi.String("string"),
})

var storageIntegrationResource = new StorageIntegration("storageIntegrationResource", StorageIntegrationArgs.builder()
    .storageAllowedLocations("string")
    .storageProvider("string")
    .azureTenantId("string")
    .comment("string")
    .enabled(false)
    .name("string")
    .storageAwsExternalId("string")
    .storageAwsObjectAcl("string")
    .storageAwsRoleArn("string")
    .storageBlockedLocations("string")
    .type("string")
    .usePrivatelinkEndpoint("string")
    .build());

storage_integration_resource = snowflake.StorageIntegration("storageIntegrationResource",
    storage_allowed_locations=["string"],
    storage_provider="string",
    azure_tenant_id="string",
    comment="string",
    enabled=False,
    name="string",
    storage_aws_external_id="string",
    storage_aws_object_acl="string",
    storage_aws_role_arn="string",
    storage_blocked_locations=["string"],
    type="string",
    use_privatelink_endpoint="string")

const storageIntegrationResource = new snowflake.StorageIntegration("storageIntegrationResource", {
    storageAllowedLocations: ["string"],
    storageProvider: "string",
    azureTenantId: "string",
    comment: "string",
    enabled: false,
    name: "string",
    storageAwsExternalId: "string",
    storageAwsObjectAcl: "string",
    storageAwsRoleArn: "string",
    storageBlockedLocations: ["string"],
    type: "string",
    usePrivatelinkEndpoint: "string",
});

type: snowflake:StorageIntegration
properties:
    azureTenantId: string
    comment: string
    enabled: false
    name: string
    storageAllowedLocations:
        - string
    storageAwsExternalId: string
    storageAwsObjectAcl: string
    storageAwsRoleArn: string
    storageBlockedLocations:
        - string
    storageProvider: string
    type: string
    usePrivatelinkEndpoint: string

StorageIntegration 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 StorageIntegration resource accepts the following input properties:

Outputs

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

Look up Existing StorageIntegration Resource

Get an existing StorageIntegration 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?: StorageIntegrationState, opts?: CustomResourceOptions): StorageIntegration

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        azure_consent_url: Optional[str] = None,
        azure_multi_tenant_app_name: Optional[str] = None,
        azure_tenant_id: Optional[str] = None,
        comment: Optional[str] = None,
        created_on: Optional[str] = None,
        describe_outputs: Optional[Sequence[StorageIntegrationDescribeOutputArgs]] = None,
        enabled: Optional[bool] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        storage_allowed_locations: Optional[Sequence[str]] = None,
        storage_aws_external_id: Optional[str] = None,
        storage_aws_iam_user_arn: Optional[str] = None,
        storage_aws_object_acl: Optional[str] = None,
        storage_aws_role_arn: Optional[str] = None,
        storage_blocked_locations: Optional[Sequence[str]] = None,
        storage_gcp_service_account: Optional[str] = None,
        storage_provider: Optional[str] = None,
        type: Optional[str] = None,
        use_privatelink_endpoint: Optional[str] = None) -> StorageIntegration

func GetStorageIntegration(ctx *Context, name string, id IDInput, state *StorageIntegrationState, opts ...ResourceOption) (*StorageIntegration, error)

public static StorageIntegration Get(string name, Input<string> id, StorageIntegrationState? state, CustomResourceOptions? opts = null)

public static StorageIntegration get(String name, Output<String> id, StorageIntegrationState state, CustomResourceOptions options)

resources:  _:    type: snowflake:StorageIntegration    get:      id: ${id}

Supporting Types

StorageIntegrationDescribeOutput, StorageIntegrationDescribeOutputArgs

StorageIntegrationDescribeOutputAzureConsentUrl, StorageIntegrationDescribeOutputAzureConsentUrlArgs

StorageIntegrationDescribeOutputAzureMultiTenantAppName, StorageIntegrationDescribeOutputAzureMultiTenantAppNameArgs

StorageIntegrationDescribeOutputComment, StorageIntegrationDescribeOutputCommentArgs

StorageIntegrationDescribeOutputEnabled, StorageIntegrationDescribeOutputEnabledArgs

StorageIntegrationDescribeOutputStorageAllowedLocation, StorageIntegrationDescribeOutputStorageAllowedLocationArgs

StorageIntegrationDescribeOutputStorageAwsExternalId, StorageIntegrationDescribeOutputStorageAwsExternalIdArgs

StorageIntegrationDescribeOutputStorageAwsIamUserArn, StorageIntegrationDescribeOutputStorageAwsIamUserArnArgs

StorageIntegrationDescribeOutputStorageAwsObjectAcl, StorageIntegrationDescribeOutputStorageAwsObjectAclArgs

StorageIntegrationDescribeOutputStorageAwsRoleArn, StorageIntegrationDescribeOutputStorageAwsRoleArnArgs

StorageIntegrationDescribeOutputStorageBlockedLocation, StorageIntegrationDescribeOutputStorageBlockedLocationArgs

StorageIntegrationDescribeOutputStorageGcpServiceAccount, StorageIntegrationDescribeOutputStorageGcpServiceAccountArgs

StorageIntegrationDescribeOutputStorageProvider, StorageIntegrationDescribeOutputStorageProviderArgs

StorageIntegrationDescribeOutputUsePrivatelinkEndpoint, StorageIntegrationDescribeOutputUsePrivatelinkEndpointArgs

Import

$ pulumi import snowflake:index/storageIntegration:StorageIntegration 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.