interface ArtifactStoreProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.CodePipeline.CfnPipeline.ArtifactStoreProperty |
Java | software.amazon.awscdk.services.codepipeline.CfnPipeline.ArtifactStoreProperty |
Python | aws_cdk.aws_codepipeline.CfnPipeline.ArtifactStoreProperty |
TypeScript | @aws-cdk/aws-codepipeline » CfnPipeline » ArtifactStoreProperty |
The S3 bucket where artifacts for the pipeline are stored.
You must include either
artifactStore
orartifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codepipeline from '@aws-cdk/aws-codepipeline';
const artifactStoreProperty: codepipeline.CfnPipeline.ArtifactStoreProperty = {
location: 'location',
type: 'type',
// the properties below are optional
encryptionKey: {
id: 'id',
type: 'type',
},
};
Properties
Name | Type | Description |
---|---|---|
location | string | The S3 bucket used for storing the artifacts for a pipeline. |
type | string | The type of the artifact store, such as S3. |
encryption | IResolvable | Encryption | The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key. |
location
Type:
string
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.
type
Type:
string
The type of the artifact store, such as S3.
encryptionKey?
Type:
IResolvable
|
Encryption
(optional)
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 .