PipelineActionDeclaration

data class PipelineActionDeclaration(val actionTypeId: PipelineActionTypeId, val commands: List<String>? = null, val configuration: Any? = null, val environmentVariables: List<PipelineEnvironmentVariable>? = null, val inputArtifacts: List<PipelineInputArtifact>? = null, val name: String, val namespace: String? = null, val outputArtifacts: List<PipelineOutputArtifact>? = null, val outputVariables: List<String>? = null, val region: String? = null, val roleArn: String? = null, val runOrder: Int? = null, val timeoutInMinutes: Int? = null)

Represents information about an action declaration.

Constructors

Link copied to clipboard
constructor(actionTypeId: PipelineActionTypeId, commands: List<String>? = null, configuration: Any? = null, environmentVariables: List<PipelineEnvironmentVariable>? = null, inputArtifacts: List<PipelineInputArtifact>? = null, name: String, namespace: String? = null, outputArtifacts: List<PipelineOutputArtifact>? = null, outputVariables: List<String>? = null, region: String? = null, roleArn: String? = null, runOrder: Int? = null, timeoutInMinutes: Int? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Specifies the action type and the provider of the action.

Link copied to clipboard
val commands: List<String>? = null

The shell commands to run with your compute action in CodePipeline.

Link copied to clipboard
val configuration: Any? = null

The action's configuration. These are key-value pairs that specify input values for an action.

Link copied to clipboard

The list of environment variables that are input to a compute based action.

Link copied to clipboard

The name or ID of the artifact consumed by the action, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .

Link copied to clipboard

The action declaration's name.

Link copied to clipboard
val namespace: String? = null

The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

Link copied to clipboard

The name or ID of the result of the action declaration, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .

Link copied to clipboard

The list of variables that are to be exported from the compute action.

Link copied to clipboard
val region: String? = null

The action declaration's AWS Region, such as us-east-1.

Link copied to clipboard
val roleArn: String? = null

The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.

Link copied to clipboard
val runOrder: Int? = null

The order in which actions are run.

Link copied to clipboard
val timeoutInMinutes: Int? = null

A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for AWS CodePipeline. This attribute is available only to the manual approval ActionType.