AWS SDK for C++  1.9.103
AWS SDK for C++
Public Member Functions | List of all members
Aws::CodePipeline::Model::EncryptionKey Class Reference

#include <EncryptionKey.h>

Public Member Functions

 EncryptionKey ()
 
 EncryptionKey (Aws::Utils::Json::JsonView jsonValue)
 
EncryptionKeyoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
EncryptionKeyWithId (const Aws::String &value)
 
EncryptionKeyWithId (Aws::String &&value)
 
EncryptionKeyWithId (const char *value)
 
const EncryptionKeyTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const EncryptionKeyType &value)
 
void SetType (EncryptionKeyType &&value)
 
EncryptionKeyWithType (const EncryptionKeyType &value)
 
EncryptionKeyWithType (EncryptionKeyType &&value)
 

Detailed Description

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 Reference

Definition at line 34 of file EncryptionKey.h.

Constructor & Destructor Documentation

◆ EncryptionKey() [1/2]

Aws::CodePipeline::Model::EncryptionKey::EncryptionKey ( )

◆ EncryptionKey() [2/2]

Aws::CodePipeline::Model::EncryptionKey::EncryptionKey ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetId()

const Aws::String& Aws::CodePipeline::Model::EncryptionKey::GetId ( ) const
inline

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.

Definition at line 49 of file EncryptionKey.h.

◆ GetType()

const EncryptionKeyType& Aws::CodePipeline::Model::EncryptionKey::GetType ( ) const
inline

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

Definition at line 112 of file EncryptionKey.h.

◆ IdHasBeenSet()

bool Aws::CodePipeline::Model::EncryptionKey::IdHasBeenSet ( ) const
inline

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.

Definition at line 57 of file EncryptionKey.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::CodePipeline::Model::EncryptionKey::Jsonize ( ) const

◆ operator=()

EncryptionKey& Aws::CodePipeline::Model::EncryptionKey::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetId() [1/3]

void Aws::CodePipeline::Model::EncryptionKey::SetId ( Aws::String &&  value)
inline

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.

Definition at line 73 of file EncryptionKey.h.

◆ SetId() [2/3]

void Aws::CodePipeline::Model::EncryptionKey::SetId ( const Aws::String value)
inline

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.

Definition at line 65 of file EncryptionKey.h.

◆ SetId() [3/3]

void Aws::CodePipeline::Model::EncryptionKey::SetId ( const char *  value)
inline

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.

Definition at line 81 of file EncryptionKey.h.

◆ SetType() [1/2]

void Aws::CodePipeline::Model::EncryptionKey::SetType ( const EncryptionKeyType value)
inline

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

Definition at line 124 of file EncryptionKey.h.

◆ SetType() [2/2]

void Aws::CodePipeline::Model::EncryptionKey::SetType ( EncryptionKeyType &&  value)
inline

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

Definition at line 130 of file EncryptionKey.h.

◆ TypeHasBeenSet()

bool Aws::CodePipeline::Model::EncryptionKey::TypeHasBeenSet ( ) const
inline

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

Definition at line 118 of file EncryptionKey.h.

◆ WithId() [1/3]

EncryptionKey& Aws::CodePipeline::Model::EncryptionKey::WithId ( Aws::String &&  value)
inline

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.

Definition at line 97 of file EncryptionKey.h.

◆ WithId() [2/3]

EncryptionKey& Aws::CodePipeline::Model::EncryptionKey::WithId ( const Aws::String value)
inline

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.

Definition at line 89 of file EncryptionKey.h.

◆ WithId() [3/3]

EncryptionKey& Aws::CodePipeline::Model::EncryptionKey::WithId ( const char *  value)
inline

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.

Definition at line 105 of file EncryptionKey.h.

◆ WithType() [1/2]

EncryptionKey& Aws::CodePipeline::Model::EncryptionKey::WithType ( const EncryptionKeyType value)
inline

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

Definition at line 136 of file EncryptionKey.h.

◆ WithType() [2/2]

EncryptionKey& Aws::CodePipeline::Model::EncryptionKey::WithType ( EncryptionKeyType &&  value)
inline

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

Definition at line 142 of file EncryptionKey.h.


The documentation for this class was generated from the following file: