Experimental
@aws-cdk/aws-redshift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ResourceAction Enum
The Amazon Redshift operation.
| Stability | Experimental |
|---|---|
| Source | lib/cluster.ts |
Example
ts
import * as ec2 from 'aws-cdk-lib/aws-ec2';
import { ResourceAction } from '@aws-cdk/aws-redshift-alpha';
declare const vpc: ec2.IVpc;
// Pause the cluster
new Cluster(this, 'PausedCluster', {
masterUser: {
masterUsername: 'admin',
},
vpc,
resourceAction: ResourceAction.PAUSE,
});
// Resume the cluster
new Cluster(this, 'ResumedCluster', {
masterUser: {
masterUsername: 'admin',
},
vpc,
resourceAction: ResourceAction.RESUME,
});
// Failover the cluster
new Cluster(this, 'FailOverCluster', {
masterUser: {
masterUsername: 'admin',
},
// VPC must have 3 AZs for the cluster which executes failover action
vpc,
// Must be a multi-AZ cluster to failover
multiAz: true,
resourceAction: ResourceAction.FAILOVER_PRIMARY_COMPUTE,
});
python
from aws_cdk.aws_redshift_alpha import Login, Login, Login
import aws_cdk.aws_ec2 as ec2
from aws_cdk.aws_redshift_alpha import ResourceAction
# vpc: ec2.IVpc
# Pause the cluster
Cluster(self, "PausedCluster",
master_user=Login(
master_username="admin"
),
vpc=vpc,
resource_action=ResourceAction.PAUSE
)
# Resume the cluster
Cluster(self, "ResumedCluster",
master_user=Login(
master_username="admin"
),
vpc=vpc,
resource_action=ResourceAction.RESUME
)
# Failover the cluster
Cluster(self, "FailOverCluster",
master_user=Login(
master_username="admin"
),
# VPC must have 3 AZs for the cluster which executes failover action
vpc=vpc,
# Must be a multi-AZ cluster to failover
multi_az=True,
resource_action=ResourceAction.FAILOVER_PRIMARY_COMPUTE
)
java
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.redshift.alpha.ResourceAction;
IVpc vpc;
// Pause the cluster
// Pause the cluster
Cluster.Builder.create(this, "PausedCluster")
.masterUser(Login.builder()
.masterUsername("admin")
.build())
.vpc(vpc)
.resourceAction(ResourceAction.PAUSE)
.build();
// Resume the cluster
// Resume the cluster
Cluster.Builder.create(this, "ResumedCluster")
.masterUser(Login.builder()
.masterUsername("admin")
.build())
.vpc(vpc)
.resourceAction(ResourceAction.RESUME)
.build();
// Failover the cluster
// Failover the cluster
Cluster.Builder.create(this, "FailOverCluster")
.masterUser(Login.builder()
.masterUsername("admin")
.build())
// VPC must have 3 AZs for the cluster which executes failover action
.vpc(vpc)
// Must be a multi-AZ cluster to failover
.multiAz(true)
.resourceAction(ResourceAction.FAILOVER_PRIMARY_COMPUTE)
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Redshift.Alpha
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.Redshift.Alpha;
IVpc vpc;
// Pause the cluster
// Pause the cluster
new Cluster(this, "PausedCluster", new ClusterProps {
MasterUser = new Login {
MasterUsername = "admin"
},
Vpc = vpc,
ResourceAction = ResourceAction.PAUSE
});
// Resume the cluster
// Resume the cluster
new Cluster(this, "ResumedCluster", new ClusterProps {
MasterUser = new Login {
MasterUsername = "admin"
},
Vpc = vpc,
ResourceAction = ResourceAction.RESUME
});
// Failover the cluster
// Failover the cluster
new Cluster(this, "FailOverCluster", new ClusterProps {
MasterUser = new Login {
MasterUsername = "admin"
},
// VPC must have 3 AZs for the cluster which executes failover action
Vpc = vpc,
// Must be a multi-AZ cluster to failover
MultiAz = true,
ResourceAction = ResourceAction.FAILOVER_PRIMARY_COMPUTE
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkredshiftalpha/v2
import ec2 "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdkredshiftalpha"
var vpc IVpc
// Pause the cluster
// Pause the cluster
awscdkredshiftalpha.NewCluster(this, jsii.String("PausedCluster"), &ClusterProps{
MasterUser: &Login{
MasterUsername: jsii.String("admin"),
},
Vpc: Vpc,
ResourceAction: awscdkredshiftalpha.ResourceAction_PAUSE,
})
// Resume the cluster
// Resume the cluster
awscdkredshiftalpha.NewCluster(this, jsii.String("ResumedCluster"), &ClusterProps{
MasterUser: &Login{
MasterUsername: jsii.String("admin"),
},
Vpc: Vpc,
ResourceAction: awscdkredshiftalpha.ResourceAction_RESUME,
})
// Failover the cluster
// Failover the cluster
awscdkredshiftalpha.NewCluster(this, jsii.String("FailOverCluster"), &ClusterProps{
MasterUser: &Login{
MasterUsername: jsii.String("admin"),
},
// VPC must have 3 AZs for the cluster which executes failover action
Vpc: Vpc,
// Must be a multi-AZ cluster to failover
MultiAz: jsii.Boolean(true),
ResourceAction: awscdkredshiftalpha.ResourceAction_FAILOVER_PRIMARY_COMPUTE,
})
Members
| Member | Description |
|---|---|
PAUSE_CLUSTER | Pause the cluster. |
RESUME_CLUSTER | Resume the cluster. |
FAILOVER_PRIMARY_COMPUTE | Failing over to the other availability zone. |
Referenced by
ClusterProps.resourceActionresource_actionresourceActionResourceActionResourceAction