-
Notifications
You must be signed in to change notification settings - Fork 4k
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.
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
feat(apigatewayv2): add aws service integration -- step functions #14498
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
import { ParameterMapping } from '@aws-cdk/aws-apigatewayv2'; | ||
import * as iam from '@aws-cdk/aws-iam'; | ||
import { IStateMachine } from '@aws-cdk/aws-stepfunctions'; | ||
import { Construct } from 'constructs'; | ||
import { AwsServiceIntegration, AwsServiceIntegrationProps } from './private/integration'; | ||
/** | ||
* The common Step Functions integration resource for HTTP API | ||
*/ | ||
abstract class StepFunctionsIntegration extends AwsServiceIntegration { | ||
|
||
/** | ||
* | ||
* @internal | ||
*/ | ||
protected _integrationService(): string { | ||
return 'StepFunctions'; | ||
} | ||
} | ||
|
||
/** | ||
* Step Functions StartExecution integration properties | ||
*/ | ||
export interface StepFunctionsStartExecutionIntegrationProps extends AwsServiceIntegrationProps { | ||
|
||
/** | ||
* The state machine to be executed | ||
*/ | ||
readonly stateMachine: IStateMachine; | ||
|
||
/** | ||
* The execution name | ||
* | ||
* @default - undefined | ||
*/ | ||
readonly name?: string; | ||
|
||
/** | ||
* The input parameters of execution | ||
* | ||
* @default - undefined | ||
*/ | ||
readonly input?: any; | ||
|
||
/** | ||
* The region of state machine | ||
* | ||
* @default - undefined | ||
*/ | ||
readonly region?: string; | ||
|
||
/** | ||
* Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload. | ||
* | ||
* @default - undefined | ||
*/ | ||
readonly traceHeader?: string; | ||
|
||
/** | ||
* Specifies how to transform HTTP requests before sending them to the backend | ||
* @see https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html | ||
* @default undefined requests are sent to the backend unmodified | ||
*/ | ||
readonly parameterMapping?: ParameterMapping; | ||
|
||
} | ||
|
||
/** | ||
* The StepFunctions-StartExecution integration resource for HTTP API | ||
*/ | ||
export class StepFunctionsStartExecutionIntegration extends StepFunctionsIntegration { | ||
|
||
constructor(private readonly _scope: Construct, private readonly _props: StepFunctionsStartExecutionIntegrationProps) { | ||
super(_props); | ||
} | ||
|
||
/** | ||
* | ||
* @internal | ||
*/ | ||
protected _integrationAction(): string { | ||
return 'StartExecution'; | ||
} | ||
|
||
/** | ||
* | ||
* @internal | ||
*/ | ||
protected _fulfillRole(credentialsRole: iam.IRole): void { | ||
this._props.stateMachine.grantStartExecution(credentialsRole); | ||
credentialsRole.attachInlinePolicy( | ||
new iam.Policy(this._scope, 'AllowSfnExec', { | ||
statements: [ | ||
new iam.PolicyStatement({ | ||
actions: ['states:StartExecution'], | ||
effect: iam.Effect.ALLOW, | ||
resources: [this._props.stateMachine.stateMachineArn], | ||
}), | ||
], | ||
}), | ||
); | ||
|
||
} | ||
|
||
/** | ||
* | ||
* @internal | ||
*/ | ||
protected _buildRequestParameters(): { [key: string]: any } { | ||
return { | ||
StateMachineArn: this._props.stateMachine.stateMachineArn, | ||
Name: this._props.name, | ||
Input: this._props.input, | ||
Region: this._props.region, | ||
TraceHeader: this._props.traceHeader, | ||
ParameterMapping: this._props.parameterMapping?.mappings, | ||
}; | ||
} | ||
} | ||
|
||
/** | ||
* Step Functions StartSyncExecution integration properties | ||
*/ | ||
export interface StepFunctionsStartSyncExecutionIntegrationProps extends StepFunctionsStartExecutionIntegrationProps { | ||
} | ||
|
||
/** | ||
* The StepFunctions-StartExecution integration resource for HTTP API | ||
*/ | ||
export class StepFunctionsStartSyncExecutionIntegration extends StepFunctionsIntegration { | ||
|
||
constructor(private readonly _scope: Construct, private readonly _props: StepFunctionsStartSyncExecutionIntegrationProps) { | ||
super(_props); | ||
} | ||
|
||
/** | ||
* | ||
* @internal | ||
*/ | ||
protected _integrationAction(): string { | ||
return 'StartSyncExecution'; | ||
} | ||
|
||
/** | ||
* | ||
* @internal | ||
*/ | ||
protected _fulfillRole(credentialsRole: iam.IRole): void { | ||
|
||
this._props.stateMachine.grantExecution(credentialsRole.grantPrincipal, 'states:StartSyncExecution'); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. could you please clarify what is this line of code doing? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It grants the execution permission, but does not attach the policy. That needs to be done explicitly. |
||
credentialsRole.attachInlinePolicy( | ||
new iam.Policy(this._scope, 'AllowSfnSyncExec', { | ||
statements: [ | ||
new iam.PolicyStatement({ | ||
actions: ['states:StartSyncExecution'], | ||
effect: iam.Effect.ALLOW, | ||
resources: [this._props.stateMachine.stateMachineArn], | ||
}), | ||
], | ||
}), | ||
); | ||
|
||
} | ||
|
||
/** | ||
* | ||
* @internal | ||
*/ | ||
protected _buildRequestParameters(): { [key: string]: any } { | ||
return { | ||
StateMachineArn: this._props.stateMachine.stateMachineArn, | ||
Name: this._props.name, | ||
Input: this._props.input, | ||
Region: this._props.region, | ||
TraceHeader: this._props.traceHeader, | ||
ParameterMapping: this._props.parameterMapping?.mappings, | ||
}; | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this one says StartExecution but later on L79 you are giving permission to StartSyncExecution.
Also resources [*] should be avoided if you have the state machine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good Note. I will fix this. Thank you