Aws::SSM::Model::Parameter Class Reference

#include <Parameter.h>

Public Member Functions

AWS_SSM_API Parameter ()=default

 

AWS_SSM_API Parameter (Aws::Utils::Json::JsonView jsonValue)

 

AWS_SSM_API Parameter & operator= (Aws::Utils::Json::JsonView jsonValue)

 

AWS_SSM_API Aws::Utils::Json::JsonValue Jsonize () const

 

const Aws::String & GetName () const

 

bool NameHasBeenSet () const

 

template<typename NameT = Aws::String>

void SetName (NameT &&value)

 

template<typename NameT = Aws::String>

Parameter & WithName (NameT &&value)

 

ParameterType GetType () const

 

bool TypeHasBeenSet () const

 

void SetType (ParameterType value)

 

Parameter & WithType (ParameterType value)

 

const Aws::String & GetValue () const

 

bool ValueHasBeenSet () const

 

template<typename ValueT = Aws::String>

void SetValue (ValueT &&value)

 

template<typename ValueT = Aws::String>

Parameter & WithValue (ValueT &&value)

 

long long GetVersion () const

 

bool VersionHasBeenSet () const

 

void SetVersion (long long value)

 

Parameter & WithVersion (long long value)

 

const Aws::String & GetSelector () const

 

bool SelectorHasBeenSet () const

 

template<typename SelectorT = Aws::String>

void SetSelector (SelectorT &&value)

 

template<typename SelectorT = Aws::String>

Parameter & WithSelector (SelectorT &&value)

 

const Aws::String & GetSourceResult () const

 

bool SourceResultHasBeenSet () const

 

template<typename SourceResultT = Aws::String>

void SetSourceResult (SourceResultT &&value)

 

template<typename SourceResultT = Aws::String>

Parameter & WithSourceResult (SourceResultT &&value)

 

const Aws::Utils::DateTime & GetLastModifiedDate () const

 

bool LastModifiedDateHasBeenSet () const

 

template<typename LastModifiedDateT = Aws::Utils::DateTime>

void SetLastModifiedDate (LastModifiedDateT &&value)

 

template<typename LastModifiedDateT = Aws::Utils::DateTime>

Parameter & WithLastModifiedDate (LastModifiedDateT &&value)

 

const Aws::String & GetARN () const

 

bool ARNHasBeenSet () const

 

template<typename ARNT = Aws::String>

void SetARN (ARNT &&value)

 

template<typename ARNT = Aws::String>

Parameter & WithARN (ARNT &&value)

 

const Aws::String & GetDataType () const

 

bool DataTypeHasBeenSet () const

 

template<typename DataTypeT = Aws::String>

void SetDataType (DataTypeT &&value)

 

template<typename DataTypeT = Aws::String>

Parameter & WithDataType (DataTypeT &&value)

 

Detailed Description

An Amazon Web Services Systems Manager parameter in Parameter Store.

See Also:

AWS API Reference

Definition at line 34 of file Parameter.h.

Constructor & Destructor Documentation

Parameter() [1/2]

AWS_SSM_API Aws::SSM::Model::Parameter::Parameter ( )

default

Parameter() [2/2]

AWS_SSM_API Aws::SSM::Model::Parameter::Parameter ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

ARNHasBeenSet()

bool Aws::SSM::Model::Parameter::ARNHasBeenSet ( ) const

inline

The Amazon Resource Name (ARN) of the parameter.

Definition at line 139 of file Parameter.h.

DataTypeHasBeenSet()

bool Aws::SSM::Model::Parameter::DataTypeHasBeenSet ( ) const

inline

The data type of the parameter, such as text or aws:ec2:image. The default is text.

Definition at line 152 of file Parameter.h.

GetARN()

const Aws::String & Aws::SSM::Model::Parameter::GetARN ( ) const

inline

The Amazon Resource Name (ARN) of the parameter.

