@pulumi/aws/redshiftserverless/getWorkgroup.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Data source for managing an AWS Redshift Serverless Workgroup.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.redshiftserverless.getWorkgroup({
 *     workgroupName: exampleAwsRedshiftserverlessWorkgroup.workgroupName,
 * });
 * ```
 */
export declare function getWorkgroup(args: GetWorkgroupArgs, opts?: pulumi.InvokeOptions): Promise<GetWorkgroupResult>;
/**
 * A collection of arguments for invoking getWorkgroup.
 */
export interface GetWorkgroupArgs {
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * The name of the workgroup associated with the database.
     */
    workgroupName: string;
}
/**
 * A collection of values returned by getWorkgroup.
 */
export interface GetWorkgroupResult {
    /**
     * Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
     */
    readonly arn: string;
    /**
     * The endpoint that is created from the workgroup. See `Endpoint` below.
     */
    readonly endpoints: outputs.redshiftserverless.GetWorkgroupEndpoint[];
    /**
     * The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
     */
    readonly enhancedVpcRouting: boolean;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly namespaceName: string;
    /**
     * A value that specifies whether the workgroup can be accessed from a public network.
     */
    readonly publiclyAccessible: boolean;
    readonly region: string;
    /**
     * An array of security group IDs to associate with the workgroup.
     */
    readonly securityGroupIds: string[];
    /**
     * An array of VPC subnet IDs to associate with the workgroup. When set, must contain at least three subnets spanning three Availability Zones. A minimum number of IP addresses is required and scales with the Base Capacity. For more information, see the following [AWS document](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-known-issues.html).
     */
    readonly subnetIds: string[];
    /**
     * The name of the track for the workgroup.
     */
    readonly trackName: string;
    /**
     * The Redshift Workgroup ID.
     */
    readonly workgroupId: string;
    readonly workgroupName: string;
}
/**
 * Data source for managing an AWS Redshift Serverless Workgroup.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.redshiftserverless.getWorkgroup({
 *     workgroupName: exampleAwsRedshiftserverlessWorkgroup.workgroupName,
 * });
 * ```
 */
export declare function getWorkgroupOutput(args: GetWorkgroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWorkgroupResult>;
/**
 * A collection of arguments for invoking getWorkgroup.
 */
export interface GetWorkgroupOutputArgs {
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * The name of the workgroup associated with the database.
     */
    workgroupName: pulumi.Input<string>;
}