Class S3ArtifactsProps
Construction properties for S3Artifacts
.
Inheritance
Namespace: Amazon.CDK.AWS.CodeBuild
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3ArtifactsProps : Object, IS3ArtifactsProps, IArtifactsProps
Syntax (vb)
Public Class S3ArtifactsProps
Inherits Object
Implements IS3ArtifactsProps, IArtifactsProps
Remarks
ExampleMetadata: infused
Examples
Bucket bucket;
var project = new Project(this, "MyProject", new ProjectProps {
BuildSpec = BuildSpec.FromObject(new Dictionary<string, object> {
{ "version", "0.2" }
}),
Artifacts = Artifacts.S3(new S3ArtifactsProps {
Bucket = bucket,
IncludeBuildId = false,
PackageZip = true,
Path = "another/path",
Identifier = "AddArtifact1"
})
});
Synopsis
Constructors
S3ArtifactsProps() |
Properties
Bucket | The name of the output bucket. |
Encryption | If this is false, build output will not be encrypted. |
Identifier | The artifact identifier. |
IncludeBuildId | Indicates if the build ID should be included in the path. |
Name | The name of the build output ZIP file or folder inside the bucket. |
PackageZip | If this is true, all build output will be packaged into a single .zip file. Otherwise, all files will be uploaded to <path>/<name>. |
Path | 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 |
Constructors
S3ArtifactsProps()
public S3ArtifactsProps()
Properties
Bucket
Encryption
If this is false, build output will not be encrypted.
public Nullable<bool> Encryption { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
This is useful if the artifact to publish a static website or sharing content with others
Default: true - output will be encrypted
Identifier
The artifact identifier.
public string Identifier { get; set; }
Property Value
System.String
Remarks
This property is required on secondary artifacts.
IncludeBuildId
Indicates if the build ID should be included in the path.
public Nullable<bool> IncludeBuildId { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If this is set to true,
then the build artifact will be stored in "
Default: true
Name
The name of the build output ZIP file or folder inside the bucket.
public string Name { get; set; }
Property Value
System.String
Remarks
The full S3 object key will be "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
PackageZip
If this is true, all build output will be packaged into a single .zip file. Otherwise, all files will be uploaded to <path>/<name>.
public Nullable<bool> PackageZip { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true - files will be archived
Path
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).
public string Path { get; set; }
Property Value
System.String
Remarks
Default: the root of the bucket