Class CfnWorkgroup
A CloudFormation AWS::RedshiftServerless::Workgroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.RedshiftServerless
Assembly: Amazon.CDK.AWS.RedshiftServerless.dll
Syntax (csharp)
public class CfnWorkgroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnWorkgroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The collection of compute resources in Amazon Redshift Serverless.
CloudformationResource: AWS::RedshiftServerless::Workgroup
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 cfnWorkgroup = new CfnWorkgroup(this, "MyCfnWorkgroup", new CfnWorkgroupProps {
WorkgroupName = "workgroupName",
// the properties below are optional
BaseCapacity = 123,
ConfigParameters = new [] { new ConfigParameterProperty {
ParameterKey = "parameterKey",
ParameterValue = "parameterValue"
} },
EnhancedVpcRouting = false,
NamespaceName = "namespaceName",
Port = 123,
PubliclyAccessible = false,
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnWorkgroup(Construct, String, ICfnWorkgroupProps) | Create a new |
CfnWorkgroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnWorkgroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrWorkgroupBaseCapacity | The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs). |
AttrWorkgroupConfigParameters | |
AttrWorkgroupCreationDate | The creation date of the workgroup. |
AttrWorkgroupEndpointAddress | The DNS address of the VPC endpoint. |
AttrWorkgroupEndpointPort | The custom port to use when connecting to a workgroup. |
AttrWorkgroupEndpointVpcEndpoints | |
AttrWorkgroupEnhancedVpcRouting | The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. |
AttrWorkgroupNamespaceName | The namespace the workgroup is associated with. |
AttrWorkgroupPubliclyAccessible | A value that specifies whether the workgroup can be accessible from a public network. |
AttrWorkgroupSecurityGroupIds | An array of security group IDs to associate with the workgroup. |
AttrWorkgroupStatus | The status of the workgroup. |
AttrWorkgroupSubnetIds | An array of subnet IDs the workgroup is associated with. |
AttrWorkgroupWorkgroupArn | The Amazon Resource Name (ARN) that links to the workgroup. |
AttrWorkgroupWorkgroupId | The unique identifier of the workgroup. |
AttrWorkgroupWorkgroupName | The name of the workgroup. |
BaseCapacity | The base compute capacity of the workgroup in Redshift Processing Units (RPUs). |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConfigParameters | A list of parameters to set for finer control over a database. |
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. |
NamespaceName | The namespace the workgroup is associated with. |
Port | The custom port to use when connecting to a workgroup. |
PubliclyAccessible | A value that specifies whether the workgroup can be accessible from a public network. |
SecurityGroupIds | A list of security group IDs to associate with the workgroup. |
SubnetIds | A list of subnet IDs the workgroup is associated with. |
Tags | The map of the key-value pairs used to tag the workgroup. |
WorkgroupName | The name of the workgroup. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnWorkgroup(Construct, String, ICfnWorkgroupProps)
Create a new AWS::RedshiftServerless::Workgroup
.
public CfnWorkgroup(Construct scope, string id, ICfnWorkgroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnWorkgroupProps
- resource properties.
CfnWorkgroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnWorkgroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnWorkgroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnWorkgroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrWorkgroupBaseCapacity
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
public virtual double AttrWorkgroupBaseCapacity { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: Workgroup.BaseCapacity
AttrWorkgroupConfigParameters
public virtual IResolvable AttrWorkgroupConfigParameters { get; }
Property Value
Remarks
CloudformationAttribute: Workgroup.ConfigParameters
AttrWorkgroupCreationDate
The creation date of the workgroup.
public virtual string AttrWorkgroupCreationDate { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Workgroup.CreationDate
AttrWorkgroupEndpointAddress
The DNS address of the VPC endpoint.
public virtual string AttrWorkgroupEndpointAddress { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Workgroup.Endpoint.Address
AttrWorkgroupEndpointPort
The custom port to use when connecting to a workgroup.
public virtual double AttrWorkgroupEndpointPort { get; }
Property Value
System.Double
Remarks
Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
CloudformationAttribute: Workgroup.Endpoint.Port
AttrWorkgroupEndpointVpcEndpoints
public virtual IResolvable AttrWorkgroupEndpointVpcEndpoints { get; }
Property Value
Remarks
CloudformationAttribute: Workgroup.Endpoint.VpcEndpoints
AttrWorkgroupEnhancedVpcRouting
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 virtual IResolvable AttrWorkgroupEnhancedVpcRouting { get; }
Property Value
Remarks
CloudformationAttribute: Workgroup.EnhancedVpcRouting
AttrWorkgroupNamespaceName
The namespace the workgroup is associated with.
public virtual string AttrWorkgroupNamespaceName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Workgroup.NamespaceName
AttrWorkgroupPubliclyAccessible
A value that specifies whether the workgroup can be accessible from a public network.
public virtual IResolvable AttrWorkgroupPubliclyAccessible { get; }
Property Value
Remarks
CloudformationAttribute: Workgroup.PubliclyAccessible
AttrWorkgroupSecurityGroupIds
An array of security group IDs to associate with the workgroup.
public virtual string[] AttrWorkgroupSecurityGroupIds { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: Workgroup.SecurityGroupIds
AttrWorkgroupStatus
The status of the workgroup.
public virtual string AttrWorkgroupStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Workgroup.Status
AttrWorkgroupSubnetIds
An array of subnet IDs the workgroup is associated with.
public virtual string[] AttrWorkgroupSubnetIds { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: Workgroup.SubnetIds
AttrWorkgroupWorkgroupArn
The Amazon Resource Name (ARN) that links to the workgroup.
public virtual string AttrWorkgroupWorkgroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Workgroup.WorkgroupArn
AttrWorkgroupWorkgroupId
The unique identifier of the workgroup.
public virtual string AttrWorkgroupWorkgroupId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Workgroup.WorkgroupId
AttrWorkgroupWorkgroupName
The name of the workgroup.
public virtual string AttrWorkgroupWorkgroupName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Workgroup.WorkgroupName
BaseCapacity
The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
public virtual Nullable<double> BaseCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConfigParameters
A list of parameters to set for finer control over a database.
public virtual object ConfigParameters { get; set; }
Property Value
System.Object
Remarks
Available options are datestyle
, enable_user_activity_logging
, query_group
, search_path
, and max_query_execution_time
.
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 virtual object EnhancedVpcRouting { get; set; }
Property Value
System.Object
Remarks
NamespaceName
The namespace the workgroup is associated with.
public virtual string NamespaceName { get; set; }
Property Value
System.String
Remarks
Port
The custom port to use when connecting to a workgroup.
public virtual Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
PubliclyAccessible
A value that specifies whether the workgroup can be accessible from a public network.
public virtual object PubliclyAccessible { get; set; }
Property Value
System.Object
Remarks
SecurityGroupIds
A list of security group IDs to associate with the workgroup.
public virtual string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
Remarks
SubnetIds
A list of subnet IDs the workgroup is associated with.
public virtual string[] SubnetIds { get; set; }
Property Value
System.String[]
Remarks
Tags
The map of the key-value pairs used to tag the workgroup.
public virtual TagManager Tags { get; }
Property Value
Remarks
WorkgroupName
The name of the workgroup.
public virtual string WorkgroupName { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>