Skip to content
v2.277.0

Experimental

@aws-cdk/aws-redshift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ClusterAttributes Struct ​

Properties that describe an existing cluster instance.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';

declare const securityGroup: ec2.SecurityGroup;
const clusterAttributes: redshift_alpha.ClusterAttributes = {
  clusterEndpointAddress: 'clusterEndpointAddress',
  clusterEndpointPort: 123,
  clusterName: 'clusterName',

  // the properties below are optional
  securityGroups: [securityGroup],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift_alpha as redshift_alpha
from aws_cdk import aws_ec2 as ec2

# security_group: ec2.SecurityGroup

cluster_attributes = redshift_alpha.ClusterAttributes(
    cluster_endpoint_address="clusterEndpointAddress",
    cluster_endpoint_port=123,
    cluster_name="clusterName",

    # the properties below are optional
    security_groups=[security_group]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.redshift.alpha.*;
import software.amazon.awscdk.services.ec2.*;

SecurityGroup securityGroup;

ClusterAttributes clusterAttributes = ClusterAttributes.builder()
        .clusterEndpointAddress("clusterEndpointAddress")
        .clusterEndpointPort(123)
        .clusterName("clusterName")

        // the properties below are optional
        .securityGroups(List.of(securityGroup))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Redshift.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Redshift.Alpha;
using Amazon.CDK.AWS.EC2;

SecurityGroup securityGroup;

var clusterAttributes = new ClusterAttributes {
    ClusterEndpointAddress = "clusterEndpointAddress",
    ClusterEndpointPort = 123,
    ClusterName = "clusterName",

    // the properties below are optional
    SecurityGroups = new [] { securityGroup }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdkredshiftalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import redshift_alpha "github.com/aws/aws-cdk-go/awscdkredshiftalpha"
import "github.com/aws/aws-cdk-go/awscdk"

var securityGroup SecurityGroup

clusterAttributes := &ClusterAttributes{
	ClusterEndpointAddress: jsii.String("clusterEndpointAddress"),
	ClusterEndpointPort: jsii.Number(123),
	ClusterName: jsii.String("clusterName"),

	// the properties below are optional
	SecurityGroups: []ISecurityGroup{
		securityGroup,
	},
}

Properties ​

clusterEndpointAddressstringcluster_endpoint_addressstrclusterEndpointAddressStringClusterEndpointAddressstringClusterEndpointAddress*stringrequired#
Cluster endpoint address.
clusterEndpointPortnumbercluster_endpoint_portint | floatclusterEndpointPortNumberClusterEndpointPortdoubleClusterEndpointPort*float64required#
Cluster endpoint port.
clusterNamestringcluster_namestrclusterNameStringClusterNamestringClusterName*stringrequired#
Identifier for the cluster.
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup#
The security groups of the redshift cluster.

Default: no security groups will be attached to the import