com.pulumi.aws.redshiftdata.Statement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
There is a newer version: 6.72.0
// *** 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.aws.redshiftdata;

import com.pulumi.aws.Utilities;
import com.pulumi.aws.redshiftdata.StatementArgs;
import com.pulumi.aws.redshiftdata.inputs.StatementState;
import com.pulumi.aws.redshiftdata.outputs.StatementParameter;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;

/**
 * Executes a Redshift Data Statement.
 * 
 * ## Example Usage
 * 
 * ### cluster_identifier
 * 
 * <!--Start PulumiCodeChooser -->
 *  * {@code
 * package generated_program;
 * 
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.aws.redshiftdata.Statement;
 * import com.pulumi.aws.redshiftdata.StatementArgs;
 * import java.util.List;
 * import java.util.ArrayList;
 * import java.util.Map;
 * import java.io.File;
 * import java.nio.file.Files;
 * import java.nio.file.Paths;
 * 
 * public class App {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 * 
 *     public static void stack(Context ctx) {
 *         var example = new Statement("example", StatementArgs.builder()
 *             .clusterIdentifier(exampleAwsRedshiftCluster.clusterIdentifier())
 *             .database(exampleAwsRedshiftCluster.databaseName())
 *             .dbUser(exampleAwsRedshiftCluster.masterUsername())
 *             .sql("CREATE GROUP group_name;")
 *             .build());
 * 
 *     }
 * }
 * }
 * 
 * <!--End PulumiCodeChooser -->
 * 
 * ### workgroup_name
 * 
 * <!--Start PulumiCodeChooser -->
 *  * {@code
 * package generated_program;
 * 
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.aws.redshiftdata.Statement;
 * import com.pulumi.aws.redshiftdata.StatementArgs;
 * import java.util.List;
 * import java.util.ArrayList;
 * import java.util.Map;
 * import java.io.File;
 * import java.nio.file.Files;
 * import java.nio.file.Paths;
 * 
 * public class App {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 * 
 *     public static void stack(Context ctx) {
 *         var example = new Statement("example", StatementArgs.builder()
 *             .workgroupName(exampleAwsRedshiftserverlessWorkgroup.workgroupName())
 *             .database("dev")
 *             .sql("CREATE GROUP group_name;")
 *             .build());
 * 
 *     }
 * }
 * }
 * 
 * <!--End PulumiCodeChooser -->
 * 
 * ## Import
 * 
 * Using `pulumi import`, import Redshift Data Statements using the `id`. For example:
 * 
 * ```sh
 * $ pulumi import aws:redshiftdata/statement:Statement example example
 * ```
 * 
 */
@ResourceType(type="aws:redshiftdata/statement:Statement")
public class Statement extends com.pulumi.resources.CustomResource {
    /**
     * The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
     * 
     */
    @Export(name="clusterIdentifier", refs={String.class}, tree="[0]")
    private Output clusterIdentifier;

    /**
     * @return The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
     * 
     */
    public Output> clusterIdentifier() {
        return Codegen.optional(this.clusterIdentifier);
    }
    /**
     * The name of the database.
     * 
     */
    @Export(name="database", refs={String.class}, tree="[0]")
    private Output database;

    /**
     * @return The name of the database.
     * 
     */
    public Output database() {
        return this.database;
    }
    /**
     * The database user name.
     * 
     */
    @Export(name="dbUser", refs={String.class}, tree="[0]")
    private Output dbUser;

    /**
     * @return The database user name.
     * 
     */
    public Output> dbUser() {
        return Codegen.optional(this.dbUser);
    }
    @Export(name="parameters", refs={List.class,StatementParameter.class}, tree="[0,1]")
    private Output> parameters;

    public Output>> parameters() {
        return Codegen.optional(this.parameters);
    }
    /**
     * The name or ARN of the secret that enables access to the database.
     * 
     */
    @Export(name="secretArn", refs={String.class}, tree="[0]")
    private Output secretArn;

    /**
     * @return The name or ARN of the secret that enables access to the database.
     * 
     */
    public Output> secretArn() {
        return Codegen.optional(this.secretArn);
    }
    /**
     * The SQL statement text to run.
     * 
     * The following arguments are optional:
     * 
     */
    @Export(name="sql", refs={String.class}, tree="[0]")
    private Output sql;

    /**
     * @return The SQL statement text to run.
     * 
     * The following arguments are optional:
     * 
     */
    public Output sql() {
        return this.sql;
    }
    /**
     * The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
     * 
     */
    @Export(name="statementName", refs={String.class}, tree="[0]")
    private Output statementName;

    /**
     * @return The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
     * 
     */
    public Output> statementName() {
        return Codegen.optional(this.statementName);
    }
    /**
     * A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
     * 
     */
    @Export(name="withEvent", refs={Boolean.class}, tree="[0]")
    private Output withEvent;

    /**
     * @return A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
     * 
     */
    public Output> withEvent() {
        return Codegen.optional(this.withEvent);
    }
    /**
     * The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
     * 
     */
    @Export(name="workgroupName", refs={String.class}, tree="[0]")
    private Output workgroupName;

    /**
     * @return The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
     * 
     */
    public Output> workgroupName() {
        return Codegen.optional(this.workgroupName);
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public Statement(java.lang.String name) {
        this(name, StatementArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public Statement(java.lang.String name, StatementArgs 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 Statement(java.lang.String name, StatementArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:redshiftdata/statement:Statement", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private Statement(java.lang.String name, Output id, @Nullable StatementState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:redshiftdata/statement:Statement", name, state, makeResourceOptions(options, id), false);
    }

    private static StatementArgs makeArgs(StatementArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? StatementArgs.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 Statement get(java.lang.String name, Output id, @Nullable StatementState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new Statement(name, id, state, options);
    }
}