Interface IClusterProps
(experimental) Properties for a new database cluster.
Namespace: Amazon.CDK.AWS.Redshift
Assembly: Amazon.CDK.AWS.Redshift.dll
Syntax (csharp)
public interface IClusterProps
Syntax (vb)
Public Interface IClusterProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.EC2;
var vpc = new Vpc(this, "Vpc");
var cluster = new Cluster(this, "Redshift", new ClusterProps {
MasterUser = new Login {
MasterUsername = "admin"
},
Vpc = vpc
});
Synopsis
Properties
ClusterName | (experimental) An optional identifier for the cluster. |
ClusterType | (experimental) Settings for the individual instances that are launched. |
DefaultDatabaseName | (experimental) Name of a database which is automatically created inside the cluster. |
Encrypted | (experimental) Whether to enable encryption of data at rest in the cluster. |
EncryptionKey | (experimental) The KMS key to use for encryption of data at rest. |
LoggingBucket | (experimental) Bucket to send logs to. |
LoggingKeyPrefix | (experimental) Prefix used for logging. |
MasterUser | (experimental) Username and password for the administrative user. |
NodeType | (experimental) The node type to be provisioned for the cluster. |
NumberOfNodes | (experimental) Number of compute nodes in the cluster. Only specify this property for multi-node clusters. |
ParameterGroup | (experimental) Additional parameters to pass to the database engine https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html. |
Port | (experimental) What port to listen on. |
PreferredMaintenanceWindow | (experimental) A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). |
PubliclyAccessible | (experimental) Whether to make cluster publicly accessible. |
RemovalPolicy | (experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update. |
Roles | (experimental) A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services. |
SecurityGroups | (experimental) Security group. |
SubnetGroup | (experimental) A cluster subnet group to use with this cluster. |
Vpc | (experimental) The VPC to place the cluster in. |
VpcSubnets | (experimental) Where to place the instances within the VPC. |
Properties
ClusterName
(experimental) An optional identifier for the cluster.
virtual string ClusterName { get; }
Property Value
System.String
Remarks
Default: - A name is automatically generated.
Stability: Experimental
ClusterType
(experimental) Settings for the individual instances that are launched.
virtual Nullable<ClusterType> ClusterType { get; }
Property Value
System.Nullable<ClusterType>
Remarks
Default: {@link ClusterType.MULTI_NODE}
Stability: Experimental
DefaultDatabaseName
(experimental) Name of a database which is automatically created inside the cluster.
virtual string DefaultDatabaseName { get; }
Property Value
System.String
Remarks
Default: - default_db
Stability: Experimental
Encrypted
(experimental) Whether to enable encryption of data at rest in the cluster.
virtual Nullable<bool> Encrypted { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Stability: Experimental
EncryptionKey
(experimental) The KMS key to use for encryption of data at rest.
virtual IKey EncryptionKey { get; }
Property Value
Remarks
Default: - AWS-managed key, if encryption at rest is enabled
Stability: Experimental
LoggingBucket
(experimental) Bucket to send logs to.
virtual IBucket LoggingBucket { get; }
Property Value
Remarks
Logging information includes queries and connection attempts, for the specified Amazon Redshift cluster.
Default: - No Logs
Stability: Experimental
LoggingKeyPrefix
(experimental) Prefix used for logging.
virtual string LoggingKeyPrefix { get; }
Property Value
System.String
Remarks
Default: - no prefix
Stability: Experimental
MasterUser
(experimental) Username and password for the administrative user.
ILogin MasterUser { get; }
Property Value
Remarks
Stability: Experimental
NodeType
(experimental) The node type to be provisioned for the cluster.
virtual Nullable<NodeType> NodeType { get; }
Property Value
System.Nullable<NodeType>
Remarks
Default: {@link NodeType.DC2_LARGE}
Stability: Experimental
NumberOfNodes
(experimental) Number of compute nodes in the cluster. Only specify this property for multi-node clusters.
virtual Nullable<double> NumberOfNodes { get; }
Property Value
System.Nullable<System.Double>
Remarks
Value must be at least 2 and no more than 100.
Default: - 2 if clusterType
is ClusterType.MULTI_NODE, undefined otherwise
Stability: Experimental
ParameterGroup
(experimental) Additional parameters to pass to the database engine https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html.
virtual IClusterParameterGroup ParameterGroup { get; }
Property Value
Remarks
Default: - No parameter group.
Stability: Experimental
Port
(experimental) What port to listen on.
virtual Nullable<double> Port { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - The default for the engine is used.
Stability: Experimental
PreferredMaintenanceWindow
(experimental) A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).
virtual string PreferredMaintenanceWindow { get; }
Property Value
System.String
Remarks
Example: 'Sun:23:45-Mon:00:15'
Default: - 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Stability: Experimental
PubliclyAccessible
(experimental) Whether to make cluster publicly accessible.
virtual Nullable<bool> PubliclyAccessible { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
RemovalPolicy
(experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
virtual Nullable<RemovalPolicy> RemovalPolicy { get; }
Property Value
System.Nullable<RemovalPolicy>
Remarks
Default: RemovalPolicy.RETAIN
Stability: Experimental
Roles
(experimental) A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.
virtual IRole[] Roles { get; }
Property Value
IRole[]
Remarks
Specify a maximum of 10 roles.
Default: - No role is attached to the cluster.
Stability: Experimental
SecurityGroups
(experimental) Security group.
virtual ISecurityGroup[] SecurityGroups { get; }
Property Value
Remarks
Default: - a new security group is created.
Stability: Experimental
SubnetGroup
(experimental) A cluster subnet group to use with this cluster.
virtual IClusterSubnetGroup SubnetGroup { get; }
Property Value
Remarks
Default: - a new subnet group will be created.
Stability: Experimental
Vpc
(experimental) The VPC to place the cluster in.
IVpc Vpc { get; }
Property Value
Remarks
Stability: Experimental
VpcSubnets
(experimental) Where to place the instances within the VPC.
virtual ISubnetSelection VpcSubnets { get; }
Property Value
Remarks
Default: - private subnets
Stability: Experimental