Class Cluster
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.redshift.alpha.Cluster
- All Implemented Interfaces:
IResource
,IConnectable
,ICluster
,ISecretAttachmentTarget
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-29T22:54:28.011Z")
@Stability(Experimental)
public class Cluster
extends Resource
implements ICluster
(experimental) Create a Redshift cluster a given number of nodes.
Example:
import software.amazon.awscdk.services.ec2.*; import software.amazon.awscdk.*; Vpc vpc; Cluster cluster = Cluster.Builder.create(this, "Cluster") .masterUser(Login.builder() .masterUsername("admin") .masterPassword(SecretValue.unsafePlainText("tooshort")) .build()) .vpc(vpc) .build(); cluster.addToParameterGroup("enable_user_activity_logging", "true");
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.redshift.alpha.ICluster
ICluster.Jsii$Default, ICluster.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Cluster
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
Cluster
(software.amazon.jsii.JsiiObjectRef objRef) Cluster
(software.constructs.Construct scope, String id, ClusterProps props) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDefaultIamRole
(IRole defaultIamRole) (experimental) Adds default IAM role to cluster.void
addIamRole
(IRole role) (experimental) Adds a role to the cluster.addRotationMultiUser
(String id, RotationMultiUserOptions options) (experimental) Adds the multi user rotation to this cluster.(experimental) Adds the single user rotation of the master password to this cluster.addRotationSingleUser
(Duration automaticallyAfter) (experimental) Adds the single user rotation of the master password to this cluster.void
addToParameterGroup
(String name, String value) (experimental) Adds a parameter to the Clusters' parameter group.(experimental) Renders the secret attachment target specifications.void
(experimental) Enables automatic cluster rebooting when changes to the cluster's parameter group require a restart to apply.static ICluster
fromClusterAttributes
(software.constructs.Construct scope, String id, ClusterAttributes attrs) (experimental) Import an existing DatabaseCluster from properties.(experimental) The endpoint to use for read/write operations.(experimental) Identifier of the cluster.(experimental) Access to the network connections.protected IClusterParameterGroup
(experimental) The cluster's parameter group.(experimental) The secret attached to this cluster.protected void
(experimental) The cluster's parameter group.Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
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.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Cluster
protected Cluster(software.amazon.jsii.JsiiObjectRef objRef) -
Cluster
protected Cluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
Cluster
@Stability(Experimental) public Cluster(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ClusterProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
fromClusterAttributes
@Stability(Experimental) @NotNull public static ICluster fromClusterAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ClusterAttributes attrs) (experimental) Import an existing DatabaseCluster from properties.- Parameters:
scope
- This parameter is required.id
- This parameter is required.attrs
- This parameter is required.
-
addDefaultIamRole
(experimental) Adds default IAM role to cluster.The default IAM role must be already associated to the cluster to be added as the default role.
- Parameters:
defaultIamRole
- the IAM role to be set as the default role. This parameter is required.
-
addIamRole
(experimental) Adds a role to the cluster.- Parameters:
role
- the role to add. This parameter is required.
-
addRotationMultiUser
@Stability(Experimental) @NotNull public SecretRotation addRotationMultiUser(@NotNull String id, @NotNull RotationMultiUserOptions options) (experimental) Adds the multi user rotation to this cluster.- Parameters:
id
- This parameter is required.options
- This parameter is required.
-
addRotationSingleUser
@Stability(Experimental) @NotNull public SecretRotation addRotationSingleUser(@Nullable Duration automaticallyAfter) (experimental) Adds the single user rotation of the master password to this cluster.- Parameters:
automaticallyAfter
- Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
-
addRotationSingleUser
(experimental) Adds the single user rotation of the master password to this cluster. -
addToParameterGroup
@Stability(Experimental) public void addToParameterGroup(@NotNull String name, @NotNull String value) (experimental) Adds a parameter to the Clusters' parameter group.- Parameters:
name
- the parameter name. This parameter is required.value
- the parameter name. This parameter is required.
-
asSecretAttachmentTarget
(experimental) Renders the secret attachment target specifications.- Specified by:
asSecretAttachmentTarget
in interfaceISecretAttachmentTarget
-
enableRebootForParameterChanges
@Stability(Experimental) public void enableRebootForParameterChanges()(experimental) Enables automatic cluster rebooting when changes to the cluster's parameter group require a restart to apply. -
getClusterEndpoint
(experimental) The endpoint to use for read/write operations.- Specified by:
getClusterEndpoint
in interfaceICluster
-
getClusterName
(experimental) Identifier of the cluster.- Specified by:
getClusterName
in interfaceICluster
-
getConnections
(experimental) Access to the network connections.- Specified by:
getConnections
in interfaceIConnectable
-
getSecret
(experimental) The secret attached to this cluster. -
getParameterGroup
(experimental) The cluster's parameter group. -
setParameterGroup
(experimental) The cluster's parameter group.
-