Class CfnWorkgroupPropsMixin.WorkgroupProperty

The collection of computing resources from which an endpoint is created.

Inheritance

object

CfnWorkgroupPropsMixin.WorkgroupProperty

Implements

CfnWorkgroupPropsMixin.IWorkgroupProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.RedshiftServerless.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnWorkgroupPropsMixin.WorkgroupProperty : CfnWorkgroupPropsMixin.IWorkgroupProperty

Syntax (vb)

Public Class CfnWorkgroupPropsMixin.WorkgroupProperty Implements CfnWorkgroupPropsMixin.IWorkgroupProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.RedshiftServerless.Mixins;

             var workgroupProperty = new WorkgroupProperty {
                 BaseCapacity = 123,
                 ConfigParameters = new [] { new ConfigParameterProperty {
                     ParameterKey = "parameterKey",
                     ParameterValue = "parameterValue"
                 } },
                 CreationDate = "creationDate",
                 Endpoint = new EndpointProperty {
                     Address = "address",
                     Port = 123,
                     VpcEndpoints = new [] { new VpcEndpointProperty {
                         NetworkInterfaces = new [] { new NetworkInterfaceProperty {
                             AvailabilityZone = "availabilityZone",
                             NetworkInterfaceId = "networkInterfaceId",
                             PrivateIpAddress = "privateIpAddress",
                             SubnetId = "subnetId"
                         } },
                         VpcEndpointId = "vpcEndpointId",
                         VpcId = "vpcId"
                     } }
                 },
                 EnhancedVpcRouting = false,
                 MaxCapacity = 123,
                 NamespaceName = "namespaceName",
                 PricePerformanceTarget = new PerformanceTargetProperty {
                     Level = 123,
                     Status = "status"
                 },
                 PubliclyAccessible = false,
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 Status = "status",
                 SubnetIds = new [] { "subnetIds" },
                 TrackName = "trackName",
                 WorkgroupArn = "workgroupArn",
                 WorkgroupId = "workgroupId",
                 WorkgroupName = "workgroupName"
             };

Synopsis

Constructors

WorkgroupProperty()

The collection of computing resources from which an endpoint is created.

Properties

BaseCapacity	The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
ConfigParameters	An array of parameters to set for advanced control over a database.
CreationDate	The creation date of the workgroup.
Endpoint	The endpoint that is created from the workgroup.
EnhancedVpcRouting	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	The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
NamespaceName	The namespace the workgroup is associated with.
PricePerformanceTarget	An object that represents the price performance target settings for the workgroup.
PubliclyAccessible	A value that specifies whether the workgroup can be accessible from a public network.
SecurityGroupIds	An array of security group IDs to associate with the workgroup.
Status	The status of the workgroup.
SubnetIds	An array of subnet IDs the workgroup is associated with.
TrackName	The name of the track for the workgroup.
WorkgroupArn	The Amazon Resource Name (ARN) that links to the workgroup.
WorkgroupId	The unique identifier of the workgroup.
WorkgroupName	The name of the workgroup.

Constructors

WorkgroupProperty()

The collection of computing resources from which an endpoint is created.

public WorkgroupProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.RedshiftServerless.Mixins;

             var workgroupProperty = new WorkgroupProperty {
                 BaseCapacity = 123,
                 ConfigParameters = new [] { new ConfigParameterProperty {
                     ParameterKey = "parameterKey",
                     ParameterValue = "parameterValue"
                 } },
                 CreationDate = "creationDate",
                 Endpoint = new EndpointProperty {
                     Address = "address",
                     Port = 123,
                     VpcEndpoints = new [] { new VpcEndpointProperty {
                         NetworkInterfaces = new [] { new NetworkInterfaceProperty {
                             AvailabilityZone = "availabilityZone",
                             NetworkInterfaceId = "networkInterfaceId",
                             PrivateIpAddress = "privateIpAddress",
                             SubnetId = "subnetId"
                         } },
                         VpcEndpointId = "vpcEndpointId",
                         VpcId = "vpcId"
                     } }
                 },
                 EnhancedVpcRouting = false,
                 MaxCapacity = 123,
                 NamespaceName = "namespaceName",
                 PricePerformanceTarget = new PerformanceTargetProperty {
                     Level = 123,
                     Status = "status"
                 },
                 PubliclyAccessible = false,
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 Status = "status",
                 SubnetIds = new [] { "subnetIds" },
                 TrackName = "trackName",
                 WorkgroupArn = "workgroupArn",
                 WorkgroupId = "workgroupId",
                 WorkgroupName = "workgroupName"
             };

Properties

BaseCapacity

The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

public double? BaseCapacity { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-basecapacity

ConfigParameters

An array of parameters to set for advanced control over a database.

public object? ConfigParameters { get; set; }

Property Value

object

Remarks

The options are auto_mv , datestyle , enable_case_sensitive_identifier , enable_user_activity_logging , query_group , search_path , require_ssl , use_fips_ssl , and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-configparameters

Type union: either IResolvable or (either IResolvable or CfnWorkgroupPropsMixin.IConfigParameterProperty)[]

CreationDate

The creation date of the workgroup.

public string? CreationDate { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-creationdate

Endpoint

The endpoint that is created from the workgroup.

public object? Endpoint { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-endpoint

Type union: either IResolvable or CfnWorkgroupPropsMixin.IEndpointProperty

EnhancedVpcRouting

The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

public object? EnhancedVpcRouting { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-enhancedvpcrouting

Type union: either bool or IResolvable

MaxCapacity

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.

public double? MaxCapacity { get; set; }

Property Value

double?

Remarks

The max capacity is specified in RPUs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-maxcapacity

NamespaceName

The namespace the workgroup is associated with.

public string? NamespaceName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-namespacename

PricePerformanceTarget

An object that represents the price performance target settings for the workgroup.

public object? PricePerformanceTarget { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-priceperformancetarget

Type union: either IResolvable or CfnWorkgroupPropsMixin.IPerformanceTargetProperty

PubliclyAccessible

A value that specifies whether the workgroup can be accessible from a public network.

public object? PubliclyAccessible { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-publiclyaccessible

Type union: either bool or IResolvable

SecurityGroupIds

An array of security group IDs to associate with the workgroup.

public string[]? SecurityGroupIds { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-securitygroupids

Status

The status of the workgroup.

public string? Status { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-status

SubnetIds

An array of subnet IDs the workgroup is associated with.

public string[]? SubnetIds { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-subnetids

TrackName

The name of the track for the workgroup.

public string? TrackName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-trackname

WorkgroupArn

The Amazon Resource Name (ARN) that links to the workgroup.

public string? WorkgroupArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-workgrouparn

WorkgroupId

The unique identifier of the workgroup.

public string? WorkgroupId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-workgroupid

WorkgroupName

The name of the workgroup.

public string? WorkgroupName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-workgroupname

Implements

CfnWorkgroupPropsMixin.IWorkgroupProperty