Skip to content
v2.278.0

EncryptionKeyProperty Struct ​

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

EncryptionKey is a property of the ArtifactStore property type.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';
const encryptionKeyProperty: codepipeline.CfnPipeline.EncryptionKeyProperty = {
  id: 'id',
  type: 'type',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codepipeline as codepipeline

encryption_key_property = codepipeline.CfnPipeline.EncryptionKeyProperty(
    id="id",
    type="type"
)
java
// 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.*;

EncryptionKeyProperty encryptionKeyProperty = EncryptionKeyProperty.builder()
        .id("id")
        .type("type")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodePipeline;

var encryptionKeyProperty = new EncryptionKeyProperty {
    Id = "id",
    Type = "type"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

encryptionKeyProperty := &EncryptionKeyProperty{
	Id: jsii.String("id"),
	Type: jsii.String("type"),
}

Properties ​

idstringidstridStringIdstringId*string required #
The ID used to identify the key.
notes

For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.

Aliases are recognized only in the account that created the AWS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).

typestringtypestrtypeStringTypestringType*string required #
The type of encryption key, such as an AWS KMS key.

When creating or updating a pipeline, the value must be set to 'KMS'.