Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. redshiftserverless
  5. Workgroup

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.redshiftserverless.Workgroup

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::RedshiftServerless::Workgroup Resource Type

    Create Workgroup Resource

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

    Constructor syntax

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

@overload
def Workgroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              base_capacity: Optional[int] = None,
              config_parameters: Optional[Sequence[WorkgroupConfigParameterArgs]] = None,
              enhanced_vpc_routing: Optional[bool] = None,
              max_capacity: Optional[int] = None,
              namespace_name: Optional[str] = None,
              port: Optional[int] = None,
              publicly_accessible: Optional[bool] = None,
              security_group_ids: Optional[Sequence[str]] = None,
              subnet_ids: Optional[Sequence[str]] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
              workgroup_name: Optional[str] = None)
    func NewWorkgroup(ctx *Context, name string, args *WorkgroupArgs, opts ...ResourceOption) (*Workgroup, error)
    public Workgroup(string name, WorkgroupArgs? args = null, CustomResourceOptions? opts = null)
    public Workgroup(String name, WorkgroupArgs args)
public Workgroup(String name, WorkgroupArgs args, CustomResourceOptions options)

    type: aws-native:redshiftserverless:Workgroup
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 WorkgroupArgs
    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 WorkgroupArgs
    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 WorkgroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkgroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkgroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const workgroupResource = new aws_native.redshiftserverless.Workgroup("workgroupResource", {
    baseCapacity: 0,
    configParameters: [{
        parameterKey: "string",
        parameterValue: "string",
    }],
    enhancedVpcRouting: false,
    maxCapacity: 0,
    namespaceName: "string",
    port: 0,
    publiclyAccessible: false,
    securityGroupIds: ["string"],
    subnetIds: ["string"],
    tags: [{
        key: "string",
        value: "string",
    }],
    workgroupName: "string",
});

    Coming soon!

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

    BaseCapacity int
    The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
    ConfigParameters List<Pulumi.AwsNative.RedshiftServerless.Inputs.WorkgroupConfigParameter>
    A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
    EnhancedVpcRouting bool
    The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
    MaxCapacity int
    The max compute capacity of the workgroup in Redshift Processing Units (RPUs).
    NamespaceName string
    The namespace the workgroup is associated with.
    Port int
    The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
    PubliclyAccessible bool
    A value that specifies whether the workgroup can be accessible from a public network.
    SecurityGroupIds List<string>
    A list of security group IDs to associate with the workgroup.
    SubnetIds List<string>
    A list of subnet IDs the workgroup is associated with.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The map of the key-value pairs used to tag the workgroup.
    WorkgroupName string
    The name of the workgroup.
    BaseCapacity int
    The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
    ConfigParameters []WorkgroupConfigParameterArgs
    A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
    EnhancedVpcRouting bool
    The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
    MaxCapacity int
    The max compute capacity of the workgroup in Redshift Processing Units (RPUs).
    NamespaceName string
    The namespace the workgroup is associated with.
    Port int
    The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
    PubliclyAccessible bool
    A value that specifies whether the workgroup can be accessible from a public network.
    SecurityGroupIds []string
    A list of security group IDs to associate with the workgroup.
    SubnetIds []string
    A list of subnet IDs the workgroup is associated with.
    Tags TagArgs
    The map of the key-value pairs used to tag the workgroup.
    WorkgroupName string
    The name of the workgroup.
    baseCapacity Integer
    The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
    configParameters List<WorkgroupConfigParameter>
    A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
    enhancedVpcRouting Boolean
    The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
    maxCapacity Integer
    The max compute capacity of the workgroup in Redshift Processing Units (RPUs).
    namespaceName String
    The namespace the workgroup is associated with.
    port Integer
    The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
    publiclyAccessible Boolean
    A value that specifies whether the workgroup can be accessible from a public network.
    securityGroupIds List<String>
    A list of security group IDs to associate with the workgroup.
    subnetIds List<String>
    A list of subnet IDs the workgroup is associated with.
    tags List<Tag>
    The map of the key-value pairs used to tag the workgroup.
    workgroupName String
    The name of the workgroup.
    baseCapacity number
    The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
    configParameters WorkgroupConfigParameter[]
    A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
    enhancedVpcRouting boolean
    The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
    maxCapacity number
    The max compute capacity of the workgroup in Redshift Processing Units (RPUs).
    namespaceName string
    The namespace the workgroup is associated with.
    port number
    The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
    publiclyAccessible boolean
    A value that specifies whether the workgroup can be accessible from a public network.
    securityGroupIds string[]
    A list of security group IDs to associate with the workgroup.
    subnetIds string[]
    A list of subnet IDs the workgroup is associated with.
    tags Tag[]
    The map of the key-value pairs used to tag the workgroup.
    workgroupName string
    The name of the workgroup.
    base_capacity int
    The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
    config_parameters Sequence[WorkgroupConfigParameterArgs]
    A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
    enhanced_vpc_routing bool
    The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
    max_capacity int
    The max compute capacity of the workgroup in Redshift Processing Units (RPUs).
    namespace_name str
    The namespace the workgroup is associated with.
    port int
    The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
    publicly_accessible bool
    A value that specifies whether the workgroup can be accessible from a public network.
    security_group_ids Sequence[str]
    A list of security group IDs to associate with the workgroup.
    subnet_ids Sequence[str]
    A list of subnet IDs the workgroup is associated with.
    tags Sequence[TagArgs]
    The map of the key-value pairs used to tag the workgroup.
    workgroup_name str
    The name of the workgroup.
    baseCapacity Number
    The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
    configParameters List<Property Map>
    A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.
    enhancedVpcRouting Boolean
    The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
    maxCapacity Number
    The max compute capacity of the workgroup in Redshift Processing Units (RPUs).
    namespaceName String
    The namespace the workgroup is associated with.
    port Number
    The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
    publiclyAccessible Boolean
    A value that specifies whether the workgroup can be accessible from a public network.
    securityGroupIds List<String>
    A list of security group IDs to associate with the workgroup.
    subnetIds List<String>
    A list of subnet IDs the workgroup is associated with.
    tags List<Property Map>
    The map of the key-value pairs used to tag the workgroup.
    workgroupName String
    The name of the workgroup.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    WorkgroupValue Pulumi.AwsNative.RedshiftServerless.Outputs.Workgroup
    Definition for workgroup resource
    Id string
    The provider-assigned unique ID for this managed resource.
    Workgroup WorkgroupType
    Definition for workgroup resource
    id String
    The provider-assigned unique ID for this managed resource.
    workgroup Workgroup
    Definition for workgroup resource
    id string
    The provider-assigned unique ID for this managed resource.
    workgroup Workgroup
    Definition for workgroup resource
    id str
    The provider-assigned unique ID for this managed resource.
    workgroup Workgroup
    Definition for workgroup resource
    id String
    The provider-assigned unique ID for this managed resource.
    workgroup Property Map
    Definition for workgroup resource

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Workgroup, WorkgroupArgs

    WorkgroupConfigParameter, WorkgroupConfigParameterArgs

    WorkgroupEndpoint, WorkgroupEndpointArgs

    WorkgroupNetworkInterface, WorkgroupNetworkInterfaceArgs

    WorkgroupStatus, WorkgroupStatusArgs

    Creating
    CREATING
    Available
    AVAILABLE
    Modifying
    MODIFYING
    Deleting
    DELETING
    WorkgroupStatusCreating
    CREATING
    WorkgroupStatusAvailable
    AVAILABLE
    WorkgroupStatusModifying
    MODIFYING
    WorkgroupStatusDeleting
    DELETING
    Creating
    CREATING
    Available
    AVAILABLE
    Modifying
    MODIFYING
    Deleting
    DELETING
    Creating
    CREATING
    Available
    AVAILABLE
    Modifying
    MODIFYING
    Deleting
    DELETING
    CREATING
    CREATING
    AVAILABLE
    AVAILABLE
    MODIFYING
    MODIFYING
    DELETING
    DELETING
    "CREATING"
    CREATING
    "AVAILABLE"
    AVAILABLE
    "MODIFYING"
    MODIFYING
    "DELETING"
    DELETING

    WorkgroupVpcEndpoint, WorkgroupVpcEndpointArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
    pulumi/pulumi-aws-native