1. Packages
  2. Snowflake Provider
  3. API Docs
  4. StorageIntegrationAws
Snowflake v2.12.0 published on Friday, Feb 13, 2026 by Pulumi
snowflake logo
Snowflake v2.12.0 published on Friday, Feb 13, 2026 by Pulumi

    !> 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 External changes to integration category, type, or incompatible storage_provider are not currently supported. They will be handled in the following versions of the provider which may still affect this resource.

    Resource used to manage AWS storage integration objects. For more information, check storage integration documentation.

    Example Usage

    Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.

    import * as pulumi from "@pulumi/pulumi";
    import * as snowflake from "@pulumi/snowflake";
    
    // minimal
    const minimal = new snowflake.StorageIntegrationAws("minimal", {
        name: "example_aws_storage_integration",
        enabled: true,
        storageProvider: "S3",
        storageAllowedLocations: ["s3://mybucket1/path1/"],
        storageAwsRoleArn: "arn:aws:iam::001234567890:role/myrole",
    });
    // all fields
    const all = new snowflake.StorageIntegrationAws("all", {
        name: "example_aws_storage_integration",
        enabled: true,
        storageProvider: "S3",
        storageAllowedLocations: [
            "s3://mybucket1/allowed-location/",
            "s3://mybucket1/allowed-location2/",
        ],
        storageBlockedLocations: [
            "s3://mybucket1/blocked-location/",
            "s3://mybucket1/blocked-location2/",
        ],
        usePrivatelinkEndpoint: "true",
        comment: "some comment",
        storageAwsRoleArn: "arn:aws:iam::001234567890:role/myrole",
        storageAwsExternalId: "some_external_id",
        storageAwsObjectAcl: "bucket-owner-full-control",
    });
    
    import pulumi
    import pulumi_snowflake as snowflake
    
    # minimal
    minimal = snowflake.StorageIntegrationAws("minimal",
        name="example_aws_storage_integration",
        enabled=True,
        storage_provider="S3",
        storage_allowed_locations=["s3://mybucket1/path1/"],
        storage_aws_role_arn="arn:aws:iam::001234567890:role/myrole")
    # all fields
    all = snowflake.StorageIntegrationAws("all",
        name="example_aws_storage_integration",
        enabled=True,
        storage_provider="S3",
        storage_allowed_locations=[
            "s3://mybucket1/allowed-location/",
            "s3://mybucket1/allowed-location2/",
        ],
        storage_blocked_locations=[
            "s3://mybucket1/blocked-location/",
            "s3://mybucket1/blocked-location2/",
        ],
        use_privatelink_endpoint="true",
        comment="some comment",
        storage_aws_role_arn="arn:aws:iam::001234567890:role/myrole",
        storage_aws_external_id="some_external_id",
        storage_aws_object_acl="bucket-owner-full-control")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-snowflake/sdk/v2/go/snowflake"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// minimal
    		_, err := snowflake.NewStorageIntegrationAws(ctx, "minimal", &snowflake.StorageIntegrationAwsArgs{
    			Name:            pulumi.String("example_aws_storage_integration"),
    			Enabled:         pulumi.Bool(true),
    			StorageProvider: pulumi.String("S3"),
    			StorageAllowedLocations: pulumi.StringArray{
    				pulumi.String("s3://mybucket1/path1/"),
    			},
    			StorageAwsRoleArn: pulumi.String("arn:aws:iam::001234567890:role/myrole"),
    		})
    		if err != nil {
    			return err
    		}
    		// all fields
    		_, err = snowflake.NewStorageIntegrationAws(ctx, "all", &snowflake.StorageIntegrationAwsArgs{
    			Name:            pulumi.String("example_aws_storage_integration"),
    			Enabled:         pulumi.Bool(true),
    			StorageProvider: pulumi.String("S3"),
    			StorageAllowedLocations: pulumi.StringArray{
    				pulumi.String("s3://mybucket1/allowed-location/"),
    				pulumi.String("s3://mybucket1/allowed-location2/"),
    			},
    			StorageBlockedLocations: pulumi.StringArray{
    				pulumi.String("s3://mybucket1/blocked-location/"),
    				pulumi.String("s3://mybucket1/blocked-location2/"),
    			},
    			UsePrivatelinkEndpoint: pulumi.String("true"),
    			Comment:                pulumi.String("some comment"),
    			StorageAwsRoleArn:      pulumi.String("arn:aws:iam::001234567890:role/myrole"),
    			StorageAwsExternalId:   pulumi.String("some_external_id"),
    			StorageAwsObjectAcl:    pulumi.String("bucket-owner-full-control"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Snowflake = Pulumi.Snowflake;
    
    return await Deployment.RunAsync(() => 
    {
        // minimal
        var minimal = new Snowflake.StorageIntegrationAws("minimal", new()
        {
            Name = "example_aws_storage_integration",
            Enabled = true,
            StorageProvider = "S3",
            StorageAllowedLocations = new[]
            {
                "s3://mybucket1/path1/",
            },
            StorageAwsRoleArn = "arn:aws:iam::001234567890:role/myrole",
        });
    
        // all fields
        var all = new Snowflake.StorageIntegrationAws("all", new()
        {
            Name = "example_aws_storage_integration",
            Enabled = true,
            StorageProvider = "S3",
            StorageAllowedLocations = new[]
            {
                "s3://mybucket1/allowed-location/",
                "s3://mybucket1/allowed-location2/",
            },
            StorageBlockedLocations = new[]
            {
                "s3://mybucket1/blocked-location/",
                "s3://mybucket1/blocked-location2/",
            },
            UsePrivatelinkEndpoint = "true",
            Comment = "some comment",
            StorageAwsRoleArn = "arn:aws:iam::001234567890:role/myrole",
            StorageAwsExternalId = "some_external_id",
            StorageAwsObjectAcl = "bucket-owner-full-control",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.snowflake.StorageIntegrationAws;
    import com.pulumi.snowflake.StorageIntegrationAwsArgs;
    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) {
            // minimal
            var minimal = new StorageIntegrationAws("minimal", StorageIntegrationAwsArgs.builder()
                .name("example_aws_storage_integration")
                .enabled(true)
                .storageProvider("S3")
                .storageAllowedLocations("s3://mybucket1/path1/")
                .storageAwsRoleArn("arn:aws:iam::001234567890:role/myrole")
                .build());
    
            // all fields
            var all = new StorageIntegrationAws("all", StorageIntegrationAwsArgs.builder()
                .name("example_aws_storage_integration")
                .enabled(true)
                .storageProvider("S3")
                .storageAllowedLocations(            
                    "s3://mybucket1/allowed-location/",
                    "s3://mybucket1/allowed-location2/")
                .storageBlockedLocations(            
                    "s3://mybucket1/blocked-location/",
                    "s3://mybucket1/blocked-location2/")
                .usePrivatelinkEndpoint("true")
                .comment("some comment")
                .storageAwsRoleArn("arn:aws:iam::001234567890:role/myrole")
                .storageAwsExternalId("some_external_id")
                .storageAwsObjectAcl("bucket-owner-full-control")
                .build());
    
        }
    }
    
    resources:
      # minimal
      minimal:
        type: snowflake:StorageIntegrationAws
        properties:
          name: example_aws_storage_integration
          enabled: true
          storageProvider: S3
          storageAllowedLocations:
            - s3://mybucket1/path1/
          storageAwsRoleArn: arn:aws:iam::001234567890:role/myrole
      # all fields
      all:
        type: snowflake:StorageIntegrationAws
        properties:
          name: example_aws_storage_integration
          enabled: true
          storageProvider: S3
          storageAllowedLocations:
            - s3://mybucket1/allowed-location/
            - s3://mybucket1/allowed-location2/
          storageBlockedLocations:
            - s3://mybucket1/blocked-location/
            - s3://mybucket1/blocked-location2/
          usePrivatelinkEndpoint: 'true'
          comment: some comment
          storageAwsRoleArn: arn:aws:iam::001234567890:role/myrole
          storageAwsExternalId: some_external_id
          storageAwsObjectAcl: bucket-owner-full-control
    

    Note If a field has a default value, it is shown next to the type in the schema.

    Create StorageIntegrationAws Resource

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

    Constructor syntax

    new StorageIntegrationAws(name: string, args: StorageIntegrationAwsArgs, opts?: CustomResourceOptions);
    @overload
    def StorageIntegrationAws(resource_name: str,
                              args: StorageIntegrationAwsArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def StorageIntegrationAws(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              enabled: Optional[bool] = None,
                              storage_allowed_locations: Optional[Sequence[str]] = None,
                              storage_aws_role_arn: Optional[str] = None,
                              storage_provider: Optional[str] = None,
                              comment: Optional[str] = None,
                              name: Optional[str] = None,
                              storage_aws_external_id: Optional[str] = None,
                              storage_aws_object_acl: Optional[str] = None,
                              storage_blocked_locations: Optional[Sequence[str]] = None,
                              use_privatelink_endpoint: Optional[str] = None)
    func NewStorageIntegrationAws(ctx *Context, name string, args StorageIntegrationAwsArgs, opts ...ResourceOption) (*StorageIntegrationAws, error)
    public StorageIntegrationAws(string name, StorageIntegrationAwsArgs args, CustomResourceOptions? opts = null)
    public StorageIntegrationAws(String name, StorageIntegrationAwsArgs args)
    public StorageIntegrationAws(String name, StorageIntegrationAwsArgs args, CustomResourceOptions options)
    
    type: snowflake:StorageIntegrationAws
    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 StorageIntegrationAwsArgs
    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 StorageIntegrationAwsArgs
    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 StorageIntegrationAwsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StorageIntegrationAwsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StorageIntegrationAwsArgs
    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 storageIntegrationAwsResource = new Snowflake.StorageIntegrationAws("storageIntegrationAwsResource", new()
    {
        Enabled = false,
        StorageAllowedLocations = new[]
        {
            "string",
        },
        StorageAwsRoleArn = "string",
        StorageProvider = "string",
        Comment = "string",
        Name = "string",
        StorageAwsExternalId = "string",
        StorageAwsObjectAcl = "string",
        StorageBlockedLocations = new[]
        {
            "string",
        },
        UsePrivatelinkEndpoint = "string",
    });
    
    example, err := snowflake.NewStorageIntegrationAws(ctx, "storageIntegrationAwsResource", &snowflake.StorageIntegrationAwsArgs{
    	Enabled: pulumi.Bool(false),
    	StorageAllowedLocations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	StorageAwsRoleArn:    pulumi.String("string"),
    	StorageProvider:      pulumi.String("string"),
    	Comment:              pulumi.String("string"),
    	Name:                 pulumi.String("string"),
    	StorageAwsExternalId: pulumi.String("string"),
    	StorageAwsObjectAcl:  pulumi.String("string"),
    	StorageBlockedLocations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UsePrivatelinkEndpoint: pulumi.String("string"),
    })
    
    var storageIntegrationAwsResource = new StorageIntegrationAws("storageIntegrationAwsResource", StorageIntegrationAwsArgs.builder()
        .enabled(false)
        .storageAllowedLocations("string")
        .storageAwsRoleArn("string")
        .storageProvider("string")
        .comment("string")
        .name("string")
        .storageAwsExternalId("string")
        .storageAwsObjectAcl("string")
        .storageBlockedLocations("string")
        .usePrivatelinkEndpoint("string")
        .build());
    
    storage_integration_aws_resource = snowflake.StorageIntegrationAws("storageIntegrationAwsResource",
        enabled=False,
        storage_allowed_locations=["string"],
        storage_aws_role_arn="string",
        storage_provider="string",
        comment="string",
        name="string",
        storage_aws_external_id="string",
        storage_aws_object_acl="string",
        storage_blocked_locations=["string"],
        use_privatelink_endpoint="string")
    
    const storageIntegrationAwsResource = new snowflake.StorageIntegrationAws("storageIntegrationAwsResource", {
        enabled: false,
        storageAllowedLocations: ["string"],
        storageAwsRoleArn: "string",
        storageProvider: "string",
        comment: "string",
        name: "string",
        storageAwsExternalId: "string",
        storageAwsObjectAcl: "string",
        storageBlockedLocations: ["string"],
        usePrivatelinkEndpoint: "string",
    });
    
    type: snowflake:StorageIntegrationAws
    properties:
        comment: string
        enabled: false
        name: string
        storageAllowedLocations:
            - string
        storageAwsExternalId: string
        storageAwsObjectAcl: string
        storageAwsRoleArn: string
        storageBlockedLocations:
            - string
        storageProvider: string
        usePrivatelinkEndpoint: string
    

    StorageIntegrationAws Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The StorageIntegrationAws resource accepts the following input properties:

    Enabled bool
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    StorageAllowedLocations List<string>
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    StorageAwsRoleArn string
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    StorageProvider string
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    Comment string
    Specifies a comment for the storage integration.
    Name string
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    StorageAwsExternalId string
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    StorageAwsObjectAcl string
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    StorageBlockedLocations List<string>
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    UsePrivatelinkEndpoint string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    Enabled bool
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    StorageAllowedLocations []string
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    StorageAwsRoleArn string
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    StorageProvider string
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    Comment string
    Specifies a comment for the storage integration.
    Name string
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    StorageAwsExternalId string
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    StorageAwsObjectAcl string
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    StorageBlockedLocations []string
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    UsePrivatelinkEndpoint string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    enabled Boolean
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    storageAllowedLocations List<String>
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    storageAwsRoleArn String
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    storageProvider String
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    comment String
    Specifies a comment for the storage integration.
    name String
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    storageAwsExternalId String
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    storageAwsObjectAcl String
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    storageBlockedLocations List<String>
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    usePrivatelinkEndpoint String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    enabled boolean
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    storageAllowedLocations string[]
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    storageAwsRoleArn string
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    storageProvider string
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    comment string
    Specifies a comment for the storage integration.
    name string
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    storageAwsExternalId string
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    storageAwsObjectAcl string
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    storageBlockedLocations string[]
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    usePrivatelinkEndpoint string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    enabled bool
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    storage_allowed_locations Sequence[str]
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    storage_aws_role_arn str
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    storage_provider str
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    comment str
    Specifies a comment for the storage integration.
    name str
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    storage_aws_external_id str
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    storage_aws_object_acl str
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    storage_blocked_locations Sequence[str]
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    use_privatelink_endpoint str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    enabled Boolean
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    storageAllowedLocations List<String>
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    storageAwsRoleArn String
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    storageProvider String
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    comment String
    Specifies a comment for the storage integration.
    name String
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    storageAwsExternalId String
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    storageAwsObjectAcl String
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    storageBlockedLocations List<String>
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    usePrivatelinkEndpoint String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.

    Outputs

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

    DescribeOutputs List<StorageIntegrationAwsDescribeOutput>
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShowOutputs List<StorageIntegrationAwsShowOutput>
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.
    DescribeOutputs []StorageIntegrationAwsDescribeOutput
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShowOutputs []StorageIntegrationAwsShowOutput
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.
    describeOutputs List<StorageIntegrationAwsDescribeOutput>
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    showOutputs List<StorageIntegrationAwsShowOutput>
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.
    describeOutputs StorageIntegrationAwsDescribeOutput[]
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    showOutputs StorageIntegrationAwsShowOutput[]
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.
    describe_outputs Sequence[StorageIntegrationAwsDescribeOutput]
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    id str
    The provider-assigned unique ID for this managed resource.
    show_outputs Sequence[StorageIntegrationAwsShowOutput]
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    showOutputs List<Property Map>
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.

    Look up Existing StorageIntegrationAws Resource

    Get an existing StorageIntegrationAws 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?: StorageIntegrationAwsState, opts?: CustomResourceOptions): StorageIntegrationAws
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            comment: Optional[str] = None,
            describe_outputs: Optional[Sequence[StorageIntegrationAwsDescribeOutputArgs]] = None,
            enabled: Optional[bool] = None,
            fully_qualified_name: Optional[str] = None,
            name: Optional[str] = None,
            show_outputs: Optional[Sequence[StorageIntegrationAwsShowOutputArgs]] = None,
            storage_allowed_locations: Optional[Sequence[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,
            storage_provider: Optional[str] = None,
            use_privatelink_endpoint: Optional[str] = None) -> StorageIntegrationAws
    func GetStorageIntegrationAws(ctx *Context, name string, id IDInput, state *StorageIntegrationAwsState, opts ...ResourceOption) (*StorageIntegrationAws, error)
    public static StorageIntegrationAws Get(string name, Input<string> id, StorageIntegrationAwsState? state, CustomResourceOptions? opts = null)
    public static StorageIntegrationAws get(String name, Output<String> id, StorageIntegrationAwsState state, CustomResourceOptions options)
    resources:  _:    type: snowflake:StorageIntegrationAws    get:      id: ${id}
    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:
    Comment string
    Specifies a comment for the storage integration.
    DescribeOutputs List<StorageIntegrationAwsDescribeOutput>
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    Enabled bool
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs List<StorageIntegrationAwsShowOutput>
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.
    StorageAllowedLocations List<string>
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    StorageAwsExternalId string
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    StorageAwsObjectAcl string
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    StorageAwsRoleArn string
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    StorageBlockedLocations List<string>
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    StorageProvider string
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    UsePrivatelinkEndpoint string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    Comment string
    Specifies a comment for the storage integration.
    DescribeOutputs []StorageIntegrationAwsDescribeOutputArgs
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    Enabled bool
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs []StorageIntegrationAwsShowOutputArgs
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.
    StorageAllowedLocations []string
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    StorageAwsExternalId string
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    StorageAwsObjectAcl string
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    StorageAwsRoleArn string
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    StorageBlockedLocations []string
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    StorageProvider string
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    UsePrivatelinkEndpoint string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    comment String
    Specifies a comment for the storage integration.
    describeOutputs List<StorageIntegrationAwsDescribeOutput>
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    enabled Boolean
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<StorageIntegrationAwsShowOutput>
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.
    storageAllowedLocations List<String>
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    storageAwsExternalId String
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    storageAwsObjectAcl String
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    storageAwsRoleArn String
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    storageBlockedLocations List<String>
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    storageProvider String
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    usePrivatelinkEndpoint String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    comment string
    Specifies a comment for the storage integration.
    describeOutputs StorageIntegrationAwsDescribeOutput[]
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    enabled boolean
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs StorageIntegrationAwsShowOutput[]
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.
    storageAllowedLocations string[]
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    storageAwsExternalId string
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    storageAwsObjectAcl string
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    storageAwsRoleArn string
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    storageBlockedLocations string[]
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    storageProvider string
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    usePrivatelinkEndpoint string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    comment str
    Specifies a comment for the storage integration.
    describe_outputs Sequence[StorageIntegrationAwsDescribeOutputArgs]
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    enabled bool
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    name str
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    show_outputs Sequence[StorageIntegrationAwsShowOutputArgs]
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.
    storage_allowed_locations Sequence[str]
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    storage_aws_external_id str
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    storage_aws_object_acl str
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    storage_aws_role_arn str
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    storage_blocked_locations Sequence[str]
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    storage_provider str
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    use_privatelink_endpoint str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    comment String
    Specifies a comment for the storage integration.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE STORAGE INTEGRATION for the given storage integration.
    enabled Boolean
    Specifies whether this storage integration is available for usage in stages. TRUE allows users to create new stages that reference this integration. Existing stages that reference this integration function normally. FALSE prevents users from creating new stages that reference this integration. Existing stages that reference this integration cannot access the storage location in the stage definition.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    String that specifies the identifier (i.e. name) for the integration; must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<Property Map>
    Outputs the result of SHOW STORAGE INTEGRATIONS for the given storage integration.
    storageAllowedLocations List<String>
    Explicitly limits external stages that use the integration to reference one or more storage locations.
    storageAwsExternalId String
    Optionally specifies an external ID that Snowflake uses to establish a trust relationship with AWS.
    storageAwsObjectAcl String
    Enables support for AWS access control lists (ACLs) to grant the bucket owner full control. bucket-owner-full-control is the only currently supported value.
    storageAwsRoleArn String
    Specifies the Amazon Resource Name (ARN) of the AWS identity and access management (IAM) role that grants privileges on the S3 bucket containing your data files.
    storageBlockedLocations List<String>
    Explicitly prohibits external stages that use the integration from referencing one or more storage locations.
    storageProvider String
    Specifies the storage provider for the integration. Valid options are: S3 | S3GOV | S3CHINA | GCS | AZURE
    usePrivatelinkEndpoint String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to use outbound private connectivity to harden the security posture. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.

    Supporting Types

    StorageIntegrationAwsDescribeOutput, StorageIntegrationAwsDescribeOutputArgs

    AllowedLocations List<string>
    BlockedLocations List<string>
    Comment string
    Enabled bool
    ExternalId string
    IamUserArn string
    Id string
    ObjectAcl string
    Provider string
    RoleArn string
    UsePrivatelinkEndpoint bool
    AllowedLocations []string
    BlockedLocations []string
    Comment string
    Enabled bool
    ExternalId string
    IamUserArn string
    Id string
    ObjectAcl string
    Provider string
    RoleArn string
    UsePrivatelinkEndpoint bool
    allowedLocations List<String>
    blockedLocations List<String>
    comment String
    enabled Boolean
    externalId String
    iamUserArn String
    id String
    objectAcl String
    provider String
    roleArn String
    usePrivatelinkEndpoint Boolean
    allowedLocations string[]
    blockedLocations string[]
    comment string
    enabled boolean
    externalId string
    iamUserArn string
    id string
    objectAcl string
    provider string
    roleArn string
    usePrivatelinkEndpoint boolean
    allowedLocations List<String>
    blockedLocations List<String>
    comment String
    enabled Boolean
    externalId String
    iamUserArn String
    id String
    objectAcl String
    provider String
    roleArn String
    usePrivatelinkEndpoint Boolean

    StorageIntegrationAwsShowOutput, StorageIntegrationAwsShowOutputArgs

    Category string
    Comment string
    CreatedOn string
    Enabled bool
    Name string
    StorageType string
    Category string
    Comment string
    CreatedOn string
    Enabled bool
    Name string
    StorageType string
    category String
    comment String
    createdOn String
    enabled Boolean
    name String
    storageType String
    category string
    comment string
    createdOn string
    enabled boolean
    name string
    storageType string
    category String
    comment String
    createdOn String
    enabled Boolean
    name String
    storageType String

    Import

    $ pulumi import snowflake:index/storageIntegrationAws:StorageIntegrationAws example '"<storage_integration_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 v2.12.0 published on Friday, Feb 13, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate