commonMain.aws.sdk.kotlin.services.codepipeline.model.ActionDeclaration.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of codepipeline-jvm Show documentation
Show all versions of codepipeline-jvm Show documentation
The AWS SDK for Kotlin client for CodePipeline
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.codepipeline.model
import aws.smithy.kotlin.runtime.SdkDsl
/**
* Represents information about an action declaration.
*/
public class ActionDeclaration private constructor(builder: Builder) {
/**
* Specifies the action type and the provider of the action.
*/
public val actionTypeId: aws.sdk.kotlin.services.codepipeline.model.ActionTypeId? = builder.actionTypeId
/**
* The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
*
* Using compute time for this action will incur separate charges in CodeBuild.
*/
public val commands: List? = builder.commands
/**
* The action's configuration. These are key-value pairs that specify input values for an action. For more information, see [Action Structure Requirements in CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements). For the list of configuration properties for the CloudFormation action type in CodePipeline, see [Configuration Properties Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html) in the *CloudFormation User Guide*. For template snippets with examples, see [Using Parameter Override Functions with CodePipeline Pipelines](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html) in the *CloudFormation User Guide*.
*
* The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
*
* *JSON:*
*
* `"Configuration" : { Key : Value },`
*/
public val configuration: Map? = builder.configuration
/**
* The name or ID of the artifact consumed by the action, such as a test or build artifact.
*/
public val inputArtifacts: List? = builder.inputArtifacts
/**
* The action declaration's name.
*/
public val name: kotlin.String = requireNotNull(builder.name) { "A non-null value must be provided for name" }
/**
* The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
*/
public val namespace: kotlin.String? = builder.namespace
/**
* The name or ID of the result of the action declaration, such as a test or build artifact.
*/
public val outputArtifacts: List? = builder.outputArtifacts
/**
* The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
*/
public val outputVariables: List? = builder.outputVariables
/**
* The action declaration's Amazon Web Services Region, such as us-east-1.
*/
public val region: kotlin.String? = builder.region
/**
* The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
*/
public val roleArn: kotlin.String? = builder.roleArn
/**
* The order in which actions are run.
*/
public val runOrder: kotlin.Int? = builder.runOrder
/**
* A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in [Quotas for CodePipeline ](https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html). This attribute is available only to the manual approval ActionType.
*/
public val timeoutInMinutes: kotlin.Int? = builder.timeoutInMinutes
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.codepipeline.model.ActionDeclaration = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("ActionDeclaration(")
append("actionTypeId=$actionTypeId,")
append("commands=$commands,")
append("configuration=$configuration,")
append("inputArtifacts=$inputArtifacts,")
append("name=$name,")
append("namespace=$namespace,")
append("outputArtifacts=$outputArtifacts,")
append("outputVariables=$outputVariables,")
append("region=$region,")
append("roleArn=$roleArn,")
append("runOrder=$runOrder,")
append("timeoutInMinutes=$timeoutInMinutes")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = actionTypeId?.hashCode() ?: 0
result = 31 * result + (commands?.hashCode() ?: 0)
result = 31 * result + (configuration?.hashCode() ?: 0)
result = 31 * result + (inputArtifacts?.hashCode() ?: 0)
result = 31 * result + (name.hashCode())
result = 31 * result + (namespace?.hashCode() ?: 0)
result = 31 * result + (outputArtifacts?.hashCode() ?: 0)
result = 31 * result + (outputVariables?.hashCode() ?: 0)
result = 31 * result + (region?.hashCode() ?: 0)
result = 31 * result + (roleArn?.hashCode() ?: 0)
result = 31 * result + (runOrder ?: 0)
result = 31 * result + (timeoutInMinutes ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as ActionDeclaration
if (actionTypeId != other.actionTypeId) return false
if (commands != other.commands) return false
if (configuration != other.configuration) return false
if (inputArtifacts != other.inputArtifacts) return false
if (name != other.name) return false
if (namespace != other.namespace) return false
if (outputArtifacts != other.outputArtifacts) return false
if (outputVariables != other.outputVariables) return false
if (region != other.region) return false
if (roleArn != other.roleArn) return false
if (runOrder != other.runOrder) return false
if (timeoutInMinutes != other.timeoutInMinutes) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.codepipeline.model.ActionDeclaration = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* Specifies the action type and the provider of the action.
*/
public var actionTypeId: aws.sdk.kotlin.services.codepipeline.model.ActionTypeId? = null
/**
* The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
*
* Using compute time for this action will incur separate charges in CodeBuild.
*/
public var commands: List? = null
/**
* The action's configuration. These are key-value pairs that specify input values for an action. For more information, see [Action Structure Requirements in CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements). For the list of configuration properties for the CloudFormation action type in CodePipeline, see [Configuration Properties Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html) in the *CloudFormation User Guide*. For template snippets with examples, see [Using Parameter Override Functions with CodePipeline Pipelines](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html) in the *CloudFormation User Guide*.
*
* The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
*
* *JSON:*
*
* `"Configuration" : { Key : Value },`
*/
public var configuration: Map? = null
/**
* The name or ID of the artifact consumed by the action, such as a test or build artifact.
*/
public var inputArtifacts: List? = null
/**
* The action declaration's name.
*/
public var name: kotlin.String? = null
/**
* The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
*/
public var namespace: kotlin.String? = null
/**
* The name or ID of the result of the action declaration, such as a test or build artifact.
*/
public var outputArtifacts: List? = null
/**
* The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
*/
public var outputVariables: List? = null
/**
* The action declaration's Amazon Web Services Region, such as us-east-1.
*/
public var region: kotlin.String? = null
/**
* The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
*/
public var roleArn: kotlin.String? = null
/**
* The order in which actions are run.
*/
public var runOrder: kotlin.Int? = null
/**
* A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in [Quotas for CodePipeline ](https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html). This attribute is available only to the manual approval ActionType.
*/
public var timeoutInMinutes: kotlin.Int? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.codepipeline.model.ActionDeclaration) : this() {
this.actionTypeId = x.actionTypeId
this.commands = x.commands
this.configuration = x.configuration
this.inputArtifacts = x.inputArtifacts
this.name = x.name
this.namespace = x.namespace
this.outputArtifacts = x.outputArtifacts
this.outputVariables = x.outputVariables
this.region = x.region
this.roleArn = x.roleArn
this.runOrder = x.runOrder
this.timeoutInMinutes = x.timeoutInMinutes
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.codepipeline.model.ActionDeclaration = ActionDeclaration(this)
/**
* construct an [aws.sdk.kotlin.services.codepipeline.model.ActionTypeId] inside the given [block]
*/
public fun actionTypeId(block: aws.sdk.kotlin.services.codepipeline.model.ActionTypeId.Builder.() -> kotlin.Unit) {
this.actionTypeId = aws.sdk.kotlin.services.codepipeline.model.ActionTypeId.invoke(block)
}
internal fun correctErrors(): Builder {
if (name == null) name = ""
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy