Show / Hide Table of Contents

Class CfnClusterMixinProps

Properties for CfnClusterPropsMixin.

Inheritance
object
CfnClusterMixinProps
Implements
ICfnClusterMixinProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Redshift
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnClusterMixinProps : ICfnClusterMixinProps
Syntax (vb)
Public Class CfnClusterMixinProps Implements ICfnClusterMixinProps
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.CfnPropertyMixins.AWS.Redshift;

             var namespaceResourcePolicy;

             var cfnClusterMixinProps = new CfnClusterMixinProps {
                 AllowVersionUpgrade = false,
                 AquaConfigurationStatus = "aquaConfigurationStatus",
                 AutomatedSnapshotRetentionPeriod = 123,
                 AvailabilityZone = "availabilityZone",
                 AvailabilityZoneRelocation = false,
                 AvailabilityZoneRelocationStatus = "availabilityZoneRelocationStatus",
                 Classic = false,
                 ClusterIdentifier = "clusterIdentifier",
                 ClusterParameterGroupName = "clusterParameterGroupName",
                 ClusterSecurityGroups = new [] { "clusterSecurityGroups" },
                 ClusterSubnetGroupName = "clusterSubnetGroupName",
                 ClusterType = "clusterType",
                 ClusterVersion = "clusterVersion",
                 DbName = "dbName",
                 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",
                 MasterUsername = "masterUsername",
                 MasterUserPassword = "masterUserPassword",
                 MultiAz = false,
                 NamespaceResourcePolicy = namespaceResourcePolicy,
                 NodeType = "nodeType",
                 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

CfnClusterMixinProps()

Properties for CfnClusterPropsMixin.

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.

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 true , the data in the cluster is encrypted at rest.

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 true , Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.

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.

MasterUserPassword

The password associated with the admin user account for the cluster that is being created.

MasterUsername

The user name 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 true , the cluster can be accessed from a public network.

ResourceAction

The Amazon Redshift operation to be performed.

RevisionTarget

Describes a RevisionTarget object.

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.

Constructors

CfnClusterMixinProps()

Properties for CfnClusterPropsMixin.

public CfnClusterMixinProps()
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.CfnPropertyMixins.AWS.Redshift;

             var namespaceResourcePolicy;

             var cfnClusterMixinProps = new CfnClusterMixinProps {
                 AllowVersionUpgrade = false,
                 AquaConfigurationStatus = "aquaConfigurationStatus",
                 AutomatedSnapshotRetentionPeriod = 123,
                 AvailabilityZone = "availabilityZone",
                 AvailabilityZoneRelocation = false,
                 AvailabilityZoneRelocationStatus = "availabilityZoneRelocationStatus",
                 Classic = false,
                 ClusterIdentifier = "clusterIdentifier",
                 ClusterParameterGroupName = "clusterParameterGroupName",
                 ClusterSecurityGroups = new [] { "clusterSecurityGroups" },
                 ClusterSubnetGroupName = "clusterSubnetGroupName",
                 ClusterType = "clusterType",
                 ClusterVersion = "clusterVersion",
                 DbName = "dbName",
                 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",
                 MasterUsername = "masterUsername",
                 MasterUserPassword = "masterUserPassword",
                 MultiAz = false,
                 NamespaceResourcePolicy = namespaceResourcePolicy,
                 NodeType = "nodeType",
                 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" }
             };

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 object? AllowVersionUpgrade { get; set; }
Property Value

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-allowversionupgrade

Type union: either bool or IResolvable

AquaConfigurationStatus

This parameter is retired.

public string? AquaConfigurationStatus { get; set; }
Property Value

string

Remarks

It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-aquaconfigurationstatus

AutomatedSnapshotRetentionPeriod

The number of days that automated snapshots are retained.

public double? AutomatedSnapshotRetentionPeriod { get; set; }
Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-automatedsnapshotretentionperiod

AvailabilityZone

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.

public string? AvailabilityZone { get; set; }
Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzone

AvailabilityZoneRelocation

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

public object? AvailabilityZoneRelocation { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocation

Type union: either bool or IResolvable

AvailabilityZoneRelocationStatus

Describes the status of the Availability Zone relocation operation.

public string? AvailabilityZoneRelocationStatus { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocationstatus

Classic

A boolean value indicating whether the resize operation is using the classic resize process.

public object? Classic { get; set; }
Property Value

object

Remarks

If you don't provide this parameter or set the value to false , the resize type is elastic.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-classic

Type union: either bool or IResolvable

ClusterIdentifier

A unique identifier for the cluster.

public string? ClusterIdentifier { get; set; }
Property Value

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

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusteridentifier

    ClusterParameterGroupName

    The name of the parameter group to be associated with this cluster.

    public object? ClusterParameterGroupName { get; set; }
    Property Value

    object

    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:

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterparametergroupname

      Type union: either string or IClusterParameterGroupRef

      ClusterSecurityGroups

      A list of security groups to be associated with this cluster.

      public object[]? ClusterSecurityGroups { get; set; }
      Property Value

      object[]

      Remarks

      Default: The default cluster security group for Amazon Redshift.

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersecuritygroups

      Type union: (either string or ISecurityGroupRef or IClusterSecurityGroupRef)[]

      ClusterSubnetGroupName

      The name of a cluster subnet group to be associated with this cluster.

      public object? ClusterSubnetGroupName { get; set; }
      Property Value

      object

      Remarks

      If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersubnetgroupname

      Type union: either string or IClusterSubnetGroupRef

      ClusterType

      The type of the cluster. When cluster type is specified as.

      public string? ClusterType { get; set; }
      Property Value

      string

      Remarks

        Valid Values: multi-node | single-node

        Default: multi-node

        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustertype

        ClusterVersion

        The version of the Amazon Redshift engine software that you want to deploy on the cluster.

        public string? ClusterVersion { get; set; }
        Property Value

        string

        Remarks

        The version selected runs on all the nodes in the cluster.

        Constraints: Only version 1.0 is currently available.

        Example: 1.0

        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterversion

        DbName

        The name of the first database to be created when the cluster is created.

        public string? DbName { get; set; }
        Property Value

        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:

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-dbname

          DeferMaintenance

          A Boolean indicating whether to enable the deferred maintenance window.

          public object? DeferMaintenance { get; set; }
          Property Value

          object

          Remarks

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenance

          Type union: either bool or IResolvable

          DeferMaintenanceDuration

          An integer indicating the duration of the maintenance window in days.

          public double? DeferMaintenanceDuration { get; set; }
          Property Value

          double?

          Remarks

          If you specify a duration, you can't specify an end time. The duration must be 45 days or less.

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenanceduration

          DeferMaintenanceEndTime

          A timestamp for the end of the time period when we defer maintenance.

          public string? DeferMaintenanceEndTime { get; set; }
          Property Value

          string

          Remarks

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenanceendtime

          DeferMaintenanceStartTime

          A timestamp indicating the start time for the deferred maintenance window.

          public string? DeferMaintenanceStartTime { get; set; }
          Property Value

          string

          Remarks

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenancestarttime

          DestinationRegion

          The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          public string? DestinationRegion { get; set; }
          Property Value

          string

          Remarks

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-destinationregion

          ElasticIp

          The Elastic IP (EIP) address for the cluster.

          public object? ElasticIp { get; set; }
          Property Value

          object

          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.

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-elasticip

          Type union: either string or IEIPRef

          Encrypted

          If true , the data in the cluster is encrypted at rest.

          public object? Encrypted { get; set; }
          Property Value

          object

          Remarks

          If you set the value on this parameter to false , the request will fail.

          Default: true

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-encrypted

          Type union: either bool or IResolvable

          Endpoint

          The connection endpoint.

          public object? Endpoint { get; set; }
          Property Value

          object

          Remarks

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-endpoint

          Type union: either IResolvable or CfnClusterPropsMixin.IEndpointProperty

          EnhancedVpcRouting

          An option that specifies whether to create the cluster with enhanced VPC routing enabled.

          public object? EnhancedVpcRouting { get; set; }
          Property Value

          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

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-enhancedvpcrouting

          Type union: either bool or IResolvable

          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 string? HsmClientCertificateIdentifier { get; set; }
          Property Value

          string

          Remarks

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmclientcertificateidentifier

          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 string? HsmConfigurationIdentifier { get; set; }
          Property Value

          string

          Remarks

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmconfigurationidentifier

          IamRoles

          A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

          public object[]? IamRoles { get; set; }
          Property Value

          object[]

          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 .

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-iamroles

          Type union: (either string or IRoleRef)[]

          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 object? KmsKeyId { get; set; }
          Property Value

          object

          Remarks

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-kmskeyid

          Type union: either string or IKeyRef

          LoggingProperties

          Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

          public object? LoggingProperties { get; set; }
          Property Value

          object

          Remarks

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-loggingproperties

          Type union: either IResolvable or CfnClusterPropsMixin.ILoggingPropertiesProperty

          MaintenanceTrackName

          An optional parameter for the name of the maintenance track for the cluster.

          public string? MaintenanceTrackName { get; set; }
          Property Value

          string

          Remarks

          If you don't provide a maintenance track name, the cluster is assigned to the current track.

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-maintenancetrackname

          ManageMasterPassword

          If true , Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.

          public object? ManageMasterPassword { get; set; }
          Property Value

          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.

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-managemasterpassword

          Type union: either bool or IResolvable

          ManualSnapshotRetentionPeriod

          The default number of days to retain a manual snapshot.

          public double? ManualSnapshotRetentionPeriod { get; set; }
          Property Value

          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.

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-manualsnapshotretentionperiod

          MasterPasswordSecretKmsKeyId

          The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

          public object? MasterPasswordSecretKmsKeyId { get; set; }
          Property Value

          object

          Remarks

          You can only use this parameter if ManageMasterPassword is true.

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masterpasswordsecretkmskeyid

          Type union: either string or IKeyRef

          MasterUserPassword

          The password associated with the admin user account for the cluster that is being created.

          public string? MasterUserPassword { get; set; }
          Property Value

          string

          Remarks

          You can't use MasterUserPassword if ManageMasterPassword is true .

          Constraints:

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masteruserpassword

            MasterUsername

            The user name associated with the admin user account for the cluster that is being created.

            public string? MasterUsername { get; set; }
            Property Value

            string

            Remarks

            Constraints:

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masterusername

              MultiAz

              A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.

              public object? MultiAz { get; set; }
              Property Value

              object

              Remarks

              The default is false.

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-multiaz

              Type union: either bool or IResolvable

              NamespaceResourcePolicy

              The policy that is attached to a resource.

              public object? NamespaceResourcePolicy { get; set; }
              Property Value

              object

              Remarks

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-namespaceresourcepolicy

              NodeType

              The node type to be provisioned for the cluster.

              public string? NodeType { get; set; }
              Property Value

              string

              Remarks

              For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .

              Valid Values: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-nodetype

              NumberOfNodes

              The number of compute nodes in the cluster.

              public double? NumberOfNodes { get; set; }
              Property Value

              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.

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-numberofnodes

              OwnerAccount

              The AWS account used to create or copy the snapshot.

              public string? OwnerAccount { get; set; }
              Property Value

              string

              Remarks

              Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-owneraccount

              Port

              The port number on which the cluster accepts incoming connections.

              public double? Port { get; set; }
              Property Value

              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:

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-port

                PreferredMaintenanceWindow

                The weekly time range (in UTC) during which automated cluster maintenance can occur.

                public string? PreferredMaintenanceWindow { get; set; }
                Property Value

                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.

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-preferredmaintenancewindow

                PubliclyAccessible

                If true , the cluster can be accessed from a public network.

                public object? PubliclyAccessible { get; set; }
                Property Value

                object

                Remarks

                Default: false

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-publiclyaccessible

                Type union: either bool or IResolvable

                ResourceAction

                The Amazon Redshift operation to be performed.

                public string? ResourceAction { get; set; }
                Property Value

                string

                Remarks

                Supported operations are pause-cluster , resume-cluster , and failover-primary-compute .

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-resourceaction

                RevisionTarget

                Describes a RevisionTarget object.

                public string? RevisionTarget { get; set; }
                Property Value

                string

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-revisiontarget

                RotateEncryptionKey

                Rotates the encryption keys for a cluster.

                public object? RotateEncryptionKey { get; set; }
                Property Value

                object

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-rotateencryptionkey

                Type union: either bool or IResolvable

                SnapshotClusterIdentifier

                The name of the cluster the source snapshot was created from.

                public string? SnapshotClusterIdentifier { get; set; }
                Property Value

                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.

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotclusteridentifier

                SnapshotCopyGrantName

                The name of the snapshot copy grant.

                public string? SnapshotCopyGrantName { get; set; }
                Property Value

                string

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopygrantname

                SnapshotCopyManual

                Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

                public object? SnapshotCopyManual { get; set; }
                Property Value

                object

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopymanual

                Type union: either bool or IResolvable

                SnapshotCopyRetentionPeriod

                The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .

                public double? SnapshotCopyRetentionPeriod { get; set; }
                Property Value

                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.

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopyretentionperiod

                SnapshotIdentifier

                The name of the snapshot from which to create the new cluster.

                public string? SnapshotIdentifier { get; set; }
                Property Value

                string

                Remarks

                This parameter isn't case sensitive. You must specify this parameter or snapshotArn , but not both.

                Example: my-snapshot-id

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotidentifier

                Tags

                A list of tag instances.

                public ICfnTag[]? Tags { get; set; }
                Property Value

                ICfnTag[]

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-tags

                VpcSecurityGroupIds

                A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

                public object[]? VpcSecurityGroupIds { get; set; }
                Property Value

                object[]

                Remarks

                Default: The default VPC security group is associated with the cluster.

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-vpcsecuritygroupids

                Type union: (either string or ISecurityGroupRef)[]

                Implements

                ICfnClusterMixinProps
                Back to top Generated by DocFX