AWS SDK for C++  1.9.66
AWS SDK for C++
Public Member Functions | List of all members
Aws::ForecastService::Model::EncryptionConfig Class Reference

#include <EncryptionConfig.h>

Public Member Functions

 EncryptionConfig ()
 
 EncryptionConfig (Aws::Utils::Json::JsonView jsonValue)
 
EncryptionConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
EncryptionConfigWithRoleArn (const Aws::String &value)
 
EncryptionConfigWithRoleArn (Aws::String &&value)
 
EncryptionConfigWithRoleArn (const char *value)
 
const Aws::StringGetKMSKeyArn () const
 
bool KMSKeyArnHasBeenSet () const
 
void SetKMSKeyArn (const Aws::String &value)
 
void SetKMSKeyArn (Aws::String &&value)
 
void SetKMSKeyArn (const char *value)
 
EncryptionConfigWithKMSKeyArn (const Aws::String &value)
 
EncryptionConfigWithKMSKeyArn (Aws::String &&value)
 
EncryptionConfigWithKMSKeyArn (const char *value)
 

Detailed Description

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.

See Also:

AWS API Reference

Definition at line 34 of file EncryptionConfig.h.

Constructor & Destructor Documentation

◆ EncryptionConfig() [1/2]

Aws::ForecastService::Model::EncryptionConfig::EncryptionConfig ( )

◆ EncryptionConfig() [2/2]

Aws::ForecastService::Model::EncryptionConfig::EncryptionConfig ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetKMSKeyArn()

const Aws::String& Aws::ForecastService::Model::EncryptionConfig::GetKMSKeyArn ( ) const
inline

The Amazon Resource Name (ARN) of the KMS key.

Definition at line 111 of file EncryptionConfig.h.

◆ GetRoleArn()

const Aws::String& Aws::ForecastService::Model::EncryptionConfig::GetRoleArn ( ) const
inline

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Definition at line 49 of file EncryptionConfig.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ForecastService::Model::EncryptionConfig::Jsonize ( ) const

◆ KMSKeyArnHasBeenSet()

bool Aws::ForecastService::Model::EncryptionConfig::KMSKeyArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the KMS key.

Definition at line 116 of file EncryptionConfig.h.

◆ operator=()

EncryptionConfig& Aws::ForecastService::Model::EncryptionConfig::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleArnHasBeenSet()

bool Aws::ForecastService::Model::EncryptionConfig::RoleArnHasBeenSet ( ) const
inline

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Definition at line 57 of file EncryptionConfig.h.

◆ SetKMSKeyArn() [1/3]

void Aws::ForecastService::Model::EncryptionConfig::SetKMSKeyArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the KMS key.

Definition at line 126 of file EncryptionConfig.h.

◆ SetKMSKeyArn() [2/3]

void Aws::ForecastService::Model::EncryptionConfig::SetKMSKeyArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the KMS key.

Definition at line 121 of file EncryptionConfig.h.

◆ SetKMSKeyArn() [3/3]

void Aws::ForecastService::Model::EncryptionConfig::SetKMSKeyArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the KMS key.

Definition at line 131 of file EncryptionConfig.h.

◆ SetRoleArn() [1/3]

void Aws::ForecastService::Model::EncryptionConfig::SetRoleArn ( Aws::String &&  value)
inline

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Definition at line 73 of file EncryptionConfig.h.

◆ SetRoleArn() [2/3]

void Aws::ForecastService::Model::EncryptionConfig::SetRoleArn ( const Aws::String value)
inline

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Definition at line 65 of file EncryptionConfig.h.

◆ SetRoleArn() [3/3]

void Aws::ForecastService::Model::EncryptionConfig::SetRoleArn ( const char *  value)
inline

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Definition at line 81 of file EncryptionConfig.h.

◆ WithKMSKeyArn() [1/3]

EncryptionConfig& Aws::ForecastService::Model::EncryptionConfig::WithKMSKeyArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the KMS key.

Definition at line 141 of file EncryptionConfig.h.

◆ WithKMSKeyArn() [2/3]

EncryptionConfig& Aws::ForecastService::Model::EncryptionConfig::WithKMSKeyArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the KMS key.

Definition at line 136 of file EncryptionConfig.h.

◆ WithKMSKeyArn() [3/3]

EncryptionConfig& Aws::ForecastService::Model::EncryptionConfig::WithKMSKeyArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the KMS key.

Definition at line 146 of file EncryptionConfig.h.

◆ WithRoleArn() [1/3]

EncryptionConfig& Aws::ForecastService::Model::EncryptionConfig::WithRoleArn ( Aws::String &&  value)
inline

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Definition at line 97 of file EncryptionConfig.h.

◆ WithRoleArn() [2/3]

EncryptionConfig& Aws::ForecastService::Model::EncryptionConfig::WithRoleArn ( const Aws::String value)
inline

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Definition at line 89 of file EncryptionConfig.h.

◆ WithRoleArn() [3/3]

EncryptionConfig& Aws::ForecastService::Model::EncryptionConfig::WithRoleArn ( const char *  value)
inline

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Definition at line 105 of file EncryptionConfig.h.


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