CodeBuildActionProps

class aws_cdk.aws_codepipeline_actions.CodeBuildActionProps(*, action_name, run_order=None, variables_namespace=None, role=None, input, project, environment_variables=None, extra_inputs=None, outputs=None, type=None)

Bases: aws_cdk.aws_codepipeline.CommonAwsActionProps

__init__(*, action_name, run_order=None, variables_namespace=None, role=None, input, project, environment_variables=None, extra_inputs=None, outputs=None, type=None)

Construction properties of the {@link CodeBuildAction CodeBuild build CodePipeline action}.

Parameters
  • action_name (str) – The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.

  • run_order (Union[int, float, None]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1

  • variables_namespace (Optional[str]) – The name of the namespace to use for variables emitted by this action. 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

  • role (Optional[IRole]) – The Role in which context’s this Action will be executing in. 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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property. Default: a new Role will be generated

  • input (Artifact) – The source to use as input for this action.

  • project (IProject) – The action’s Project.

  • environment_variables (Optional[Mapping[str, BuildEnvironmentVariable]]) – 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: - No additional environment variables are specified.

  • extra_inputs (Optional[List[Artifact]]) – The list of additional input Artifacts for this action. The directories the additional inputs will be available at are available during the project’s build in the CODEBUILD_SRC_DIR_ environment variables. The project’s build always starts in the directory with the primary input artifact checked out, the one pointed to by the {@link input} property. For more information, see https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html .

  • outputs (Optional[List[Artifact]]) – The list of output Artifacts for this action. 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

  • type (Optional[CodeBuildActionType]) – The type of the action that determines its CodePipeline Category - Build, or Test. Default: CodeBuildActionType.BUILD

Return type

None

Attributes

action_name

The physical, human-readable name of the Action.

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

Return type

str

environment_variables

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.

Return type

Optional[Mapping[str, BuildEnvironmentVariable]]

extra_inputs

The list of additional input Artifacts for this action.

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

Return type

Optional[List[Artifact]]

input

The source to use as input for this action.

Return type

Artifact

outputs

The list of output Artifacts for this action.

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 :default: the action will not have any outputs

Return type

Optional[List[Artifact]]

project

The action’s Project.

Return type

IProject

role

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

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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

default :default: a new Role will be generated

Return type

Optional[IRole]

run_order

The runOrder property for this Action.

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

default :default: 1

see :see: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

Return type

Union[int, float, None]

type

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

default :default: CodeBuildActionType.BUILD

Return type

Optional[CodeBuildActionType]

variables_namespace

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

Return type

Optional[str]