@aws-cdk/aws-codebuild/lib/artifacts.d.ts

The CDK Construct Library for AWS::CodeBuild

import * as s3 from '@aws-cdk/aws-s3';
import { CfnProject } from './codebuild.generated';
import { IProject } from './project';
import { Construct as CoreConstruct } from '@aws-cdk/core';
/**
 * The type returned from {@link IArtifacts#bind}.
 */
export interface ArtifactsConfig {
    /**
     * The low-level CloudFormation artifacts property.
     */
    readonly artifactsProperty: CfnProject.ArtifactsProperty;
}
/**
 * The abstract interface of a CodeBuild build output.
 * Implemented by {@link Artifacts}.
 */
export interface IArtifacts {
    /**
     * The artifact identifier.
     * This property is required on secondary artifacts.
     */
    readonly identifier?: string;
    /**
     * The CodeBuild type of this artifact.
     */
    readonly type: string;
    /**
     * Callback when an Artifacts class is used in a CodeBuild Project.
     *
     * @param scope a root Construct that allows creating new Constructs
     * @param project the Project this Artifacts is used in
     */
    bind(scope: CoreConstruct, project: IProject): ArtifactsConfig;
}
/**
 * Properties common to all Artifacts classes.
 */
export interface ArtifactsProps {
    /**
     * The artifact identifier.
     * This property is required on secondary artifacts.
     */
    readonly identifier?: string;
}
/**
 * Artifacts definition for a CodeBuild Project.
 */
export declare abstract class Artifacts implements IArtifacts {
    static s3(props: S3ArtifactsProps): IArtifacts;
    readonly identifier?: string;
    abstract readonly type: string;
    protected constructor(props: ArtifactsProps);
    bind(_scope: CoreConstruct, _project: IProject): ArtifactsConfig;
}
/**
 * Construction properties for {@link S3Artifacts}.
 */
export interface S3ArtifactsProps extends ArtifactsProps {
    /**
     * The name of the output bucket.
     */
    readonly bucket: s3.IBucket;
    /**
     * The path inside of the bucket for the build output .zip file or folder.
     * If a value is not specified, then build output will be stored at the root of the
     * bucket (or under the <build-id> directory if `includeBuildId` is set to true).
     *
     * @default the root of the bucket
     */
    readonly path?: string;
    /**
     * The name of the build output ZIP file or folder inside the bucket.
     *
     * The full S3 object key will be "<path>/<build-id>/<name>" or
     * "<path>/<name>" depending on whether `includeBuildId` is set to true.
     *
     * If not set, `overrideArtifactName` will be set and the name from the
     * buildspec will be used instead.
     *
     * @default undefined, and use the name from the buildspec
     */
    readonly name?: string;
    /**
     * Indicates if the build ID should be included in the path. If this is set to true,
     * then the build artifact will be stored in "<path>/<build-id>/<name>".
     *
     * @default true
     */
    readonly includeBuildId?: boolean;
    /**
     * If this is true, all build output will be packaged into a single .zip file.
     * Otherwise, all files will be uploaded to <path>/<name>
     *
     * @default true - files will be archived
     */
    readonly packageZip?: boolean;
    /**
     * If this is false, build output will not be encrypted.
     * This is useful if the artifact to publish a static website or sharing content with others
     *
     * @default true - output will be encrypted
     */
    readonly encryption?: boolean;
}