Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(EcsDeployAction): define service attributes instead of service itself #17917

Closed
wants to merge 1 commit into from
Closed

feat(EcsDeployAction): define service attributes instead of service itself #17917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 53 additions & 3 deletions packages/@aws-cdk/aws-codepipeline-actions/lib/ecs/deploy-action.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ import { deployArtifactBounds } from '../common';
// eslint-disable-next-line no-duplicate-imports, import/order
import { Construct } from '@aws-cdk/core';

/**
* ECS Service Attributes to describle the CodePipeline Actions.
*/
export interface EcsServiceAttribute {
/**
* The ECS serviceName to deploy to.
*/
readonly serviceName: string;
/**
* The ECS clusterName to deploy to.
*/
readonly clusterName: string;
}

/**
* Construction properties of {@link EcsDeployAction}.
*/
Expand Down Expand Up @@ -42,9 +56,23 @@ export interface EcsDeployActionProps extends codepipeline.CommonAwsActionProps

/**
* The ECS Service to deploy.
* @default - one of this property, or `serviceAttributes`, is required
*/
readonly service?: ecs.IBaseService;

/**
* The ECS Service Attributes to deploy, must be specificed with `region` and `role`.
* Ensure if the role being specified is not in the same account has ECS deployment permissions.
* @default - one of this property, or `service`, is required
* @see https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-custom-role.html#how-to-update-role-new-services
*/
readonly service: ecs.IBaseService;
readonly serviceAttributes?: EcsServiceAttribute;

/**
* The region the ECS Service is deployed in, must be specificed when using `serviceAttributes`.
* @default - will be defined by `service`.
*/
readonly region?: string;
/**
* Timeout for the ECS deployment in minutes. Value must be between 1-60.
*
Expand All @@ -71,6 +99,27 @@ export class EcsDeployAction extends Action {
resource: props.service,
});

if (props.service && props.serviceAttributes) {
throw new Error("Exactly one of 'service' or 'serviceAttributes' can be provided in the ECS deploy Action");
}
if (!props.service && !props.serviceAttributes) {
throw new Error("Specifying one of 'service' or 'serviceAttributes' is required for the ECS deploy Action");
}
if (props.serviceAttributes) {
if (!props.region && !props.role) {
throw new Error("Specifying 'region' and 'role' is required when specifying 'serviceAttributes'");
}
if (!props.region) {
throw new Error("Specifying 'region' is required when specifying 'serviceAttributes'");
}
if (!props.role) {
throw new Error("Specifying 'role' is required when specifying 'serviceAttributes'");
}
}
if (props.service && props.region) {
throw new Error("Must not specify 'region' when specifying 'service'");
}

const deploymentTimeout = props.deploymentTimeout?.toMinutes({ integral: true });
if (deploymentTimeout !== undefined && (deploymentTimeout < 1 || deploymentTimeout > 60)) {
throw new Error(`Deployment timeout must be between 1 and 60 minutes, got: ${deploymentTimeout}`);
Expand All @@ -84,6 +133,7 @@ export class EcsDeployAction extends Action {
codepipeline.ActionConfig {
// permissions based on CodePipeline documentation:
// https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-custom-role.html#how-to-update-role-new-services
// If this role is not in the same account, this policy will not be applied.
options.role.addToPolicy(new iam.PolicyStatement({
actions: [
'ecs:DescribeServices',
Expand Down Expand Up @@ -113,8 +163,8 @@ export class EcsDeployAction extends Action {

return {
configuration: {
ClusterName: this.props.service.cluster.clusterName,
ServiceName: this.props.service.serviceName,
ClusterName: this.props.serviceAttributes ? this.props.serviceAttributes!.clusterName : this.props.service!.cluster.clusterName,
ServiceName: this.props.serviceAttributes ? this.props.serviceAttributes!.serviceName: this.props.service!.serviceName,
FileName: this.props.imageFile?.fileName,
DeploymentTimeout: this.deploymentTimeout,
},
Expand Down
Loading