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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-codepipeline/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN.

<note markdown=“1”> Aliases are recognized only in the account that created the 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).

</note>

Returns:

  • (String)


1782
1783
1784
1785
1786
1787
# File 'lib/aws-sdk-codepipeline/types.rb', line 1782

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

#typeString

The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to ‘KMS’.

Returns:

  • (String)


1782
1783
1784
1785
1786
1787
# File 'lib/aws-sdk-codepipeline/types.rb', line 1782

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