@aws-cdk_aws-redshift-alpha.ICluster

interface ICluster ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Redshift.Alpha.ICluster
Gogithub.com/aws/aws-cdk-go/awscdkredshiftalpha/v2#ICluster
Javasoftware.amazon.awscdk.services.redshift.alpha.ICluster
Pythonaws_cdk.aws_redshift_alpha.ICluster
TypeScript (source)@aws-cdk/aws-redshift-alpha ยป ICluster

Implemented by Cluster

Obtainable from Cluster.fromClusterAttributes()

Create a Redshift Cluster with a given number of nodes.

Implemented by Cluster via ClusterBase.

Properties

NameTypeDescription
clusterEndpoint๐Ÿ”นEndpointThe endpoint to use for read/write operations.
clusterName๐Ÿ”นstringName of the cluster.
connections๐Ÿ”นConnectionsThe network connections associated with this resource.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.

clusterEndpoint๐Ÿ”น

Type: Endpoint

The endpoint to use for read/write operations.


clusterName๐Ÿ”น

Type: string

Name of the cluster.


connections๐Ÿ”น

Type: Connections

The network connections associated with this resource.


env๐Ÿ”น

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node๐Ÿ”น

Type: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
asSecretAttachmentTarget()๐Ÿ”นRenders the target specifications.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


asSecretAttachmentTarget()๐Ÿ”น

public asSecretAttachmentTarget(): SecretAttachmentTargetProps

Returns

  • SecretAttachmentTargetProps

Renders the target specifications.