software.amazon.awscdk.services.codepipeline

Interface CfnPipeline.ArtifactStoreProperty

All Known Implementing Classes:

CfnPipeline.ArtifactStoreProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

public static interface CfnPipeline.ArtifactStoreProperty

The S3 bucket where artifacts for the pipeline are stored.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 ArtifactStoreProperty artifactStoreProperty = ArtifactStoreProperty.builder()
         .location("location")
         .type("type")
         // the properties below are optional
         .encryptionKey(EncryptionKeyProperty.builder()
                 .id("id")
                 .type("type")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnPipeline.ArtifactStoreProperty.Builder A builder for CfnPipeline.ArtifactStoreProperty
static class	CfnPipeline.ArtifactStoreProperty.Jsii$Proxy An implementation for CfnPipeline.ArtifactStoreProperty

Method Summary

Modifier and Type	Method and Description
static CfnPipeline.ArtifactStoreProperty.Builder	builder()
default java.lang.Object	getEncryptionKey() The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.
java.lang.String	getLocation() The S3 bucket used for storing the artifacts for a pipeline.
java.lang.String	getType() The type of the artifact store, such as S3.

Method Detail

getLocation

java.lang.String getLocation()

The S3 bucket used for storing the artifacts for a pipeline.

You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.

getType

java.lang.String getType()

The type of the artifact store, such as S3.

getEncryptionKey

default java.lang.Object getEncryptionKey()

The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.

If this is undefined, the default key for Amazon S3 is used. To see an example artifact store encryption key field, see the example structure here: AWS::CodePipeline::Pipeline .

builder

static CfnPipeline.ArtifactStoreProperty.Builder builder()

Returns:

a CfnPipeline.ArtifactStoreProperty.Builder of CfnPipeline.ArtifactStoreProperty