Interface CfnPipeline.IEncryptionKeyProperty

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

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.AWS.CodePipeline.dll

Syntax (csharp)

public interface IEncryptionKeyProperty

Syntax (vb)

Public Interface IEncryptionKeyProperty

Remarks

EncryptionKey is a property of the ArtifactStore property type.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html

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;

EncryptionKeyProperty encryptionKeyProperty = new EncryptionKeyProperty {
    Id = "id",
    Type = "type"
};

Synopsis

Properties

Id	The ID used to identify the key.
Type	The type of encryption key, such as an AWS KMS key.

Properties

Id

The ID used to identify the key.

string Id { get; }

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-id

Type

The type of encryption key, such as an AWS KMS key.

string Type { get; }

Property Value

System.String

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-type