AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::Redshift::Model::UsageLimit Class Reference

#include <UsageLimit.h>

Public Member Functions

 UsageLimit ()
 
 UsageLimit (const Aws::Utils::Xml::XmlNode &xmlNode)
 
UsageLimitoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetUsageLimitId () const
 
bool UsageLimitIdHasBeenSet () const
 
void SetUsageLimitId (const Aws::String &value)
 
void SetUsageLimitId (Aws::String &&value)
 
void SetUsageLimitId (const char *value)
 
UsageLimitWithUsageLimitId (const Aws::String &value)
 
UsageLimitWithUsageLimitId (Aws::String &&value)
 
UsageLimitWithUsageLimitId (const char *value)
 
const Aws::StringGetClusterIdentifier () const
 
bool ClusterIdentifierHasBeenSet () const
 
void SetClusterIdentifier (const Aws::String &value)
 
void SetClusterIdentifier (Aws::String &&value)
 
void SetClusterIdentifier (const char *value)
 
UsageLimitWithClusterIdentifier (const Aws::String &value)
 
UsageLimitWithClusterIdentifier (Aws::String &&value)
 
UsageLimitWithClusterIdentifier (const char *value)
 
const UsageLimitFeatureTypeGetFeatureType () const
 
bool FeatureTypeHasBeenSet () const
 
void SetFeatureType (const UsageLimitFeatureType &value)
 
void SetFeatureType (UsageLimitFeatureType &&value)
 
UsageLimitWithFeatureType (const UsageLimitFeatureType &value)
 
UsageLimitWithFeatureType (UsageLimitFeatureType &&value)
 
const UsageLimitLimitTypeGetLimitType () const
 
bool LimitTypeHasBeenSet () const
 
void SetLimitType (const UsageLimitLimitType &value)
 
void SetLimitType (UsageLimitLimitType &&value)
 
UsageLimitWithLimitType (const UsageLimitLimitType &value)
 
UsageLimitWithLimitType (UsageLimitLimitType &&value)
 
long long GetAmount () const
 
bool AmountHasBeenSet () const
 
void SetAmount (long long value)
 
UsageLimitWithAmount (long long value)
 
const UsageLimitPeriodGetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (const UsageLimitPeriod &value)
 
void SetPeriod (UsageLimitPeriod &&value)
 
UsageLimitWithPeriod (const UsageLimitPeriod &value)
 
UsageLimitWithPeriod (UsageLimitPeriod &&value)
 
const UsageLimitBreachActionGetBreachAction () const
 
bool BreachActionHasBeenSet () const
 
void SetBreachAction (const UsageLimitBreachAction &value)
 
void SetBreachAction (UsageLimitBreachAction &&value)
 
UsageLimitWithBreachAction (const UsageLimitBreachAction &value)
 
