aws-cdk-lib.pipelines.ConfirmPermissionsBroadening

class ConfirmPermissionsBroadening

LanguageType name
.NETAmazon.CDK.Pipelines.ConfirmPermissionsBroadening
Gogithub.com/aws/aws-cdk-go/awscdk/v2/pipelines#ConfirmPermissionsBroadening
Javasoftware.amazon.awscdk.pipelines.ConfirmPermissionsBroadening
Pythonaws_cdk.pipelines.ConfirmPermissionsBroadening
TypeScript (source)aws-cdk-lib » pipelines » ConfirmPermissionsBroadening

Implements IFileSetProducer, ICodePipelineActionFactory

Extends Step

Pause the pipeline if a deployment would add IAM permissions or Security Group rules.

This step is only supported in CodePipeline pipelines.

Example

declare const pipeline: pipelines.CodePipeline;
const stage = new MyApplicationStage(this, 'MyApplication');
pipeline.addStage(stage, {
  pre: [
    new pipelines.ConfirmPermissionsBroadening('Check', { stage }),
  ],
});

Initializer

new ConfirmPermissionsBroadening(id: string, props: PermissionsBroadeningCheckProps)

Parameters

  • id string — Identifier for this step.
  • props PermissionsBroadeningCheckProps

Properties

NameTypeDescription
consumedStackOutputsStackOutputReference[]StackOutputReferences this step consumes.
dependenciesStep[]Return the steps this step depends on, based on the FileSets it requires.
dependencyFileSetsFileSet[]The list of FileSets consumed by this Step.
idstringIdentifier for this step.
isSourcebooleanWhether or not this is a Source step.
primaryOutput?FileSetThe primary FileSet produced by this Step.

consumedStackOutputs

Type: StackOutputReference[]

StackOutputReferences this step consumes.


dependencies

Type: Step[]

Return the steps this step depends on, based on the FileSets it requires.


dependencyFileSets

Type: FileSet[]

The list of FileSets consumed by this Step.


id

Type: string

Identifier for this step.


isSource

Type: boolean

Whether or not this is a Source step.

What it means to be a Source step depends on the engine.


primaryOutput?

Type: FileSet (optional)

The primary FileSet produced by this Step.

Not all steps produce an output FileSet--if they do you can substitute the Step object for the FileSet object.

Methods

NameDescription
addStepDependency(step)Add a dependency on another step.
produceAction(stage, options)Create the desired Action and add it to the pipeline.
toString()Return a string representation of this Step.

addStepDependency(step)

public addStepDependency(step: Step): void

Parameters

  • step Step

Add a dependency on another step.


produceAction(stage, options)

public produceAction(stage: IStage, options: ProduceActionOptions): CodePipelineActionFactoryResult

Parameters

  • stage IStage
  • options ProduceActionOptions

Returns

  • CodePipelineActionFactoryResult

Create the desired Action and add it to the pipeline.


toString()

public toString(): string

Returns

  • string

Return a string representation of this Step.