Interface CfnWorkgroupProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnWorkgroupProps.Jsii$Proxy
CfnWorkgroup.
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.*;
CfnWorkgroupProps cfnWorkgroupProps = CfnWorkgroupProps.builder()
.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)
.pricePerformanceTarget(PerformanceTargetProperty.builder()
.level(123)
.status("status")
.build())
.publiclyAccessible(false)
.recoveryPointId("recoveryPointId")
.securityGroupIds(List.of("securityGroupIds"))
.snapshotArn("snapshotArn")
.snapshotName("snapshotName")
.snapshotOwnerAccount("snapshotOwnerAccount")
.subnetIds(List.of("subnetIds"))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.trackName("trackName")
.workgroup(WorkgroupProperty.builder()
.baseCapacity(123)
.configParameters(List.of(ConfigParameterProperty.builder()
.parameterKey("parameterKey")
.parameterValue("parameterValue")
.build()))
.creationDate("creationDate")
.endpoint(EndpointProperty.builder()
.address("address")
.port(123)
.vpcEndpoints(List.of(VpcEndpointProperty.builder()
.networkInterfaces(List.of(NetworkInterfaceProperty.builder()
.availabilityZone("availabilityZone")
.networkInterfaceId("networkInterfaceId")
.privateIpAddress("privateIpAddress")
.subnetId("subnetId")
.build()))
.vpcEndpointId("vpcEndpointId")
.vpcId("vpcId")
.build()))
.build())
.enhancedVpcRouting(false)
.maxCapacity(123)
.namespaceName("namespaceName")
.pricePerformanceTarget(PerformanceTargetProperty.builder()
.level(123)
.status("status")
.build())
.publiclyAccessible(false)
.securityGroupIds(List.of("securityGroupIds"))
.status("status")
.subnetIds(List.of("subnetIds"))
.trackName("trackName")
.workgroupArn("workgroupArn")
.workgroupId("workgroupId")
.workgroupName("workgroupName")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnWorkgroupPropsstatic final classAn implementation forCfnWorkgroupProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnWorkgroupProps.Builderbuilder()default NumberThe base compute capacity of the workgroup in Redshift Processing Units (RPUs).default ObjectThe key of the parameter.default ObjectThe value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.default NumberThe maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.default StringThe namespace the workgroup is associated with.default NumbergetPort()The custom port to use when connecting to a workgroup.default ObjectAn object that represents the price performance target settings for the workgroup.default ObjectA value that specifies whether the workgroup can be accessible from a public network.default StringThe recovery point id to restore from.A list of security group IDs to associate with the workgroup.default StringThe Amazon Resource Name (ARN) of the snapshot to restore from.default StringThe snapshot name to restore from.default StringThe Amazon Web Services account that owns the snapshot.A list of subnet IDs the workgroup is associated with.getTags()The map of the key-value pairs used to tag the workgroup.default StringAn optional parameter for the name of the track for the workgroup.default ObjectThe collection of computing resources from which an endpoint is created.The name of the workgroup.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getWorkgroupName
The name of the workgroup.- See Also:
-
getBaseCapacity
The base compute capacity of the workgroup in Redshift Processing Units (RPUs).- See Also:
-
getConfigParameters
The key of the parameter.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 .Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnWorkgroup.ConfigParameterProperty>- See Also:
-
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.Returns union: either
BooleanorIResolvableDefault: - false
- See Also:
-
getMaxCapacity
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.The max capacity is specified in RPUs.
- See Also:
-
getNamespaceName
The namespace the workgroup is associated with.- See Also:
-
getPort
The custom port to use when connecting to a workgroup.Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
- See Also:
-
getPricePerformanceTarget
An object that represents the price performance target settings for the workgroup.Returns union: either
IResolvableorCfnWorkgroup.PerformanceTargetProperty- See Also:
-
getPubliclyAccessible
A value that specifies whether the workgroup can be accessible from a public network.Returns union: either
BooleanorIResolvableDefault: - false
- See Also:
-
getRecoveryPointId
The recovery point id to restore from.- See Also:
-
getSecurityGroupIds
A list of security group IDs to associate with the workgroup.Returns union: Listinvalid input: '<'either
StringorISecurityGroupRef>- See Also:
-
getSnapshotArn
The Amazon Resource Name (ARN) of the snapshot to restore from.- See Also:
-
getSnapshotName
The snapshot name to restore from.- See Also:
-
getSnapshotOwnerAccount
The Amazon Web Services account that owns the snapshot.- See Also:
-
getSubnetIds
A list of subnet IDs the workgroup is associated with.Returns union: Listinvalid input: '<'either
StringorISubnetRef>- See Also:
-
getTags
The map of the key-value pairs used to tag the workgroup.- See Also:
-
getTrackName
An optional parameter for the name of the track for the workgroup.If you don't provide a track name, the workgroup is assigned to the current track.
- See Also:
-
getWorkgroup
The collection of computing resources from which an endpoint is created.Returns union: either
IResolvableorCfnWorkgroup.WorkgroupProperty- See Also:
-
builder
- Returns:
- a
CfnWorkgroupProps.BuilderofCfnWorkgroupProps
-