software.amazon.awscdk.services.codepipeline

Class Artifact

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codepipeline.Artifact

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:56.602Z")
 @Stability(value=Experimental)
public class Artifact
extends software.amazon.jsii.JsiiObject

(experimental) An output artifact of an action.

Artifacts can be used as input by some actions.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	Artifact()
protected	Artifact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Artifact(software.amazon.jsii.JsiiObjectRef objRef)
	Artifact(String artifactName)

Method Summary

Modifier and Type	Method and Description
static Artifact	artifact(String name) (experimental) A static factory method used to create instances of the Artifact class.
ArtifactPath	atPath(String fileName) (experimental) Returns an ArtifactPath for a file within this artifact.
String	getArtifactName()
String	getBucketName() (experimental) The artifact attribute for the name of the S3 bucket where the artifact is stored.
Object	getMetadata(String key) (experimental) Retrieve the metadata stored in this artifact under the given key.
String	getObjectKey() (experimental) The artifact attribute for The name of the .zip file that contains the artifact that is generated by AWS CodePipeline, such as 1ABCyZZ.zip.
String	getParam(String jsonFile, String keyName) (experimental) Returns a token for a value inside a JSON file within this artifact.
Location	getS3Location() (experimental) Returns the location of the .zip file in S3 that this Artifact represents.
String	getUrl() (experimental) The artifact attribute of the Amazon Simple Storage Service (Amazon S3) URL of the artifact, such as https://s3-us-west-2.amazonaws.com/artifactstorebucket-yivczw8jma0c/test/TemplateSo/1ABCyZZ.zip.
void	setMetadata(String key, Object value) (experimental) Add arbitrary extra payload to the artifact under a given key.
String	toString()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Artifact

protected Artifact(software.amazon.jsii.JsiiObjectRef objRef)

Artifact

protected Artifact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Artifact

@Stability(value=Experimental)
public Artifact(@Nullable
                                               String artifactName)

Parameters:

artifactName -

Artifact

@Stability(value=Experimental)
public Artifact()

Method Detail

artifact

@Stability(value=Experimental)
 @NotNull
public static Artifact artifact(@NotNull
                                                                         String name)

(experimental) A static factory method used to create instances of the Artifact class.

Mainly meant to be used from decdk.

Parameters:

name - the (required) name of the Artifact. This parameter is required.

atPath

@Stability(value=Experimental)
 @NotNull
public ArtifactPath atPath(@NotNull
                                                                    String fileName)

(experimental) Returns an ArtifactPath for a file within this artifact.

CfnOutput is in the form "::"

Parameters:

fileName - The name of the file. This parameter is required.

getMetadata

@Stability(value=Experimental)
 @NotNull
public Object getMetadata(@NotNull
                                                                   String key)

(experimental) Retrieve the metadata stored in this artifact under the given key.

If there is no metadata stored under the given key, null will be returned.

Parameters:

key - This parameter is required.

getParam

@Stability(value=Experimental)
 @NotNull
public String getParam(@NotNull
                                                                String jsonFile,
                                                                @NotNull
                                                                String keyName)

(experimental) Returns a token for a value inside a JSON file within this artifact.

Parameters:

jsonFile - The JSON file name. This parameter is required.

keyName - The hash key. This parameter is required.

setMetadata

@Stability(value=Experimental)
public void setMetadata(@NotNull
                                                       String key,
                                                       @NotNull
                                                       Object value)

(experimental) Add arbitrary extra payload to the artifact under a given key.

This can be used by CodePipeline actions to communicate data between themselves. If metadata was already present under the given key, it will be overwritten with the new value.

Parameters:

key - This parameter is required.

value - This parameter is required.

toString

@Stability(value=Experimental)
 @Nullable
public String toString()

Overrides:

toString in class Object

getBucketName

@Stability(value=Experimental)
 @NotNull
public String getBucketName()

(experimental) The artifact attribute for the name of the S3 bucket where the artifact is stored.

getObjectKey

@Stability(value=Experimental)
 @NotNull
public String getObjectKey()

(experimental) The artifact attribute for The name of the .zip file that contains the artifact that is generated by AWS CodePipeline, such as 1ABCyZZ.zip.

getS3Location

@Stability(value=Experimental)
 @NotNull
public Location getS3Location()

(experimental) Returns the location of the .zip file in S3 that this Artifact represents. Used by Lambda's `CfnParametersCode` when being deployed in a CodePipeline.

getUrl

@Stability(value=Experimental)
 @NotNull
public String getUrl()

(experimental) The artifact attribute of the Amazon Simple Storage Service (Amazon S3) URL of the artifact, such as https://s3-us-west-2.amazonaws.com/artifactstorebucket-yivczw8jma0c/test/TemplateSo/1ABCyZZ.zip.

getArtifactName

@Stability(value=Experimental)
 @Nullable
public String getArtifactName()