Package software.amazon.awscdk.services.codepipeline

Interface CfnPipeline.EncryptionKeyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.EncryptionKeyProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

@Stability(Stable)
public static interface CfnPipeline.EncryptionKeyProperty
extends software.amazon.jsii.JsiiSerializable

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:

 // 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.EncryptionKeyProperty.Builder	builder()
String	getId()	The ID used to identify the key.
String	getType()	The type of encryption key, such as an AWS KMS key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getId

@Stability(Stable)
@NotNull
String getId()

The ID used to identify the key.

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).

getType

@Stability(Stable)
@NotNull
String getType()

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

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

builder

@Stability(Stable)
static CfnPipeline.EncryptionKeyProperty.Builder builder()

Returns:

a CfnPipeline.EncryptionKeyProperty.Builder of CfnPipeline.EncryptionKeyProperty