UsageLimitWithBreachAction (UsageLimitBreachAction &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
UsageLimitWithTags (const Aws::Vector< Tag > &value)
 
UsageLimitWithTags (Aws::Vector< Tag > &&value)
 
UsageLimitAddTags (const Tag &value)
 
UsageLimitAddTags (Tag &&value)
 
const ResponseMetadataGetResponseMetadata () const
 
bool ResponseMetadataHasBeenSet () const
 
void SetResponseMetadata (const ResponseMetadata &value)
 
void SetResponseMetadata (ResponseMetadata &&value)
 
UsageLimitWithResponseMetadata (const ResponseMetadata &value)
 
UsageLimitWithResponseMetadata (ResponseMetadata &&value)
 

Detailed Description

Describes a usage limit object for a cluster.

See Also:

AWS API Reference

Definition at line 38 of file UsageLimit.h.

Constructor & Destructor Documentation

◆ UsageLimit() [1/2]

Aws::Redshift::Model::UsageLimit::UsageLimit ( )

◆ UsageLimit() [2/2]

Aws::Redshift::Model::UsageLimit::UsageLimit ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddTags() [1/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::AddTags ( const Tag value)
inline

A list of tag instances.

Definition at line 349 of file UsageLimit.h.

◆ AddTags() [2/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::AddTags ( Tag &&  value)
inline

A list of tag instances.

Definition at line 354 of file UsageLimit.h.

◆ AmountHasBeenSet()

bool Aws::Redshift::Model::UsageLimit::AmountHasBeenSet ( ) const
inline

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

Definition at line 209 of file UsageLimit.h.

◆ BreachActionHasBeenSet()

bool Aws::Redshift::Model::UsageLimit::BreachActionHasBeenSet ( ) const
inline

The action that Amazon Redshift takes when the limit is reached. Possible values are:

  • log - To log an event in a system table. The default is log.

  • emit-metric - To emit CloudWatch metrics.

  • disable - To disable the feature until the next usage period begins.

Definition at line 277 of file UsageLimit.h.

◆ ClusterIdentifierHasBeenSet()

bool Aws::Redshift::Model::UsageLimit::ClusterIdentifierHasBeenSet ( ) const
inline

The identifier of the cluster with a usage limit.

Definition at line 98 of file UsageLimit.h.

◆ FeatureTypeHasBeenSet()

bool Aws::Redshift::Model::UsageLimit::FeatureTypeHasBeenSet ( ) const
inline

The Amazon Redshift feature to which the limit applies.

Definition at line 139 of file UsageLimit.h.

◆ GetAmount()

long long Aws::Redshift::Model::UsageLimit::GetAmount ( ) const
inline

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

Definition at line 203 of file UsageLimit.h.

◆ GetBreachAction()

const UsageLimitBreachAction& Aws::Redshift::Model::UsageLimit::GetBreachAction ( ) const
inline

The action that Amazon Redshift takes when the limit is reached. Possible values are:

  • log - To log an event in a system table. The default is log.

  • emit-metric - To emit CloudWatch metrics.

  • disable - To disable the feature until the next usage period begins.

Definition at line 268 of file UsageLimit.h.

◆ GetClusterIdentifier()

const Aws::String& Aws::Redshift::Model::UsageLimit::GetClusterIdentifier ( ) const
inline

The identifier of the cluster with a usage limit.

Definition at line 93 of file UsageLimit.h.

◆ GetFeatureType()

const UsageLimitFeatureType& Aws::Redshift::Model::UsageLimit::GetFeatureType ( ) const
inline

The Amazon Redshift feature to which the limit applies.

Definition at line 134 of file UsageLimit.h.

◆ GetLimitType()

const UsageLimitLimitType& Aws::Redshift::Model::UsageLimit::GetLimitType ( ) const
inline

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

Definition at line 166 of file UsageLimit.h.

◆ GetPeriod()

const UsageLimitPeriod& Aws::Redshift::Model::UsageLimit::GetPeriod ( ) const
inline

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Definition at line 228 of file UsageLimit.h.

◆ GetResponseMetadata()

const ResponseMetadata& Aws::Redshift::Model::UsageLimit::GetResponseMetadata ( ) const
inline

Definition at line 358 of file UsageLimit.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::Redshift::Model::UsageLimit::GetTags ( ) const
inline

A list of tag instances.

Definition at line 319 of file UsageLimit.h.

◆ GetUsageLimitId()

const Aws::String& Aws::Redshift::Model::UsageLimit::GetUsageLimitId ( ) const
inline

The identifier of the usage limit.

Definition at line 52 of file UsageLimit.h.

◆ LimitTypeHasBeenSet()

bool Aws::Redshift::Model::UsageLimit::LimitTypeHasBeenSet ( ) const
inline

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

Definition at line 172 of file UsageLimit.h.

◆ operator=()

UsageLimit& Aws::Redshift::Model::UsageLimit::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::Redshift::Model::UsageLimit::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::Redshift::Model::UsageLimit::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ PeriodHasBeenSet()

bool Aws::Redshift::Model::UsageLimit::PeriodHasBeenSet ( ) const
inline

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Definition at line 234 of file UsageLimit.h.

◆ ResponseMetadataHasBeenSet()

bool Aws::Redshift::Model::UsageLimit::ResponseMetadataHasBeenSet ( ) const
inline

Definition at line 361 of file UsageLimit.h.

◆ SetAmount()

void Aws::Redshift::Model::UsageLimit::SetAmount ( long long  value)
inline

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

Definition at line 215 of file UsageLimit.h.

◆ SetBreachAction() [1/2]

void Aws::Redshift::Model::UsageLimit::SetBreachAction ( const UsageLimitBreachAction value)
inline

The action that Amazon Redshift takes when the limit is reached. Possible values are:

  • log - To log an event in a system table. The default is log.

  • emit-metric - To emit CloudWatch metrics.

  • disable - To disable the feature until the next usage period begins.

Definition at line 286 of file UsageLimit.h.

◆ SetBreachAction() [2/2]

void Aws::Redshift::Model::UsageLimit::SetBreachAction ( UsageLimitBreachAction &&  value)
inline

The action that Amazon Redshift takes when the limit is reached. Possible values are:

  • log - To log an event in a system table. The default is log.

  • emit-metric - To emit CloudWatch metrics.

  • disable - To disable the feature until the next usage period begins.

Definition at line 295 of file UsageLimit.h.

◆ SetClusterIdentifier() [1/3]

void Aws::Redshift::Model::UsageLimit::SetClusterIdentifier ( const Aws::String value)
inline

The identifier of the cluster with a usage limit.

Definition at line 103 of file UsageLimit.h.

◆ SetClusterIdentifier() [2/3]

void Aws::Redshift::Model::UsageLimit::SetClusterIdentifier ( Aws::String &&  value)
inline

The identifier of the cluster with a usage limit.

Definition at line 108 of file UsageLimit.h.

◆ SetClusterIdentifier() [3/3]

void Aws::Redshift::Model::UsageLimit::SetClusterIdentifier ( const char *  value)
inline

The identifier of the cluster with a usage limit.

Definition at line 113 of file UsageLimit.h.

◆ SetFeatureType() [1/2]

void Aws::Redshift::Model::UsageLimit::SetFeatureType ( const UsageLimitFeatureType value)
inline

The Amazon Redshift feature to which the limit applies.

Definition at line 144 of file UsageLimit.h.

◆ SetFeatureType() [2/2]

void Aws::Redshift::Model::UsageLimit::SetFeatureType ( UsageLimitFeatureType &&  value)
inline

The Amazon Redshift feature to which the limit applies.

Definition at line 149 of file UsageLimit.h.

◆ SetLimitType() [1/2]

void Aws::Redshift::Model::UsageLimit::SetLimitType ( const UsageLimitLimitType value)
inline

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

Definition at line 178 of file UsageLimit.h.

◆ SetLimitType() [2/2]

void Aws::Redshift::Model::UsageLimit::SetLimitType ( UsageLimitLimitType &&  value)
inline

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

Definition at line 184 of file UsageLimit.h.

◆ SetPeriod() [1/2]

void Aws::Redshift::Model::UsageLimit::SetPeriod ( const UsageLimitPeriod value)
inline

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Definition at line 240 of file UsageLimit.h.

◆ SetPeriod() [2/2]

void Aws::Redshift::Model::UsageLimit::SetPeriod ( UsageLimitPeriod &&  value)
inline

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Definition at line 246 of file UsageLimit.h.

◆ SetResponseMetadata() [1/2]

void Aws::Redshift::Model::UsageLimit::SetResponseMetadata ( const ResponseMetadata value)
inline

Definition at line 364 of file UsageLimit.h.

◆ SetResponseMetadata() [2/2]

void Aws::Redshift::Model::UsageLimit::SetResponseMetadata ( ResponseMetadata &&  value)
inline

Definition at line 367 of file UsageLimit.h.

◆ SetTags() [1/2]

void Aws::Redshift::Model::UsageLimit::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of tag instances.

Definition at line 329 of file UsageLimit.h.

◆ SetTags() [2/2]

void Aws::Redshift::Model::UsageLimit::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of tag instances.

Definition at line 334 of file UsageLimit.h.

◆ SetUsageLimitId() [1/3]

void Aws::Redshift::Model::UsageLimit::SetUsageLimitId ( const Aws::String value)
inline

The identifier of the usage limit.

Definition at line 62 of file UsageLimit.h.

◆ SetUsageLimitId() [2/3]

void Aws::Redshift::Model::UsageLimit::SetUsageLimitId ( Aws::String &&  value)
inline

The identifier of the usage limit.

Definition at line 67 of file UsageLimit.h.

◆ SetUsageLimitId() [3/3]

void Aws::Redshift::Model::UsageLimit::SetUsageLimitId ( const char *  value)
inline

The identifier of the usage limit.

Definition at line 72 of file UsageLimit.h.

◆ TagsHasBeenSet()

bool Aws::Redshift::Model::UsageLimit::TagsHasBeenSet ( ) const
inline

A list of tag instances.

Definition at line 324 of file UsageLimit.h.

◆ UsageLimitIdHasBeenSet()

bool Aws::Redshift::Model::UsageLimit::UsageLimitIdHasBeenSet ( ) const
inline

The identifier of the usage limit.

Definition at line 57 of file UsageLimit.h.

◆ WithAmount()

UsageLimit& Aws::Redshift::Model::UsageLimit::WithAmount ( long long  value)
inline

The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

Definition at line 221 of file UsageLimit.h.

◆ WithBreachAction() [1/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithBreachAction ( const UsageLimitBreachAction value)
inline

The action that Amazon Redshift takes when the limit is reached. Possible values are:

  • log - To log an event in a system table. The default is log.

  • emit-metric - To emit CloudWatch metrics.

  • disable - To disable the feature until the next usage period begins.

Definition at line 304 of file UsageLimit.h.

◆ WithBreachAction() [2/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithBreachAction ( UsageLimitBreachAction &&  value)
inline

The action that Amazon Redshift takes when the limit is reached. Possible values are:

  • log - To log an event in a system table. The default is log.

  • emit-metric - To emit CloudWatch metrics.

  • disable - To disable the feature until the next usage period begins.

Definition at line 313 of file UsageLimit.h.

◆ WithClusterIdentifier() [1/3]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithClusterIdentifier ( const Aws::String value)
inline

The identifier of the cluster with a usage limit.

Definition at line 118 of file UsageLimit.h.

◆ WithClusterIdentifier() [2/3]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithClusterIdentifier ( Aws::String &&  value)
inline

The identifier of the cluster with a usage limit.

Definition at line 123 of file UsageLimit.h.

◆ WithClusterIdentifier() [3/3]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithClusterIdentifier ( const char *  value)
inline

The identifier of the cluster with a usage limit.

Definition at line 128 of file UsageLimit.h.

◆ WithFeatureType() [1/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithFeatureType ( const UsageLimitFeatureType value)
inline

The Amazon Redshift feature to which the limit applies.

Definition at line 154 of file UsageLimit.h.

◆ WithFeatureType() [2/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithFeatureType ( UsageLimitFeatureType &&  value)
inline

The Amazon Redshift feature to which the limit applies.

Definition at line 159 of file UsageLimit.h.

◆ WithLimitType() [1/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithLimitType ( const UsageLimitLimitType value)
inline

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

Definition at line 190 of file UsageLimit.h.

◆ WithLimitType() [2/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithLimitType ( UsageLimitLimitType &&  value)
inline

The type of limit. Depending on the feature type, this can be based on a time duration or data size.

Definition at line 196 of file UsageLimit.h.

◆ WithPeriod() [1/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithPeriod ( const UsageLimitPeriod value)
inline

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Definition at line 252 of file UsageLimit.h.

◆ WithPeriod() [2/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithPeriod ( UsageLimitPeriod &&  value)
inline

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Definition at line 258 of file UsageLimit.h.

◆ WithResponseMetadata() [1/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithResponseMetadata ( const ResponseMetadata value)
inline

Definition at line 370 of file UsageLimit.h.

◆ WithResponseMetadata() [2/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithResponseMetadata ( ResponseMetadata &&  value)
inline

Definition at line 373 of file UsageLimit.h.

◆ WithTags() [1/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of tag instances.

Definition at line 339 of file UsageLimit.h.

◆ WithTags() [2/2]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of tag instances.

Definition at line 344 of file UsageLimit.h.

◆ WithUsageLimitId() [1/3]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithUsageLimitId ( const Aws::String value)
inline

The identifier of the usage limit.

Definition at line 77 of file UsageLimit.h.

◆ WithUsageLimitId() [2/3]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithUsageLimitId ( Aws::String &&  value)
inline

The identifier of the usage limit.

Definition at line 82 of file UsageLimit.h.

◆ WithUsageLimitId() [3/3]

UsageLimit& Aws::Redshift::Model::UsageLimit::WithUsageLimitId ( const char *  value)
inline

The identifier of the usage limit.

Definition at line 87 of file UsageLimit.h.


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