Class CfnPipeline.EncryptionKeyProperty
Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.AWS.CodePipeline.dll
Syntax (csharp)
public class EncryptionKeyProperty : Object, CfnPipeline.IEncryptionKeyProperty
Syntax (vb)
Public Class EncryptionKeyProperty
Inherits Object
Implements CfnPipeline.IEncryptionKeyProperty
Remarks
EncryptionKey
is a property of the ArtifactStore property type.
ExampleMetadata: fixture=_generated
Examples
// 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"
};
Synopsis
Constructors
EncryptionKeyProperty() |
Properties
Id | The ID used to identify the key. |
Type | The type of encryption key, such as an AWS KMS key. |
Constructors
EncryptionKeyProperty()
public EncryptionKeyProperty()
Properties
Id
The ID used to identify the key.
public string Id { get; set; }
Property Value
System.String
Remarks
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 KMS 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).
Type
The type of encryption key, such as an AWS KMS key.
public string Type { get; set; }
Property Value
System.String
Remarks
When creating or updating a pipeline, the value must be set to 'KMS'.