aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,067 lines • 99.6 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* 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, 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;
/**
* The namespace Amazon Resource Name (ARN) of the cluster.
*
* @cloudformationAttribute ClusterNamespaceArn
*/
readonly attrClusterNamespaceArn: string;
/**
* A unique identifier for the maintenance window.
*
* @cloudformationAttribute DeferMaintenanceIdentifier
*/
readonly attrDeferMaintenanceIdentifier: string;
/**
* The connection endpoint for the Amazon Redshift cluster. For example: `examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com` .
*
* @cloudformationAttribute Endpoint.Address
*/
readonly attrEndpointAddress: string;
/**
* The port number on which the Amazon Redshift cluster accepts connections. For example: `5439` .
*
* @cloudformationAttribute Endpoint.Port
*/
readonly attrEndpointPort: string;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
*
* @cloudformationAttribute MasterPasswordSecretArn
*/
readonly attrMasterPasswordSecretArn: string;
/**
* If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
*/
allowVersionUpgrade?: boolean | cdk.IResolvable;
/**
* This parameter is retired.
*/
aquaConfigurationStatus?: string;
/**
* The number of days that automated snapshots are retained.
*/
automatedSnapshotRetentionPeriod?: number;
/**
* The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
*/
availabilityZone?: string;
/**
* The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
*/
availabilityZoneRelocation?: boolean | cdk.IResolvable;
/**
* Describes the status of the Availability Zone relocation operation.
*/
availabilityZoneRelocationStatus?: string;
/**
* A boolean value indicating whether the resize operation is using the classic resize process.
*/
classic?: boolean | cdk.IResolvable;
/**
* A unique identifier for the cluster.
*/
clusterIdentifier?: string;
/**
* The name of the parameter group to be associated with this cluster.
*/
clusterParameterGroupName?: string;
/**
* A list of security groups to be associated with this cluster.
*/
clusterSecurityGroups?: Array<string>;
/**
* The name of a cluster subnet group to be associated with this cluster.
*/
clusterSubnetGroupName?: string;
/**
* The type of the cluster. When cluster type is specified as.
*/
clusterType: string;
/**
* The version of the Amazon Redshift engine software that you want to deploy on the cluster.
*/
clusterVersion?: string;
/**
* The name of the first database to be created when the cluster is created.
*/
dbName: string;
/**
* A Boolean indicating whether to enable the deferred maintenance window.
*/
deferMaintenance?: boolean | cdk.IResolvable;
/**
* An integer indicating the duration of the maintenance window in days.
*/
deferMaintenanceDuration?: number;
/**
* A timestamp for the end of the time period when we defer maintenance.
*/
deferMaintenanceEndTime?: string;
/**
* A timestamp indicating the start time for the deferred maintenance window.
*/
deferMaintenanceStartTime?: string;
/**
* The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
*/
destinationRegion?: string;
/**
* The Elastic IP (EIP) address for the cluster.
*/
elasticIp?: string;
/**
* If `true` , the data in the cluster is encrypted at rest.
*/
encrypted?: boolean | cdk.IResolvable;
/**
* The connection endpoint.
*/
endpoint?: CfnCluster.EndpointProperty | cdk.IResolvable;
/**
* An option that specifies whether to create the cluster with enhanced VPC routing enabled.
*/
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.
*/
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.
*/
hsmConfigurationIdentifier?: string;
/**
* A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
*/
iamRoles?: Array<string>;
/**
* The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
*/
kmsKeyId?: string;
/**
* Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
*/
loggingProperties?: cdk.IResolvable | CfnCluster.LoggingPropertiesProperty;
/**
* An optional parameter for the name of the maintenance track for the cluster.
*/
maintenanceTrackName?: string;
/**
* If `true` , Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.
*/
manageMasterPassword?: boolean | cdk.IResolvable;
/**
* The default number of days to retain a manual snapshot.
*/
manualSnapshotRetentionPeriod?: number;
/**
* The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
*/
masterPasswordSecretKmsKeyId?: string;
/**
* The user name associated with the admin user account for the cluster that is being created.
*/
masterUsername: string;
/**
* The password associated with the admin user account for the cluster that is being created.
*/
masterUserPassword?: string;
/**
* A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.
*/
multiAz?: boolean | cdk.IResolvable;
/**
* The policy that is attached to a resource.
*/
namespaceResourcePolicy?: any | cdk.IResolvable;
/**
* The node type to be provisioned for the cluster.
*/
nodeType: string;
/**
* The number of compute nodes in the cluster.
*/
numberOfNodes?: number;
/**
* The AWS account used to create or copy the snapshot.
*/
ownerAccount?: string;
/**
* The port number on which the cluster accepts incoming connections.
*/
port?: number;
/**
* The weekly time range (in UTC) during which automated cluster maintenance can occur.
*/
preferredMaintenanceWindow?: string;
/**
* If `true` , the cluster can be accessed from a public network.
*/
publiclyAccessible?: boolean | cdk.IResolvable;
/**
* The Amazon Redshift operation to be performed.
*/
resourceAction?: string;
/**
* Describes a `RevisionTarget` object.
*/
revisionTarget?: string;
/**
* Rotates the encryption keys for a cluster.
*/
rotateEncryptionKey?: boolean | cdk.IResolvable;
/**
* The name of the cluster the source snapshot was created from.
*/
snapshotClusterIdentifier?: string;
/**
* The name of the snapshot copy grant.
*/
snapshotCopyGrantName?: string;
/**
* Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
*/
snapshotCopyManual?: boolean | cdk.IResolvable;
/**
* The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .
*/
snapshotCopyRetentionPeriod?: number;
/**
* The name of the snapshot from which to create the new cluster.
*/
snapshotIdentifier?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* A list of tag instances.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
*/
vpcSecurityGroupIds?: Array<string>;
/**
* @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);
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?: 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<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?: 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?: 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<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?: 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?: 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.xlplus` | `ra3.4xlarge` | `ra3.16xlarge`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-nodetype
*/
readonly nodeType: string;
/**
* The number of compute nodes in the cluster.
*
* 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](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) 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
*/
readonly numberOfNodes?: number;
/**
* The AWS account used to create or copy the snapshot.
*
* 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
*/
readonly ownerAccount?: string;
/**
* The port number on which the cluster accepts incoming connections.
*
* 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:
*
* - For clusters with ra3 nodes - Select a port within the ranges `5431-5455` or `8191-8215` . (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.)
* - For clusters with dc2 nodes - Select a port within the range `1150-65535` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-port
*/
readonly port?: number;
/**
* The weekly time range (in UTC) during which automated cluster maintenance can occur.
*
* 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](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-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
*/
readonly preferredMaintenanceWindow?: string;
/**
* If `true` , the cluster can be accessed from a public network.
*
* Default: false
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-publiclyaccessible
*/
readonly publiclyAccessible?: boolean | cdk.IResolvable;
/**
* The Amazon Redshift operation to be performed.
*
* 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
*/
readonly resourceAction?: string;
/**
* Describes a `RevisionTarget` object.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-revisiontarget
*/
readonly revisionTarget?: string;
/**
* Rotates the encryption keys for a cluster.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-rotateencryptionkey
*/
readonly rotateEncryptionKey?: boolean | cdk.IResolvable;
/**
* The name of the cluster the source snapshot was created from.
*
* 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
*/
readonly snapshotClusterIdentifier?: string;
/**
* The name of the snapshot copy grant.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopygrantname
*/
readonly snapshotCopyGrantName?: string;
/**
* Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotcopymanual
*/
readonly snapshotCopyManual?: boolean | cdk.IResolvable;
/**
* The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .
*
* 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
*/
readonly snapshotCopyRetentionPeriod?: number;
/**
* The name of the snapshot from which to create the new cluster.
*
* 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
*/
readonly snapshotIdentifier?: string;
/**
* A list of tag instances.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
*
* 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
*/
readonly vpcSecurityGroupIds?: Array<string>;
}
/**
* Describes a parameter group.
*
* @cloudformationResource AWS::Redshift::ClusterParameterGroup
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html
*/
export declare class CfnClusterParameterGroup extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnClusterParameterGroup 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): CfnClusterParameterGroup;
/**
* The description of the parameter group.
*/
description: string;
/**
* The name of the cluster parameter group family that this cluster parameter group is compatible with.
*/
parameterGroupFamily: string;
/**
* The name of the cluster parameter group.
*/
parameterGroupName?: string;
/**
* An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
*/
parameters?: Array<cdk.IResolvable | CfnClusterParameterGroup.ParameterProperty> | cdk.IResolvable;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* The list of tags for the cluster parameter group.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @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: CfnClusterParameterGroupProps);
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 CfnClusterParameterGroup {
/**
* Describes a parameter in a cluster parameter group.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-clusterparametergroup-parameter.html
*/
interface ParameterProperty {
/**
* The name of the parameter.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-clusterparametergroup-parameter.html#cfn-redshift-clusterparametergroup-parameter-parametername
*/
readonly parameterName: string;
/**
* The value of the parameter.
*
* If `ParameterName` is `wlm_json_configuration` , then the maximum size of `ParameterValue` is 8000 characters.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-clusterparametergroup-parameter.html#cfn-redshift-clusterparametergroup-parameter-parametervalue
*/
readonly parameterValue: string;
}
}
/**
* Properties for defining a `CfnClusterParameterGroup`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html
*/
export interface CfnClusterParameterGroupProps {
/**
* The description of the parameter group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-description
*/
readonly description: string;
/**
* The name of the cluster parameter group family that this cluster parameter group is compatible with.
*
* You can create a custom parameter group and then associate your cluster with it. For more information, see [Amazon Redshift parameter groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parametergroupfamily
*/
readonly parameterGroupFamily: string;
/**
* The name of the cluster parameter group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parametergroupname
*/
readonly parameterGroupName?: string;
/**
* An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
*
* For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
*
* For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parameters
*/
readonly parameters?: Array<cdk.IResolvable | CfnClusterParameterGroup.ParameterProperty> | cdk.IResolvable;
/**
* The list of tags for the cluster parameter group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Specifies a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.
*
* For information about managing security groups, go to [Amazon Redshift Cluster Security Groups](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) in the *Amazon Redshift Cluster Management Guide* .
*
* @cloudformationResource AWS::Redshift::ClusterSecurityGroup
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html
*/
export declare class CfnClusterSecurityGroup extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnClusterSecurityGroup 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): CfnClusterSecurityGroup;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* A description for the security group.
*/
description: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Specifies an arbitrary set of tags (key–value pairs) to associate with this security group.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @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: CfnClusterSecurityGroupProps);
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>;
}
/**
* Properties for defining a `CfnClusterSecurityGroup`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html
*/
export interface CfnClusterSecurityGroupProps {
/**
* A description for the security group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html#cfn-redshift-clustersecuritygroup-description
*/
readonly description: string;
/**
* Specifies an arbitrary set of tags (key–value pairs) to associate with this security group.
*
* Use tags to manage your resources.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html#cfn-redshift-clustersecuritygroup-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Adds an inbound (ingress) rule to an Amazon Redshift security group.
*
* Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP)