Class CfnWorkgroup
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.redshiftserverless.CfnWorkgroup
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-11T15:56:04.935Z")
@Stability(Stable)
public class CfnWorkgroup
extends CfnResource
implements IInspectable, ITaggable
The collection of compute resources in Amazon Redshift Serverless.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.redshiftserverless.*; CfnWorkgroup cfnWorkgroup = CfnWorkgroup.Builder.create(this, "MyCfnWorkgroup") .workgroupName("workgroupName") // the properties below are optional .baseCapacity(123) .configParameters(List.of(ConfigParameterProperty.builder() .parameterKey("parameterKey") .parameterValue("parameterValue") .build())) .enhancedVpcRouting(false) .maxCapacity(123) .namespaceName("namespaceName") .port(123) .publiclyAccessible(false) .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnWorkgroup
.static interface
A array of parameters to set for more control over a serverless database.static interface
The VPC endpoint object.static interface
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.static interface
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.static interface
The collection of computing resources from which an endpoint is created.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnWorkgroup
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnWorkgroup
(software.amazon.jsii.JsiiObjectRef objRef) CfnWorkgroup
(software.constructs.Construct scope, String id, CfnWorkgroupProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).The creation date of the workgroup.The DNS address of the VPC endpoint.The custom port to use when connecting to a workgroup.The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.The namespace the workgroup is associated with.A value that specifies whether the workgroup can be accessible from a public network.An array of security group IDs to associate with the workgroup.The status of the workgroup.An array of subnet IDs the workgroup is associated with.The Amazon Resource Name (ARN) that links to the workgroup.The unique identifier of the workgroup.The name of the workgroup.The base compute capacity of the workgroup in Redshift Processing Units (RPUs).A list of parameters to set for finer control over a database.The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.The namespace the workgroup is associated with.getPort()
The custom port to use when connecting to a workgroup.A value that specifies whether the workgroup can be accessible from a public network.A list of security group IDs to associate with the workgroup.A list of subnet IDs the workgroup is associated with.getTags()
Tag Manager which manages the tags for this resource.The map of the key-value pairs used to tag the workgroup.The name of the workgroup.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setBaseCapacity
(Number value) The base compute capacity of the workgroup in Redshift Processing Units (RPUs).void
setConfigParameters
(List<Object> value) A list of parameters to set for finer control over a database.void
setConfigParameters
(IResolvable value) A list of parameters to set for finer control over a database.void
setEnhancedVpcRouting
(Boolean value) The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.void
setEnhancedVpcRouting
(IResolvable value) The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.void
setMaxCapacity
(Number value) The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.void
setNamespaceName
(String value) The namespace the workgroup is associated with.void
The custom port to use when connecting to a workgroup.void
setPubliclyAccessible
(Boolean value) A value that specifies whether the workgroup can be accessible from a public network.void
setPubliclyAccessible
(IResolvable value) A value that specifies whether the workgroup can be accessible from a public network.void
setSecurityGroupIds
(List<String> value) A list of security group IDs to associate with the workgroup.void
setSubnetIds
(List<String> value) A list of subnet IDs the workgroup is associated with.void
setTagsRaw
(List<CfnTag> value) The map of the key-value pairs used to tag the workgroup.void
setWorkgroupName
(String value) The name of the workgroup.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnWorkgroup
protected CfnWorkgroup(software.amazon.jsii.JsiiObjectRef objRef) -
CfnWorkgroup
protected CfnWorkgroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnWorkgroup
@Stability(Stable) public CfnWorkgroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWorkgroupProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrWorkgroup
-
getAttrWorkgroupBaseCapacity
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs). -
getAttrWorkgroupConfigParameters
-
getAttrWorkgroupCreationDate
The creation date of the workgroup. -
getAttrWorkgroupEndpoint
-
getAttrWorkgroupEndpointAddress
The DNS address of the VPC endpoint. -
getAttrWorkgroupEndpointPort
The custom port to use when connecting to a workgroup.Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
-
getAttrWorkgroupEndpointVpcEndpoints
-
getAttrWorkgroupEnhancedVpcRouting
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. -
getAttrWorkgroupMaxCapacity
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.The max capacity is specified in RPUs.
-
getAttrWorkgroupNamespaceName
The namespace the workgroup is associated with. -
getAttrWorkgroupPubliclyAccessible
A value that specifies whether the workgroup can be accessible from a public network. -
getAttrWorkgroupSecurityGroupIds
An array of security group IDs to associate with the workgroup. -
getAttrWorkgroupStatus
The status of the workgroup. -
getAttrWorkgroupSubnetIds
An array of subnet IDs the workgroup is associated with. -
getAttrWorkgroupWorkgroupArn
The Amazon Resource Name (ARN) that links to the workgroup. -
getAttrWorkgroupWorkgroupId
The unique identifier of the workgroup. -
getAttrWorkgroupWorkgroupName
The name of the workgroup. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getWorkgroupName
The name of the workgroup. -
setWorkgroupName
The name of the workgroup. -
getBaseCapacity
The base compute capacity of the workgroup in Redshift Processing Units (RPUs). -
setBaseCapacity
The base compute capacity of the workgroup in Redshift Processing Units (RPUs). -
getConfigParameters
A list of parameters to set for finer control over a database. -
setConfigParameters
A list of parameters to set for finer control over a database. -
setConfigParameters
A list of parameters to set for finer control over a database. -
getEnhancedVpcRouting
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. -
setEnhancedVpcRouting
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. -
setEnhancedVpcRouting
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. -
getMaxCapacity
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. -
setMaxCapacity
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. -
getNamespaceName
The namespace the workgroup is associated with. -
setNamespaceName
The namespace the workgroup is associated with. -
getPort
The custom port to use when connecting to a workgroup. -
setPort
The custom port to use when connecting to a workgroup. -
getPubliclyAccessible
A value that specifies whether the workgroup can be accessible from a public network. -
setPubliclyAccessible
A value that specifies whether the workgroup can be accessible from a public network. -
setPubliclyAccessible
A value that specifies whether the workgroup can be accessible from a public network. -
getSecurityGroupIds
A list of security group IDs to associate with the workgroup. -
setSecurityGroupIds
A list of security group IDs to associate with the workgroup. -
getSubnetIds
A list of subnet IDs the workgroup is associated with. -
setSubnetIds
A list of subnet IDs the workgroup is associated with. -
getTagsRaw
The map of the key-value pairs used to tag the workgroup. -
setTagsRaw
The map of the key-value pairs used to tag the workgroup.
-