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

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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb

Overview

Note:

When making an API call, you may pass EncryptionKey data as a 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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1500

class EncryptionKey < Struct.new(
  :id,
  :type)
  include Aws::Structure
end

#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'.

Returns:

• (String)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1500

class EncryptionKey < Struct.new(
  :id,
  :type)
  include Aws::Structure
end