Class CfnCluster
Specifies a cluster. A cluster is a fully managed data warehouse that consists of a set of compute nodes.
Inherited Members
Namespace: Amazon.CDK.AWS.Redshift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCluster : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnCluster
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html
CloudformationResource: AWS::Redshift::Cluster
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Redshift;
var namespaceResourcePolicy;
var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
ClusterType = "clusterType",
DbName = "dbName",
MasterUsername = "masterUsername",
NodeType = "nodeType",
// the properties below are optional
AllowVersionUpgrade = false,
AquaConfigurationStatus = "aquaConfigurationStatus",
AutomatedSnapshotRetentionPeriod = 123,
AvailabilityZone = "availabilityZone",
AvailabilityZoneRelocation = false,
AvailabilityZoneRelocationStatus = "availabilityZoneRelocationStatus",
Classic = false,
ClusterIdentifier = "clusterIdentifier",
ClusterParameterGroupName = "clusterParameterGroupName",
ClusterSecurityGroups = new [] { "clusterSecurityGroups" },
ClusterSubnetGroupName = "clusterSubnetGroupName",
ClusterVersion = "clusterVersion",
DeferMaintenance = false,
DeferMaintenanceDuration = 123,
DeferMaintenanceEndTime = "deferMaintenanceEndTime",
DeferMaintenanceStartTime = "deferMaintenanceStartTime",
DestinationRegion = "destinationRegion",
ElasticIp = "elasticIp",
Encrypted = false,
Endpoint = new EndpointProperty {
Address = "address",
Port = "port"
},
EnhancedVpcRouting = false,
HsmClientCertificateIdentifier = "hsmClientCertificateIdentifier",
HsmConfigurationIdentifier = "hsmConfigurationIdentifier",
IamRoles = new [] { "iamRoles" },
KmsKeyId = "kmsKeyId",
LoggingProperties = new LoggingPropertiesProperty {
BucketName = "bucketName",
LogDestinationType = "logDestinationType",
LogExports = new [] { "logExports" },
S3KeyPrefix = "s3KeyPrefix"
},
MaintenanceTrackName = "maintenanceTrackName",
ManageMasterPassword = false,
ManualSnapshotRetentionPeriod = 123,
MasterPasswordSecretKmsKeyId = "masterPasswordSecretKmsKeyId",
MasterUserPassword = "masterUserPassword",
MultiAz = false,
NamespaceResourcePolicy = namespaceResourcePolicy,
NumberOfNodes = 123,
OwnerAccount = "ownerAccount",
Port = 123,
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
PubliclyAccessible = false,
ResourceAction = "resourceAction",
RevisionTarget = "revisionTarget",
RotateEncryptionKey = false,
SnapshotClusterIdentifier = "snapshotClusterIdentifier",
SnapshotCopyGrantName = "snapshotCopyGrantName",
SnapshotCopyManual = false,
SnapshotCopyRetentionPeriod = 123,
SnapshotIdentifier = "snapshotIdentifier",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
});
Synopsis
Constructors
CfnCluster(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCluster(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnCluster(Construct, String, ICfnClusterProps) |
Properties
AllowVersionUpgrade | If |
AquaConfigurationStatus | This parameter is retired. |
AttrClusterNamespaceArn | The namespace Amazon Resource Name (ARN) of the cluster. |
AttrDeferMaintenanceIdentifier | A unique identifier for the maintenance window. |
AttrEndpointAddress | The connection endpoint for the Amazon Redshift cluster. |
AttrEndpointPort | The port number on which the Amazon Redshift cluster accepts connections. |
AttrId | |
AttrMasterPasswordSecretArn | The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. |
AutomatedSnapshotRetentionPeriod | The number of days that automated snapshots are retained. |
AvailabilityZone | The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. |
AvailabilityZoneRelocation | The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created. |
AvailabilityZoneRelocationStatus | Describes the status of the Availability Zone relocation operation. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Classic | A boolean value indicating whether the resize operation is using the classic resize process. |
ClusterIdentifier | A unique identifier for the cluster. |
ClusterParameterGroupName | The name of the parameter group to be associated with this cluster. |
ClusterSecurityGroups | A list of security groups to be associated with this cluster. |
ClusterSubnetGroupName | The name of a cluster subnet group to be associated with this cluster. |
ClusterType | The type of the cluster. |
ClusterVersion | The version of the Amazon Redshift engine software that you want to deploy on the cluster. |
DbName | The name of the first database to be created when the cluster is created. |
DeferMaintenance | A Boolean indicating whether to enable the deferred maintenance window. |
DeferMaintenanceDuration | An integer indicating the duration of the maintenance window in days. |
DeferMaintenanceEndTime | A timestamp for the end of the time period when we defer maintenance. |
DeferMaintenanceStartTime | A timestamp indicating the start time for the deferred maintenance window. |
DestinationRegion | The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. |
ElasticIp | The Elastic IP (EIP) address for the cluster. |
Encrypted | If |
Endpoint | The connection endpoint. |
EnhancedVpcRouting | An option that specifies whether to create the cluster with enhanced VPC routing enabled. |
HsmClientCertificateIdentifier | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. |
HsmConfigurationIdentifier | Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. |
IamRoles | A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. |
KmsKeyId | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. |
LoggingProperties | Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. |
MaintenanceTrackName | An optional parameter for the name of the maintenance track for the cluster. |
ManageMasterPassword | If |
ManualSnapshotRetentionPeriod | The default number of days to retain a manual snapshot. |
MasterPasswordSecretKmsKeyId | The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. |
MasterUsername | The user name associated with the admin user account for the cluster that is being created. |
MasterUserPassword | The password associated with the admin user account for the cluster that is being created. |
MultiAz | A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. |
NamespaceResourcePolicy | The policy that is attached to a resource. |
NodeType | The node type to be provisioned for the cluster. |
NumberOfNodes | The number of compute nodes in the cluster. |
OwnerAccount | The AWS account used to create or copy the snapshot. |
Port | The port number on which the cluster accepts incoming connections. |
PreferredMaintenanceWindow | The weekly time range (in UTC) during which automated cluster maintenance can occur. |
PubliclyAccessible | If |
ResourceAction | The Amazon Redshift operation to be performed. |
RevisionTarget | Describes a |
RotateEncryptionKey | Rotates the encryption keys for a cluster. |
SnapshotClusterIdentifier | The name of the cluster the source snapshot was created from. |
SnapshotCopyGrantName | The name of the snapshot copy grant. |
SnapshotCopyManual | Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. |
SnapshotCopyRetentionPeriod | The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region . |
SnapshotIdentifier | The name of the snapshot from which to create the new cluster. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | A list of tag instances. |
VpcSecurityGroupIds | A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCluster(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCluster(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCluster(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCluster(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnCluster(Construct, String, ICfnClusterProps)
public CfnCluster(Construct scope, string id, ICfnClusterProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnClusterProps
Resource properties.
Properties
AllowVersionUpgrade
If true
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
public virtual object AllowVersionUpgrade { get; set; }
Property Value
System.Object
AquaConfigurationStatus
This parameter is retired.
public virtual string AquaConfigurationStatus { get; set; }
Property Value
System.String
AttrClusterNamespaceArn
The namespace Amazon Resource Name (ARN) of the cluster.
public virtual string AttrClusterNamespaceArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ClusterNamespaceArn
AttrDeferMaintenanceIdentifier
A unique identifier for the maintenance window.
public virtual string AttrDeferMaintenanceIdentifier { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DeferMaintenanceIdentifier
AttrEndpointAddress
The connection endpoint for the Amazon Redshift cluster.
public virtual string AttrEndpointAddress { get; }
Property Value
System.String
Remarks
For example: examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com
.
CloudformationAttribute: Endpoint.Address
AttrEndpointPort
The port number on which the Amazon Redshift cluster accepts connections.
public virtual string AttrEndpointPort { get; }
Property Value
System.String
Remarks
For example: 5439
.
CloudformationAttribute: Endpoint.Port
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrMasterPasswordSecretArn
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
public virtual string AttrMasterPasswordSecretArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: MasterPasswordSecretArn
AutomatedSnapshotRetentionPeriod
The number of days that automated snapshots are retained.
public virtual Nullable<double> AutomatedSnapshotRetentionPeriod { get; set; }
Property Value
System.Nullable<System.Double>
AvailabilityZone
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
public virtual string AvailabilityZone { get; set; }
Property Value
System.String
AvailabilityZoneRelocation
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
public virtual object AvailabilityZoneRelocation { get; set; }
Property Value
System.Object
AvailabilityZoneRelocationStatus
Describes the status of the Availability Zone relocation operation.
public virtual string AvailabilityZoneRelocationStatus { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Classic
A boolean value indicating whether the resize operation is using the classic resize process.
public virtual object Classic { get; set; }
Property Value
System.Object
ClusterIdentifier
A unique identifier for the cluster.
public virtual string ClusterIdentifier { get; set; }
Property Value
System.String
ClusterParameterGroupName
The name of the parameter group to be associated with this cluster.
public virtual string ClusterParameterGroupName { get; set; }
Property Value
System.String
ClusterSecurityGroups
A list of security groups to be associated with this cluster.
public virtual string[] ClusterSecurityGroups { get; set; }
Property Value
System.String[]
ClusterSubnetGroupName
The name of a cluster subnet group to be associated with this cluster.
public virtual string ClusterSubnetGroupName { get; set; }
Property Value
System.String
ClusterType
The type of the cluster.
public virtual string ClusterType { get; set; }
Property Value
System.String
Remarks
When cluster type is specified as.
ClusterVersion
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
public virtual string ClusterVersion { get; set; }
Property Value
System.String
DbName
The name of the first database to be created when the cluster is created.
public virtual string DbName { get; set; }
Property Value
System.String
DeferMaintenance
A Boolean indicating whether to enable the deferred maintenance window.
public virtual object DeferMaintenance { get; set; }
Property Value
System.Object
DeferMaintenanceDuration
An integer indicating the duration of the maintenance window in days.
public virtual Nullable<double> DeferMaintenanceDuration { get; set; }
Property Value
System.Nullable<System.Double>
DeferMaintenanceEndTime
A timestamp for the end of the time period when we defer maintenance.
public virtual string DeferMaintenanceEndTime { get; set; }
Property Value
System.String
DeferMaintenanceStartTime
A timestamp indicating the start time for the deferred maintenance window.
public virtual string DeferMaintenanceStartTime { get; set; }
Property Value
System.String
DestinationRegion
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
public virtual string DestinationRegion { get; set; }
Property Value
System.String
ElasticIp
The Elastic IP (EIP) address for the cluster.
public virtual string ElasticIp { get; set; }
Property Value
System.String
Encrypted
If true
, the data in the cluster is encrypted at rest.
public virtual object Encrypted { get; set; }
Property Value
System.Object
Endpoint
The connection endpoint.
public virtual object Endpoint { get; set; }
Property Value
System.Object
EnhancedVpcRouting
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
public virtual object EnhancedVpcRouting { get; set; }
Property Value
System.Object
HsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
public virtual string HsmClientCertificateIdentifier { get; set; }
Property Value
System.String
HsmConfigurationIdentifier
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
public virtual string HsmConfigurationIdentifier { get; set; }
Property Value
System.String
IamRoles
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
public virtual string[] IamRoles { get; set; }
Property Value
System.String[]
KmsKeyId
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
LoggingProperties
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
public virtual object LoggingProperties { get; set; }
Property Value
System.Object
MaintenanceTrackName
An optional parameter for the name of the maintenance track for the cluster.
public virtual string MaintenanceTrackName { get; set; }
Property Value
System.String
ManageMasterPassword
If true
, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.
public virtual object ManageMasterPassword { get; set; }
Property Value
System.Object
ManualSnapshotRetentionPeriod
The default number of days to retain a manual snapshot.
public virtual Nullable<double> ManualSnapshotRetentionPeriod { get; set; }
Property Value
System.Nullable<System.Double>
MasterPasswordSecretKmsKeyId
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
public virtual string MasterPasswordSecretKmsKeyId { get; set; }
Property Value
System.String
MasterUsername
The user name associated with the admin user account for the cluster that is being created.
public virtual string MasterUsername { get; set; }
Property Value
System.String
MasterUserPassword
The password associated with the admin user account for the cluster that is being created.
public virtual string MasterUserPassword { get; set; }
Property Value
System.String
MultiAz
A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.
public virtual object MultiAz { get; set; }
Property Value
System.Object
NamespaceResourcePolicy
The policy that is attached to a resource.
public virtual object NamespaceResourcePolicy { get; set; }
Property Value
System.Object
NodeType
The node type to be provisioned for the cluster.
public virtual string NodeType { get; set; }
Property Value
System.String
NumberOfNodes
The number of compute nodes in the cluster.
public virtual Nullable<double> NumberOfNodes { get; set; }
Property Value
System.Nullable<System.Double>
OwnerAccount
The AWS account used to create or copy the snapshot.
public virtual string OwnerAccount { get; set; }
Property Value
System.String
Port
The port number on which the cluster accepts incoming connections.
public virtual Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
PreferredMaintenanceWindow
The weekly time range (in UTC) during which automated cluster maintenance can occur.
public virtual string PreferredMaintenanceWindow { get; set; }
Property Value
System.String
PubliclyAccessible
If true
, the cluster can be accessed from a public network.
public virtual object PubliclyAccessible { get; set; }
Property Value
System.Object
ResourceAction
The Amazon Redshift operation to be performed.
public virtual string ResourceAction { get; set; }
Property Value
System.String
RevisionTarget
Describes a RevisionTarget
object.
public virtual string RevisionTarget { get; set; }
Property Value
System.String
RotateEncryptionKey
Rotates the encryption keys for a cluster.
public virtual object RotateEncryptionKey { get; set; }
Property Value
System.Object
SnapshotClusterIdentifier
The name of the cluster the source snapshot was created from.
public virtual string SnapshotClusterIdentifier { get; set; }
Property Value
System.String
SnapshotCopyGrantName
The name of the snapshot copy grant.
public virtual string SnapshotCopyGrantName { get; set; }
Property Value
System.String
SnapshotCopyManual
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
public virtual object SnapshotCopyManual { get; set; }
Property Value
System.Object
SnapshotCopyRetentionPeriod
The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .
public virtual Nullable<double> SnapshotCopyRetentionPeriod { get; set; }
Property Value
System.Nullable<System.Double>
SnapshotIdentifier
The name of the snapshot from which to create the new cluster.
public virtual string SnapshotIdentifier { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
VpcSecurityGroupIds
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
public virtual string[] VpcSecurityGroupIds { get; set; }
Property Value
System.String[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>