AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::CloudFormation::Model::ListTypesRequest Class Reference

#include <ListTypesRequest.h>

+ Inheritance diagram for Aws::CloudFormation::Model::ListTypesRequest:

Public Member Functions

 ListTypesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const VisibilityGetVisibility () const
 
bool VisibilityHasBeenSet () const
 
void SetVisibility (const Visibility &value)
 
void SetVisibility (Visibility &&value)
 
ListTypesRequestWithVisibility (const Visibility &value)
 
ListTypesRequestWithVisibility (Visibility &&value)
 
const ProvisioningTypeGetProvisioningType () const
 
bool ProvisioningTypeHasBeenSet () const
 
void SetProvisioningType (const ProvisioningType &value)
 
void SetProvisioningType (ProvisioningType &&value)
 
ListTypesRequestWithProvisioningType (const ProvisioningType &value)
 
ListTypesRequestWithProvisioningType (ProvisioningType &&value)
 
const DeprecatedStatusGetDeprecatedStatus () const
 
bool DeprecatedStatusHasBeenSet () const
 
void SetDeprecatedStatus (const DeprecatedStatus &value)
 
void SetDeprecatedStatus (DeprecatedStatus &&value)
 
ListTypesRequestWithDeprecatedStatus (const DeprecatedStatus &value)
 
