CodeBuildActionProps Struct

Construction properties of the CodeBuildAction CodeBuild build CodePipeline action.

Source: aws-codepipeline-actions/lib/codebuild/build-action.ts

Example

// Create a Cloudfront Web Distribution
import * as cloudfront from 'aws-cdk-lib/aws-cloudfront';
declare const distribution: cloudfront.Distribution;

// Create the build project that will invalidate the cache
const invalidateBuildProject = new codebuild.PipelineProject(this, `InvalidateProject`, {
  buildSpec: codebuild.BuildSpec.fromObject({
    version: '0.2',
    phases: {
      build: {
        commands:[
          'aws cloudfront create-invalidation --distribution-id ${CLOUDFRONT_ID} --paths "/*"',
          // Choose whatever files or paths you'd like, or all files as specified here
        ],
      },
    },
  }),
  environmentVariables: {
    CLOUDFRONT_ID: { value: distribution.distributionId },
  },
});

// Add Cloudfront invalidation permissions to the project
const distributionArn = `arn:aws:cloudfront::${this.account}:distribution/${distribution.distributionId}`;
invalidateBuildProject.addToRolePolicy(new iam.PolicyStatement({
  resources: [distributionArn],
  actions: [
    'cloudfront:CreateInvalidation',
  ],
}));

// Create the pipeline (here only the S3 deploy and Invalidate cache build)
const deployBucket = new s3.Bucket(this, 'DeployBucket');
const deployInput = new codepipeline.Artifact();
new codepipeline.Pipeline(this, 'Pipeline', {
  stages: [
    // ...
    {
      stageName: 'Deploy',
      actions: [
        new codepipeline_actions.S3DeployAction({
          actionName: 'S3Deploy',
          bucket: deployBucket,
          input: deployInput,
          runOrder: 1,
        }),
        new codepipeline_actions.CodeBuildAction({
          actionName: 'InvalidateCache',
          project: invalidateBuildProject,
          input: deployInput,
          runOrder: 2,
        }),
      ],
    },
  ],
});

Properties

actionNamestringaction_namestractionNameStringActionNamestringActionName*stringrequired#

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

checkSecretsInPlainTextEnvVariablesbooleancheck_secrets_in_plain_text_env_variablesboolcheckSecretsInPlainTextEnvVariablesBooleanCheckSecretsInPlainTextEnvVariablesboolCheckSecretsInPlainTextEnvVariables*bool= true#

Whether to check for the presence of any secrets in the environment variables of the default type, BuildEnvironmentVariableType.PLAINTEXT. Since using a secret for the value of that kind of variable would result in it being displayed in plain text in the AWS Console, the construct will throw an exception if it detects a secret was passed there. Pass this property as false if you want to skip this validation, and keep using a secret in a plain text environment variable.

combineBatchBuildArtifactsbooleancombine_batch_build_artifactsboolcombineBatchBuildArtifactsBooleanCombineBatchBuildArtifactsboolCombineBatchBuildArtifacts*bool= false#

Combine the build artifacts for a batch builds.

Enabling this will combine the build artifacts into the same location for batch builds. If executeBatchBuild is not set to true, this property is ignored.

environmentVariables{ [key: string]: BuildEnvironmentVariable }environment_variablestyping.Mapping[str, BuildEnvironmentVariable]environmentVariablesMap<String, BuildEnvironmentVariable>EnvironmentVariablesIDictionary<string, BuildEnvironmentVariable>EnvironmentVariables*map[string]BuildEnvironmentVariable= No additional environment variab…#

The environment variables to pass to the CodeBuild project when this action executes.

If a variable with the same name was set both on the project level, and here, this value will take precedence.

default

Default: No additional environment variables are specified.

executeBatchBuildbooleanexecute_batch_buildboolexecuteBatchBuildBooleanExecuteBatchBuildboolExecuteBatchBuild*bool= false#

Trigger a batch build.

Enabling this will enable batch builds on the CodeBuild project.

extraInputsArtifact[]extra_inputstyping.List[Artifact]extraInputsList<Artifact>ExtraInputsArtifact[]ExtraInputs*[]Artifact#

The list of additional input Artifacts for this action.

notes

The directories the additional inputs will be available at are available during the project's build in the CODEBUILD_SRC_DIR_<artifact-name> environment variables. The project's build always starts in the directory with the primary input artifact checked out, the one pointed to by the input property. For more information, see https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html .

inputArtifactinputArtifactinputArtifactInputArtifactInputArtifactrequired#

The source to use as input for this action.

outputsArtifact[]outputstyping.List[Artifact]outputsList<Artifact>OutputsArtifact[]Outputs*[]Artifact= the action will not have any out…#

The list of output Artifacts for this action.

notes · default

Note: if you specify more than one output Artifact here, you cannot use the primary 'artifacts' section of the buildspec; you have to use the 'secondary-artifacts' section instead. See https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html for details.

Default: the action will not have any outputs

projectIProjectprojectIProjectprojectIProjectProjectIProjectProjectIProjectrequired#

The action's Project.

roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole= a new Role will be generated#

The Role in which context's this Action will be executing in.

notes

The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property.

runOrdernumberrun_orderint | floatrunOrderNumberRunOrderdoubleRunOrder*float64= 1#

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

typeCodeBuildActionTypetypeCodeBuildActionTypetypeCodeBuildActionTypeTypeCodeBuildActionTypeTypeCodeBuildActionType= CodeBuildActionType.BUILD#

The type of the action that determines its CodePipeline Category - Build, or Test.

variablesNamespacestringvariables_namespacestrvariablesNamespaceStringVariablesNamespacestringVariablesNamespace*string= a name will be generated, based …#

The name of the namespace to use for variables emitted by this action.

default

Default: a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

Used as props by

CodeBuildAction

CodeBuildActionProps Struct ​

Example ​

Properties ​

Used as props by ​

CodeBuildActionProps Struct

Example

Properties

Used as props by