Class Cluster

(experimental) Create a Redshift cluster a given number of nodes.

Inheritance

object

Resource

Cluster

Implements

ICluster

IResource

IConstruct

IDependable

IConnectable

ISecretAttachmentTarget

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Redshift.Alpha

Assembly: Amazon.CDK.AWS.Redshift.Alpha.dll

Syntax (csharp)

public class Cluster : Resource, ICluster, IResource, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget

Syntax (vb)

Public Class Cluster Inherits Resource Implements ICluster, IResource, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget

Remarks

Stability: Experimental

Resource: AWS::Redshift::Cluster

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.EC2;
             using Amazon.CDK.AWS.IAM;
             Vpc vpc;


             var defaultRole = new Role(this, "DefaultRole", new RoleProps {
                 AssumedBy = new ServicePrincipal("redshift.amazonaws.com")
             });

             new Cluster(this, "Redshift", new ClusterProps {
                 MasterUser = new Login {
                     MasterUsername = "admin"
                 },
                 Vpc = vpc,
                 Roles = new [] { defaultRole },
                 DefaultRole = defaultRole
             });

Synopsis

Constructors

Cluster(Construct, string, IClusterProps)

(experimental) Create a Redshift cluster a given number of nodes.

Properties

ClusterEndpoint	(experimental) The endpoint to use for read/write operations.
ClusterName	(experimental) Identifier of the cluster.
Connections	(experimental) Access to the network connections.
PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.
ParameterGroup	(experimental) The cluster's parameter group.
Secret	(experimental) The secret attached to this cluster.

Methods

AddDefaultIamRole(IRole)	(experimental) Adds default IAM role to cluster.
AddIamRole(IRole)	(experimental) Adds a role to the cluster.
AddRotationMultiUser(string, IRotationMultiUserOptions)	(experimental) Adds the multi user rotation to this cluster.
AddRotationSingleUser(Duration?)	(experimental) Adds the single user rotation of the master password to this cluster.
AddToParameterGroup(string, string)	(experimental) Adds a parameter to the Clusters' parameter group.
AsSecretAttachmentTarget()	(experimental) Renders the secret attachment target specifications.
EnableRebootForParameterChanges()	(experimental) Enables automatic cluster rebooting when changes to the cluster's parameter group require a restart to apply.
FromClusterAttributes(Construct, string, IClusterAttributes)	(experimental) Import an existing DatabaseCluster from properties.

Constructors

Cluster(Construct, string, IClusterProps)

(experimental) Create a Redshift cluster a given number of nodes.

public Cluster(Construct scope, string id, IClusterProps props)

Parameters

scope Construct
id string
props IClusterProps

Remarks

Stability: Experimental

Properties

ClusterEndpoint

(experimental) The endpoint to use for read/write operations.

public virtual Endpoint ClusterEndpoint { get; }

Property Value

Endpoint

Remarks

Stability: Experimental

ClusterName

(experimental) Identifier of the cluster.

public virtual string ClusterName { get; }

Property Value

string

Remarks

Stability: Experimental

Connections

(experimental) Access to the network connections.

public virtual Connections_ Connections { get; }

Property Value

Connections_

Remarks

Stability: Experimental

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Stability: Experimental

ParameterGroup

(experimental) The cluster's parameter group.

protected virtual IClusterParameterGroup? ParameterGroup { get; set; }

Property Value

IClusterParameterGroup

Remarks

Stability: Experimental

Secret

(experimental) The secret attached to this cluster.

public virtual ISecret? Secret { get; }

Property Value

ISecret

Remarks

Stability: Experimental

Methods

AddDefaultIamRole(IRole)

(experimental) Adds default IAM role to cluster.

public virtual void AddDefaultIamRole(IRole defaultIamRole)

Parameters

defaultIamRole IRole: the IAM role to be set as the default role.

Remarks

The default IAM role must be already associated to the cluster to be added as the default role.

Stability: Experimental

AddIamRole(IRole)

(experimental) Adds a role to the cluster.

public virtual void AddIamRole(IRole role)

Parameters

role IRole: the role to add.

Remarks

Stability: Experimental

AddRotationMultiUser(string, IRotationMultiUserOptions)

(experimental) Adds the multi user rotation to this cluster.

public virtual SecretRotation AddRotationMultiUser(string id, IRotationMultiUserOptions options)

Parameters

id string
options IRotationMultiUserOptions

Returns

SecretRotation

Remarks

Stability: Experimental

AddRotationSingleUser(Duration?)

(experimental) Adds the single user rotation of the master password to this cluster.

public virtual SecretRotation AddRotationSingleUser(Duration? automaticallyAfter = null)

Parameters

automaticallyAfter Duration: Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.

Returns

SecretRotation

Remarks

Stability: Experimental

AddToParameterGroup(string, string)

(experimental) Adds a parameter to the Clusters' parameter group.

public virtual void AddToParameterGroup(string name, string value)

Parameters

name string: the parameter name.
value string: the parameter name.

Remarks

Stability: Experimental

AsSecretAttachmentTarget()

(experimental) Renders the secret attachment target specifications.

public virtual ISecretAttachmentTargetProps AsSecretAttachmentTarget()

Returns

ISecretAttachmentTargetProps

Remarks

Stability: Experimental

EnableRebootForParameterChanges()

(experimental) Enables automatic cluster rebooting when changes to the cluster's parameter group require a restart to apply.

public virtual void EnableRebootForParameterChanges()

Remarks

Stability: Experimental

FromClusterAttributes(Construct, string, IClusterAttributes)

(experimental) Import an existing DatabaseCluster from properties.

public static ICluster FromClusterAttributes(Construct scope, string id, IClusterAttributes attrs)

Parameters

scope Construct
id string
attrs IClusterAttributes

Returns

ICluster

Remarks

Stability: Experimental

Implements

ICluster

IResource

Constructs.IConstruct

Constructs.IDependable

IConnectable

ISecretAttachmentTarget