Package software.amazon.awscdk.services.redshiftserverless

Interface CfnWorkgroup.WorkgroupProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkgroup.WorkgroupProperty.Jsii$Proxy

Enclosing class:

CfnWorkgroup

@Stability(Stable)
public static interface CfnWorkgroup.WorkgroupProperty
extends software.amazon.jsii.JsiiSerializable

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

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.*;
 WorkgroupProperty workgroupProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkgroup.WorkgroupProperty.Builder	A builder for CfnWorkgroup.WorkgroupProperty
static final class	CfnWorkgroup.WorkgroupProperty.Jsii$Proxy	An implementation for CfnWorkgroup.WorkgroupProperty

Method Summary

Modifier and Type	Method	Description
static CfnWorkgroup.WorkgroupProperty.Builder	builder()
default Number	getBaseCapacity()	The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
default Object	getConfigParameters()	An array of parameters to set for advanced control over a database.
default String	getCreationDate()	The creation date of the workgroup.
default Object	getEndpoint()	The endpoint that is created from the workgroup.
default Object	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.
default Number	getMaxCapacity()	The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
default String	getNamespaceName()	The namespace the workgroup is associated with.
default Object	getPricePerformanceTarget()	An object that represents the price performance target settings for the workgroup.
default Object	getPubliclyAccessible()	A value that specifies whether the workgroup can be accessible from a public network.
default List<String>	getSecurityGroupIds()	An array of security group IDs to associate with the workgroup.
default String	getStatus()	The status of the workgroup.
default List<String>	getSubnetIds()	An array of subnet IDs the workgroup is associated with.
default String	getTrackName()	The name of the track for the workgroup.
default String	getWorkgroupArn()	The Amazon Resource Name (ARN) that links to the workgroup.
default String	getWorkgroupId()	The unique identifier of the workgroup.
default String	getWorkgroupName()	The name of the workgroup.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBaseCapacity

@Stability(Stable)
@Nullable
default Number getBaseCapacity()

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

See Also:

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

getConfigParameters

@Stability(Stable)
@Nullable
default Object getConfigParameters()

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

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 IResolvable or Listinvalid input: '<'either IResolvable or CfnWorkgroup.ConfigParameterProperty>

See Also:

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

getCreationDate

@Stability(Stable)
@Nullable
default String getCreationDate()

The creation date of the workgroup.

See Also:

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

getEndpoint

@Stability(Stable)
@Nullable
default Object getEndpoint()

The endpoint that is created from the workgroup.

Returns union: either IResolvable or CfnWorkgroup.EndpointProperty

See Also:

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

getEnhancedVpcRouting

@Stability(Stable)
@Nullable
default Object 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 Boolean or IResolvable

See Also:

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

getMaxCapacity

@Stability(Stable)
@Nullable
default Number getMaxCapacity()

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

The max capacity is specified in RPUs.

See Also:

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

getNamespaceName

@Stability(Stable)
@Nullable
default String getNamespaceName()

The namespace the workgroup is associated with.

See Also:

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

getPricePerformanceTarget

@Stability(Stable)
@Nullable
default Object getPricePerformanceTarget()

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

Returns union: either IResolvable or CfnWorkgroup.PerformanceTargetProperty

See Also:

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

getPubliclyAccessible

@Stability(Stable)
@Nullable
default Object getPubliclyAccessible()

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

Returns union: either Boolean or IResolvable

See Also:

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

getSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getSecurityGroupIds()

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

See Also:

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

The status of the workgroup.

See Also:

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

getSubnetIds

@Stability(Stable)
@Nullable
default List<String> getSubnetIds()

An array of subnet IDs the workgroup is associated with.

See Also:

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

getTrackName

@Stability(Stable)
@Nullable
default String getTrackName()

The name of the track for the workgroup.

See Also:

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

getWorkgroupArn

@Stability(Stable)
@Nullable
default String getWorkgroupArn()

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

See Also:

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

getWorkgroupId

@Stability(Stable)
@Nullable
default String getWorkgroupId()

The unique identifier of the workgroup.

See Also:

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

getWorkgroupName

@Stability(Stable)
@Nullable
default String getWorkgroupName()

The name of the workgroup.

See Also:

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

builder

@Stability(Stable)
static CfnWorkgroup.WorkgroupProperty.Builder builder()

Returns:

a CfnWorkgroup.WorkgroupProperty.Builder of CfnWorkgroup.WorkgroupProperty