ListTypesRequestWithDeprecatedStatus (DeprecatedStatus &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListTypesRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListTypesRequestWithNextToken (const Aws::String &value)
 
ListTypesRequestWithNextToken (Aws::String &&value)
 
ListTypesRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual ~CloudFormationRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 24 of file ListTypesRequest.h.

Constructor & Destructor Documentation

◆ ListTypesRequest()

Aws::CloudFormation::Model::ListTypesRequest::ListTypesRequest ( )

Member Function Documentation

◆ DeprecatedStatusHasBeenSet()

bool Aws::CloudFormation::Model::ListTypesRequest::DeprecatedStatusHasBeenSet ( ) const
inline

The deprecation status of the types that you want to get summary information about.

Valid values include:

  • LIVE: The type is registered for use in CloudFormation operations.

  • DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Definition at line 210 of file ListTypesRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudFormation::Model::ListTypesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetDeprecatedStatus()

const DeprecatedStatus& Aws::CloudFormation::Model::ListTypesRequest::GetDeprecatedStatus ( ) const
inline

The deprecation status of the types that you want to get summary information about.

Valid values include:

  • LIVE: The type is registered for use in CloudFormation operations.

  • DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Definition at line 201 of file ListTypesRequest.h.

◆ GetMaxResults()

int Aws::CloudFormation::Model::ListTypesRequest::GetMaxResults ( ) const
inline

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Definition at line 255 of file ListTypesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::CloudFormation::Model::ListTypesRequest::GetNextToken ( ) const
inline

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 290 of file ListTypesRequest.h.

◆ GetProvisioningType()

const ProvisioningType& Aws::CloudFormation::Model::ListTypesRequest::GetProvisioningType ( ) const
inline

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Definition at line 121 of file ListTypesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudFormation::Model::ListTypesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file ListTypesRequest.h.

◆ GetVisibility()

const Visibility& Aws::CloudFormation::Model::ListTypesRequest::GetVisibility ( ) const
inline

The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

  • PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Definition at line 51 of file ListTypesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::CloudFormation::Model::ListTypesRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Definition at line 263 of file ListTypesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::CloudFormation::Model::ListTypesRequest::NextTokenHasBeenSet ( ) const
inline

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 300 of file ListTypesRequest.h.

◆ ProvisioningTypeHasBeenSet()

bool Aws::CloudFormation::Model::ListTypesRequest::ProvisioningTypeHasBeenSet ( ) const
inline

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Definition at line 135 of file ListTypesRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudFormation::Model::ListTypesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDeprecatedStatus() [1/2]

void Aws::CloudFormation::Model::ListTypesRequest::SetDeprecatedStatus ( const DeprecatedStatus value)
inline

The deprecation status of the types that you want to get summary information about.

Valid values include:

  • LIVE: The type is registered for use in CloudFormation operations.

  • DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Definition at line 219 of file ListTypesRequest.h.

◆ SetDeprecatedStatus() [2/2]

void Aws::CloudFormation::Model::ListTypesRequest::SetDeprecatedStatus ( DeprecatedStatus &&  value)
inline

The deprecation status of the types that you want to get summary information about.

Valid values include:

  • LIVE: The type is registered for use in CloudFormation operations.

  • DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Definition at line 228 of file ListTypesRequest.h.

◆ SetMaxResults()

void Aws::CloudFormation::Model::ListTypesRequest::SetMaxResults ( int  value)
inline

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Definition at line 271 of file ListTypesRequest.h.

◆ SetNextToken() [1/3]

void Aws::CloudFormation::Model::ListTypesRequest::SetNextToken ( const Aws::String value)
inline

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 310 of file ListTypesRequest.h.

◆ SetNextToken() [2/3]

void Aws::CloudFormation::Model::ListTypesRequest::SetNextToken ( Aws::String &&  value)
inline

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 320 of file ListTypesRequest.h.

◆ SetNextToken() [3/3]

void Aws::CloudFormation::Model::ListTypesRequest::SetNextToken ( const char *  value)
inline

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 330 of file ListTypesRequest.h.

◆ SetProvisioningType() [1/2]

void Aws::CloudFormation::Model::ListTypesRequest::SetProvisioningType ( const ProvisioningType value)
inline

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Definition at line 149 of file ListTypesRequest.h.

◆ SetProvisioningType() [2/2]

void Aws::CloudFormation::Model::ListTypesRequest::SetProvisioningType ( ProvisioningType &&  value)
inline

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Definition at line 163 of file ListTypesRequest.h.

◆ SetVisibility() [1/2]

void Aws::CloudFormation::Model::ListTypesRequest::SetVisibility ( const Visibility value)
inline

The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

  • PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Definition at line 73 of file ListTypesRequest.h.

◆ SetVisibility() [2/2]

void Aws::CloudFormation::Model::ListTypesRequest::SetVisibility ( Visibility &&  value)
inline

The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

  • PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Definition at line 84 of file ListTypesRequest.h.

◆ VisibilityHasBeenSet()

bool Aws::CloudFormation::Model::ListTypesRequest::VisibilityHasBeenSet ( ) const
inline

The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

  • PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Definition at line 62 of file ListTypesRequest.h.

◆ WithDeprecatedStatus() [1/2]

ListTypesRequest& Aws::CloudFormation::Model::ListTypesRequest::WithDeprecatedStatus ( const DeprecatedStatus value)
inline

The deprecation status of the types that you want to get summary information about.

Valid values include:

  • LIVE: The type is registered for use in CloudFormation operations.

  • DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Definition at line 237 of file ListTypesRequest.h.

◆ WithDeprecatedStatus() [2/2]

ListTypesRequest& Aws::CloudFormation::Model::ListTypesRequest::WithDeprecatedStatus ( DeprecatedStatus &&  value)
inline

The deprecation status of the types that you want to get summary information about.

Valid values include:

  • LIVE: The type is registered for use in CloudFormation operations.

  • DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.

Definition at line 246 of file ListTypesRequest.h.

◆ WithMaxResults()

ListTypesRequest& Aws::CloudFormation::Model::ListTypesRequest::WithMaxResults ( int  value)
inline

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Definition at line 279 of file ListTypesRequest.h.

◆ WithNextToken() [1/3]

ListTypesRequest& Aws::CloudFormation::Model::ListTypesRequest::WithNextToken ( const Aws::String value)
inline

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 340 of file ListTypesRequest.h.

◆ WithNextToken() [2/3]

ListTypesRequest& Aws::CloudFormation::Model::ListTypesRequest::WithNextToken ( Aws::String &&  value)
inline

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 350 of file ListTypesRequest.h.

◆ WithNextToken() [3/3]

ListTypesRequest& Aws::CloudFormation::Model::ListTypesRequest::WithNextToken ( const char *  value)
inline

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 360 of file ListTypesRequest.h.

◆ WithProvisioningType() [1/2]

ListTypesRequest& Aws::CloudFormation::Model::ListTypesRequest::WithProvisioningType ( const ProvisioningType value)
inline

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Definition at line 177 of file ListTypesRequest.h.

◆ WithProvisioningType() [2/2]

ListTypesRequest& Aws::CloudFormation::Model::ListTypesRequest::WithProvisioningType ( ProvisioningType &&  value)
inline

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

Valid values include:

  • FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations.

  • IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

  • NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

Definition at line 191 of file ListTypesRequest.h.

◆ WithVisibility() [1/2]

ListTypesRequest& Aws::CloudFormation::Model::ListTypesRequest::WithVisibility ( const Visibility value)
inline

The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

  • PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Definition at line 95 of file ListTypesRequest.h.

◆ WithVisibility() [2/2]

ListTypesRequest& Aws::CloudFormation::Model::ListTypesRequest::WithVisibility ( Visibility &&  value)
inline

The scope at which the type is visible and usable in CloudFormation operations.

Valid values include:

  • PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE.

  • PUBLIC: The type is publically visible and usable within any Amazon account.

The default is PRIVATE.

Definition at line 106 of file ListTypesRequest.h.


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