Class: AWSCDK::Codepipeline::CfnPipeline::EncryptionKeyProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Codepipeline::CfnPipeline::EncryptionKeyProperty

Defined in:

codepipeline/cfn_pipeline.rb

Overview

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.

See Also:

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

Instance Attribute Summary

• #id ⇒ String readonly

  The ID used to identify the key.

• #type ⇒ String readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(id:, type:) ⇒ EncryptionKeyProperty constructor

  A new instance of EncryptionKeyProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(id:, type:) ⇒ EncryptionKeyProperty

Returns a new instance of EncryptionKeyProperty.

Parameters:

• id (String) —

  The ID used to identify the key.

• type (String) —

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

# File 'codepipeline/cfn_pipeline.rb', line 1170

def initialize(id:, type:)
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
end

Instance Attribute Details

#id ⇒ String (readonly)

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

Returns:

• (String)

See Also:

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

# File 'codepipeline/cfn_pipeline.rb', line 1185

def id
  @id
end

#type ⇒ String (readonly)

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

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

Returns:

• (String)

See Also:

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

# File 'codepipeline/cfn_pipeline.rb', line 1192

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'codepipeline/cfn_pipeline.rb', line 1194

def self.jsii_properties
  {
    :id => "id",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'codepipeline/cfn_pipeline.rb', line 1201

def to_jsii
  result = {}
  result.merge!({
    "id" => @id,
    "type" => @type,
  })
  result.compact
end