software.amazon.awscdk.services.redshiftserverless

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.553Z")
 @Stability(value=Stable)
public class CfnWorkgroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RedshiftServerless::Workgroup`.

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)
         .namespaceName("namespaceName")
         .publiclyAccessible(false)
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnWorkgroup.Builder A fluent builder for CfnWorkgroup.
static interface	CfnWorkgroup.ConfigParameterProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnWorkgroup(software.constructs.Construct scope, String id, CfnWorkgroupProps props) Create a new `AWS::RedshiftServerless::Workgroup`.
protected	CfnWorkgroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkgroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Number	getBaseCapacity() `AWS::RedshiftServerless::Workgroup.BaseCapacity`.
protected Map<String,Object>	getCfnProperties()
Object	getConfigParameters() `AWS::RedshiftServerless::Workgroup.ConfigParameters`.
Object	getEnhancedVpcRouting() `AWS::RedshiftServerless::Workgroup.EnhancedVpcRouting`.
String	getNamespaceName() `AWS::RedshiftServerless::Workgroup.NamespaceName`.
Object	getPubliclyAccessible() `AWS::RedshiftServerless::Workgroup.PubliclyAccessible`.
List<String>	getSecurityGroupIds() `AWS::RedshiftServerless::Workgroup.SecurityGroupIds`.
List<String>	getSubnetIds() `AWS::RedshiftServerless::Workgroup.SubnetIds`.
TagManager	getTags() `AWS::RedshiftServerless::Workgroup.Tags`.
String	getWorkgroupName() `AWS::RedshiftServerless::Workgroup.WorkgroupName`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBaseCapacity(Number value) `AWS::RedshiftServerless::Workgroup.BaseCapacity`.
void	setConfigParameters(IResolvable value) `AWS::RedshiftServerless::Workgroup.ConfigParameters`.
void	setConfigParameters(List<Object> value) `AWS::RedshiftServerless::Workgroup.ConfigParameters`.
void	setEnhancedVpcRouting(Boolean value) `AWS::RedshiftServerless::Workgroup.EnhancedVpcRouting`.
void	setEnhancedVpcRouting(IResolvable value) `AWS::RedshiftServerless::Workgroup.EnhancedVpcRouting`.
void	setNamespaceName(String value) `AWS::RedshiftServerless::Workgroup.NamespaceName`.
void	setPubliclyAccessible(Boolean value) `AWS::RedshiftServerless::Workgroup.PubliclyAccessible`.
void	setPubliclyAccessible(IResolvable value) `AWS::RedshiftServerless::Workgroup.PubliclyAccessible`.
void	setSecurityGroupIds(List<String> value) `AWS::RedshiftServerless::Workgroup.SecurityGroupIds`.
void	setSubnetIds(List<String> value) `AWS::RedshiftServerless::Workgroup.SubnetIds`.
void	setWorkgroupName(String value) `AWS::RedshiftServerless::Workgroup.WorkgroupName`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnWorkgroup

protected CfnWorkgroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnWorkgroup

protected CfnWorkgroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnWorkgroup

@Stability(value=Stable)
public CfnWorkgroup(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnWorkgroupProps props)

Create a new `AWS::RedshiftServerless::Workgroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::RedshiftServerless::Workgroup.Tags`.

getWorkgroupName

@Stability(value=Stable)
 @NotNull
public String getWorkgroupName()

`AWS::RedshiftServerless::Workgroup.WorkgroupName`.

setWorkgroupName

@Stability(value=Stable)
public void setWorkgroupName(@NotNull
                                                      String value)

`AWS::RedshiftServerless::Workgroup.WorkgroupName`.

getBaseCapacity

@Stability(value=Stable)
 @Nullable
public Number getBaseCapacity()

`AWS::RedshiftServerless::Workgroup.BaseCapacity`.

setBaseCapacity

@Stability(value=Stable)
public void setBaseCapacity(@Nullable
                                                     Number value)

`AWS::RedshiftServerless::Workgroup.BaseCapacity`.

getConfigParameters

@Stability(value=Stable)
 @Nullable
public Object getConfigParameters()

`AWS::RedshiftServerless::Workgroup.ConfigParameters`.

setConfigParameters

@Stability(value=Stable)
public void setConfigParameters(@Nullable
                                                         IResolvable value)

`AWS::RedshiftServerless::Workgroup.ConfigParameters`.

setConfigParameters

@Stability(value=Stable)
public void setConfigParameters(@Nullable
                                                         List<Object> value)

`AWS::RedshiftServerless::Workgroup.ConfigParameters`.

getEnhancedVpcRouting

@Stability(value=Stable)
 @Nullable
public Object getEnhancedVpcRouting()

`AWS::RedshiftServerless::Workgroup.EnhancedVpcRouting`.

setEnhancedVpcRouting

@Stability(value=Stable)
public void setEnhancedVpcRouting(@Nullable
                                                           Boolean value)

`AWS::RedshiftServerless::Workgroup.EnhancedVpcRouting`.

setEnhancedVpcRouting

@Stability(value=Stable)
public void setEnhancedVpcRouting(@Nullable
                                                           IResolvable value)

`AWS::RedshiftServerless::Workgroup.EnhancedVpcRouting`.

getNamespaceName

@Stability(value=Stable)
 @Nullable
public String getNamespaceName()

`AWS::RedshiftServerless::Workgroup.NamespaceName`.

setNamespaceName

@Stability(value=Stable)
public void setNamespaceName(@Nullable
                                                      String value)

`AWS::RedshiftServerless::Workgroup.NamespaceName`.

getPubliclyAccessible

@Stability(value=Stable)
 @Nullable
public Object getPubliclyAccessible()

`AWS::RedshiftServerless::Workgroup.PubliclyAccessible`.

setPubliclyAccessible

@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           Boolean value)

`AWS::RedshiftServerless::Workgroup.PubliclyAccessible`.

setPubliclyAccessible

@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           IResolvable value)

`AWS::RedshiftServerless::Workgroup.PubliclyAccessible`.

getSecurityGroupIds

@Stability(value=Stable)
 @Nullable
public List<String> getSecurityGroupIds()

`AWS::RedshiftServerless::Workgroup.SecurityGroupIds`.

setSecurityGroupIds

@Stability(value=Stable)
public void setSecurityGroupIds(@Nullable
                                                         List<String> value)

`AWS::RedshiftServerless::Workgroup.SecurityGroupIds`.

getSubnetIds

@Stability(value=Stable)
 @Nullable
public List<String> getSubnetIds()

`AWS::RedshiftServerless::Workgroup.SubnetIds`.

setSubnetIds

@Stability(value=Stable)
public void setSubnetIds(@Nullable
                                                  List<String> value)

`AWS::RedshiftServerless::Workgroup.SubnetIds`.