Package-level declarations

Types

Link copied to clipboard
data class CustomActionTypeArtifactDetails(val maximumCount: Int, val minimumCount: Int)

Returns information about the details of an artifact.

Link copied to clipboard
data class CustomActionTypeConfigurationProperties(val description: String? = null, val key: Boolean, val name: String, val queryable: Boolean? = null, val required: Boolean, val secret: Boolean, val type: String? = null)

The configuration properties for the custom action.

Link copied to clipboard
data class CustomActionTypeSettings(val entityUrlTemplate: String? = null, val executionUrlTemplate: String? = null, val revisionUrlTemplate: String? = null, val thirdPartyConfigurationUrl: String? = null)

Settings is a property of the AWS::CodePipeline::CustomActionType resource that provides URLs that users can access to view information about the CodePipeline custom action.

Link copied to clipboard
data class GetCustomActionTypeResult(val id: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetPipelineResult(val artifactStore: PipelineArtifactStore? = null, val artifactStores: List<PipelineArtifactStoreMap>? = null, val disableInboundStageTransitions: List<PipelineStageTransition>? = null, val executionMode: PipelineExecutionMode? = null, val pipelineType: PipelineType? = null, val roleArn: String? = null, val stages: List<PipelineStageDeclaration>? = null, val tags: List<Tag>? = null, val triggers: List<PipelineTriggerDeclaration>? = null, val variables: List<PipelineVariableDeclaration>? = null, val version: String? = null)
Link copied to clipboard
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.

Link copied to clipboard
data class PipelineActionTypeId(val category: PipelineActionTypeIdCategory, val owner: String, val provider: String, val version: String)

Represents information about an action type.

Link copied to clipboard
data class PipelineArtifactStore(val encryptionKey: PipelineEncryptionKey? = null, val location: String, val type: PipelineArtifactStoreType)

The S3 bucket where artifacts for the pipeline are stored.

Link copied to clipboard
data class PipelineArtifactStoreMap(val artifactStore: PipelineArtifactStore, val region: String)

A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

Link copied to clipboard
data class PipelineBeforeEntryConditions(val conditions: List<PipelineCondition>? = null)

The configuration that specifies the rules to run before stage starts.

Link copied to clipboard

Reserved for future use.

Link copied to clipboard
data class PipelineCondition(val result: String? = null, val rules: List<PipelineRuleDeclaration>? = null)

Represents information about condition.

Link copied to clipboard
data class PipelineEncryptionKey(val id: String, val type: String)

Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key

Link copied to clipboard
data class PipelineEnvironmentVariable(val name: String, val type: PipelineEnvironmentVariableType? = null, val value: String)

Represents information about the environment variable of an action.

Link copied to clipboard
data class PipelineFailureConditions(val conditions: List<PipelineCondition>? = null, val result: PipelineFailureConditionsResult? = null, val retryConfiguration: PipelineFailureConditionsRetryConfigurationProperties? = null)

The configuration that specifies the result, such as rollback, to occur upon stage failure

The configuration that specifies the retry configuration for a stage

Link copied to clipboard
data class PipelineGitBranchFilterCriteria(val excludes: List<String>? = null, val includes: List<String>? = null)

The Git repository branches specified as filter criteria to start the pipeline.

Link copied to clipboard
data class PipelineGitConfiguration(val pullRequest: List<PipelineGitPullRequestFilter>? = null, val push: List<PipelineGitPushFilter>? = null, val sourceActionName: String)

A type of trigger configuration for Git-based source actions.

Link copied to clipboard
data class PipelineGitFilePathFilterCriteria(val excludes: List<String>? = null, val includes: List<String>? = null)

The Git repository file paths specified as filter criteria to start the pipeline.

Link copied to clipboard
data class PipelineGitPullRequestFilter(val branches: PipelineGitBranchFilterCriteria? = null, val events: List<String>? = null, val filePaths: PipelineGitFilePathFilterCriteria? = null)

The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.

Link copied to clipboard
data class PipelineGitPushFilter(val branches: PipelineGitBranchFilterCriteria? = null, val filePaths: PipelineGitFilePathFilterCriteria? = null, val tags: PipelineGitTagFilterCriteria? = null)

The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.

Link copied to clipboard
data class PipelineGitTagFilterCriteria(val excludes: List<String>? = null, val includes: List<String>? = null)

The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.

Link copied to clipboard
data class PipelineInputArtifact(val name: String)

Represents information about an artifact to be worked on, such as a test or build artifact.

Link copied to clipboard
data class PipelineOutputArtifact(val files: List<String>? = null, val name: String)

Represents information about the output of an action.

Link copied to clipboard
data class PipelineRuleDeclaration(val commands: List<String>? = null, val configuration: Any? = null, val inputArtifacts: List<PipelineInputArtifact>? = null, val name: String? = null, val region: String? = null, val roleArn: String? = null, val ruleTypeId: PipelineRuleTypeId? = null)

Represents information about condition.

Link copied to clipboard
data class PipelineRuleTypeId(val category: String? = null, val owner: String? = null, val provider: String? = null, val version: String? = null)

Represents information about a rule type.

Link copied to clipboard
data class PipelineStageDeclaration(val actions: List<PipelineActionDeclaration>, val beforeEntry: PipelineBeforeEntryConditions? = null, val blockers: List<PipelineBlockerDeclaration>? = null, val name: String, val onFailure: PipelineFailureConditions? = null, val onSuccess: PipelineSuccessConditions? = null)

Represents information about a stage and its definition.

Link copied to clipboard
data class PipelineStageTransition(val reason: String, val stageName: String)

The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.

Link copied to clipboard
data class PipelineSuccessConditions(val conditions: List<PipelineCondition>? = null)

The configuration that specifies the result, such as rollback, to occur upon stage failure

Link copied to clipboard
data class PipelineTriggerDeclaration(val gitConfiguration: PipelineGitConfiguration? = null, val providerType: PipelineTriggerDeclarationProviderType)

Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.

Link copied to clipboard
data class PipelineVariableDeclaration(val defaultValue: String? = null, val description: String? = null, val name: String)

A variable declared at the pipeline level.