Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake
  3. API Docs
  4. DatabaseOld
Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.DatabaseOld

Explore with Pulumi AI

snowflake logo
Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-snowflake

    Import

    $ pulumi import snowflake:index/databaseOld:DatabaseOld example 'database_name'

    Create DatabaseOld Resource

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

    Constructor syntax

    new DatabaseOld(name: string, args?: DatabaseOldArgs, opts?: CustomResourceOptions);
    @overload
def DatabaseOld(resource_name: str,
                args: Optional[DatabaseOldArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def DatabaseOld(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                comment: Optional[str] = None,
                data_retention_time_in_days: Optional[int] = None,
                from_database: Optional[str] = None,
                from_replica: Optional[str] = None,
                from_share: Optional[Mapping[str, str]] = None,
                is_transient: Optional[bool] = None,
                name: Optional[str] = None,
                replication_configuration: Optional[DatabaseOldReplicationConfigurationArgs] = None)
    func NewDatabaseOld(ctx *Context, name string, args *DatabaseOldArgs, opts ...ResourceOption) (*DatabaseOld, error)
    public DatabaseOld(string name, DatabaseOldArgs? args = null, CustomResourceOptions? opts = null)
    public DatabaseOld(String name, DatabaseOldArgs args)
public DatabaseOld(String name, DatabaseOldArgs args, CustomResourceOptions options)

    type: snowflake:DatabaseOld
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 DatabaseOldArgs
    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 DatabaseOldArgs
    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 DatabaseOldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseOldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseOldArgs
    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 databaseOldResource = new Snowflake.DatabaseOld("databaseOldResource", new()
{
    Comment = "string",
    DataRetentionTimeInDays = 0,
    FromDatabase = "string",
    FromReplica = "string",
    FromShare = 
    {
        { "string", "string" },
    },
    IsTransient = false,
    Name = "string",
    ReplicationConfiguration = new Snowflake.Inputs.DatabaseOldReplicationConfigurationArgs
    {
        Accounts = new[]
        {
            "string",
        },
        IgnoreEditionCheck = false,
    },
});

    example, err := snowflake.NewDatabaseOld(ctx, "databaseOldResource", &snowflake.DatabaseOldArgs{
	Comment:                 pulumi.String("string"),
	DataRetentionTimeInDays: pulumi.Int(0),
	FromDatabase:            pulumi.String("string"),
	FromReplica:             pulumi.String("string"),
	FromShare: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsTransient: pulumi.Bool(false),
	Name:        pulumi.String("string"),
	ReplicationConfiguration: &snowflake.DatabaseOldReplicationConfigurationArgs{
		Accounts: pulumi.StringArray{
			pulumi.String("string"),
		},
		IgnoreEditionCheck: pulumi.Bool(false),
	},
})

    var databaseOldResource = new DatabaseOld("databaseOldResource", DatabaseOldArgs.builder()
    .comment("string")
    .dataRetentionTimeInDays(0)
    .fromDatabase("string")
    .fromReplica("string")
    .fromShare(Map.of("string", "string"))
    .isTransient(false)
    .name("string")
    .replicationConfiguration(DatabaseOldReplicationConfigurationArgs.builder()
        .accounts("string")
        .ignoreEditionCheck(false)
        .build())
    .build());

    database_old_resource = snowflake.DatabaseOld("databaseOldResource",
    comment="string",
    data_retention_time_in_days=0,
    from_database="string",
    from_replica="string",
    from_share={
        "string": "string",
    },
    is_transient=False,
    name="string",
    replication_configuration=snowflake.DatabaseOldReplicationConfigurationArgs(
        accounts=["string"],
        ignore_edition_check=False,
    ))

    const databaseOldResource = new snowflake.DatabaseOld("databaseOldResource", {
    comment: "string",
    dataRetentionTimeInDays: 0,
    fromDatabase: "string",
    fromReplica: "string",
    fromShare: {
        string: "string",
    },
    isTransient: false,
    name: "string",
    replicationConfiguration: {
        accounts: ["string"],
        ignoreEditionCheck: false,
    },
});

    type: snowflake:DatabaseOld
properties:
    comment: string
    dataRetentionTimeInDays: 0
    fromDatabase: string
    fromReplica: string
    fromShare:
        string: string
    isTransient: false
    name: string
    replicationConfiguration:
        accounts:
            - string
        ignoreEditionCheck: false

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

    Comment string
    Specifies a comment for the database.
    DataRetentionTimeInDays int
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    FromDatabase string
    Specify a database to create a clone from.
    FromReplica string
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    FromShare Dictionary<string, string>
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    IsTransient bool
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    Name string
    Specifies the identifier for the database; must be unique for your account.
    ReplicationConfiguration DatabaseOldReplicationConfiguration
    When set, specifies the configurations for database replication.
    Comment string
    Specifies a comment for the database.
    DataRetentionTimeInDays int
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    FromDatabase string
    Specify a database to create a clone from.
    FromReplica string
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    FromShare map[string]string
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    IsTransient bool
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    Name string
    Specifies the identifier for the database; must be unique for your account.
    ReplicationConfiguration DatabaseOldReplicationConfigurationArgs
    When set, specifies the configurations for database replication.
    comment String
    Specifies a comment for the database.
    dataRetentionTimeInDays Integer
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    fromDatabase String
    Specify a database to create a clone from.
    fromReplica String
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    fromShare Map<String,String>
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    isTransient Boolean
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    name String
    Specifies the identifier for the database; must be unique for your account.
    replicationConfiguration DatabaseOldReplicationConfiguration
    When set, specifies the configurations for database replication.
    comment string
    Specifies a comment for the database.
    dataRetentionTimeInDays number
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    fromDatabase string
    Specify a database to create a clone from.
    fromReplica string
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    fromShare {[key: string]: string}
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    isTransient boolean
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    name string
    Specifies the identifier for the database; must be unique for your account.
    replicationConfiguration DatabaseOldReplicationConfiguration
    When set, specifies the configurations for database replication.
    comment str
    Specifies a comment for the database.
    data_retention_time_in_days int
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    from_database str
    Specify a database to create a clone from.
    from_replica str
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    from_share Mapping[str, str]
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    is_transient bool
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    name str
    Specifies the identifier for the database; must be unique for your account.
    replication_configuration DatabaseOldReplicationConfigurationArgs
    When set, specifies the configurations for database replication.
    comment String
    Specifies a comment for the database.
    dataRetentionTimeInDays Number
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    fromDatabase String
    Specify a database to create a clone from.
    fromReplica String
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    fromShare Map<String>
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    isTransient Boolean
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    name String
    Specifies the identifier for the database; must be unique for your account.
    replicationConfiguration Property Map
    When set, specifies the configurations for database replication.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DatabaseOld Resource

    Get an existing DatabaseOld 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?: DatabaseOldState, opts?: CustomResourceOptions): DatabaseOld
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        data_retention_time_in_days: Optional[int] = None,
        from_database: Optional[str] = None,
        from_replica: Optional[str] = None,
        from_share: Optional[Mapping[str, str]] = None,
        is_transient: Optional[bool] = None,
        name: Optional[str] = None,
        replication_configuration: Optional[DatabaseOldReplicationConfigurationArgs] = None) -> DatabaseOld
    func GetDatabaseOld(ctx *Context, name string, id IDInput, state *DatabaseOldState, opts ...ResourceOption) (*DatabaseOld, error)
    public static DatabaseOld Get(string name, Input<string> id, DatabaseOldState? state, CustomResourceOptions? opts = null)
    public static DatabaseOld get(String name, Output<String> id, DatabaseOldState 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:
    Comment string
    Specifies a comment for the database.
    DataRetentionTimeInDays int
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    FromDatabase string
    Specify a database to create a clone from.
    FromReplica string
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    FromShare Dictionary<string, string>
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    IsTransient bool
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    Name string
    Specifies the identifier for the database; must be unique for your account.
    ReplicationConfiguration DatabaseOldReplicationConfiguration
    When set, specifies the configurations for database replication.
    Comment string
    Specifies a comment for the database.
    DataRetentionTimeInDays int
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    FromDatabase string
    Specify a database to create a clone from.
    FromReplica string
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    FromShare map[string]string
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    IsTransient bool
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    Name string
    Specifies the identifier for the database; must be unique for your account.
    ReplicationConfiguration DatabaseOldReplicationConfigurationArgs
    When set, specifies the configurations for database replication.
    comment String
    Specifies a comment for the database.
    dataRetentionTimeInDays Integer
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    fromDatabase String
    Specify a database to create a clone from.
    fromReplica String
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    fromShare Map<String,String>
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    isTransient Boolean
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    name String
    Specifies the identifier for the database; must be unique for your account.
    replicationConfiguration DatabaseOldReplicationConfiguration
    When set, specifies the configurations for database replication.
    comment string
    Specifies a comment for the database.
    dataRetentionTimeInDays number
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    fromDatabase string
    Specify a database to create a clone from.
    fromReplica string
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    fromShare {[key: string]: string}
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    isTransient boolean
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    name string
    Specifies the identifier for the database; must be unique for your account.
    replicationConfiguration DatabaseOldReplicationConfiguration
    When set, specifies the configurations for database replication.
    comment str
    Specifies a comment for the database.
    data_retention_time_in_days int
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    from_database str
    Specify a database to create a clone from.
    from_replica str
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    from_share Mapping[str, str]
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    is_transient bool
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    name str
    Specifies the identifier for the database; must be unique for your account.
    replication_configuration DatabaseOldReplicationConfigurationArgs
    When set, specifies the configurations for database replication.
    comment String
    Specifies a comment for the database.
    dataRetentionTimeInDays Number
    Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database. Default value for this field is set to -1, which is a fallback to use Snowflake default. For more information, see Understanding & Using Time Travel.
    fromDatabase String
    Specify a database to create a clone from.
    fromReplica String
    Specify a fully-qualified path to a database to create a replica from. A fully qualified path follows the format of "<organization_name>"."<account_name>"."<db_name>". An example would be: "myorg1"."account1"."db1"
    fromShare Map<String>
    Specify a provider and a share in this map to create a database from a share. As of version 0.87.0, the provider field is the account locator.
    isTransient Boolean
    Specifies a database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
    name String
    Specifies the identifier for the database; must be unique for your account.
    replicationConfiguration Property Map
    When set, specifies the configurations for database replication.

    Supporting Types

    DatabaseOldReplicationConfiguration, DatabaseOldReplicationConfigurationArgs

    Accounts List<string>
    IgnoreEditionCheck bool
    accounts List<String>
    ignoreEditionCheck Boolean
    accounts Sequence[str]
    ignore_edition_check bool
    accounts List<String>
    ignoreEditionCheck Boolean

    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.59.0 published on Friday, Sep 20, 2024 by Pulumi
    pulumi/pulumi-snowflake