aws-cdk-lib

import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { aws_ec2 as ec2Refs, aws_iam as iamRefs, aws_kms as kmsRefs, aws_redshift as redshiftRefs, aws_sns as snsRefs } from "../../interfaces"; import { ClusterParameterGroupReference, ClusterReference, ClusterSecurityGroupIngressReference, ClusterSecurityGroupReference, ClusterSubnetGroupReference, EndpointAccessReference, EndpointAuthorizationReference, EventSubscriptionReference, IClusterParameterGroupRef, IClusterRef, IClusterSecurityGroupIngressRef, IClusterSecurityGroupRef, IClusterSubnetGroupRef, IEndpointAccessRef, IEndpointAuthorizationRef, IEventSubscriptionRef, IIntegrationRef, IntegrationReference, IScheduledActionRef, ScheduledActionReference } from "../../interfaces/generated/aws-redshift-interfaces.generated"; /** * Specifies a cluster. A *cluster* is a fully managed data warehouse that consists of a set of compute nodes. * * 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](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in the *Amazon Redshift Cluster Management Guide* . * * @cloudformationResource AWS::Redshift::Cluster * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html */ export declare class CfnCluster extends cdk.CfnResource implements cdk.IInspectable, IClusterRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnCluster from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCluster; /** * Checks whether the given object is a CfnCluster */ static isCfnCluster(x: any): x is CfnCluster; /** * If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. */ private _allowVersionUpgrade?; /** * This parameter is retired. */ private _aquaConfigurationStatus?; /** * The number of days that automated snapshots are retained. */ private _automatedSnapshotRetentionPeriod?; /** * The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. */ private _availabilityZone?; /** * The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created. */ private _availabilityZoneRelocation?; /** * Describes the status of the Availability Zone relocation operation. */ private _availabilityZoneRelocationStatus?; /** * A boolean value indicating whether the resize operation is using the classic resize process. */ private _classic?; /** * A unique identifier for the cluster. */ private _clusterIdentifier?; /** * The name of the parameter group to be associated with this cluster. */ private _clusterParameterGroupName?; /** * A list of security groups to be associated with this cluster. */ private _clusterSecurityGroups?; /** * The name of a cluster subnet group to be associated with this cluster. */ private _clusterSubnetGroupName?; /** * The type of the cluster. When cluster type is specified as. */ private _clusterType; /** * The version of the Amazon Redshift engine software that you want to deploy on the cluster. */ private _clusterVersion?; /** * The name of the first database to be created when the cluster is created. */ private _dbName; /** * A Boolean indicating whether to enable the deferred maintenance window. */ private _deferMaintenance?; /** * An integer indicating the duration of the maintenance window in days. */ private _deferMaintenanceDuration?; /** * A timestamp for the end of the time period when we defer maintenance. */ private _deferMaintenanceEndTime?; /** * A timestamp indicating the start time for the deferred maintenance window. */ private _deferMaintenanceStartTime?; /** * The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. */ private _destinationRegion?; /** * The Elastic IP (EIP) address for the cluster. */ private _elasticIp?; /** * If `true` , the data in the cluster is encrypted at rest. */ private _encrypted?; /** * The connection endpoint. */ private _endpoint?; /** * An option that specifies whether to create the cluster with enhanced VPC routing enabled. */ private _enhancedVpcRouting?; /** * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. */ private _hsmClientCertificateIdentifier?; /** * 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. */ private _hsmConfigurationIdentifier?; /** * A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. */ private _iamRoles?; /** * The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. */ private _kmsKeyId?; /** * Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. */ private _loggingProperties?; /** * An optional parameter for the name of the maintenance track for the cluster. */ private _maintenanceTrackName?; /** * If `true` , Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials. */ private _manageMasterPassword?; /** * The default number of days to retain a manual snapshot. */ private _manualSnapshotRetentionPeriod?; /** * The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. */ private _masterPasswordSecretKmsKeyId?; /** * The user name associated with the admin user account for the cluster that is being created. */ private _masterUsername; /** * The password associated with the admin user account for the cluster that is being created. */ private _masterUserPassword?; /** * A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. */ private _multiAz?; /** * The policy that is attached to a resource. */ private _namespaceResourcePolicy?; /** * The node type to be provisioned for the cluster. */ private _nodeType; /** * The number of compute nodes in the cluster. */ private _numberOfNodes?; /** * The AWS account used to create or copy the snapshot. */ private _ownerAccount?; /** * The port number on which the cluster accepts incoming connections. */ private _port?; /** * The weekly time range (in UTC) during which automated cluster maintenance can occur. */ private _preferredMaintenanceWindow?; /** * If `true` , the cluster can be accessed from a public network. */ private _publiclyAccessible?; /** * The Amazon Redshift operation to be performed. */ private _resourceAction?; /** * Describes a `RevisionTarget` object. */ private _revisionTarget?; /** * Rotates the encryption keys for a cluster. */ private _rotateEncryptionKey?; /** * The name of the cluster the source snapshot was created from. */ private _snapshotClusterIdentifier?; /** * The name of the snapshot copy grant. */ private _snapshotCopyGrantName?; /** * Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. */ private _snapshotCopyManual?; /** * The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region . */ private _snapshotCopyRetentionPeriod?; /** * The name of the snapshot from which to create the new cluster. */ private _snapshotIdentifier?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * A list of tag instances. */ private _tagsRaw?; /** * A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. */ private _vpcSecurityGroupIds?; /** * Create a new `AWS::Redshift::Cluster`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnClusterProps); get clusterRef(): ClusterReference; /** * If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. */ get allowVersionUpgrade(): boolean | cdk.IResolvable | undefined; /** * If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. */ set allowVersionUpgrade(value: boolean | cdk.IResolvable | undefined); /** * This parameter is retired. */ get aquaConfigurationStatus(): string | undefined; /** * This parameter is retired. */ set aquaConfigurationStatus(value: string | undefined); /** * The number of days that automated snapshots are retained. */ get automatedSnapshotRetentionPeriod(): number | undefined; /** * The number of days that automated snapshots are retained. */ set automatedSnapshotRetentionPeriod(value: number | undefined); /** * The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. */ get availabilityZone(): string | undefined; /** * The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. */ set availabilityZone(value: string | undefined); /** * The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created. */ get availabilityZoneRelocation(): boolean | cdk.IResolvable | undefined; /** * The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created. */ set availabilityZoneRelocation(value: boolean | cdk.IResolvable | undefined); /** * Describes the status of the Availability Zone relocation operation. */ get availabilityZoneRelocationStatus(): string | undefined; /** * Describes the status of the Availability Zone relocation operation. */ set availabilityZoneRelocationStatus(value: string | undefined); /** * A boolean value indicating whether the resize operation is using the classic resize process. */ get classic(): boolean | cdk.IResolvable | undefined; /** * A boolean value indicating whether the resize operation is using the classic resize process. */ set classic(value: boolean | cdk.IResolvable | undefined); /** * A unique identifier for the cluster. */ get clusterIdentifier(): string | undefined; /** * A unique identifier for the cluster. */ set clusterIdentifier(value: string | undefined); /** * The name of the parameter group to be associated with this cluster. */ get clusterParameterGroupName(): string | undefined; /** * The name of the parameter group to be associated with this cluster. */ set clusterParameterGroupName(value: string | undefined); /** * A list of security groups to be associated with this cluster. */ get clusterSecurityGroups(): Array<string> | undefined; /** * A list of security groups to be associated with this cluster. */ set clusterSecurityGroups(value: Array<string> | undefined); /** * The name of a cluster subnet group to be associated with this cluster. */ get clusterSubnetGroupName(): string | undefined; /** * The name of a cluster subnet group to be associated with this cluster. */ set clusterSubnetGroupName(value: string | undefined); /** * The type of the cluster. When cluster type is specified as. */ get clusterType(): string; /** * The type of the cluster. When cluster type is specified as. */ set clusterType(value: string); /** * The version of the Amazon Redshift engine software that you want to deploy on the cluster. */ get clusterVersion(): string | undefined; /** * The version of the Amazon Redshift engine software that you want to deploy on the cluster. */ set clusterVersion(value: string | undefined); /** * The name of the first database to be created when the cluster is created. */ get dbName(): string; /** * The name of the first database to be created when the cluster is created. */ set dbName(value: string); /** * A Boolean indicating whether to enable the deferred maintenance window. */ get deferMaintenance(): boolean | cdk.IResolvable | undefined; /** * A Boolean indicating whether to enable the deferred maintenance window. */ set deferMaintenance(value: boolean | cdk.IResolvable | undefined); /** * An integer indicating the duration of the maintenance window in days. */ get deferMaintenanceDuration(): number | undefined; /** * An integer indicating the duration of the maintenance window in days. */ set deferMaintenanceDuration(value: number | undefined); /** * A timestamp for the end of the time period when we defer maintenance. */ get deferMaintenanceEndTime(): string | undefined; /** * A timestamp for the end of the time period when we defer maintenance. */ set deferMaintenanceEndTime(value: string | undefined); /** * A timestamp indicating the start time for the deferred maintenance window. */ get deferMaintenanceStartTime(): string | undefined; /** * A timestamp indicating the start time for the deferred maintenance window. */ set deferMaintenanceStartTime(value: string | undefined); /** * The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. */ get destinationRegion(): string | undefined; /** * The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. */ set destinationRegion(value: string | undefined); /** * The Elastic IP (EIP) address for the cluster. */ get elasticIp(): string | undefined; /** * The Elastic IP (EIP) address for the cluster. */ set elasticIp(value: string | undefined); /** * If `true` , the data in the cluster is encrypted at rest. */ get encrypted(): boolean | cdk.IResolvable | undefined; /** * If `true` , the data in the cluster is encrypted at rest. */ set encrypted(value: boolean | cdk.IResolvable | undefined); /** * The connection endpoint. */ get endpoint(): CfnCluster.EndpointProperty | cdk.IResolvable | undefined; /** * The connection endpoint. */ set endpoint(value: CfnCluster.EndpointProperty | cdk.IResolvable | undefined); /** * An option that specifies whether to create the cluster with enhanced VPC routing enabled. */ get enhancedVpcRouting(): boolean | cdk.IResolvable | undefined; /** * An option that specifies whether to create the cluster with enhanced VPC routing enabled. */ set enhancedVpcRouting(value: boolean | cdk.IResolvable | undefined); /** * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. */ get hsmClientCertificateIdentifier(): string | undefined; /** * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. */ set hsmClientCertificateIdentifier(value: string | undefined); /** * 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. */ get hsmConfigurationIdentifier(): string | undefined; /** * 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. */ set hsmConfigurationIdentifier(value: string | undefined); /** * A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. */ get iamRoles(): Array<string> | undefined; /** * A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. */ set iamRoles(value: Array<string> | undefined); /** * The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. */ get kmsKeyId(): string | undefined; /** * The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. */ set kmsKeyId(value: string | undefined); /** * Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. */ get loggingProperties(): cdk.IResolvable | CfnCluster.LoggingPropertiesProperty | undefined; /** * Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. */ set loggingProperties(value: cdk.IResolvable | CfnCluster.LoggingPropertiesProperty | undefined); /** * An optional parameter for the name of the maintenance track for the cluster. */ get maintenanceTrackName(): string | undefined; /** * An optional parameter for the name of the maintenance track for the cluster. */ set maintenanceTrackName(value: string | undefined); /** * If `true` , Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials. */ get manageMasterPassword(): boolean | cdk.IResolvable | undefined; /** * If `true` , Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials. */ set manageMasterPassword(value: boolean | cdk.IResolvable | undefined); /** * The default number of days to retain a manual snapshot. */ get manualSnapshotRetentionPeriod(): number | undefined; /** * The default number of days to retain a manual snapshot. */ set manualSnapshotRetentionPeriod(value: number | undefined); /** * The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. */ get masterPasswordSecretKmsKeyId(): string | undefined; /** * The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. */ set masterPasswordSecretKmsKeyId(value: string | undefined); /** * The user name associated with the admin user account for the cluster that is being created. */ get masterUsername(): string; /** * The user name associated with the admin user account for the cluster that is being created. */ set masterUsername(value: string); /** * The password associated with the admin user account for the cluster that is being created. */ get masterUserPassword(): string | undefined; /** * The password associated with the admin user account for the cluster that is being created. */ set masterUserPassword(value: string | undefined); /** * A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. */ get multiAz(): boolean | cdk.IResolvable | undefined; /** * A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. */ set multiAz(value: boolean | cdk.IResolvable | undefined); /** * The policy that is attached to a resource. */ get namespaceResourcePolicy(): any | cdk.IResolvable | undefined; /** * The policy that is attached to a resource. */ set namespaceResourcePolicy(value: any | cdk.IResolvable | undefined); /** * The node type to be provisioned for the cluster. */ get nodeType(): string; /** * The node type to be provisioned for the cluster. */ set nodeType(value: string); /** * The number of compute nodes in the cluster. */ get numberOfNodes(): number | undefined; /** * The number of compute nodes in the cluster. */ set numberOfNodes(value: number | undefined); /** * The AWS account used to create or copy the snapshot. */ get ownerAccount(): string | undefined; /** * The AWS account used to create or copy the snapshot. */ set ownerAccount(value: string | undefined); /** * The port number on which the cluster accepts incoming connections. */ get port(): number | undefined; /** * The port number on which the cluster accepts incoming connections. */ set port(value: number | undefined); /** * The weekly time range (in UTC) during which automated cluster maintenance can occur. */ get preferredMaintenanceWindow(): string | undefined; /** * The weekly time range (in UTC) during which automated cluster maintenance can occur. */ set preferredMaintenanceWindow(value: string | undefined); /** * If `true` , the cluster can be accessed from a public network. */ get publiclyAccessible(): boolean | cdk.IResolvable | undefined; /** * If `true` , the cluster can be accessed from a public network. */ set publiclyAccessible(value: boolean | cdk.IResolvable | undefined); /** * The Amazon Redshift operation to be performed. */ get resourceAction(): string | undefined; /** * The Amazon Redshift operation to be performed. */ set resourceAction(value: string | undefined); /** * Describes a `RevisionTarget` object. */ get revisionTarget(): string | undefined; /** * Describes a `RevisionTarget` object. */ set revisionTarget(value: string | undefined); /** * Rotates the encryption keys for a cluster. */ get rotateEncryptionKey(): boolean | cdk.IResolvable | undefined; /** * Rotates the encryption keys for a cluster. */ set rotateEncryptionKey(value: boolean | cdk.IResolvable | undefined); /** * The name of the cluster the source snapshot was created from. */ get snapshotClusterIdentifier(): string | undefined; /** * The name of the cluster the source snapshot was created from. */ set snapshotClusterIdentifier(value: string | undefined); /** * The name of the snapshot copy grant. */ get snapshotCopyGrantName(): string | undefined; /** * The name of the snapshot copy grant. */ set snapshotCopyGrantName(value: string | undefined); /** * Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. */ get snapshotCopyManual(): boolean | cdk.IResolvable | undefined; /** * Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. */ set snapshotCopyManual(value: boolean | cdk.IResolvable | undefined); /** * The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region . */ get snapshotCopyRetentionPeriod(): number | undefined; /** * The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region . */ set snapshotCopyRetentionPeriod(value: number | undefined); /** * The name of the snapshot from which to create the new cluster. */ get snapshotIdentifier(): string | undefined; /** * The name of the snapshot from which to create the new cluster. */ set snapshotIdentifier(value: string | undefined); /** * A list of tag instances. */ get tagsRaw(): Array<cdk.CfnTag> | undefined; /** * A list of tag instances. */ set tagsRaw(value: Array<cdk.CfnTag> | undefined); /** * A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. */ get vpcSecurityGroupIds(): Array<string> | undefined; /** * A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. */ set vpcSecurityGroupIds(value: Array<string> | undefined); /** * The namespace Amazon Resource Name (ARN) of the cluster. * * @cloudformationAttribute ClusterNamespaceArn */ get attrClusterNamespaceArn(): string; /** * A unique identifier for the maintenance window. * * @cloudformationAttribute DeferMaintenanceIdentifier */ get attrDeferMaintenanceIdentifier(): string; /** * The connection endpoint for the Amazon Redshift cluster. For example: `examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com` . * * @cloudformationAttribute Endpoint.Address */ get attrEndpointAddress(): string; /** * The port number on which the Amazon Redshift cluster accepts connections. For example: `5439` . * * @cloudformationAttribute Endpoint.Port */ get attrEndpointPort(): string; /** * @cloudformationAttribute Id */ get attrId(): string; /** * The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. * * @cloudformationAttribute MasterPasswordSecretArn */ get attrMasterPasswordSecretArn(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnCluster { /** * Describes a connection endpoint. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html */ interface EndpointProperty { /** * The DNS address of the cluster. * * This property is read only. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html#cfn-redshift-cluster-endpoint-address */ readonly address?: string; /** * The port that the database engine is listening on. * * This property is read only. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html#cfn-redshift-cluster-endpoint-port */ readonly port?: string; } /** * Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html */ interface LoggingPropertiesProperty { /** * The name of an existing S3 bucket where the log files are to be stored. * * Constraints: * * - Must be in the same region as the cluster * - The cluster must have read bucket and put object permissions * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-bucketname */ readonly bucketName?: string; /** * The log destination type. * * An enum with possible values of `s3` and `cloudwatch` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-logdestinationtype */ readonly logDestinationType?: string; /** * The collection of exported log types. * * Possible values are `connectionlog` , `useractivitylog` , and `userlog` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-logexports */ readonly logExports?: Array<string>; /** * The prefix applied to the log file names. * * Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore ( `_` ), period ( `.` ), colon ( `:` ), slash ( `/` ), equal ( `=` ), plus ( `+` ), backslash ( `\` ), hyphen ( `-` ), at symbol ( `@` ). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-s3keyprefix */ readonly s3KeyPrefix?: string; } } /** * Properties for defining a `CfnCluster` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html */ export interface CfnClusterProps { /** * If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. * * 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 */ readonly allowVersionUpgrade?: boolean | cdk.IResolvable; /** * This parameter is retired. * * 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 */ readonly aquaConfigurationStatus?: string; /** * The number of days that automated snapshots are retained. * * 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](https://docs.aws.amazon.com/redshift/latest/APIReference/API_CreateClusterSnapshot.html) 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 */ readonly automatedSnapshotRetentionPeriod?: number; /** * The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. * * 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 */ readonly availabilityZone?: string; /** * The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocation */ readonly availabilityZoneRelocation?: boolean | cdk.IResolvable; /** * Describes the status of the Availability Zone relocation operation. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzonerelocationstatus */ readonly availabilityZoneRelocationStatus?: string; /** * A boolean value indicating whether the resize operation is using the classic resize process. * * 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 */ readonly classic?: boolean | cdk.IResolvable; /** * A unique identifier for the cluster. * * 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: * * - Must contain from 1 to 63 alphanumeric characters or hyphens. * - Alphabetic characters must be lowercase. * - First character must be a letter. * - Cannot end with a hyphen or contain two consecutive hyphens. * - Must be unique for all clusters within an AWS account . * * Example: `myexamplecluster` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusteridentifier */ readonly clusterIdentifier?: string; /** * The name of the parameter group to be associated with this cluster. * * Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to [Working with Amazon Redshift Parameter Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) * * Constraints: * * - Must be 1 to 255 alphanumeric characters or hyphens. * - First character must be a letter. * - Cannot end with a hyphen or contain two consecutive hyphens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterparametergroupname */ readonly clusterParameterGroupName?: redshiftRefs.IClusterParameterGroupRef | string; /** * A list of security groups to be associated with this cluster. * * 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 */ readonly clusterSecurityGroups?: Array<ec2Refs.ISecurityGroupRef | redshiftRefs.IClusterSecurityGroupRef | string>; /** * The name of a cluster subnet group to be associated with this cluster. * * 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 */ readonly clusterSubnetGroupName?: redshiftRefs.IClusterSubnetGroupRef | string; /** * The type of the cluster. When cluster type is specified as. * * - `single-node` , the *NumberOfNodes* parameter is not required. * - `multi-node` , the *NumberOfNodes* parameter is required. * * 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 */ readonly clusterType: string; /** * The version of the Amazon Redshift engine software that you want to deploy on the cluster. * * 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 */ readonly clusterVersion?: string; /** * The name of the first database to be created when the cluster is created. * * 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](https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html) in the Amazon Redshift Database Developer Guide. * * Default: `dev` * * Constraints: * * - Must contain 1 to 64 alphanumeric characters. * - Must contain only lowercase letters. * - Cannot be a word that is reserved by the service. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-dbname */ readonly dbName: string; /** * A Boolean indicating whether to enable the deferred maintenance window. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenance */ readonly deferMaintenance?: boolean | cdk.IResolvable; /** * An integer indicating the duration of the maintenance window in days. * * 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 */ readonly deferMaintenanceDuration?: number; /** * A timestamp for the end of the time period when we defer maintenance. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenanceendtime */ readonly deferMaintenanceEndTime?: string; /** * A timestamp indicating the start time for the deferred maintenance window. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-defermaintenancestarttime */ readonly deferMaintenanceStartTime?: string; /** * The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-destinationregion */ readonly destinationRegion?: string; /** * The Elastic IP (EIP) address for the cluster. * * 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](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) 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 */ readonly elasticIp?: ec2Refs.IEIPRef | string; /** * If `true` , the data in the cluster is encrypted at rest. * * 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 */ readonly encrypted?: boolean | cdk.IResolvable; /** * The connection endpoint. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-endpoint */ readonly endpoint?: CfnCluster.EndpointProperty | cdk.IResolvable; /** * An option that specifies whether to create the cluster with enhanced VPC routing enabled. * * To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see [Enhanced VPC Routing](https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) 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 */ readonly enhancedVpcRouting?: boolean | cdk.IResolvable; /** * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmclientcertificateidentifier */ readonly hsmClientCertificateIdentifier?: string; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmconfigurationidentifier */ readonly hsmConfigurationIdentifier?: string; /** * A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. * * 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](https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) 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 */ readonly iamRoles?: Array<iamRefs.IRoleRef | string>; /** * The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-kmskeyid */ readonly kmsKeyId?: kmsRefs.IKeyRef | string; /** * Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-loggingproperties */ readonly loggingProperties?: cdk.IResolvable | CfnCluster.LoggingPropertiesProperty; /** * An optional parameter for the name of the maintenance track for the cluster. * * 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 */ readonly maintenanceTrackName?: string; /** * If `true` , Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials. * * 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 */ readonly manageMasterPassword?: boolean | cdk.IResolvable; /** * The default number of days to retain a manual snapshot. * * 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 */ readonly manualSnapshotRetentionPeriod?: number; /** * The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. * * 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 */ readonly masterPasswordSecretKmsKeyId?: kmsRefs.IKeyRef | string; /** * The user name associated with the admin user account for the cluster that is being created. * * Constraints: * * - Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be `PUBLIC` . * - Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. * - The first character must be a letter. * - Must not contain a colon (:) or a slash (/). * - Cannot be a reserved word. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masterusername */ readonly masterUsername: string; /** * The password associated with the admin user account for the cluster that is being created. * * You can't use `MasterUserPassword` if `ManageMasterPassword` is `true` . * * Constraints: * * - Must be between 8 and 64 characters in length. * - Must contain at least one uppercase letter. * - Must contain at least one lowercase letter. * - Must contain one number. * - Can be any printable ASCII character (ASCII code 33-126) except `'` (single quote), `"` (double quote), `\` , `/` , or `@` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masteruserpassword */ readonly masterUserPassword?: string; /** * A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. * * The default is false. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-multiaz */ readonly multiAz?: boolean | cdk.IResolvable; /** * The policy that is attached to a resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-namespaceresourcepolicy */ readonly namespaceResourcePolicy?: any | cdk.IResolvable; /** * The node type to be provisioned for the cluster. * * For information about node types, go to [Working with Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) in the *Amazon Redshift Cluster Management Guide* . * * Valid Values: `dc2.large` | `dc2.8xlarge` | `ra3.large` | `ra3