Definition at line 138 of file Parameter.h.

GetDataType()

const Aws::String & Aws::SSM::Model::Parameter::GetDataType ( ) const

inline

The data type of the parameter, such as text or aws:ec2:image. The default is text.

Definition at line 151 of file Parameter.h.

GetLastModifiedDate()

const Aws::Utils::DateTime & Aws::SSM::Model::Parameter::GetLastModifiedDate ( ) const

inline

Date the parameter was last changed or updated and the parameter version was created.

Definition at line 126 of file Parameter.h.

GetName()

const Aws::String & Aws::SSM::Model::Parameter::GetName ( ) const

inline

The name of the parameter.

Definition at line 47 of file Parameter.h.

GetSelector()

const Aws::String & Aws::SSM::Model::Parameter::GetSelector ( ) const

inline

Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

parameter_name:version

parameter_name:label

Definition at line 99 of file Parameter.h.

GetSourceResult()

const Aws::String & Aws::SSM::Model::Parameter::GetSourceResult ( ) const

inline

Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

Definition at line 113 of file Parameter.h.

GetType()

ParameterType Aws::SSM::Model::Parameter::GetType ( ) const

inline

The type of parameter. Valid values include the following: String, StringList, and SecureString.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

Definition at line 63 of file Parameter.h.

GetValue()

const Aws::String & Aws::SSM::Model::Parameter::GetValue ( ) const

inline

The parameter value.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

Definition at line 75 of file Parameter.h.

GetVersion()

long long Aws::SSM::Model::Parameter::GetVersion ( ) const

inline

The parameter version.

Definition at line 87 of file Parameter.h.

Jsonize()

AWS_SSM_API Aws::Utils::Json::JsonValue Aws::SSM::Model::Parameter::Jsonize ( ) const

LastModifiedDateHasBeenSet()

bool Aws::SSM::Model::Parameter::LastModifiedDateHasBeenSet ( ) const

inline

Date the parameter was last changed or updated and the parameter version was created.

Definition at line 127 of file Parameter.h.

NameHasBeenSet()

bool Aws::SSM::Model::Parameter::NameHasBeenSet ( ) const

inline

The name of the parameter.

Definition at line 48 of file Parameter.h.

operator=()

AWS_SSM_API Parameter & Aws::SSM::Model::Parameter::operator= ( Aws::Utils::Json::JsonView  jsonValue)

SelectorHasBeenSet()

bool Aws::SSM::Model::Parameter::SelectorHasBeenSet ( ) const

inline

Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

parameter_name:version

parameter_name:label

Definition at line 100 of file Parameter.h.

SetARN()

template<typename ARNT = Aws::String>

void Aws::SSM::Model::Parameter::SetARN ( ARNT &&  value)

inline

The Amazon Resource Name (ARN) of the parameter.

Definition at line 141 of file Parameter.h.

SetDataType()

template<typename DataTypeT = Aws::String>

void Aws::SSM::Model::Parameter::SetDataType ( DataTypeT &&  value)

inline

The data type of the parameter, such as text or aws:ec2:image. The default is text.

Definition at line 154 of file Parameter.h.

SetLastModifiedDate()

template<typename LastModifiedDateT = Aws::Utils::DateTime>

void Aws::SSM::Model::Parameter::SetLastModifiedDate ( LastModifiedDateT &&  value)

inline

Date the parameter was last changed or updated and the parameter version was created.

Definition at line 129 of file Parameter.h.

SetName()

template<typename NameT = Aws::String>

void Aws::SSM::Model::Parameter::SetName ( NameT &&  value)

inline

The name of the parameter.

Definition at line 50 of file Parameter.h.

SetSelector()

template<typename SelectorT = Aws::String>

void Aws::SSM::Model::Parameter::SetSelector ( SelectorT &&  value)

inline

Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

parameter_name:version

parameter_name:label

Definition at line 102 of file Parameter.h.

SetSourceResult()

