You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodePipeline::Types::EncryptionKey

Inherits:

Struct

Object
Struct
Aws::CodePipeline::Types::EncryptionKey

show all

Defined in:: (unknown)

Overview

Note:

When passing EncryptionKey as input to an Aws::Client method, you can use a vanilla Hash:

{
  id: "EncryptionKeyId", # required
  type: "KMS", # required, accepts KMS
}

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

Returned by:

Instance Attribute Summary collapse

#id ⇒ String
The ID used to identify the key.
#type ⇒ String
The type of encryption key, such as an AWS Key Management Service (AWS KMS) key.

Instance Attribute Details

#id ⇒ `String`

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 customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.

Returns:

(String) —
The ID used to identify the key.

#type ⇒ `String`

The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to \'KMS\'.

Possible values:

KMS