Skip to content

Commit

Permalink
feat(msk): support ServerlessCluster
Browse files Browse the repository at this point in the history
  • Loading branch information
mazyu36 committed Jan 8, 2025
1 parent db345c5 commit 6147f11
Show file tree
Hide file tree
Showing 14 changed files with 3,331 additions and 1 deletion.
1 change: 1 addition & 0 deletions packages/@aws-cdk/aws-msk-alpha/awslint.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"exclude": [
"props-physical-name:@aws-cdk/aws-msk-alpha.ServerlessClusterProps"
]
}
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-msk-alpha/lib/cluster.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export interface ICluster extends core.IResource, ec2.IConnectable {
/**
* A new or imported MSK Cluster.
*/
abstract class ClusterBase extends core.Resource implements ICluster {
export abstract class ClusterBase extends core.Resource implements ICluster {
public abstract readonly clusterArn: string;
public abstract readonly clusterName: string;
/** @internal */
Expand Down
1 change: 1 addition & 0 deletions packages/@aws-cdk/aws-msk-alpha/lib/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export * from './cluster';
export * from './cluster-version';
export * from './serverless-cluster';

// AWS::MSK CloudFormation Resources:
157 changes: 157 additions & 0 deletions packages/@aws-cdk/aws-msk-alpha/lib/serverless-cluster.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
import * as ec2 from 'aws-cdk-lib/aws-ec2';
import { Fn, Lazy, Names, Token } from 'aws-cdk-lib';
import * as constructs from 'constructs';
import { ClusterBase, ICluster } from '.';
import { CfnServerlessCluster } from 'aws-cdk-lib/aws-msk';

/**
* Properties for a MSK Serverless Cluster
*/
export interface ServerlessClusterProps {
/**
* The physical name of the cluster.
*
* @default - auto generate
*/
readonly clusterName?: string;

/**
* The configuration of the Amazon VPCs for the cluster.
* You can specify up to 5 VPC configurations.
*/
readonly vpcConfigs: VpcConfig[];
}

/**
* The configuration of the Amazon VPCs for the cluster.
*/
export interface VpcConfig {
/**
* Defines the virtual networking environment for this cluster.
* Must have at least 2 subnets in two different AZs.
*/
readonly vpc: ec2.IVpc;

/**
* The subnets associated with the cluster.
*
* @default - the Vpc default strategy if not specified.
*/
readonly vpcSubnets?: ec2.SubnetSelection;

/**
* The security groups associated with the cluster.
* You can specify up to 5 security groups.
*
* @default - create new security group
*/
readonly securityGroups?: ec2.ISecurityGroup[];
}

/**
* Create a MSK Serverless Cluster.
*
* @resource AWS::MSK::ServerlessCluster
*/
export class ServerlessCluster extends ClusterBase {
/**
* Reference an existing cluster, defined outside of the CDK code, by name.
*/
public static fromClusterArn(
scope: constructs.Construct,
id: string,
clusterArn: string,
): ICluster {
class Import extends ClusterBase {
public readonly clusterArn = clusterArn;
public readonly clusterName = Fn.select(1, Fn.split('/', clusterArn)); // ['arn:partition:kafka:region:account-id', clusterName, clusterId]
}

return new Import(scope, id);
}

public readonly clusterArn: string;
public readonly clusterName: string;

private _securityGroups: ec2.ISecurityGroup[] = [];

constructor(scope: constructs.Construct, id: string, props: ServerlessClusterProps) {
if (!Token.isUnresolved(props.clusterName) && props.clusterName !== undefined) {
if (!/^[a-zA-Z0-9]+$/.test(props.clusterName)) {
throw Error(`The cluster name must only contain alphanumeric characters. got: ${props.clusterName}.`);
}

if (props.clusterName.length > 64) {
throw Error(`The cluster name must not exceed 64 characters. got: ${props.clusterName.length} characters.`);
}
}

super(scope, id, {
physicalName: props.clusterName ??
Lazy.string({
produce: () => Names.uniqueResourceName(this, { maxLength: 64 }),
}),
});

if (props.vpcConfigs.length < 1 || props.vpcConfigs.length > 5) {
throw Error(`\`vpcConfigs\` must contain between 1 and 5 configurations, got ${props.vpcConfigs.length} configurations.`);
}

const vpcConfigs = props.vpcConfigs.map((vpcConfig, index) => this._renderVpcConfig(vpcConfig, index));

this._connections = new ec2.Connections({
securityGroups: this._securityGroups,
});

const resource = new CfnServerlessCluster(this, 'Resource', {
clusterName: this.physicalName,
clientAuthentication: {
sasl: {
iam: {
enabled: true,
},
},
},
vpcConfigs,
});

this.clusterName = this.getResourceNameAttribute(
Fn.select(1, Fn.split('/', resource.ref)),
);
this.clusterArn = resource.ref;
}

/**
* Render Vpc Config property
*/
private _renderVpcConfig(vpcConfig: VpcConfig, index: number): CfnServerlessCluster.VpcConfigProperty {
const subnetSelection = vpcConfig.vpc.selectSubnets(vpcConfig.vpcSubnets);

if (subnetSelection.subnets.length < 2) {
throw Error(
`Cluster requires at least 2 subnets, got ${subnetSelection.subnets.length}.`,
);
}

let securityGroups: ec2.ISecurityGroup[] = [];

if (vpcConfig.securityGroups) {
if (vpcConfig.securityGroups.length > 5) {
throw Error(`\`securityGroups\` must not exceed 5 elements, got ${vpcConfig.securityGroups.length} elements.`);
}
securityGroups = vpcConfig.securityGroups;
} else {
securityGroups.push(new ec2.SecurityGroup(this, `SecurityGroup-${index}`, {
description: 'MSK Serverless security group',
vpc: vpcConfig.vpc,
}));
}

this._securityGroups.push(...securityGroups);

return {
subnetIds: subnetSelection.subnets.map((subnet) => subnet.subnetId),
securityGroups: securityGroups?.map((securityGroup) => securityGroup.securityGroupId),
};
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 6147f11

Please sign in to comment.