com.pulumi.snowflake.DatabaseOld Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of snowflake Show documentation
A Pulumi package for creating and managing snowflake cloud resources.
The newest version!
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.snowflake;

import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.snowflake.DatabaseOldArgs;
import com.pulumi.snowflake.Utilities;
import com.pulumi.snowflake.inputs.DatabaseOldState;
import com.pulumi.snowflake.outputs.DatabaseOldReplicationConfiguration;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;

/**
 * ## Import
 * 
 * ```sh
 * $ pulumi import snowflake:index/databaseOld:DatabaseOld example 'database_name'
 * ```
 * 
 */
@ResourceType(type="snowflake:index/databaseOld:DatabaseOld")
public class DatabaseOld extends com.pulumi.resources.CustomResource {
    /**
     * Specifies a comment for the database.
     * 
     */
    @Export(name="comment", refs={String.class}, tree="[0]")
    private Output comment;

    /**
     * @return Specifies a comment for the database.
     * 
     */
    public Output> comment() {
        return Codegen.optional(this.comment);
    }
    /**
     * 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](https://docs.snowflake.com/en/user-guide/data-time-travel).
     * 
     */
    @Export(name="dataRetentionTimeInDays", refs={Integer.class}, tree="[0]")
    private Output dataRetentionTimeInDays;

    /**
     * @return 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](https://docs.snowflake.com/en/user-guide/data-time-travel).
     * 
     */
    public Output> dataRetentionTimeInDays() {
        return Codegen.optional(this.dataRetentionTimeInDays);
    }
    /**
     * Specify a database to create a clone from.
     * 
     */
    @Export(name="fromDatabase", refs={String.class}, tree="[0]")
    private Output fromDatabase;

    /**
     * @return Specify a database to create a clone from.
     * 
     */
    public Output> fromDatabase() {
        return Codegen.optional(this.fromDatabase);
    }
    /**
     * 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"`
     * 
     */
    @Export(name="fromReplica", refs={String.class}, tree="[0]")
    private Output fromReplica;

    /**
     * @return 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"`
     * 
     */
    public Output> fromReplica() {
        return Codegen.optional(this.fromReplica);
    }
    /**
     * 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.
     * 
     */
    @Export(name="fromShare", refs={Map.class,String.class}, tree="[0,1,1]")
    private Output> fromShare;

    /**
     * @return 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.
     * 
     */
    public Output>> fromShare() {
        return Codegen.optional(this.fromShare);
    }
    /**
     * 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.
     * 
     */
    @Export(name="isTransient", refs={Boolean.class}, tree="[0]")
    private Output isTransient;

    /**
     * @return 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.
     * 
     */
    public Output> isTransient() {
        return Codegen.optional(this.isTransient);
    }
    /**
     * Specifies the identifier for the database; must be unique for your account.
     * 
     */
    @Export(name="name", refs={String.class}, tree="[0]")
    private Output name;

    /**
     * @return Specifies the identifier for the database; must be unique for your account.
     * 
     */
    public Output name() {
        return this.name;
    }
    /**
     * When set, specifies the configurations for database replication.
     * 
     */
    @Export(name="replicationConfiguration", refs={DatabaseOldReplicationConfiguration.class}, tree="[0]")
    private Output replicationConfiguration;

    /**
     * @return When set, specifies the configurations for database replication.
     * 
     */
    public Output> replicationConfiguration() {
        return Codegen.optional(this.replicationConfiguration);
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public DatabaseOld(java.lang.String name) {
        this(name, DatabaseOldArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public DatabaseOld(java.lang.String name, @Nullable DatabaseOldArgs args) {
        this(name, args, null);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param options A bag of options that control this resource's behavior.
     */
    public DatabaseOld(java.lang.String name, @Nullable DatabaseOldArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("snowflake:index/databaseOld:DatabaseOld", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private DatabaseOld(java.lang.String name, Output id, @Nullable DatabaseOldState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("snowflake:index/databaseOld:DatabaseOld", name, state, makeResourceOptions(options, id), false);
    }

    private static DatabaseOldArgs makeArgs(@Nullable DatabaseOldArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? DatabaseOldArgs.Empty : args;
    }

    private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
        var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
            .version(Utilities.getVersion())
            .build();
        return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
    }

    /**
     * Get an existing Host resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state
     * @param options Optional settings to control the behavior of the CustomResource.
     */
    public static DatabaseOld get(java.lang.String name, Output id, @Nullable DatabaseOldState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new DatabaseOld(name, id, state, options);
    }
}