template<typename SourceResultT = Aws::String>

void Aws::SSM::Model::Parameter::SetSourceResult ( SourceResultT &&  value)

inline

Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

Definition at line 116 of file Parameter.h.

SetType()

void Aws::SSM::Model::Parameter::SetType ( ParameterType  value)

inline

The type of parameter. Valid values include the following: String, StringList, and SecureString.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

Definition at line 65 of file Parameter.h.

SetValue()

template<typename ValueT = Aws::String>

void Aws::SSM::Model::Parameter::SetValue ( ValueT &&  value)

inline

The parameter value.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

Definition at line 78 of file Parameter.h.

SetVersion()

void Aws::SSM::Model::Parameter::SetVersion ( long long  value)

inline

The parameter version.

Definition at line 89 of file Parameter.h.

SourceResultHasBeenSet()

bool Aws::SSM::Model::Parameter::SourceResultHasBeenSet ( ) const

inline

Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

Definition at line 114 of file Parameter.h.

TypeHasBeenSet()

bool Aws::SSM::Model::Parameter::TypeHasBeenSet ( ) const

inline

The type of parameter. Valid values include the following: String, StringList, and SecureString.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

Definition at line 64 of file Parameter.h.

ValueHasBeenSet()

bool Aws::SSM::Model::Parameter::ValueHasBeenSet ( ) const

inline

The parameter value.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

Definition at line 76 of file Parameter.h.

VersionHasBeenSet()

bool Aws::SSM::Model::Parameter::VersionHasBeenSet ( ) const

inline

The parameter version.

Definition at line 88 of file Parameter.h.

WithARN()

template<typename ARNT = Aws::String>

Parameter & Aws::SSM::Model::Parameter::WithARN ( ARNT &&  value)

inline

The Amazon Resource Name (ARN) of the parameter.

Definition at line 143 of file Parameter.h.

WithDataType()

template<typename DataTypeT = Aws::String>

Parameter & Aws::SSM::Model::Parameter::WithDataType ( DataTypeT &&  value)

inline

The data type of the parameter, such as text or aws:ec2:image. The default is text.

Definition at line 156 of file Parameter.h.

WithLastModifiedDate()

template<typename LastModifiedDateT = Aws::Utils::DateTime>

Parameter & Aws::SSM::Model::Parameter::WithLastModifiedDate ( LastModifiedDateT &&  value)

inline

Date the parameter was last changed or updated and the parameter version was created.

Definition at line 131 of file Parameter.h.

WithName()

template<typename NameT = Aws::String>

Parameter & Aws::SSM::Model::Parameter::WithName ( NameT &&  value)

inline

The name of the parameter.

Definition at line 52 of file Parameter.h.

WithSelector()

template<typename SelectorT = Aws::String>

Parameter & Aws::SSM::Model::Parameter::WithSelector ( SelectorT &&  value)

inline

Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

parameter_name:version

parameter_name:label

Definition at line 104 of file Parameter.h.

WithSourceResult()

template<typename SourceResultT = Aws::String>

Parameter & Aws::SSM::Model::Parameter::WithSourceResult ( SourceResultT &&  value)

inline

Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

Definition at line 118 of file Parameter.h.

WithType()

Parameter & Aws::SSM::Model::Parameter::WithType ( ParameterType  value)

inline

The type of parameter. Valid values include the following: String, StringList, and SecureString.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

Definition at line 66 of file Parameter.h.

WithValue()

template<typename ValueT = Aws::String>

Parameter & Aws::SSM::Model::Parameter::WithValue ( ValueT &&  value)

inline

The parameter value.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

Definition at line 80 of file Parameter.h.

WithVersion()

Parameter & Aws::SSM::Model::Parameter::WithVersion ( long long  value)

inline

The parameter version.

Definition at line 90 of file Parameter.h.

---

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

• generated/src/aws-cpp-sdk-ssm/include/aws/ssm/model/Parameter.h