Class CfnWorkgroupProps

Properties for defining a CfnWorkgroup.

Inheritance

object

CfnWorkgroupProps

Implements

ICfnWorkgroupProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RedshiftServerless

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnWorkgroupProps : ICfnWorkgroupProps

Syntax (vb)

Public Class CfnWorkgroupProps Implements ICfnWorkgroupProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-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.AWS.RedshiftServerless;

             var cfnWorkgroupProps = new CfnWorkgroupProps {
                 WorkgroupName = "workgroupName",

                 // the properties below are optional
                 BaseCapacity = 123,
                 ConfigParameters = new [] { new ConfigParameterProperty {
                     ParameterKey = "parameterKey",
                     ParameterValue = "parameterValue"
                 } },
                 EnhancedVpcRouting = false,
                 MaxCapacity = 123,
                 NamespaceName = "namespaceName",
                 Port = 123,
                 PricePerformanceTarget = new PerformanceTargetProperty {
                     Level = 123,
                     Status = "status"
                 },
                 PubliclyAccessible = false,
                 RecoveryPointId = "recoveryPointId",
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 SnapshotArn = "snapshotArn",
                 SnapshotName = "snapshotName",
                 SnapshotOwnerAccount = "snapshotOwnerAccount",
                 SubnetIds = new [] { "subnetIds" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TrackName = "trackName",
                 Workgroup = 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

CfnWorkgroupProps()

Properties for defining a CfnWorkgroup.

Properties

BaseCapacity	The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
ConfigParameters	The key of the parameter.
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.
Port	The custom port to use when connecting to a workgroup.
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.
RecoveryPointId	The recovery point id to restore from.
SecurityGroupIds	A list of security group IDs to associate with the workgroup.
SnapshotArn	The Amazon Resource Name (ARN) of the snapshot to restore from.
SnapshotName	The snapshot name to restore from.
SnapshotOwnerAccount	The Amazon Web Services account that owns the snapshot.
SubnetIds	A list of subnet IDs the workgroup is associated with.
Tags	The map of the key-value pairs used to tag the workgroup.
TrackName	An optional parameter for the name of the track for the workgroup.
Workgroup	The collection of computing resources from which an endpoint is created.
WorkgroupName	The name of the workgroup.

Constructors

CfnWorkgroupProps()

Properties for defining a CfnWorkgroup.

public CfnWorkgroupProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-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.AWS.RedshiftServerless;

             var cfnWorkgroupProps = new CfnWorkgroupProps {
                 WorkgroupName = "workgroupName",

                 // the properties below are optional
                 BaseCapacity = 123,
                 ConfigParameters = new [] { new ConfigParameterProperty {
                     ParameterKey = "parameterKey",
                     ParameterValue = "parameterValue"
                 } },
                 EnhancedVpcRouting = false,
                 MaxCapacity = 123,
                 NamespaceName = "namespaceName",
                 Port = 123,
                 PricePerformanceTarget = new PerformanceTargetProperty {
                     Level = 123,
                     Status = "status"
                 },
                 PubliclyAccessible = false,
                 RecoveryPointId = "recoveryPointId",
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 SnapshotArn = "snapshotArn",
                 SnapshotName = "snapshotName",
                 SnapshotOwnerAccount = "snapshotOwnerAccount",
                 SubnetIds = new [] { "subnetIds" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TrackName = "trackName",
                 Workgroup = 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 compute 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-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-basecapacity

ConfigParameters

The key of the parameter.

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-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-configparameters

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

Default: - false

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

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-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-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-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-namespacename

Port

The custom port to use when connecting to a workgroup.

public double? Port { get; set; }

Property Value

double?

Remarks

Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

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

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-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-priceperformancetarget

PubliclyAccessible

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

public object? PubliclyAccessible { get; set; }

Property Value

object

Remarks

Default: - false

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

RecoveryPointId

The recovery point id to restore from.

public string? RecoveryPointId { get; set; }

Property Value

string

Remarks

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

SecurityGroupIds

A list 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-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-securitygroupids

SnapshotArn

The Amazon Resource Name (ARN) of the snapshot to restore from.

public string? SnapshotArn { get; set; }

Property Value

string

Remarks

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

SnapshotName

The snapshot name to restore from.

public string? SnapshotName { get; set; }

Property Value

string

Remarks

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

SnapshotOwnerAccount

The Amazon Web Services account that owns the snapshot.

public string? SnapshotOwnerAccount { get; set; }

Property Value

string

Remarks

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

SubnetIds

A list 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-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-subnetids

Tags

The map of the key-value pairs used to tag the workgroup.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

TrackName

An optional parameter for the name of the track for the workgroup.

public string? TrackName { get; set; }

Property Value

string

Remarks

If you don't provide a track name, the workgroup is assigned to the current track.

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

Workgroup

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

public object? Workgroup { get; set; }

Property Value

object

Remarks

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

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-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-workgroupname

Implements

ICfnWorkgroupProps