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

#include <S3Config.h>

Public Member Functions

 S3Config ()
 
 S3Config (Aws::Utils::Json::JsonView jsonValue)
 
S3Configoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
S3ConfigWithPath (const Aws::String &value)
 
S3ConfigWithPath (Aws::String &&value)
 
S3ConfigWithPath (const char *value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
S3ConfigWithRoleArn (const Aws::String &value)
 
S3ConfigWithRoleArn (Aws::String &&value)
 
S3ConfigWithRoleArn (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)
 
S3ConfigWithKMSKeyArn (const Aws::String &value)
 
S3ConfigWithKMSKeyArn (Aws::String &&value)
 
S3ConfigWithKMSKeyArn (const char *value)
 

Detailed Description

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.

See Also:

AWS API Reference

Definition at line 36 of file S3Config.h.

Constructor & Destructor Documentation

◆ S3Config() [1/2]

Aws::ForecastService::Model::S3Config::S3Config ( )

◆ S3Config() [2/2]

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

Member Function Documentation

◆ GetKMSKeyArn()

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

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Definition at line 179 of file S3Config.h.

◆ GetPath()

const Aws::String& Aws::ForecastService::Model::S3Config::GetPath ( ) const
inline

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Definition at line 49 of file S3Config.h.

◆ GetRoleArn()

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

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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 102 of file S3Config.h.

◆ Jsonize()

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

◆ KMSKeyArnHasBeenSet()

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

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Definition at line 185 of file S3Config.h.

◆ operator=()

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

◆ PathHasBeenSet()

bool Aws::ForecastService::Model::S3Config::PathHasBeenSet ( ) const
inline

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Definition at line 55 of file S3Config.h.

◆ RoleArnHasBeenSet()

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

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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 112 of file S3Config.h.

◆ SetKMSKeyArn() [1/3]

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

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Definition at line 197 of file S3Config.h.

◆ SetKMSKeyArn() [2/3]

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

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Definition at line 191 of file S3Config.h.

◆ SetKMSKeyArn() [3/3]

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

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Definition at line 203 of file S3Config.h.

◆ SetPath() [1/3]

void Aws::ForecastService::Model::S3Config::SetPath ( Aws::String &&  value)
inline

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Definition at line 67 of file S3Config.h.

◆ SetPath() [2/3]

void Aws::ForecastService::Model::S3Config::SetPath ( const Aws::String value)
inline

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Definition at line 61 of file S3Config.h.

◆ SetPath() [3/3]

void Aws::ForecastService::Model::S3Config::SetPath ( const char *  value)
inline

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Definition at line 73 of file S3Config.h.

◆ SetRoleArn() [1/3]

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

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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 132 of file S3Config.h.

◆ SetRoleArn() [2/3]

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

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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 122 of file S3Config.h.

◆ SetRoleArn() [3/3]

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

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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 142 of file S3Config.h.

◆ WithKMSKeyArn() [1/3]

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

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Definition at line 215 of file S3Config.h.

◆ WithKMSKeyArn() [2/3]

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

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Definition at line 209 of file S3Config.h.

◆ WithKMSKeyArn() [3/3]

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

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Definition at line 221 of file S3Config.h.

◆ WithPath() [1/3]

S3Config& Aws::ForecastService::Model::S3Config::WithPath ( Aws::String &&  value)
inline

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Definition at line 85 of file S3Config.h.

◆ WithPath() [2/3]

S3Config& Aws::ForecastService::Model::S3Config::WithPath ( const Aws::String value)
inline

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Definition at line 79 of file S3Config.h.

◆ WithPath() [3/3]

S3Config& Aws::ForecastService::Model::S3Config::WithPath ( const char *  value)
inline

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Definition at line 91 of file S3Config.h.

◆ WithRoleArn() [1/3]

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

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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 162 of file S3Config.h.

◆ WithRoleArn() [2/3]

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

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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 152 of file S3Config.h.

◆ WithRoleArn() [3/3]

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

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the 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 172 of file S3Config.h.


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