Interface ICfnClusterProps
Properties for defining a CfnCluster
.
Namespace: Amazon.CDK.AWS.Redshift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnClusterProps
Syntax (vb)
Public Interface ICfnClusterProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html
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 cfnClusterProps = 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",
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
Properties
AllowVersionUpgrade | If |
AquaConfigurationStatus | This parameter is retired. |
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. |
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. When cluster type is specified as. |
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 | A list of tag instances. |
VpcSecurityGroupIds | A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. |
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.
virtual object AllowVersionUpgrade { get; }
Property Value
System.Object
Remarks
When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
AquaConfigurationStatus
This parameter is retired.
virtual string AquaConfigurationStatus { get; }
Property Value
System.String
Remarks
It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AutomatedSnapshotRetentionPeriod
The number of days that automated snapshots are retained.
virtual Nullable<double> AutomatedSnapshotRetentionPeriod { get; }
Property Value
System.Nullable<System.Double>
Remarks
If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot in the Amazon Redshift API Reference .
Default: 1
Constraints: Must be a value from 0 to 35.
AvailabilityZone
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
virtual string AvailabilityZone { get; }
Property Value
System.String
Remarks
For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
AvailabilityZoneRelocation
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
virtual object AvailabilityZoneRelocation { get; }
Property Value
System.Object
Remarks
AvailabilityZoneRelocationStatus
Describes the status of the Availability Zone relocation operation.
virtual string AvailabilityZoneRelocationStatus { get; }
Property Value
System.String
Remarks
Classic
A boolean value indicating whether the resize operation is using the classic resize process.
virtual object Classic { get; }
Property Value
System.Object
Remarks
If you don't provide this parameter or set the value to false
, the resize type is elastic.
ClusterIdentifier
A unique identifier for the cluster.
virtual string ClusterIdentifier { get; }
Property Value
System.String
Remarks
You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Example: myexamplecluster
ClusterParameterGroupName
The name of the parameter group to be associated with this cluster.
virtual string ClusterParameterGroupName { get; }
Property Value
System.String
Remarks
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
ClusterSecurityGroups
A list of security groups to be associated with this cluster.
virtual string[] ClusterSecurityGroups { get; }
Property Value
System.String[]
Remarks
Default: The default cluster security group for Amazon Redshift.
ClusterSubnetGroupName
The name of a cluster subnet group to be associated with this cluster.
virtual string ClusterSubnetGroupName { get; }
Property Value
System.String
Remarks
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
ClusterType
The type of the cluster. When cluster type is specified as.
string ClusterType { get; }
Property Value
System.String
Remarks
Valid Values: multi-node
| single-node
Default: multi-node
ClusterVersion
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
virtual string ClusterVersion { get; }
Property Value
System.String
Remarks
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
DbName
The name of the first database to be created when the cluster is created.
string DbName { get; }
Property Value
System.String
Remarks
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
DeferMaintenance
A Boolean indicating whether to enable the deferred maintenance window.
virtual object DeferMaintenance { get; }
Property Value
System.Object
Remarks
DeferMaintenanceDuration
An integer indicating the duration of the maintenance window in days.
virtual Nullable<double> DeferMaintenanceDuration { get; }
Property Value
System.Nullable<System.Double>
Remarks
If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
DeferMaintenanceEndTime
A timestamp for the end of the time period when we defer maintenance.
virtual string DeferMaintenanceEndTime { get; }
Property Value
System.String
Remarks
DeferMaintenanceStartTime
A timestamp indicating the start time for the deferred maintenance window.
virtual string DeferMaintenanceStartTime { get; }
Property Value
System.String
Remarks
DestinationRegion
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
virtual string DestinationRegion { get; }
Property Value
System.String
Remarks
ElasticIp
The Elastic IP (EIP) address for the cluster.
virtual string ElasticIp { get; }
Property Value
System.String
Remarks
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
Encrypted
If true
, the data in the cluster is encrypted at rest.
virtual object Encrypted { get; }
Property Value
System.Object
Remarks
Endpoint
The connection endpoint.
virtual object Endpoint { get; }
Property Value
System.Object
Remarks
EnhancedVpcRouting
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
virtual object EnhancedVpcRouting { get; }
Property Value
System.Object
Remarks
To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
HsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
virtual string HsmClientCertificateIdentifier { get; }
Property Value
System.String
Remarks
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.
virtual string HsmConfigurationIdentifier { get; }
Property Value
System.String
Remarks
IamRoles
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
virtual string[] IamRoles { get; }
Property Value
System.String[]
Remarks
You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide .
KmsKeyId
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
virtual string KmsKeyId { get; }
Property Value
System.String
Remarks
LoggingProperties
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
virtual object LoggingProperties { get; }
Property Value
System.Object
Remarks
MaintenanceTrackName
An optional parameter for the name of the maintenance track for the cluster.
virtual string MaintenanceTrackName { get; }
Property Value
System.String
Remarks
If you don't provide a maintenance track name, the cluster is assigned to the current
track.
ManageMasterPassword
If true
, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.
virtual object ManageMasterPassword { get; }
Property Value
System.Object
Remarks
You can't use MasterUserPassword
if ManageMasterPassword
is true. If ManageMasterPassword
is false or not set, Amazon Redshift uses MasterUserPassword
for the admin user account's password.
ManualSnapshotRetentionPeriod
The default number of days to retain a manual snapshot.
virtual Nullable<double> ManualSnapshotRetentionPeriod { get; }
Property Value
System.Nullable<System.Double>
Remarks
If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
MasterPasswordSecretKmsKeyId
The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
virtual string MasterPasswordSecretKmsKeyId { get; }
Property Value
System.String
Remarks
You can only use this parameter if ManageMasterPassword
is true.
MasterUsername
The user name associated with the admin user account for the cluster that is being created.
string MasterUsername { get; }
Property Value
System.String
Remarks
MasterUserPassword
The password associated with the admin user account for the cluster that is being created.
virtual string MasterUserPassword { get; }
Property Value
System.String
Remarks
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
Constraints:
MultiAz
A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.
virtual object MultiAz { get; }
Property Value
System.Object
Remarks
NamespaceResourcePolicy
The policy that is attached to a resource.
virtual object NamespaceResourcePolicy { get; }
Property Value
System.Object
Remarks
NodeType
The node type to be provisioned for the cluster.
string NodeType { get; }
Property Value
System.String
Remarks
For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .
Valid Values: ds2.xlarge
| ds2.8xlarge
| dc1.large
| dc1.8xlarge
| dc2.large
| dc2.8xlarge
| ra3.xlplus
| ra3.4xlarge
| ra3.16xlarge
NumberOfNodes
The number of compute nodes in the cluster.
virtual Nullable<double> NumberOfNodes { get; }
Property Value
System.Nullable<System.Double>
Remarks
This parameter is required when the ClusterType parameter is specified as multi-node
.
For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default: 1
Constraints: Value must be at least 1 and no more than 100.
OwnerAccount
The AWS account used to create or copy the snapshot.
virtual string OwnerAccount { get; }
Property Value
System.String
Remarks
Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
Port
The port number on which the cluster accepts incoming connections.
virtual Nullable<double> Port { get; }
Property Value
System.Nullable<System.Double>
Remarks
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values:
PreferredMaintenanceWindow
The weekly time range (in UTC) during which automated cluster maintenance can occur.
virtual string PreferredMaintenanceWindow { get; }
Property Value
System.String
Remarks
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
PubliclyAccessible
If true
, the cluster can be accessed from a public network.
virtual object PubliclyAccessible { get; }
Property Value
System.Object
Remarks
ResourceAction
The Amazon Redshift operation to be performed.
virtual string ResourceAction { get; }
Property Value
System.String
Remarks
Supported operations are pause-cluster
, resume-cluster
, and failover-primary-compute
.
RevisionTarget
Describes a RevisionTarget
object.
virtual string RevisionTarget { get; }
Property Value
System.String
Remarks
RotateEncryptionKey
Rotates the encryption keys for a cluster.
virtual object RotateEncryptionKey { get; }
Property Value
System.Object
Remarks
SnapshotClusterIdentifier
The name of the cluster the source snapshot was created from.
virtual string SnapshotClusterIdentifier { get; }
Property Value
System.String
Remarks
This parameter is required if your user or role has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
SnapshotCopyGrantName
The name of the snapshot copy grant.
virtual string SnapshotCopyGrantName { get; }
Property Value
System.String
Remarks
SnapshotCopyManual
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
virtual object SnapshotCopyManual { get; }
Property Value
System.Object
Remarks
SnapshotCopyRetentionPeriod
The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .
virtual Nullable<double> SnapshotCopyRetentionPeriod { get; }
Property Value
System.Nullable<System.Double>
Remarks
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region , Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual
option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
SnapshotIdentifier
The name of the snapshot from which to create the new cluster.
virtual string SnapshotIdentifier { get; }
Property Value
System.String
Remarks
This parameter isn't case sensitive. You must specify this parameter or snapshotArn
, but not both.
Example: my-snapshot-id
Tags
VpcSecurityGroupIds
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
virtual string[] VpcSecurityGroupIds { get; }
Property Value
System.String[]
Remarks
Default: The default VPC security group is associated with the cluster.